Package org.lwjgl.vulkan

Class VkIndirectExecutionSetShaderInfoEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<VkIndirectExecutionSetShaderInfoEXT>

org.lwjgl.vulkan.VkIndirectExecutionSetShaderInfoEXT

All Implemented Interfaces:

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

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

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

Description

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

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

Valid Usage

• All members of pInitialShaders must have a stage supported by VkPhysicalDeviceDeviceGeneratedCommandsPropertiesEXT::supportedIndirectCommandsShaderStagesShaderBinding
• maxShaderCount must not be zero
• maxShaderCount must be less than or equal to VkPhysicalDeviceDeviceGeneratedCommandsPropertiesEXT::maxIndirectShaderObjectCount
• maxShaderCount must be greater than or equal to shaderCount
• The stage of each element in the pInitialShaders array must be unique
• Each member of pInitialShaders must have been created with SHADER_CREATE_INDIRECT_BINDABLE_BIT_EXT

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_INDIRECT_EXECUTION_SET_SHADER_INFO_EXT
• pInitialShaders must be a valid pointer to an array of shaderCount valid VkShaderEXT handles
• If pSetLayoutInfos is not NULL, pSetLayoutInfos must be a valid pointer to an array of shaderCount valid VkIndirectExecutionSetShaderLayoutInfoEXT structures
• If pushConstantRangeCount is not 0, pPushConstantRanges must be a valid pointer to an array of pushConstantRangeCount valid VkPushConstantRange structures
• shaderCount must be greater than 0

See Also

VkIndirectExecutionSetInfoEXT, VkIndirectExecutionSetShaderLayoutInfoEXT, VkPushConstantRange

Layout

 struct VkIndirectExecutionSetShaderInfoEXT {
     VkStructureType sType();
     void const * pNext();
     uint32_t shaderCount();
     VkShaderEXT const * pInitialShaders();
     VkIndirectExecutionSetShaderLayoutInfoEXT const * pSetLayoutInfos();
     uint32_t maxShaderCount();
     uint32_t pushConstantRangeCount();
     VkPushConstantRange const * pPushConstantRanges();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VkIndirectExecutionSetShaderInfoEXT.Buffer	An array of VkIndirectExecutionSetShaderInfoEXT 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	MAXSHADERCOUNT	The struct member offsets.
static final int	PINITIALSHADERS	The struct member offsets.
static final int	PNEXT	The struct member offsets.
static final int	PPUSHCONSTANTRANGES	The struct member offsets.
static final int	PSETLAYOUTINFOS	The struct member offsets.
static final int	PUSHCONSTANTRANGECOUNT	The struct member offsets.
static final int	SHADERCOUNT	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
VkIndirectExecutionSetShaderInfoEXT(ByteBuffer container)	Creates a VkIndirectExecutionSetShaderInfoEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static VkIndirectExecutionSetShaderInfoEXT	calloc()	Returns a new VkIndirectExecutionSetShaderInfoEXT instance allocated with memCalloc.
static VkIndirectExecutionSetShaderInfoEXT.Buffer	calloc(int capacity)	Returns a new VkIndirectExecutionSetShaderInfoEXT.Buffer instance allocated with memCalloc.
static VkIndirectExecutionSetShaderInfoEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkIndirectExecutionSetShaderInfoEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkIndirectExecutionSetShaderInfoEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkIndirectExecutionSetShaderInfoEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static VkIndirectExecutionSetShaderInfoEXT	create()	Returns a new VkIndirectExecutionSetShaderInfoEXT instance allocated with BufferUtils.
static VkIndirectExecutionSetShaderInfoEXT.Buffer	create(int capacity)	Returns a new VkIndirectExecutionSetShaderInfoEXT.Buffer instance allocated with BufferUtils.
static VkIndirectExecutionSetShaderInfoEXT	create(long address)	Returns a new VkIndirectExecutionSetShaderInfoEXT instance for the specified memory address.
static VkIndirectExecutionSetShaderInfoEXT.Buffer	create(long address, int capacity)	Create a VkIndirectExecutionSetShaderInfoEXT.Buffer instance at the specified memory.
static @Nullable VkIndirectExecutionSetShaderInfoEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable VkIndirectExecutionSetShaderInfoEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static VkIndirectExecutionSetShaderInfoEXT	malloc()	Returns a new VkIndirectExecutionSetShaderInfoEXT instance allocated with memAlloc.
static VkIndirectExecutionSetShaderInfoEXT.Buffer	malloc(int capacity)	Returns a new VkIndirectExecutionSetShaderInfoEXT.Buffer instance allocated with memAlloc.
static VkIndirectExecutionSetShaderInfoEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new VkIndirectExecutionSetShaderInfoEXT.Buffer instance allocated on the specified MemoryStack.
static VkIndirectExecutionSetShaderInfoEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new VkIndirectExecutionSetShaderInfoEXT instance allocated on the specified MemoryStack.
int	maxShaderCount()	the maximum number of shader objects stored in the set.
VkIndirectExecutionSetShaderInfoEXT	maxShaderCount(int value)	Sets the specified value to the maxShaderCount() field.
static int	nmaxShaderCount(long struct)	Unsafe version of maxShaderCount().
static void	nmaxShaderCount(long struct, int value)	Unsafe version of maxShaderCount.
static LongBuffer	npInitialShaders(long struct)	Unsafe version of pInitialShaders.
static void	npInitialShaders(long struct, LongBuffer value)	Unsafe version of pInitialShaders.
static long	npNext(long struct)	Unsafe version of pNext().
static void	npNext(long struct, long value)	Unsafe version of pNext.
static @Nullable VkPushConstantRange.Buffer	npPushConstantRanges(long struct)	Unsafe version of pPushConstantRanges().
static void	npPushConstantRanges(long struct, @Nullable VkPushConstantRange.Buffer value)	Unsafe version of pPushConstantRanges.
static @Nullable VkIndirectExecutionSetShaderLayoutInfoEXT.Buffer	npSetLayoutInfos(long struct)	Unsafe version of pSetLayoutInfos().
static void	npSetLayoutInfos(long struct, @Nullable VkIndirectExecutionSetShaderLayoutInfoEXT.Buffer value)	Unsafe version of pSetLayoutInfos.
static int	npushConstantRangeCount(long struct)	Unsafe version of pushConstantRangeCount().
static void	npushConstantRangeCount(long struct, int value)	Sets the specified value to the pushConstantRangeCount field of the specified struct.
static int	nshaderCount(long struct)	Unsafe version of shaderCount().
static void	nshaderCount(long struct, int value)	Sets the specified value to the shaderCount field of the specified struct.
static int	nsType(long struct)	Unsafe version of sType().
static void	nsType(long struct, int value)	Unsafe version of sType.
LongBuffer	pInitialShaders()	a pointer to an array containing a VkShaderEXT object for each shader stage that will be used in the set.
VkIndirectExecutionSetShaderInfoEXT	pInitialShaders(LongBuffer value)	Sets the address of the specified LongBuffer to the pInitialShaders() field.
long	pNext()	NULL or a pointer to a structure extending this structure.
VkIndirectExecutionSetShaderInfoEXT	pNext(long value)	Sets the specified value to the pNext() field.
@Nullable VkPushConstantRange.Buffer	pPushConstantRanges()	a pointer to the array of VkPushConstantRange ranges used by all shaders in the set.
VkIndirectExecutionSetShaderInfoEXT	pPushConstantRanges(@Nullable VkPushConstantRange.Buffer value)	Sets the address of the specified VkPushConstantRange.Buffer to the pPushConstantRanges() field.
@Nullable VkIndirectExecutionSetShaderLayoutInfoEXT.Buffer	pSetLayoutInfos()	a pointer to an array containing a VkIndirectExecutionSetShaderLayoutInfoEXT used by each corresponding pInitialShaders shader stage in the set.
VkIndirectExecutionSetShaderInfoEXT	pSetLayoutInfos(@Nullable VkIndirectExecutionSetShaderLayoutInfoEXT.Buffer value)	Sets the address of the specified VkIndirectExecutionSetShaderLayoutInfoEXT.Buffer to the pSetLayoutInfos() field.
int	pushConstantRangeCount()	the number of members in the pPushConstantRanges array.
VkIndirectExecutionSetShaderInfoEXT	set(int sType, long pNext, int shaderCount, LongBuffer pInitialShaders, @Nullable VkIndirectExecutionSetShaderLayoutInfoEXT.Buffer pSetLayoutInfos, int maxShaderCount, @Nullable VkPushConstantRange.Buffer pPushConstantRanges)	Initializes this struct with the specified values.
VkIndirectExecutionSetShaderInfoEXT	set(VkIndirectExecutionSetShaderInfoEXT src)	Copies the specified struct data to this struct.
int	shaderCount()	the number of members in the pInitialShaders and pSetLayoutInfos arrays.
VkIndirectExecutionSetShaderInfoEXT	shaderCount(int value)	Sets the specified value to the shaderCount() field.
int	sizeof()
int	sType()	a VkStructureType value identifying this structure.
VkIndirectExecutionSetShaderInfoEXT	sType(int value)	Sets the specified value to the sType() field.
VkIndirectExecutionSetShaderInfoEXT	sType$Default()	Sets the STRUCTURE_TYPE_INDIRECT_EXECUTION_SET_SHADER_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.

SHADERCOUNT

public static final int SHADERCOUNT

The struct member offsets.

PINITIALSHADERS

public static final int PINITIALSHADERS

The struct member offsets.

PSETLAYOUTINFOS

public static final int PSETLAYOUTINFOS

The struct member offsets.

MAXSHADERCOUNT

public static final int MAXSHADERCOUNT

The struct member offsets.

PUSHCONSTANTRANGECOUNT

public static final int PUSHCONSTANTRANGECOUNT

The struct member offsets.

PPUSHCONSTANTRANGES

public static final int PPUSHCONSTANTRANGES

The struct member offsets.

Constructor Details

VkIndirectExecutionSetShaderInfoEXT

public VkIndirectExecutionSetShaderInfoEXT(ByteBuffer container)

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

sType

public int sType()

a VkStructureType value identifying this structure.

pNext

public long pNext()

NULL or a pointer to a structure extending this structure.

shaderCount

public int shaderCount()

the number of members in the pInitialShaders and pSetLayoutInfos arrays.

pInitialShaders

public LongBuffer pInitialShaders()

a pointer to an array containing a VkShaderEXT object for each shader stage that will be used in the set. These shaders will be automatically added to the set beginning at index 0.

pSetLayoutInfos

public @Nullable VkIndirectExecutionSetShaderLayoutInfoEXT.Buffer pSetLayoutInfos()

a pointer to an array containing a VkIndirectExecutionSetShaderLayoutInfoEXT used by each corresponding pInitialShaders shader stage in the set.

maxShaderCount

public int maxShaderCount()

the maximum number of shader objects stored in the set.

pushConstantRangeCount

public int pushConstantRangeCount()

the number of members in the pPushConstantRanges array.

pPushConstantRanges

public @Nullable VkPushConstantRange.Buffer pPushConstantRanges()

a pointer to the array of VkPushConstantRange ranges used by all shaders in the set.

sType

public VkIndirectExecutionSetShaderInfoEXT sType(int value)

Sets the specified value to the sType() field.

sType$Default

public VkIndirectExecutionSetShaderInfoEXT sType$Default()

Sets the STRUCTURE_TYPE_INDIRECT_EXECUTION_SET_SHADER_INFO_EXT value to the sType() field.

pNext

public VkIndirectExecutionSetShaderInfoEXT pNext(long value)

Sets the specified value to the pNext() field.

shaderCount

public VkIndirectExecutionSetShaderInfoEXT shaderCount(int value)

Sets the specified value to the shaderCount() field.

pInitialShaders

public VkIndirectExecutionSetShaderInfoEXT pInitialShaders(LongBuffer value)

Sets the address of the specified LongBuffer to the pInitialShaders() field.

pSetLayoutInfos

public VkIndirectExecutionSetShaderInfoEXT pSetLayoutInfos(@Nullable VkIndirectExecutionSetShaderLayoutInfoEXT.Buffer value)

Sets the address of the specified VkIndirectExecutionSetShaderLayoutInfoEXT.Buffer to the pSetLayoutInfos() field.

maxShaderCount

public VkIndirectExecutionSetShaderInfoEXT maxShaderCount(int value)

Sets the specified value to the maxShaderCount() field.

pPushConstantRanges

public VkIndirectExecutionSetShaderInfoEXT pPushConstantRanges(@Nullable VkPushConstantRange.Buffer value)

Sets the address of the specified VkPushConstantRange.Buffer to the pPushConstantRanges() field.

set

public VkIndirectExecutionSetShaderInfoEXT set(int sType,
 long pNext,
 int shaderCount,
 LongBuffer pInitialShaders,
 @Nullable VkIndirectExecutionSetShaderLayoutInfoEXT.Buffer pSetLayoutInfos,
 int maxShaderCount,
 @Nullable VkPushConstantRange.Buffer pPushConstantRanges)

Initializes this struct with the specified values.

set

public VkIndirectExecutionSetShaderInfoEXT set(VkIndirectExecutionSetShaderInfoEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static VkIndirectExecutionSetShaderInfoEXT malloc()

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

calloc

public static VkIndirectExecutionSetShaderInfoEXT calloc()

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

create

public static VkIndirectExecutionSetShaderInfoEXT create()

Returns a new VkIndirectExecutionSetShaderInfoEXT instance allocated with BufferUtils.

create

public static VkIndirectExecutionSetShaderInfoEXT create(long address)

Returns a new VkIndirectExecutionSetShaderInfoEXT instance for the specified memory address.

createSafe

public static @Nullable VkIndirectExecutionSetShaderInfoEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static VkIndirectExecutionSetShaderInfoEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static VkIndirectExecutionSetShaderInfoEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static VkIndirectExecutionSetShaderInfoEXT.Buffer create(int capacity)

Returns a new VkIndirectExecutionSetShaderInfoEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a VkIndirectExecutionSetShaderInfoEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new VkIndirectExecutionSetShaderInfoEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nshaderCount

public static int nshaderCount(long struct)

Unsafe version of shaderCount().

npInitialShaders

public static LongBuffer npInitialShaders(long struct)

Unsafe version of pInitialShaders.

npSetLayoutInfos

public static @Nullable VkIndirectExecutionSetShaderLayoutInfoEXT.Buffer npSetLayoutInfos(long struct)

Unsafe version of pSetLayoutInfos().

nmaxShaderCount

public static int nmaxShaderCount(long struct)

Unsafe version of maxShaderCount().

npushConstantRangeCount

public static int npushConstantRangeCount(long struct)

Unsafe version of pushConstantRangeCount().

npPushConstantRanges

public static @Nullable VkPushConstantRange.Buffer npPushConstantRanges(long struct)

Unsafe version of pPushConstantRanges().

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.

nshaderCount

public static void nshaderCount(long struct,
 int value)

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

npInitialShaders

public static void npInitialShaders(long struct,
 LongBuffer value)

Unsafe version of pInitialShaders.

npSetLayoutInfos

public static void npSetLayoutInfos(long struct,
 @Nullable VkIndirectExecutionSetShaderLayoutInfoEXT.Buffer value)

Unsafe version of pSetLayoutInfos.

nmaxShaderCount

public static void nmaxShaderCount(long struct,
 int value)

Unsafe version of maxShaderCount.

npushConstantRangeCount

public static void npushConstantRangeCount(long struct,
 int value)

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

npPushConstantRanges

public static void npPushConstantRanges(long struct,
 @Nullable VkPushConstantRange.Buffer value)

Unsafe version of pPushConstantRanges.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate