VkPipelineColorBlendStateCreateInfo (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkPipelineColorBlendStateCreateInfo

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkPipelineColorBlendStateCreateInfo
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying parameters of a newly created pipeline color blend state.
Description

Each element of the pAttachments array is a VkPipelineColorBlendAttachmentState structure specifying per-target blending state for each individual color attachment. If the independent blending feature is not enabled on the device, all VkPipelineColorBlendAttachmentState elements in the pAttachments array must be identical.

Valid Usage
- If the independent blending feature is not enabled, all elements of pAttachments must be identical
- If the logic operations feature is not enabled, logicOpEnable must be FALSE
- If logicOpEnable is TRUE, logicOp must be a valid VkLogicOp value
Valid Usage (Implicit)
- sType must be STRUCTURE_TYPE_PIPELINE_COLOR_BLEND_STATE_CREATE_INFO
- pNext must be NULL or a pointer to a valid instance of VkPipelineColorBlendAdvancedStateCreateInfoEXT
- flags must be 0
- If attachmentCount is not 0, pAttachments must be a valid pointer to an array of attachmentCount valid VkPipelineColorBlendAttachmentState structures
See Also

VkGraphicsPipelineCreateInfo, VkPipelineColorBlendAttachmentState

Member documentation
- sType – the type of this structure.
- pNext – NULL or a pointer to an extension-specific structure.
- flags – reserved for future use.
- logicOpEnable – controls whether to apply Logical Operations.
- logicOp – selects which logical operation to apply.
- attachmentCount – the number of VkPipelineColorBlendAttachmentState elements in pAttachments. This value must equal the colorAttachmentCount for the subpass in which this pipeline is used.
- pAttachments – a pointer to an array of per target attachment states.
- blendConstants[4] – 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.
Layout
```
 struct VkPipelineColorBlendStateCreateInfo {
     VkStructureType sType;
     void const * pNext;
     VkPipelineColorBlendStateCreateFlags flags;
     VkBool32 logicOpEnable;
     VkLogicOp logicOp;
     uint32_t attachmentCount;
     VkPipelineColorBlendAttachmentState const * pAttachments;
     float blendConstants[4];
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkPipelineColorBlendStateCreateInfo.Buffer
An array of VkPipelineColorBlendStateCreateInfo structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

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

Field Summary

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

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description
`VkPipelineColorBlendStateCreateInfo(java.nio.ByteBuffer container)` Creates a `VkPipelineColorBlendStateCreateInfo` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`attachmentCount()` Returns the value of the `attachmentCount` field.
`java.nio.FloatBuffer`	`blendConstants()` Returns a `FloatBuffer` view of the `blendConstants` field.
`VkPipelineColorBlendStateCreateInfo`	`blendConstants(java.nio.FloatBuffer value)` Copies the specified `FloatBuffer` to the `blendConstants` field.
`float`	`blendConstants(int index)` Returns the value at the specified index of the `blendConstants` field.
`VkPipelineColorBlendStateCreateInfo`	`blendConstants(int index, float value)` Sets the specified value at the specified index of the `blendConstants` field.
`static VkPipelineColorBlendStateCreateInfo`	`calloc()` Returns a new `VkPipelineColorBlendStateCreateInfo` instance allocated with `memCalloc`.
`static VkPipelineColorBlendStateCreateInfo.Buffer`	`calloc(int capacity)` Returns a new `VkPipelineColorBlendStateCreateInfo.Buffer` instance allocated with `memCalloc`.
`static VkPipelineColorBlendStateCreateInfo`	`callocStack()` Returns a new `VkPipelineColorBlendStateCreateInfo` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkPipelineColorBlendStateCreateInfo.Buffer`	`callocStack(int capacity)` Returns a new `VkPipelineColorBlendStateCreateInfo.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkPipelineColorBlendStateCreateInfo.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkPipelineColorBlendStateCreateInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkPipelineColorBlendStateCreateInfo`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkPipelineColorBlendStateCreateInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkPipelineColorBlendStateCreateInfo`	`create()` Returns a new `VkPipelineColorBlendStateCreateInfo` instance allocated with `BufferUtils`.
`static VkPipelineColorBlendStateCreateInfo.Buffer`	`create(int capacity)` Returns a new `VkPipelineColorBlendStateCreateInfo.Buffer` instance allocated with `BufferUtils`.
`static VkPipelineColorBlendStateCreateInfo`	`create(long address)` Returns a new `VkPipelineColorBlendStateCreateInfo` instance for the specified memory address.
`static VkPipelineColorBlendStateCreateInfo.Buffer`	`create(long address, int capacity)` Create a `VkPipelineColorBlendStateCreateInfo.Buffer` instance at the specified memory.
`static VkPipelineColorBlendStateCreateInfo`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkPipelineColorBlendStateCreateInfo.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`flags()` Returns the value of the `flags` field.
`VkPipelineColorBlendStateCreateInfo`	`flags(int value)` Sets the specified value to the `flags` field.
`int`	`logicOp()` Returns the value of the `logicOp` field.
`VkPipelineColorBlendStateCreateInfo`	`logicOp(int value)` Sets the specified value to the `logicOp` field.
`boolean`	`logicOpEnable()` Returns the value of the `logicOpEnable` field.
`VkPipelineColorBlendStateCreateInfo`	`logicOpEnable(boolean value)` Sets the specified value to the `logicOpEnable` field.
`static VkPipelineColorBlendStateCreateInfo`	`malloc()` Returns a new `VkPipelineColorBlendStateCreateInfo` instance allocated with `memAlloc`.
`static VkPipelineColorBlendStateCreateInfo.Buffer`	`malloc(int capacity)` Returns a new `VkPipelineColorBlendStateCreateInfo.Buffer` instance allocated with `memAlloc`.
`static VkPipelineColorBlendStateCreateInfo`	`mallocStack()` Returns a new `VkPipelineColorBlendStateCreateInfo` instance allocated on the thread-local `MemoryStack`.
`static VkPipelineColorBlendStateCreateInfo.Buffer`	`mallocStack(int capacity)` Returns a new `VkPipelineColorBlendStateCreateInfo.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkPipelineColorBlendStateCreateInfo.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `VkPipelineColorBlendStateCreateInfo.Buffer` instance allocated on the specified `MemoryStack`.
`static VkPipelineColorBlendStateCreateInfo`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkPipelineColorBlendStateCreateInfo` instance allocated on the specified `MemoryStack`.
`static int`	`nattachmentCount(long struct)` Unsafe version of `attachmentCount()`.
`static void`	`nattachmentCount(long struct, int value)` Sets the specified value to the `attachmentCount` field of the specified `struct`.
`static java.nio.FloatBuffer`	`nblendConstants(long struct)` Unsafe version of `blendConstants()`.
`static void`	`nblendConstants(long struct, java.nio.FloatBuffer value)` Unsafe version of `blendConstants`.
`static float`	`nblendConstants(long struct, int index)` Unsafe version of `blendConstants`.
`static void`	`nblendConstants(long struct, int index, float value)` Unsafe version of `blendConstants`.
`static int`	`nflags(long struct)` Unsafe version of `flags()`.
`static void`	`nflags(long struct, int value)` Unsafe version of `flags`.
`static int`	`nlogicOp(long struct)` Unsafe version of `logicOp()`.
`static void`	`nlogicOp(long struct, int value)` Unsafe version of `logicOp`.
`static int`	`nlogicOpEnable(long struct)` Unsafe version of `logicOpEnable()`.
`static void`	`nlogicOpEnable(long struct, int value)` Unsafe version of `logicOpEnable`.
`static VkPipelineColorBlendAttachmentState.Buffer`	`npAttachments(long struct)` Unsafe version of `pAttachments()`.
`static void`	`npAttachments(long struct, VkPipelineColorBlendAttachmentState.Buffer value)` Unsafe version of `pAttachments`.
`static long`	`npNext(long struct)` Unsafe version of `pNext()`.
`static void`	`npNext(long struct, long value)` Unsafe version of `pNext`.
`static int`	`nsType(long struct)` Unsafe version of `sType()`.
`static void`	`nsType(long struct, int value)` Unsafe version of `sType`.
`VkPipelineColorBlendAttachmentState.Buffer`	`pAttachments()` Returns a `VkPipelineColorBlendAttachmentState.Buffer` view of the struct array pointed to by the `pAttachments` field.
`VkPipelineColorBlendStateCreateInfo`	`pAttachments(VkPipelineColorBlendAttachmentState.Buffer value)` Sets the address of the specified `VkPipelineColorBlendAttachmentState.Buffer` to the `pAttachments` field.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkPipelineColorBlendStateCreateInfo`	`pNext(long value)` Sets the specified value to the `pNext` field.
`VkPipelineColorBlendStateCreateInfo`	`set(int sType, long pNext, int flags, boolean logicOpEnable, int logicOp, VkPipelineColorBlendAttachmentState.Buffer pAttachments, java.nio.FloatBuffer blendConstants)` Initializes this struct with the specified values.
`VkPipelineColorBlendStateCreateInfo`	`set(VkPipelineColorBlendStateCreateInfo src)` Copies the specified struct data to this struct.
`int`	`sizeof()`
`int`	`sType()` Returns the value of the `sType` field.
`VkPipelineColorBlendStateCreateInfo`	`sType(int value)` Sets the specified value to the `sType` field.
`static void`	`validate(long struct)` Validates pointer members that should not be `NULL`.
`static void`	`validate(long array, int count)` Calls `validate(long)` for each struct contained in the specified struct array.

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

Field Detail
- SIZEOF
```
public static final int SIZEOF
```
  The struct size in bytes.
- ALIGNOF
```
public static final int ALIGNOF
```
  The struct alignment in bytes.
- STYPE
```
public static final int STYPE
```
  The struct member offsets.
- PNEXT
```
public static final int PNEXT
```
  The struct member offsets.
- FLAGS
```
public static final int FLAGS
```
  The struct member offsets.
- LOGICOPENABLE
```
public static final int LOGICOPENABLE
```
  The struct member offsets.
- LOGICOP
```
public static final int LOGICOP
```
  The struct member offsets.
- ATTACHMENTCOUNT
```
public static final int ATTACHMENTCOUNT
```
  The struct member offsets.
- PATTACHMENTS
```
public static final int PATTACHMENTS
```
  The struct member offsets.
- BLENDCONSTANTS
```
public static final int BLENDCONSTANTS
```
  The struct member offsets.

Constructor Detail
- VkPipelineColorBlendStateCreateInfo
```
public VkPipelineColorBlendStateCreateInfo(java.nio.ByteBuffer container)
```
  Creates a VkPipelineColorBlendStateCreateInfo instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.
  The created instance holds a strong reference to the container object.

Method Detail

sizeof
```
public int sizeof()
```
Specified by:

sizeof in class org.lwjgl.system.Struct

sType
```
public int sType()
```
Returns the value of the sType field.

pNext
```
public long pNext()
```
Returns the value of the pNext field.

flags
```
public int flags()
```
Returns the value of the flags field.

logicOpEnable
```
public boolean logicOpEnable()
```
Returns the value of the logicOpEnable field.

logicOp
```
public int logicOp()
```
Returns the value of the logicOp field.

attachmentCount
```
public int attachmentCount()
```
Returns the value of the attachmentCount field.

pAttachments
```
@Nullable
public VkPipelineColorBlendAttachmentState.Buffer pAttachments()
```
Returns a VkPipelineColorBlendAttachmentState.Buffer view of the struct array pointed to by the pAttachments field.

blendConstants
```
public java.nio.FloatBuffer blendConstants()
```
Returns a FloatBuffer view of the blendConstants field.

blendConstants
```
public float blendConstants(int index)
```
Returns the value at the specified index of the blendConstants field.

sType

public VkPipelineColorBlendStateCreateInfo sType(int value)

Sets the specified value to the sType field.

pNext

public VkPipelineColorBlendStateCreateInfo pNext(long value)

Sets the specified value to the pNext field.

flags

public VkPipelineColorBlendStateCreateInfo flags(int value)

Sets the specified value to the flags field.

logicOpEnable

public VkPipelineColorBlendStateCreateInfo logicOpEnable(boolean value)

Sets the specified value to the logicOpEnable field.

logicOp

public VkPipelineColorBlendStateCreateInfo logicOp(int value)

Sets the specified value to the logicOp field.

pAttachments

public VkPipelineColorBlendStateCreateInfo pAttachments(@Nullable
                                                        VkPipelineColorBlendAttachmentState.Buffer value)

Sets the address of the specified VkPipelineColorBlendAttachmentState.Buffer to the pAttachments field.

blendConstants

public VkPipelineColorBlendStateCreateInfo blendConstants(java.nio.FloatBuffer value)

Copies the specified FloatBuffer to the blendConstants field.

blendConstants

public VkPipelineColorBlendStateCreateInfo blendConstants(int index,
                                                          float value)

Sets the specified value at the specified index of the blendConstants field.

set

public VkPipelineColorBlendStateCreateInfo set(int sType,
                                               long pNext,
                                               int flags,
                                               boolean logicOpEnable,
                                               int logicOp,
                                               @Nullable
                                               VkPipelineColorBlendAttachmentState.Buffer pAttachments,
                                               java.nio.FloatBuffer blendConstants)

Initializes this struct with the specified values.

set
```
public VkPipelineColorBlendStateCreateInfo set(VkPipelineColorBlendStateCreateInfo src)
```
Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc
```
public static VkPipelineColorBlendStateCreateInfo malloc()
```
Returns a new VkPipelineColorBlendStateCreateInfo instance allocated with memAlloc. The instance must be explicitly freed.

calloc
```
public static VkPipelineColorBlendStateCreateInfo calloc()
```
Returns a new VkPipelineColorBlendStateCreateInfo instance allocated with memCalloc. The instance must be explicitly freed.

create
```
public static VkPipelineColorBlendStateCreateInfo create()
```
Returns a new VkPipelineColorBlendStateCreateInfo instance allocated with BufferUtils.

create
```
public static VkPipelineColorBlendStateCreateInfo create(long address)
```
Returns a new VkPipelineColorBlendStateCreateInfo instance for the specified memory address.

createSafe

@Nullable
public static VkPipelineColorBlendStateCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc
```
public static VkPipelineColorBlendStateCreateInfo.Buffer malloc(int capacity)
```
Returns a new VkPipelineColorBlendStateCreateInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc
```
public static VkPipelineColorBlendStateCreateInfo.Buffer calloc(int capacity)
```
Returns a new VkPipelineColorBlendStateCreateInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create
```
public static VkPipelineColorBlendStateCreateInfo.Buffer create(int capacity)
```
Returns a new VkPipelineColorBlendStateCreateInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static VkPipelineColorBlendStateCreateInfo.Buffer create(long address,
                                                                int capacity)

Create a VkPipelineColorBlendStateCreateInfo.Buffer instance at the specified memory.

Parameters:: address - the memory address; capacity - the buffer capacity

createSafe

@Nullable
public static VkPipelineColorBlendStateCreateInfo.Buffer createSafe(long address,
                                                                              int capacity)

Like create, but returns null if address is NULL.

mallocStack
```
public static VkPipelineColorBlendStateCreateInfo mallocStack()
```
Returns a new VkPipelineColorBlendStateCreateInfo instance allocated on the thread-local MemoryStack.

callocStack
```
public static VkPipelineColorBlendStateCreateInfo callocStack()
```
Returns a new VkPipelineColorBlendStateCreateInfo instance allocated on the thread-local MemoryStack and initializes all its bits to zero.

mallocStack
```
public static VkPipelineColorBlendStateCreateInfo mallocStack(org.lwjgl.system.MemoryStack stack)
```
Returns a new VkPipelineColorBlendStateCreateInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

callocStack
```
public static VkPipelineColorBlendStateCreateInfo callocStack(org.lwjgl.system.MemoryStack stack)
```
Returns a new VkPipelineColorBlendStateCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

mallocStack
```
public static VkPipelineColorBlendStateCreateInfo.Buffer mallocStack(int capacity)
```
Returns a new VkPipelineColorBlendStateCreateInfo.Buffer instance allocated on the thread-local MemoryStack.

Parameters:

capacity - the buffer capacity

callocStack
```
public static VkPipelineColorBlendStateCreateInfo.Buffer callocStack(int capacity)
```
Returns a new VkPipelineColorBlendStateCreateInfo.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.

Parameters:

capacity - the buffer capacity

mallocStack

public static VkPipelineColorBlendStateCreateInfo.Buffer mallocStack(int capacity,
                                                                     org.lwjgl.system.MemoryStack stack)

Returns a new VkPipelineColorBlendStateCreateInfo.Buffer instance allocated on the specified MemoryStack.

Parameters:: stack - the stack from which to allocate; capacity - the buffer capacity

callocStack
```
public static VkPipelineColorBlendStateCreateInfo.Buffer callocStack(int capacity,
                                                                     org.lwjgl.system.MemoryStack stack)
```
Returns a new VkPipelineColorBlendStateCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

capacity - the buffer capacity

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nflags

public static int nflags(long struct)

Unsafe version of flags().

nlogicOpEnable

public static int nlogicOpEnable(long struct)

Unsafe version of logicOpEnable().

nlogicOp

public static int nlogicOp(long struct)

Unsafe version of logicOp().

nattachmentCount
```
public static int nattachmentCount(long struct)
```
Unsafe version of attachmentCount().

npAttachments

@Nullable
public static VkPipelineColorBlendAttachmentState.Buffer npAttachments(long struct)

Unsafe version of pAttachments().

nblendConstants

public static java.nio.FloatBuffer nblendConstants(long struct)

Unsafe version of blendConstants().

nblendConstants

public static float nblendConstants(long struct,
                                    int index)

Unsafe version of blendConstants.

nsType

public static void nsType(long struct,
                          int value)

Unsafe version of sType.

npNext

public static void npNext(long struct,
                          long value)

Unsafe version of pNext.

nflags

public static void nflags(long struct,
                          int value)

Unsafe version of flags.

nlogicOpEnable

public static void nlogicOpEnable(long struct,
                                  int value)

Unsafe version of logicOpEnable.

nlogicOp

public static void nlogicOp(long struct,
                            int value)

Unsafe version of logicOp.

nattachmentCount

public static void nattachmentCount(long struct,
                                    int value)

Sets the specified value to the attachmentCount field of the specified struct.

npAttachments

public static void npAttachments(long struct,
                                 @Nullable
                                 VkPipelineColorBlendAttachmentState.Buffer value)

Unsafe version of pAttachments.

nblendConstants

public static void nblendConstants(long struct,
                                   java.nio.FloatBuffer value)

Unsafe version of blendConstants.

nblendConstants

public static void nblendConstants(long struct,
                                   int index,
                                   float value)

Unsafe version of blendConstants.

validate
```
public static void validate(long struct)
```
Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate

validate
```
public static void validate(long array,
                            int count)
```
Calls validate(long) for each struct contained in the specified struct array.

Parameters:

array - the struct array to validate

count - the number of structs in array

Class VkPipelineColorBlendStateCreateInfo

Description

Valid Usage

Valid Usage (Implicit)

See Also

Member documentation

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

STYPE

PNEXT

FLAGS

LOGICOPENABLE

LOGICOP

ATTACHMENTCOUNT

PATTACHMENTS

BLENDCONSTANTS

Constructor Detail

VkPipelineColorBlendStateCreateInfo

Method Detail

sizeof

sType

pNext

flags

logicOpEnable

logicOp

attachmentCount

pAttachments

blendConstants

blendConstants

sType

pNext

flags

logicOpEnable

logicOp

pAttachments

blendConstants

blendConstants

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nsType

npNext

nflags

nlogicOpEnable

nlogicOp

nattachmentCount

npAttachments

nblendConstants

nblendConstants

nsType

npNext