Top Description Inners Fields Constructors Methods
org.lwjgl.vulkan

public Class VkPipelineColorWriteCreateInfoEXT

extends Struct<VkPipelineColorWriteCreateInfoEXT>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Structure specifying color write state of a newly created pipeline.
Description

When this structure is included in the pNext chain of VkPipelineColorBlendStateCreateInfo, it defines per-attachment color write state. If this structure is not included in the pNext chain, it is equivalent to specifying this structure with attachmentCount equal to the attachmentCount member of VkPipelineColorBlendStateCreateInfo, and pColorWriteEnables pointing to an array of as many TRUE values.

If the colorWriteEnable feature is not enabled on the device, all VkBool32 elements in the pColorWriteEnables array must be TRUE.

Color Write Enable interacts with the Color Write Mask as follows:

Valid Usage
Valid Usage (Implicit)

Layout


struct VkPipelineColorWriteCreateInfoEXT {
    VkStructureType sType;
    void const * pNext;
    uint32_t attachmentCount;
    VkBool32 const * pColorWriteEnables;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField 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
PCOLORWRITEENABLES

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.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
public
VkPipelineColorWriteCreateInfoEXT(ByteBuffer container)

Creates a VkPipelineColorWriteCreateInfoEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public int
attachmentCount()

the number of VkBool32 elements in pColorWriteEnables.

public static VkPipelineColorWriteCreateInfoEXT
calloc()

Returns a new VkPipelineColorWriteCreateInfoEXT instance allocated with memCalloc.

public static VkPipelineColorWriteCreateInfoEXT.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new VkPipelineColorWriteCreateInfoEXT.Buffer instance allocated with memCalloc.

public static VkPipelineColorWriteCreateInfoEXT
calloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkPipelineColorWriteCreateInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static VkPipelineColorWriteCreateInfoEXT.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new VkPipelineColorWriteCreateInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

protected VkPipelineColorWriteCreateInfoEXT
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 VkPipelineColorWriteCreateInfoEXT
create()

Returns a new VkPipelineColorWriteCreateInfoEXT instance allocated with BufferUtils.

public static VkPipelineColorWriteCreateInfoEXT
create(long address)

Returns a new VkPipelineColorWriteCreateInfoEXT instance for the specified memory address.

public static VkPipelineColorWriteCreateInfoEXT.Buffer
create(int
the buffer capacity
capacity
)

Returns a new VkPipelineColorWriteCreateInfoEXT.Buffer instance allocated with BufferUtils.

public static VkPipelineColorWriteCreateInfoEXT.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a VkPipelineColorWriteCreateInfoEXT.Buffer instance at the specified memory.

public static VkPipelineColorWriteCreateInfoEXT
createSafe(long address)

Like create, but returns null if address is NULL.

public static VkPipelineColorWriteCreateInfoEXT.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public static VkPipelineColorWriteCreateInfoEXT
malloc()

Returns a new VkPipelineColorWriteCreateInfoEXT instance allocated with memAlloc.

public static VkPipelineColorWriteCreateInfoEXT.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new VkPipelineColorWriteCreateInfoEXT.Buffer instance allocated with memAlloc.

public static VkPipelineColorWriteCreateInfoEXT
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new VkPipelineColorWriteCreateInfoEXT instance allocated on the specified MemoryStack.

public static VkPipelineColorWriteCreateInfoEXT.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

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 IntBuffer
npColorWriteEnables(long struct)

Unsafe version of pColorWriteEnables.

public static void
npColorWriteEnables(long struct, IntBuffer value)

Unsafe version of pColorWriteEnables.

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 IntBuffer
pColorWriteEnables()

a pointer to an array of per target attachment boolean values specifying whether color writes are enabled for the given attachment.

public VkPipelineColorWriteCreateInfoEXT
pColorWriteEnables(IntBuffer value)

Sets the address of the specified IntBuffer to the pColorWriteEnables field.

public long
pNext()

NULL or a pointer to a structure extending this structure.

public VkPipelineColorWriteCreateInfoEXT
pNext(long value)

Sets the specified value to the pNext field.

public VkPipelineColorWriteCreateInfoEXT
set(int sType, long pNext, IntBuffer pColorWriteEnables)

Initializes this struct with the specified values.

public VkPipelineColorWriteCreateInfoEXT

Returns:

this struct
set
(VkPipelineColorWriteCreateInfoEXT
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 VkPipelineColorWriteCreateInfoEXT
sType(int value)

Sets the specified value to the sType field.

public VkPipelineColorWriteCreateInfoEXT
public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

ATTACHMENTCOUNTback to summary
public static final int ATTACHMENTCOUNT

The struct member offsets.

PCOLORWRITEENABLESback to summary
public static final int PCOLORWRITEENABLES

The struct member offsets.

PNEXTback to summary
public static final int PNEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STYPEback to summary
public static final int STYPE

The struct member offsets.

Constructor Detail

VkPipelineColorWriteCreateInfoEXTback to summary
protected VkPipelineColorWriteCreateInfoEXT(long address, ByteBuffer container)
VkPipelineColorWriteCreateInfoEXTback to summary
public VkPipelineColorWriteCreateInfoEXT(ByteBuffer container)

Creates a VkPipelineColorWriteCreateInfoEXT 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

attachmentCountback to summary
public int attachmentCount()

the number of VkBool32 elements in pColorWriteEnables.

Annotations
@NativeType:uint32_t
callocback to summary
public static VkPipelineColorWriteCreateInfoEXT calloc()

Returns a new VkPipelineColorWriteCreateInfoEXT instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static VkPipelineColorWriteCreateInfoEXT.Buffer calloc(int capacity)

Returns a new VkPipelineColorWriteCreateInfoEXT.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

callocback to summary
public static VkPipelineColorWriteCreateInfoEXT calloc(MemoryStack stack)

Returns a new VkPipelineColorWriteCreateInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static VkPipelineColorWriteCreateInfoEXT.Buffer calloc(int capacity, MemoryStack stack)

Returns a new VkPipelineColorWriteCreateInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected VkPipelineColorWriteCreateInfoEXT create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static VkPipelineColorWriteCreateInfoEXT create()

Returns a new VkPipelineColorWriteCreateInfoEXT instance allocated with BufferUtils.

createback to summary
public static VkPipelineColorWriteCreateInfoEXT create(long address)

Returns a new VkPipelineColorWriteCreateInfoEXT instance for the specified memory address.

createback to summary
public static VkPipelineColorWriteCreateInfoEXT.Buffer create(int capacity)

Returns a new VkPipelineColorWriteCreateInfoEXT.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static VkPipelineColorWriteCreateInfoEXT.Buffer create(long address, int capacity)

Create a VkPipelineColorWriteCreateInfoEXT.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static VkPipelineColorWriteCreateInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static VkPipelineColorWriteCreateInfoEXT.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static VkPipelineColorWriteCreateInfoEXT malloc()

Returns a new VkPipelineColorWriteCreateInfoEXT instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static VkPipelineColorWriteCreateInfoEXT.Buffer malloc(int capacity)

Returns a new VkPipelineColorWriteCreateInfoEXT.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static VkPipelineColorWriteCreateInfoEXT malloc(MemoryStack stack)

Returns a new VkPipelineColorWriteCreateInfoEXT instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static VkPipelineColorWriteCreateInfoEXT.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nattachmentCountback to summary
public static int nattachmentCount(long struct)

Unsafe version of attachmentCount.

nattachmentCountback to summary
public static void nattachmentCount(long struct, int value)

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

npColorWriteEnablesback to summary
public static IntBuffer npColorWriteEnables(long struct)

Unsafe version of pColorWriteEnables.

Annotations
@Nullable
npColorWriteEnablesback to summary
public static void npColorWriteEnables(long struct, IntBuffer value)

Unsafe version of pColorWriteEnables.

npNextback to summary
public static long npNext(long struct)

Unsafe version of pNext.

npNextback to summary
public static void npNext(long struct, long value)

Unsafe version of pNext.

nsTypeback to summary
public static int nsType(long struct)

Unsafe version of sType.

nsTypeback to summary
public static void nsType(long struct, int value)

Unsafe version of sType.

pColorWriteEnablesback to summary
public IntBuffer pColorWriteEnables()

a pointer to an array of per target attachment boolean values specifying whether color writes are enabled for the given attachment.

Annotations
@Nullable
@NativeType:VkBool32 const *
pColorWriteEnablesback to summary
public VkPipelineColorWriteCreateInfoEXT pColorWriteEnables(IntBuffer value)

Sets the address of the specified IntBuffer to the pColorWriteEnables field.

pNextback to summary
public long pNext()

NULL or a pointer to a structure extending this structure.

Annotations
@NativeType:void const *
pNextback to summary
public VkPipelineColorWriteCreateInfoEXT pNext(long value)

Sets the specified value to the pNext field.

setback to summary
public VkPipelineColorWriteCreateInfoEXT set(int sType, long pNext, IntBuffer pColorWriteEnables)

Initializes this struct with the specified values.

setback to summary
public VkPipelineColorWriteCreateInfoEXT set(VkPipelineColorWriteCreateInfoEXT src)

Copies the specified struct data to this struct.

Parameters
src:VkPipelineColorWriteCreateInfoEXT

the source struct

Returns:VkPipelineColorWriteCreateInfoEXT

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
sTypeback to summary
public int sType()

a VkStructureType value identifying this structure.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkPipelineColorWriteCreateInfoEXT sType(int value)

Sets the specified value to the sType field.

sType$Defaultback to summary
public VkPipelineColorWriteCreateInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_PIPELINE_COLOR_WRITE_CREATE_INFO_EXT value to the sType field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.vulkan back to summary

public Class VkPipelineColorWriteCreateInfoEXT.Buffer

extends StructBuffer<VkPipelineColorWriteCreateInfoEXT, VkPipelineColorWriteCreateInfoEXT.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of VkPipelineColorWriteCreateInfoEXT structs.

Field Summary

Modifier and TypeField and Description
private static final VkPipelineColorWriteCreateInfoEXT

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new VkPipelineColorWriteCreateInfoEXT.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public int
protected VkPipelineColorWriteCreateInfoEXT
public IntBuffer

Returns:

a IntBuffer view of the data pointed to by the VkPipelineColorWriteCreateInfoEXT#pColorWriteEnables field.
pColorWriteEnables
()

public VkPipelineColorWriteCreateInfoEXT.Buffer
public long

Returns:

the value of the VkPipelineColorWriteCreateInfoEXT#pNext field.
pNext
()

public VkPipelineColorWriteCreateInfoEXT.Buffer
pNext(long value)

Sets the specified value to the VkPipelineColorWriteCreateInfoEXT#pNext field.

protected VkPipelineColorWriteCreateInfoEXT.Buffer
public int

Returns:

the value of the VkPipelineColorWriteCreateInfoEXT#sType field.
sType
()

public VkPipelineColorWriteCreateInfoEXT.Buffer
sType(int value)

Sets the specified value to the VkPipelineColorWriteCreateInfoEXT#sType field.

public VkPipelineColorWriteCreateInfoEXT.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final VkPipelineColorWriteCreateInfoEXT ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new VkPipelineColorWriteCreateInfoEXT.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by VkPipelineColorWriteCreateInfoEXT#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

attachmentCountback to summary
public int attachmentCount()
Returns:int

the value of the VkPipelineColorWriteCreateInfoEXT#attachmentCount field.

Annotations
@NativeType:uint32_t
getElementFactoryback to summary
protected VkPipelineColorWriteCreateInfoEXT getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
pColorWriteEnablesback to summary
public IntBuffer pColorWriteEnables()
Returns:IntBuffer

a IntBuffer view of the data pointed to by the VkPipelineColorWriteCreateInfoEXT#pColorWriteEnables field.

Annotations
@Nullable
@NativeType:VkBool32 const *
pColorWriteEnablesback to summary
public VkPipelineColorWriteCreateInfoEXT.Buffer pColorWriteEnables(IntBuffer value)

Sets the address of the specified IntBuffer to the VkPipelineColorWriteCreateInfoEXT#pColorWriteEnables field.

pNextback to summary
public long pNext()
Returns:long

the value of the VkPipelineColorWriteCreateInfoEXT#pNext field.

Annotations
@NativeType:void const *
pNextback to summary
public VkPipelineColorWriteCreateInfoEXT.Buffer pNext(long value)

Sets the specified value to the VkPipelineColorWriteCreateInfoEXT#pNext field.

selfback to summary
protected VkPipelineColorWriteCreateInfoEXT.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sTypeback to summary
public int sType()
Returns:int

the value of the VkPipelineColorWriteCreateInfoEXT#sType field.

Annotations
@NativeType:VkStructureType
sTypeback to summary
public VkPipelineColorWriteCreateInfoEXT.Buffer sType(int value)

Sets the specified value to the VkPipelineColorWriteCreateInfoEXT#sType field.

sType$Defaultback to summary
public VkPipelineColorWriteCreateInfoEXT.Buffer sType$Default()

Sets the STRUCTURE_TYPE_PIPELINE_COLOR_WRITE_CREATE_INFO_EXT value to the VkPipelineColorWriteCreateInfoEXT#sType field.