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

All Implemented Interfaces:: java.lang.AutoCloseable, NativeResource, Pointer

public class VkPipelineColorBlendAttachmentState
extends Struct

Khronos Reference Page
Vulkan Specification

Contains information about per-target blending state as part of graphics pipeline creation.

Valid Usage

srcColorBlendFactor must be a valid VkBlendFactor value
dstColorBlendFactor must be a valid VkBlendFactor value
colorBlendOp must be a valid VkBlendOp value
srcAlphaBlendFactor must be a valid VkBlendFactor value
dstAlphaBlendFactor must be a valid VkBlendFactor value
alphaBlendOp must be a valid VkBlendOp value
colorWriteMask must be a valid combination of VkColorComponentFlagBits values
If the dual source blending feature is not enabled, srcColorBlendFactor must not be BLEND_FACTOR_SRC1_COLOR, BLEND_FACTOR_ONE_MINUS_SRC1_COLOR, BLEND_FACTOR_SRC1_ALPHA, or BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA
If the dual source blending feature is not enabled, dstColorBlendFactor must not be BLEND_FACTOR_SRC1_COLOR, BLEND_FACTOR_ONE_MINUS_SRC1_COLOR, BLEND_FACTOR_SRC1_ALPHA, or BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA
If the dual source blending feature is not enabled, srcAlphaBlendFactor must not be BLEND_FACTOR_SRC1_COLOR, BLEND_FACTOR_ONE_MINUS_SRC1_COLOR, BLEND_FACTOR_SRC1_ALPHA, or BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA
If the dual source blending feature is not enabled, dstAlphaBlendFactor must not be BLEND_FACTOR_SRC1_COLOR, BLEND_FACTOR_ONE_MINUS_SRC1_COLOR, BLEND_FACTOR_SRC1_ALPHA, or BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA

Member documentation

blendEnable – controls whether blending is enabled for the corresponding color attachment

srcColorBlendFactor – selects which blend factor is used to determine the source factors S_r,S_g,S_b. One of:

`BLEND_FACTOR_CONSTANT_ALPHA`	`BLEND_FACTOR_CONSTANT_COLOR`
`BLEND_FACTOR_DST_ALPHA`	`BLEND_FACTOR_DST_COLOR`
`BLEND_FACTOR_ONE`	`BLEND_FACTOR_ONE_MINUS_CONSTANT_ALPHA`
`BLEND_FACTOR_ONE_MINUS_CONSTANT_COLOR`	`BLEND_FACTOR_ONE_MINUS_DST_ALPHA`
`BLEND_FACTOR_ONE_MINUS_DST_COLOR`	`BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA`
`BLEND_FACTOR_ONE_MINUS_SRC1_COLOR`	`BLEND_FACTOR_ONE_MINUS_SRC_ALPHA`
`BLEND_FACTOR_ONE_MINUS_SRC_COLOR`	`BLEND_FACTOR_SRC1_ALPHA`
`BLEND_FACTOR_SRC1_COLOR`	`BLEND_FACTOR_SRC_ALPHA`
`BLEND_FACTOR_SRC_ALPHA_SATURATE`	`BLEND_FACTOR_SRC_COLOR`
`BLEND_FACTOR_ZERO`

dstColorBlendFactor – selects which blend factor is used to determine the destination factors D_r,D_g,D_b
colorBlendOp – selects which blend operation is used to calculate the RGB values to write to the color attachment. One of:
BLEND_OP_ADD BLEND_OP_MAX BLEND_OP_MIN BLEND_OP_REVERSE_SUBTRACT BLEND_OP_SUBTRACT
srcAlphaBlendFactor – selects which blend factor is used to determine the source factor S_a
dstAlphaBlendFactor – selects which blend factor is used to determine the destination factor D_a
alphaBlendOp – selects which blend operation is use to calculate the alpha values to write to the color attachment
colorWriteMask – a bitmask selecting which of the R, G, B, and/or A components are enabled for writing. One or more of:
COLOR_COMPONENT_A_BIT COLOR_COMPONENT_B_BIT COLOR_COMPONENT_G_BIT
COLOR_COMPONENT_R_BIT

Layout

struct VkPipelineColorBlendAttachmentState {
    VkBool32 blendEnable;
    VkBlendFactor srcColorBlendFactor;
    VkBlendFactor dstColorBlendFactor;
    VkBlendOp colorBlendOp;
    VkBlendFactor srcAlphaBlendFactor;
    VkBlendFactor dstAlphaBlendFactor;
    VkBlendOp alphaBlendOp;
    VkColorComponentFlags colorWriteMask;
}

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

Field Summary

Fields
Modifier and Type Field and Description

static int SIZEOF
The struct size in bytes.
- Fields inherited from interface org.lwjgl.system.Pointer
  POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description
`VkPipelineColorBlendAttachmentState(java.nio.ByteBuffer container)` Creates a `VkPipelineColorBlendAttachmentState` 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`	`alphaBlendOp()` Returns the value of the `alphaBlendOp` field.
`VkPipelineColorBlendAttachmentState`	`alphaBlendOp(int value)` Sets the specified value to the `alphaBlendOp` field.
`int`	`blendEnable()` Returns the value of the `blendEnable` field.
`VkPipelineColorBlendAttachmentState`	`blendEnable(int value)` Sets the specified value to the `blendEnable` field.
`static VkPipelineColorBlendAttachmentState`	`calloc()` Returns a new `VkPipelineColorBlendAttachmentState` instance allocated with `memCalloc`.
`static VkPipelineColorBlendAttachmentState.Buffer`	`calloc(int capacity)` Returns a new `VkPipelineColorBlendAttachmentState.Buffer` instance allocated with `memCalloc`.
`static VkPipelineColorBlendAttachmentState`	`callocStack()` Returns a new `VkPipelineColorBlendAttachmentState` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkPipelineColorBlendAttachmentState.Buffer`	`callocStack(int capacity)` Returns a new `VkPipelineColorBlendAttachmentState.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkPipelineColorBlendAttachmentState.Buffer`	`callocStack(int capacity, MemoryStack stack)` Returns a new `VkPipelineColorBlendAttachmentState.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkPipelineColorBlendAttachmentState`	`callocStack(MemoryStack stack)` Returns a new `VkPipelineColorBlendAttachmentState` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`int`	`colorBlendOp()` Returns the value of the `colorBlendOp` field.
`VkPipelineColorBlendAttachmentState`	`colorBlendOp(int value)` Sets the specified value to the `colorBlendOp` field.
`int`	`colorWriteMask()` Returns the value of the `colorWriteMask` field.
`VkPipelineColorBlendAttachmentState`	`colorWriteMask(int value)` Sets the specified value to the `colorWriteMask` field.
`static VkPipelineColorBlendAttachmentState`	`create()` Returns a new `VkPipelineColorBlendAttachmentState` instance allocated with `BufferUtils`.
`static VkPipelineColorBlendAttachmentState.Buffer`	`create(int capacity)` Returns a new `VkPipelineColorBlendAttachmentState.Buffer` instance allocated with `BufferUtils`.
`static VkPipelineColorBlendAttachmentState`	`create(long address)` Returns a new `VkPipelineColorBlendAttachmentState` instance for the specified memory address or `null` if the address is `NULL`.
`static VkPipelineColorBlendAttachmentState.Buffer`	`create(long address, int capacity)` Create a `VkPipelineColorBlendAttachmentState.Buffer` instance at the specified memory.
`int`	`dstAlphaBlendFactor()` Returns the value of the `dstAlphaBlendFactor` field.
`VkPipelineColorBlendAttachmentState`	`dstAlphaBlendFactor(int value)` Sets the specified value to the `dstAlphaBlendFactor` field.
`int`	`dstColorBlendFactor()` Returns the value of the `dstColorBlendFactor` field.
`VkPipelineColorBlendAttachmentState`	`dstColorBlendFactor(int value)` Sets the specified value to the `dstColorBlendFactor` field.
`static VkPipelineColorBlendAttachmentState`	`malloc()` Returns a new `VkPipelineColorBlendAttachmentState` instance allocated with `memAlloc`.
`static VkPipelineColorBlendAttachmentState.Buffer`	`malloc(int capacity)` Returns a new `VkPipelineColorBlendAttachmentState.Buffer` instance allocated with `memAlloc`.
`static VkPipelineColorBlendAttachmentState`	`mallocStack()` Returns a new `VkPipelineColorBlendAttachmentState` instance allocated on the thread-local `MemoryStack`.
`static VkPipelineColorBlendAttachmentState.Buffer`	`mallocStack(int capacity)` Returns a new `VkPipelineColorBlendAttachmentState.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkPipelineColorBlendAttachmentState.Buffer`	`mallocStack(int capacity, MemoryStack stack)` Returns a new `VkPipelineColorBlendAttachmentState.Buffer` instance allocated on the specified `MemoryStack`.
`static VkPipelineColorBlendAttachmentState`	`mallocStack(MemoryStack stack)` Returns a new `VkPipelineColorBlendAttachmentState` instance allocated on the specified `MemoryStack`.
`VkPipelineColorBlendAttachmentState`	`nset(long struct)` Unsafe version of `set`.
`VkPipelineColorBlendAttachmentState`	`set(int blendEnable, int srcColorBlendFactor, int dstColorBlendFactor, int colorBlendOp, int srcAlphaBlendFactor, int dstAlphaBlendFactor, int alphaBlendOp, int colorWriteMask)` Initializes this struct with the specified values.
`VkPipelineColorBlendAttachmentState`	`set(VkPipelineColorBlendAttachmentState src)` Copies the specified struct data to this struct.
`int`	`sizeof()` Returns the `sizeof(struct)`.
`int`	`srcAlphaBlendFactor()` Returns the value of the `srcAlphaBlendFactor` field.
`VkPipelineColorBlendAttachmentState`	`srcAlphaBlendFactor(int value)` Sets the specified value to the `srcAlphaBlendFactor` field.
`int`	`srcColorBlendFactor()` Returns the value of the `srcColorBlendFactor` field.
`VkPipelineColorBlendAttachmentState`	`srcColorBlendFactor(int value)` Sets the specified value to the `srcColorBlendFactor` field.

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

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

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
- Constructor Detail
  - VkPipelineColorBlendAttachmentState
```
public VkPipelineColorBlendAttachmentState(java.nio.ByteBuffer container)
```
    Creates a VkPipelineColorBlendAttachmentState 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()
```
    Description copied from class: Struct
    
    Returns the sizeof(struct).
    
    Specified by:
    
    sizeof in class Struct
  - blendEnable
```
public int blendEnable()
```
    Returns the value of the blendEnable field.
  - srcColorBlendFactor
```
public int srcColorBlendFactor()
```
    Returns the value of the srcColorBlendFactor field.
  - dstColorBlendFactor
```
public int dstColorBlendFactor()
```
    Returns the value of the dstColorBlendFactor field.
  - colorBlendOp
```
public int colorBlendOp()
```
    Returns the value of the colorBlendOp field.
  - srcAlphaBlendFactor
```
public int srcAlphaBlendFactor()
```
    Returns the value of the srcAlphaBlendFactor field.
  - dstAlphaBlendFactor
```
public int dstAlphaBlendFactor()
```
    Returns the value of the dstAlphaBlendFactor field.
  - alphaBlendOp
```
public int alphaBlendOp()
```
    Returns the value of the alphaBlendOp field.
  - colorWriteMask
```
public int colorWriteMask()
```
    Returns the value of the colorWriteMask field.
  - blendEnable
```
public VkPipelineColorBlendAttachmentState blendEnable(int value)
```
    Sets the specified value to the blendEnable field.
  - srcColorBlendFactor
```
public VkPipelineColorBlendAttachmentState srcColorBlendFactor(int value)
```
    Sets the specified value to the srcColorBlendFactor field.
  - dstColorBlendFactor
```
public VkPipelineColorBlendAttachmentState dstColorBlendFactor(int value)
```
    Sets the specified value to the dstColorBlendFactor field.
  - colorBlendOp
```
public VkPipelineColorBlendAttachmentState colorBlendOp(int value)
```
    Sets the specified value to the colorBlendOp field.
  - srcAlphaBlendFactor
```
public VkPipelineColorBlendAttachmentState srcAlphaBlendFactor(int value)
```
    Sets the specified value to the srcAlphaBlendFactor field.
  - dstAlphaBlendFactor
```
public VkPipelineColorBlendAttachmentState dstAlphaBlendFactor(int value)
```
    Sets the specified value to the dstAlphaBlendFactor field.
  - alphaBlendOp
```
public VkPipelineColorBlendAttachmentState alphaBlendOp(int value)
```
    Sets the specified value to the alphaBlendOp field.
  - colorWriteMask
```
public VkPipelineColorBlendAttachmentState colorWriteMask(int value)
```
    Sets the specified value to the colorWriteMask field.
  - set
```
public VkPipelineColorBlendAttachmentState set(int blendEnable,
                                               int srcColorBlendFactor,
                                               int dstColorBlendFactor,
                                               int colorBlendOp,
                                               int srcAlphaBlendFactor,
                                               int dstAlphaBlendFactor,
                                               int alphaBlendOp,
                                               int colorWriteMask)
```
    Initializes this struct with the specified values.
  - nset
```
public VkPipelineColorBlendAttachmentState nset(long struct)
```
    Unsafe version of set.
  - set
```
public VkPipelineColorBlendAttachmentState set(VkPipelineColorBlendAttachmentState src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkPipelineColorBlendAttachmentState malloc()
```
    Returns a new VkPipelineColorBlendAttachmentState instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkPipelineColorBlendAttachmentState calloc()
```
    Returns a new VkPipelineColorBlendAttachmentState instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkPipelineColorBlendAttachmentState create()
```
    Returns a new VkPipelineColorBlendAttachmentState instance allocated with BufferUtils.
  - create
```
public static VkPipelineColorBlendAttachmentState create(long address)
```
    Returns a new VkPipelineColorBlendAttachmentState instance for the specified memory address or null if the address is NULL.
  - malloc
```
public static VkPipelineColorBlendAttachmentState.Buffer malloc(int capacity)
```
    Returns a new VkPipelineColorBlendAttachmentState.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkPipelineColorBlendAttachmentState.Buffer calloc(int capacity)
```
    Returns a new VkPipelineColorBlendAttachmentState.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkPipelineColorBlendAttachmentState.Buffer create(int capacity)
```
    Returns a new VkPipelineColorBlendAttachmentState.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkPipelineColorBlendAttachmentState.Buffer create(long address,
                                                                int capacity)
```
    Create a VkPipelineColorBlendAttachmentState.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkPipelineColorBlendAttachmentState mallocStack()
```
    Returns a new VkPipelineColorBlendAttachmentState instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkPipelineColorBlendAttachmentState callocStack()
```
    Returns a new VkPipelineColorBlendAttachmentState instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkPipelineColorBlendAttachmentState mallocStack(MemoryStack stack)
```
    Returns a new VkPipelineColorBlendAttachmentState instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkPipelineColorBlendAttachmentState callocStack(MemoryStack stack)
```
    Returns a new VkPipelineColorBlendAttachmentState instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkPipelineColorBlendAttachmentState.Buffer mallocStack(int capacity)
```
    Returns a new VkPipelineColorBlendAttachmentState.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkPipelineColorBlendAttachmentState.Buffer callocStack(int capacity)
```
    Returns a new VkPipelineColorBlendAttachmentState.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkPipelineColorBlendAttachmentState.Buffer mallocStack(int capacity,
                                                                     MemoryStack stack)
```
    Returns a new VkPipelineColorBlendAttachmentState.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkPipelineColorBlendAttachmentState.Buffer callocStack(int capacity,
                                                                     MemoryStack stack)
```
    Returns a new VkPipelineColorBlendAttachmentState.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

`COLOR_COMPONENT_A_BIT`	`COLOR_COMPONENT_B_BIT`	`COLOR_COMPONENT_G_BIT`
`COLOR_COMPONENT_R_BIT`

Class VkPipelineColorBlendAttachmentState

Valid Usage

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

Constructor Detail

VkPipelineColorBlendAttachmentState

Method Detail

sizeof

blendEnable

srcColorBlendFactor

dstColorBlendFactor

colorBlendOp

srcAlphaBlendFactor

dstAlphaBlendFactor

alphaBlendOp

colorWriteMask

blendEnable

srcColorBlendFactor

dstColorBlendFactor

colorBlendOp

srcAlphaBlendFactor

dstAlphaBlendFactor

alphaBlendOp

colorWriteMask

set

nset

set

malloc

calloc

create

create

malloc

calloc

create

create

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack