Package org.lwjgl.vulkan

Class VkPipelineColorWriteCreateInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkPipelineColorWriteCreateInfoEXT>

org.lwjgl.vulkan.VkPipelineColorWriteCreateInfoEXT

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkPipelineColorWriteCreateInfoEXT
extends org.lwjgl.system.Struct<VkPipelineColorWriteCreateInfoEXT>
implements org.lwjgl.system.NativeResource

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, all VkBool32 elements in the pColorWriteEnables array must be TRUE.

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

• If colorWriteEnable is TRUE, writes to the attachment are determined by the colorWriteMask.
• If colorWriteEnable is FALSE, the colorWriteMask is ignored and writes to all components of the attachment are disabled. This is equivalent to specifying a colorWriteMask of 0.

Valid Usage

• If the colorWriteEnable feature is not enabled, all elements of pColorWriteEnables must be TRUE
• If the pipeline is being created with 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 dynamic states not set, attachmentCount must be equal to the attachmentCount member of the VkPipelineColorBlendStateCreateInfo structure specified during pipeline creation
• attachmentCount must be less than or equal to the maxColorAttachments member of VkPhysicalDeviceLimits

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_PIPELINE_COLOR_WRITE_CREATE_INFO_EXT
• If attachmentCount is not 0, pColorWriteEnables must be a valid pointer to an array of attachmentCount VkBool32 values

Layout

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkPipelineColorWriteCreateInfoEXT.Buffer	An array of VkPipelineColorWriteCreateInfoEXT structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

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

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	ATTACHMENTCOUNT	The struct member offsets.
static final int	PCOLORWRITEENABLES	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final 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	Description
VkPipelineColorWriteCreateInfoEXT(ByteBuffer container)	Creates a VkPipelineColorWriteCreateInfoEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
int	attachmentCount()	the number of VkBool32 elements in pColorWriteEnables.
static VkPipelineColorWriteCreateInfoEXT	calloc()	Returns a new VkPipelineColorWriteCreateInfoEXT instance allocated with memCalloc.
static VkPipelineColorWriteCreateInfoEXT.Buffer	calloc(int capacity)	Returns a new VkPipelineColorWriteCreateInfoEXT.Buffer instance allocated with memCalloc.
static VkPipelineColorWriteCreateInfoEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineColorWriteCreateInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPipelineColorWriteCreateInfoEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineColorWriteCreateInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkPipelineColorWriteCreateInfoEXT	create()	Returns a new VkPipelineColorWriteCreateInfoEXT instance allocated with BufferUtils.
static VkPipelineColorWriteCreateInfoEXT.Buffer	create(int capacity)	Returns a new VkPipelineColorWriteCreateInfoEXT.Buffer instance allocated with BufferUtils.
static VkPipelineColorWriteCreateInfoEXT	create(long address)	Returns a new VkPipelineColorWriteCreateInfoEXT instance for the specified memory address.
static VkPipelineColorWriteCreateInfoEXT.Buffer	create(long address, int capacity)	Create a VkPipelineColorWriteCreateInfoEXT.Buffer instance at the specified memory.
static @Nullable VkPipelineColorWriteCreateInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkPipelineColorWriteCreateInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkPipelineColorWriteCreateInfoEXT	malloc()	Returns a new VkPipelineColorWriteCreateInfoEXT instance allocated with memAlloc.
static VkPipelineColorWriteCreateInfoEXT.Buffer	malloc(int capacity)	Returns a new VkPipelineColorWriteCreateInfoEXT.Buffer instance allocated with memAlloc.
static VkPipelineColorWriteCreateInfoEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineColorWriteCreateInfoEXT.Buffer instance allocated on the specified MemoryStack.
static VkPipelineColorWriteCreateInfoEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkPipelineColorWriteCreateInfoEXT 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 @Nullable IntBuffer	npColorWriteEnables(long struct)	Unsafe version of pColorWriteEnables.
static void	npColorWriteEnables(long struct, @Nullable IntBuffer value)	Unsafe version of pColorWriteEnables.
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.
@Nullable IntBuffer	pColorWriteEnables()	a pointer to an array of per target attachment boolean values specifying whether color writes are enabled for the given attachment.
VkPipelineColorWriteCreateInfoEXT	pColorWriteEnables(@Nullable IntBuffer value)	Sets the address of the specified IntBuffer to the pColorWriteEnables() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkPipelineColorWriteCreateInfoEXT	pNext(long value)	Sets the specified value to the pNext() field.
VkPipelineColorWriteCreateInfoEXT	set(int sType, long pNext, @Nullable IntBuffer pColorWriteEnables)	Initializes this struct with the specified values.
VkPipelineColorWriteCreateInfoEXT	set(VkPipelineColorWriteCreateInfoEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkPipelineColorWriteCreateInfoEXT	sType(int value)	Sets the specified value to the sType() field.
VkPipelineColorWriteCreateInfoEXT	sType$Default()	Sets the STRUCTURE_TYPE_PIPELINE_COLOR_WRITE_CREATE_INFO_EXT value to the sType() field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

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 Details

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.

ATTACHMENTCOUNT

public static final int ATTACHMENTCOUNT

The struct member offsets.

PCOLORWRITEENABLES

public static final int PCOLORWRITEENABLES

The struct member offsets.

Constructor Details

VkPipelineColorWriteCreateInfoEXT

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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<VkPipelineColorWriteCreateInfoEXT>

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

attachmentCount

public int attachmentCount()

the number of VkBool32 elements in pColorWriteEnables.

pColorWriteEnables

public @Nullable IntBuffer pColorWriteEnables()

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

sType

public VkPipelineColorWriteCreateInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkPipelineColorWriteCreateInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_PIPELINE_COLOR_WRITE_CREATE_INFO_EXT value to the sType() field.

pNext

public VkPipelineColorWriteCreateInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

pColorWriteEnables

public VkPipelineColorWriteCreateInfoEXT pColorWriteEnables(@Nullable IntBuffer value)

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

set

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

Initializes this struct with the specified values.

set

public VkPipelineColorWriteCreateInfoEXT set(VkPipelineColorWriteCreateInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkPipelineColorWriteCreateInfoEXT malloc()

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

calloc

public static VkPipelineColorWriteCreateInfoEXT calloc()

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

create

public static VkPipelineColorWriteCreateInfoEXT create()

Returns a new VkPipelineColorWriteCreateInfoEXT instance allocated with BufferUtils.

create

public static VkPipelineColorWriteCreateInfoEXT create(long address)

Returns a new VkPipelineColorWriteCreateInfoEXT instance for the specified memory address.

createSafe

public static @Nullable VkPipelineColorWriteCreateInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkPipelineColorWriteCreateInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkPipelineColorWriteCreateInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkPipelineColorWriteCreateInfoEXT.Buffer create(int capacity)

Returns a new VkPipelineColorWriteCreateInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkPipelineColorWriteCreateInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

public static VkPipelineColorWriteCreateInfoEXT malloc(org.lwjgl.system.MemoryStack stack)

Returns a new VkPipelineColorWriteCreateInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static VkPipelineColorWriteCreateInfoEXT calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static VkPipelineColorWriteCreateInfoEXT.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static VkPipelineColorWriteCreateInfoEXT.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nsType

public static int nsType(long struct)

Unsafe version of sType().

npNext

public static long npNext(long struct)

Unsafe version of pNext().

nattachmentCount

public static int nattachmentCount(long struct)

Unsafe version of attachmentCount().

npColorWriteEnables

public static @Nullable IntBuffer npColorWriteEnables(long struct)

Unsafe version of pColorWriteEnables.

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.

nattachmentCount

public static void nattachmentCount(long struct,
 int value)

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

npColorWriteEnables

public static void npColorWriteEnables(long struct,
 @Nullable IntBuffer value)

Unsafe version of pColorWriteEnables.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate