Package org.lwjgl.vulkan

Class VkWriteIndirectExecutionSetPipelineEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkWriteIndirectExecutionSetPipelineEXT>

org.lwjgl.vulkan.VkWriteIndirectExecutionSetPipelineEXT

All Implemented Interfaces:

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

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

Struct specifying pipeline update information for an indirect execution set.

Valid Usage

• index must be less than the value of VkIndirectExecutionSetPipelineInfoEXT::maxPipelineCount used to create the set
• pipeline must have been created with PIPELINE_CREATE_2_INDIRECT_BINDABLE_BIT_EXT
• index must not be referenced by submitted command buffers
• The shader stages contained in pipeline must be supported by VkPhysicalDeviceDeviceGeneratedCommandsPropertiesEXT::supportedIndirectCommandsShaderStagesPipelineBinding

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_WRITE_INDIRECT_EXECUTION_SET_PIPELINE_EXT
• pipeline must be a valid VkPipeline handle

See Also

UpdateIndirectExecutionSetPipelineEXT

Layout

 struct VkWriteIndirectExecutionSetPipelineEXT {
     VkStructureType sType();
     void const * pNext();
     uint32_t index();
     VkPipeline pipeline();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkWriteIndirectExecutionSetPipelineEXT.Buffer	An array of VkWriteIndirectExecutionSetPipelineEXT 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	INDEX	The struct member offsets.
static final int	PIPELINE	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
VkWriteIndirectExecutionSetPipelineEXT(ByteBuffer container)	Creates a VkWriteIndirectExecutionSetPipelineEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkWriteIndirectExecutionSetPipelineEXT	calloc()	Returns a new VkWriteIndirectExecutionSetPipelineEXT instance allocated with memCalloc.
static VkWriteIndirectExecutionSetPipelineEXT.Buffer	calloc(int capacity)	Returns a new VkWriteIndirectExecutionSetPipelineEXT.Buffer instance allocated with memCalloc.
static VkWriteIndirectExecutionSetPipelineEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkWriteIndirectExecutionSetPipelineEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkWriteIndirectExecutionSetPipelineEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkWriteIndirectExecutionSetPipelineEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkWriteIndirectExecutionSetPipelineEXT	create()	Returns a new VkWriteIndirectExecutionSetPipelineEXT instance allocated with BufferUtils.
static VkWriteIndirectExecutionSetPipelineEXT.Buffer	create(int capacity)	Returns a new VkWriteIndirectExecutionSetPipelineEXT.Buffer instance allocated with BufferUtils.
static VkWriteIndirectExecutionSetPipelineEXT	create(long address)	Returns a new VkWriteIndirectExecutionSetPipelineEXT instance for the specified memory address.
static VkWriteIndirectExecutionSetPipelineEXT.Buffer	create(long address, int capacity)	Create a VkWriteIndirectExecutionSetPipelineEXT.Buffer instance at the specified memory.
static @Nullable VkWriteIndirectExecutionSetPipelineEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkWriteIndirectExecutionSetPipelineEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	index()	the element of the set to update
VkWriteIndirectExecutionSetPipelineEXT	index(int value)	Sets the specified value to the index() field.
static VkWriteIndirectExecutionSetPipelineEXT	malloc()	Returns a new VkWriteIndirectExecutionSetPipelineEXT instance allocated with memAlloc.
static VkWriteIndirectExecutionSetPipelineEXT.Buffer	malloc(int capacity)	Returns a new VkWriteIndirectExecutionSetPipelineEXT.Buffer instance allocated with memAlloc.
static VkWriteIndirectExecutionSetPipelineEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkWriteIndirectExecutionSetPipelineEXT.Buffer instance allocated on the specified MemoryStack.
static VkWriteIndirectExecutionSetPipelineEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkWriteIndirectExecutionSetPipelineEXT instance allocated on the specified MemoryStack.
static int	nindex(long struct)	Unsafe version of index().
static void	nindex(long struct, int value)	Unsafe version of index.
static long	npipeline(long struct)	Unsafe version of pipeline().
static void	npipeline(long struct, long value)	Unsafe version of pipeline.
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.
long	pipeline()	the pipeline to store in the indirect execution set
VkWriteIndirectExecutionSetPipelineEXT	pipeline(long value)	Sets the specified value to the pipeline() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkWriteIndirectExecutionSetPipelineEXT	pNext(long value)	Sets the specified value to the pNext() field.
VkWriteIndirectExecutionSetPipelineEXT	set(int sType, long pNext, int index, long pipeline)	Initializes this struct with the specified values.
VkWriteIndirectExecutionSetPipelineEXT	set(VkWriteIndirectExecutionSetPipelineEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkWriteIndirectExecutionSetPipelineEXT	sType(int value)	Sets the specified value to the sType() field.
VkWriteIndirectExecutionSetPipelineEXT	sType$Default()	Sets the STRUCTURE_TYPE_WRITE_INDIRECT_EXECUTION_SET_PIPELINE_EXT value to the sType() field.

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.

INDEX

public static final int INDEX

The struct member offsets.

PIPELINE

public static final int PIPELINE

The struct member offsets.

Constructor Details

VkWriteIndirectExecutionSetPipelineEXT

public VkWriteIndirectExecutionSetPipelineEXT(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

index

public int index()

the element of the set to update

pipeline

public long pipeline()

the pipeline to store in the indirect execution set

sType

public VkWriteIndirectExecutionSetPipelineEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkWriteIndirectExecutionSetPipelineEXT sType$Default()

Sets the STRUCTURE_TYPE_WRITE_INDIRECT_EXECUTION_SET_PIPELINE_EXT value to the sType() field.

pNext

public VkWriteIndirectExecutionSetPipelineEXT pNext(long value)

Sets the specified value to the pNext() field.

index

public VkWriteIndirectExecutionSetPipelineEXT index(int value)

Sets the specified value to the index() field.

pipeline

public VkWriteIndirectExecutionSetPipelineEXT pipeline(long value)

Sets the specified value to the pipeline() field.

set

public VkWriteIndirectExecutionSetPipelineEXT set(int sType,
 long pNext,
 int index,
 long pipeline)

Initializes this struct with the specified values.

set

public VkWriteIndirectExecutionSetPipelineEXT set(VkWriteIndirectExecutionSetPipelineEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkWriteIndirectExecutionSetPipelineEXT malloc()

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

calloc

public static VkWriteIndirectExecutionSetPipelineEXT calloc()

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

create

public static VkWriteIndirectExecutionSetPipelineEXT create()

Returns a new VkWriteIndirectExecutionSetPipelineEXT instance allocated with BufferUtils.

create

public static VkWriteIndirectExecutionSetPipelineEXT create(long address)

Returns a new VkWriteIndirectExecutionSetPipelineEXT instance for the specified memory address.

createSafe

public static @Nullable VkWriteIndirectExecutionSetPipelineEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkWriteIndirectExecutionSetPipelineEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkWriteIndirectExecutionSetPipelineEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkWriteIndirectExecutionSetPipelineEXT.Buffer create(int capacity)

Returns a new VkWriteIndirectExecutionSetPipelineEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkWriteIndirectExecutionSetPipelineEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkWriteIndirectExecutionSetPipelineEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

Returns a new VkWriteIndirectExecutionSetPipelineEXT.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().

nindex

public static int nindex(long struct)

Unsafe version of index().

npipeline

public static long npipeline(long struct)

Unsafe version of pipeline().

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.

nindex

public static void nindex(long struct,
 int value)

Unsafe version of index.

npipeline

public static void npipeline(long struct,
 long value)

Unsafe version of pipeline.