LWJGL 3.3.3 · org.lwjgl.vulkan.VkPipelineColorBlendStateCreateInfo

Structure specifying parameters of a newly created pipeline color blend state.

Valid Usage

If the independentBlend feature is not enabled, all elements of pAttachments must be identical
If the logicOp feature is not enabled, logicOpEnable must be FALSE
If logicOpEnable is TRUE, logicOp must be a valid VkLogicOp value
If the rasterizationOrderColorAttachmentAccess feature is not enabled, flags must not include PIPELINE_COLOR_BLEND_STATE_CREATE_RASTERIZATION_ORDER_ATTACHMENT_ACCESS_BIT_EXT
If attachmentCount is not 0, and any of DYNAMIC_STATE_COLOR_BLEND_ADVANCED_EXT, DYNAMIC_STATE_COLOR_BLEND_ENABLE_EXT, DYNAMIC_STATE_COLOR_BLEND_EQUATION_EXT, or DYNAMIC_STATE_COLOR_WRITE_MASK_EXT are not set, pAttachments must be a valid pointer to an array of attachmentCount valid VkPipelineColorBlendAttachmentState structures

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_PIPELINE_COLOR_BLEND_STATE_CREATE_INFO
Each pNext member of any structure (including this one) in the pNext chain must be either NULL or a pointer to a valid instance of VkPipelineColorBlendAdvancedStateCreateInfoEXT or VkPipelineColorWriteCreateInfoEXT
The sType value of each struct in the pNext chain must be unique
flags must be a valid combination of VkPipelineColorBlendStateCreateFlagBits values
If attachmentCount is not 0, and pAttachments is not NULL, pAttachments must be a valid pointer to an array of attachmentCount valid VkPipelineColorBlendAttachmentState structures

Layout


struct VkPipelineColorBlendStateCreateInfo {
    VkStructureType sType;
    void const * pNext;
    VkPipelineColorBlendStateCreateFlags flags;
    VkBool32 logicOpEnable;
    VkLogicOp logicOp;
    uint32_t attachmentCount;
    VkPipelineColorBlendAttachmentState const * pAttachments;
    float blendConstants[4];
}

Modifier and Type	Class and Description
public static class	VkPipelineColorBlendStateCreateInfo.Buffer An array of `VkPipelineColorBlendStateCreateInfo` structs.

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	ATTACHMENTCOUNT The struct member offsets.
public static final int	BLENDCONSTANTS The struct member offsets.
public static final int	FLAGS The struct member offsets.
public static final int	LOGICOP The struct member offsets.
public static final int	LOGICOPENABLE The struct member offsets.
public static final int	PATTACHMENTS The struct member offsets.
public static final int	PNEXT The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	STYPE The struct member offsets.

Access	Constructor and Description
protected	VkPipelineColorBlendStateCreateInfo(long address, ByteBuffer container)
public	VkPipelineColorBlendStateCreateInfo(ByteBuffer container) Creates a `VkPipelineColorBlendStateCreateInfo` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public int	attachmentCount() the number of `VkPipelineColorBlendAttachmentState` elements in `pAttachments`.
public VkPipelineColorBlendStateCreateInfo	attachmentCount(int value) Sets the specified value to the `attachmentCount` field.
public FloatBuffer	blendConstants() a pointer to an array of four values used as the R, G, B, and A components of the blend constant that are used in blending, depending on the blend factor.
public float	blendConstants(int index) a pointer to an array of four values used as the R, G, B, and A components of the blend constant that are used in blending, depending on the blend factor.
public VkPipelineColorBlendStateCreateInfo	blendConstants(FloatBuffer value) Copies the specified `FloatBuffer` to the `blendConstants` field.
public VkPipelineColorBlendStateCreateInfo	blendConstants(int index, float value) Sets the specified value at the specified index of the `blendConstants` field.
public static VkPipelineColorBlendStateCreateInfo	calloc() Returns a new `VkPipelineColorBlendStateCreateInfo` instance allocated with `memCalloc`.
public static VkPipelineColorBlendStateCreateInfo.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkPipelineColorBlendStateCreateInfo.Buffer` instance allocated with `memCalloc`.
public static VkPipelineColorBlendStateCreateInfo	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkPipelineColorBlendStateCreateInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkPipelineColorBlendStateCreateInfo.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkPipelineColorBlendStateCreateInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkPipelineColorBlendStateCreateInfo	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkPipelineColorBlendStateCreateInfo	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkPipelineColorBlendStateCreateInfo.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkPipelineColorBlendStateCreateInfo.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
protected VkPipelineColorBlendStateCreateInfo	create(long the struct memory address address, ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. container) Implements abstract org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass.
public static VkPipelineColorBlendStateCreateInfo	create() Returns a new `VkPipelineColorBlendStateCreateInfo` instance allocated with `BufferUtils`.
public static VkPipelineColorBlendStateCreateInfo	create(long address) Returns a new `VkPipelineColorBlendStateCreateInfo` instance for the specified memory address.
public static VkPipelineColorBlendStateCreateInfo.Buffer	create(int the buffer capacity capacity) Returns a new `VkPipelineColorBlendStateCreateInfo.Buffer` instance allocated with `BufferUtils`.
public static VkPipelineColorBlendStateCreateInfo.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkPipelineColorBlendStateCreateInfo.Buffer` instance at the specified memory.
public static VkPipelineColorBlendStateCreateInfo	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkPipelineColorBlendStateCreateInfo.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public int	flags() a bitmask of `VkPipelineColorBlendStateCreateFlagBits` specifying additional color blending information.
public VkPipelineColorBlendStateCreateInfo	flags(int value) Sets the specified value to the `flags` field.
public int	logicOp() selects which logical operation to apply.
public VkPipelineColorBlendStateCreateInfo	logicOp(int value) Sets the specified value to the `logicOp` field.
public boolean	logicOpEnable() controls whether to apply Logical Operations.
public VkPipelineColorBlendStateCreateInfo	logicOpEnable(boolean value) Sets the specified value to the `logicOpEnable` field.
public static VkPipelineColorBlendStateCreateInfo	malloc() Returns a new `VkPipelineColorBlendStateCreateInfo` instance allocated with `memAlloc`.
public static VkPipelineColorBlendStateCreateInfo.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkPipelineColorBlendStateCreateInfo.Buffer` instance allocated with `memAlloc`.
public static VkPipelineColorBlendStateCreateInfo	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkPipelineColorBlendStateCreateInfo` instance allocated on the specified `MemoryStack`.
public static VkPipelineColorBlendStateCreateInfo.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkPipelineColorBlendStateCreateInfo.Buffer` instance allocated on the specified `MemoryStack`.
public static VkPipelineColorBlendStateCreateInfo	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkPipelineColorBlendStateCreateInfo	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkPipelineColorBlendStateCreateInfo.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkPipelineColorBlendStateCreateInfo.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static int	nattachmentCount(long struct) Unsafe version of `attachmentCount`.
public static void	nattachmentCount(long struct, int value) Sets the specified value to the `attachmentCount` field of the specified `struct`.
public static FloatBuffer	nblendConstants(long struct) Unsafe version of `blendConstants`.
public static float	nblendConstants(long struct, int index) Unsafe version of `blendConstants`.
public static void	nblendConstants(long struct, FloatBuffer value) Unsafe version of `blendConstants`.
public static void	nblendConstants(long struct, int index, float value) Unsafe version of `blendConstants`.
public static int	nflags(long struct) Unsafe version of `flags`.
public static void	nflags(long struct, int value) Unsafe version of `flags`.
public static int	nlogicOp(long struct) Unsafe version of `logicOp`.
public static void	nlogicOp(long struct, int value) Unsafe version of `logicOp`.
public static int	nlogicOpEnable(long struct) Unsafe version of `logicOpEnable`.
public static void	nlogicOpEnable(long struct, int value) Unsafe version of `logicOpEnable`.
public static VkPipelineColorBlendAttachmentState.Buffer	npAttachments(long struct) Unsafe version of `pAttachments`.
public static void	npAttachments(long struct, VkPipelineColorBlendAttachmentState.Buffer value) Unsafe version of `pAttachments`.
public static long	npNext(long struct) Unsafe version of `pNext`.
public static void	npNext(long struct, long value) Unsafe version of `pNext`.
public static int	nsType(long struct) Unsafe version of `sType`.
public static void	nsType(long struct, int value) Unsafe version of `sType`.
public VkPipelineColorBlendAttachmentState.Buffer	pAttachments() a pointer to an array of `VkPipelineColorBlendAttachmentState` structures defining blend state for each color attachment.
public VkPipelineColorBlendStateCreateInfo	pAttachments(VkPipelineColorBlendAttachmentState.Buffer value) Sets the address of the specified `VkPipelineColorBlendAttachmentState.Buffer` to the `pAttachments` field.
public long	pNext() `NULL` or a pointer to a structure extending this structure.
public VkPipelineColorBlendStateCreateInfo	pNext(long value) Sets the specified value to the `pNext` field.
public VkPipelineColorBlendStateCreateInfo	pNext(VkPipelineColorBlendAdvancedStateCreateInfoEXT value) Prepends the specified `VkPipelineColorBlendAdvancedStateCreateInfoEXT` value to the `pNext` chain.
public VkPipelineColorBlendStateCreateInfo	pNext(VkPipelineColorWriteCreateInfoEXT value) Prepends the specified `VkPipelineColorWriteCreateInfoEXT` value to the `pNext` chain.
public VkPipelineColorBlendStateCreateInfo	set(int sType, long pNext, int flags, boolean logicOpEnable, int logicOp, int attachmentCount, VkPipelineColorBlendAttachmentState.Buffer pAttachments, FloatBuffer blendConstants) Initializes this struct with the specified values.
public VkPipelineColorBlendStateCreateInfo	Returns: this struct set(VkPipelineColorBlendStateCreateInfo the source struct src) Copies the specified struct data to this struct.
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.
public int	sType() a `VkStructureType` value identifying this structure.
public VkPipelineColorBlendStateCreateInfo	sType(int value) Sets the specified value to the `sType` field.
public VkPipelineColorBlendStateCreateInfo	sType$Default() Sets the `STRUCTURE_TYPE_PIPELINE_COLOR_BLEND_STATE_CREATE_INFO` value to the `sType` field.

public Class VkPipelineColorBlendStateCreateInfo

Valid Usage

Valid Usage (Implicit)

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary