Package org.lwjgl.vulkan

Class VkIndirectExecutionSetPipelineInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkIndirectExecutionSetPipelineInfoEXT>

org.lwjgl.vulkan.VkIndirectExecutionSetPipelineInfoEXT

All Implemented Interfaces:

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

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

Struct specifying parameters of a newly created indirect execution set containing only pipelines.

Description

The characteristics of initialPipeline will be used to validate all pipelines added to the set even if they are removed from the set or destroyed.

When an Indirect Execution Set created with pipelines is used, initialPipeline constitutes the initial shader state.

Valid Usage

• If VkPhysicalDeviceDeviceGeneratedCommandsPropertiesEXT::supportedIndirectCommandsShaderStagesPipelineBinding does not contain SHADER_STAGE_COMPUTE_BIT, the VkPipelineBindPoint of initialPipeline must not be PIPELINE_BIND_POINT_COMPUTE
• If VkPhysicalDeviceDeviceGeneratedCommandsPropertiesEXT::supportedIndirectCommandsShaderStagesPipelineBinding does not contain SHADER_STAGE_FRAGMENT_BIT, the VkPipelineBindPoint of initialPipeline must not be PIPELINE_BIND_POINT_GRAPHICS
• If VkPhysicalDeviceDeviceGeneratedCommandsPropertiesEXT::supportedIndirectCommandsShaderStagesPipelineBinding does not contain ray tracing stages, the VkPipelineBindPoint of initialPipeline must not be PIPELINE_BIND_POINT_RAY_TRACING_KHR
• maxPipelineCount must be between 1 and VkPhysicalDeviceDeviceGeneratedCommandsPropertiesEXT::maxIndirectPipelineCount
• initialPipeline must not use descriptors of type DESCRIPTOR_TYPE_UNIFORM_BUFFER_DYNAMIC or DESCRIPTOR_TYPE_STORAGE_BUFFER_DYNAMIC
• initialPipeline must have been created with PIPELINE_CREATE_2_INDIRECT_BINDABLE_BIT_EXT

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_INDIRECT_EXECUTION_SET_PIPELINE_INFO_EXT
• initialPipeline must be a valid VkPipeline handle

See Also

VkIndirectExecutionSetInfoEXT

Layout

 struct VkIndirectExecutionSetPipelineInfoEXT {
     VkStructureType sType();
     void const * pNext();
     VkPipeline initialPipeline();
     uint32_t maxPipelineCount();
 }

Nested Class Summary

Nested Classes

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

Method Summary

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

INITIALPIPELINE

public static final int INITIALPIPELINE

The struct member offsets.

MAXPIPELINECOUNT

public static final int MAXPIPELINECOUNT

The struct member offsets.

Constructor Details

VkIndirectExecutionSetPipelineInfoEXT

public VkIndirectExecutionSetPipelineInfoEXT(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

initialPipeline

public long initialPipeline()

the initial pipeline for the set. This pipeline will be automatically added to the set at index 0.

maxPipelineCount

public int maxPipelineCount()

the maximum number of pipelines stored in the set.

sType

public VkIndirectExecutionSetPipelineInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkIndirectExecutionSetPipelineInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_INDIRECT_EXECUTION_SET_PIPELINE_INFO_EXT value to the sType() field.

pNext

public VkIndirectExecutionSetPipelineInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

initialPipeline

public VkIndirectExecutionSetPipelineInfoEXT initialPipeline(long value)

Sets the specified value to the initialPipeline() field.

maxPipelineCount

public VkIndirectExecutionSetPipelineInfoEXT maxPipelineCount(int value)

Sets the specified value to the maxPipelineCount() field.

set

public VkIndirectExecutionSetPipelineInfoEXT set(int sType,
 long pNext,
 long initialPipeline,
 int maxPipelineCount)

Initializes this struct with the specified values.

set

public VkIndirectExecutionSetPipelineInfoEXT set(VkIndirectExecutionSetPipelineInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkIndirectExecutionSetPipelineInfoEXT malloc()

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

calloc

public static VkIndirectExecutionSetPipelineInfoEXT calloc()

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

create

public static VkIndirectExecutionSetPipelineInfoEXT create()

Returns a new VkIndirectExecutionSetPipelineInfoEXT instance allocated with BufferUtils.

create

public static VkIndirectExecutionSetPipelineInfoEXT create(long address)

Returns a new VkIndirectExecutionSetPipelineInfoEXT instance for the specified memory address.

createSafe

public static @Nullable VkIndirectExecutionSetPipelineInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkIndirectExecutionSetPipelineInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkIndirectExecutionSetPipelineInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkIndirectExecutionSetPipelineInfoEXT.Buffer create(int capacity)

Returns a new VkIndirectExecutionSetPipelineInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkIndirectExecutionSetPipelineInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkIndirectExecutionSetPipelineInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

ninitialPipeline

public static long ninitialPipeline(long struct)

Unsafe version of initialPipeline().

nmaxPipelineCount

public static int nmaxPipelineCount(long struct)

Unsafe version of maxPipelineCount().

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.

ninitialPipeline

public static void ninitialPipeline(long struct,
 long value)

Unsafe version of initialPipeline.

nmaxPipelineCount

public static void nmaxPipelineCount(long struct,
 int value)

Unsafe version of maxPipelineCount.