Package org.lwjgl.vulkan
Class VkIndirectCommandsLayoutCreateInfoEXT
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkIndirectCommandsLayoutCreateInfoEXT>
org.lwjgl.vulkan.VkIndirectCommandsLayoutCreateInfoEXT
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkIndirectCommandsLayoutCreateInfoEXT
extends org.lwjgl.system.Struct<VkIndirectCommandsLayoutCreateInfoEXT>
implements org.lwjgl.system.NativeResource
Structure specifying the parameters of a newly created indirect commands layout object.
Description
The following code illustrates some of the flags:
void cmdProcessAllSequences(cmd, indirectExecutionSet, indirectCommandsLayout, indirectAddress, sequencesCount)
{
for (s = 0; s < sequencesCount; s++)
{
sUsed = s;
if (indirectCommandsLayout.flags & VK_INDIRECT_COMMANDS_LAYOUT_USAGE_UNORDERED_SEQUENCES_BIT_EXT) {
sUsed = incoherent_implementation_dependent_permutation[ sUsed ];
}
cmdProcessSequence( cmd, indirectExecutionSet, indirectCommandsLayout, indirectAddress, sUsed );
}
}
When tokens are consumed, an offset is computed based on token offset and stream stride. The resulting offset is required to be aligned. The alignment for a specific token is equal to the scalar alignment of the data type as defined in Alignment Requirements, or 4, whichever is lower.
Valid Usage
indirectStridemust be less than or equal toVkPhysicalDeviceDeviceGeneratedCommandsPropertiesEXT::maxIndirectCommandsIndirectStrideshaderStagesmust only contain stages supported byVkPhysicalDeviceDeviceGeneratedCommandsPropertiesEXT::supportedIndirectCommandsShaderStagestokenCountmust less than or equal toVkPhysicalDeviceDeviceGeneratedCommandsPropertiesEXT::maxIndirectCommandsTokenCount- The number of tokens in the
pTokensarray withtypeequal toINDIRECT_COMMANDS_TOKEN_TYPE_EXECUTION_SET_EXTmust be less than or equal to 1 - The number of tokens in the
pTokensarray withtypeequal toINDIRECT_COMMANDS_TOKEN_TYPE_SEQUENCE_INDEX_EXTmust be less than or equal to 1 - The number of tokens in the
pTokensarray withtypeequal toINDIRECT_COMMANDS_TOKEN_TYPE_INDEX_BUFFER_EXTmust be less than or equal to 1 - If the action command token in the
pTokensarray is not an indexed draw token, thenpTokensmust not contain a member withtypeset toINDIRECT_COMMANDS_TOKEN_TYPE_INDEX_BUFFER_EXT - If the action command token in the
pTokensarray is not a non-mesh draw token, thenpTokensmust not contain a member withtypeset toINDIRECT_COMMANDS_TOKEN_TYPE_VERTEX_BUFFER_EXT - If the
pTokensarray contains multiple tokens withtypeequal toINDIRECT_COMMANDS_TOKEN_TYPE_VERTEX_BUFFER_EXT, then there must be no duplicateVkIndirectCommandsVertexBufferTokenEXT::vertexBindingUnitvalues - For all
INDIRECT_COMMANDS_TOKEN_TYPE_PUSH_CONSTANT_EXTandINDIRECT_COMMANDS_TOKEN_TYPE_SEQUENCE_INDEX_EXTtype tokens inpTokens, there must be no overlapping ranges between any specified push constant ranges - The action command token must be the last token in the
pTokensarray - If the
pTokensarray contains aINDIRECT_COMMANDS_TOKEN_TYPE_EXECUTION_SET_EXTtoken, then this token must be the first token in the array - For any element of
pTokens, iftypeisINDIRECT_COMMANDS_TOKEN_TYPE_PUSH_CONSTANT_EXTorINDIRECT_COMMANDS_TOKEN_TYPE_SEQUENCE_INDEX_EXTand thedynamicGeneratedPipelineLayoutfeature is not enabled, then thepipelineLayoutmust not beNULL_HANDLE - For any element of
pTokens, iftypeis eitherINDIRECT_COMMANDS_TOKEN_TYPE_PUSH_CONSTANT_EXTorINDIRECT_COMMANDS_TOKEN_TYPE_SEQUENCE_INDEX_EXTandpipelineLayoutisNULL_HANDLE, then thepNextchain must include aVkPipelineLayoutCreateInfostruct - For any element of
pTokens, theoffsetmust be greater than or equal to theoffsetmember of the previous tokens - For any element of
pTokens, iftypeisINDIRECT_COMMANDS_TOKEN_TYPE_INDEX_BUFFER_EXT,INDIRECT_COMMANDS_TOKEN_TYPE_VERTEX_BUFFER_EXT,INDIRECT_COMMANDS_TOKEN_TYPE_DRAW_MESH_TASKS_EXT,INDIRECT_COMMANDS_TOKEN_TYPE_DRAW_MESH_TASKS_COUNT_EXT,INDIRECT_COMMANDS_TOKEN_TYPE_DRAW_MESH_TASKS_NV_EXT,INDIRECT_COMMANDS_TOKEN_TYPE_DRAW_MESH_TASKS_COUNT_NV_EXT,INDIRECT_COMMANDS_TOKEN_TYPE_DRAW_INDEXED_COUNT_EXT,INDIRECT_COMMANDS_TOKEN_TYPE_DRAW_INDEXED_EXT, orINDIRECT_COMMANDS_TOKEN_TYPE_DRAW_EXT, thenshaderStagesmust contain graphics stages - For any element of
pTokens, iftypeisINDIRECT_COMMANDS_TOKEN_TYPE_DISPATCH_EXT, thenshaderStagesmust beSHADER_STAGE_COMPUTE_BIT - For any element of
pTokens, iftypeisINDIRECT_COMMANDS_TOKEN_TYPE_DRAW_MESH_TASKS_EXTorINDIRECT_COMMANDS_TOKEN_TYPE_DRAW_MESH_TASKS_COUNT_EXT, thenshaderStagesmust containSHADER_STAGE_MESH_BIT_EXT - For any element of
pTokens, iftypeisINDIRECT_COMMANDS_TOKEN_TYPE_DRAW_MESH_TASKS_NV_EXTorINDIRECT_COMMANDS_TOKEN_TYPE_DRAW_MESH_TASKS_COUNT_NV_EXT, then theshaderStagesmust containSHADER_STAGE_MESH_BIT_NV - For any element of
pTokens, iftypeisINDIRECT_COMMANDS_TOKEN_TYPE_TRACE_RAYS2_EXT, thenshaderStagesmust contain ray tracing stages - If
shaderStagescontains graphics stages then the state tokens inpTokensmust not includeINDIRECT_COMMANDS_TOKEN_TYPE_TRACE_RAYS2_EXT,INDIRECT_COMMANDS_TOKEN_TYPE_DISPATCH_EXT - If
shaderStagesisSHADER_STAGE_COMPUTE_BITthen the state tokens inpTokensmust only includeINDIRECT_COMMANDS_TOKEN_TYPE_DISPATCH_EXT,INDIRECT_COMMANDS_TOKEN_TYPE_EXECUTION_SET_EXT,INDIRECT_COMMANDS_TOKEN_TYPE_PUSH_CONSTANT_EXT, orINDIRECT_COMMANDS_TOKEN_TYPE_SEQUENCE_INDEX_EXT - If
shaderStagescontains ray tracing stages then the state tokens inpTokensmust only includeINDIRECT_COMMANDS_TOKEN_TYPE_TRACE_RAYS2_EXT,INDIRECT_COMMANDS_TOKEN_TYPE_EXECUTION_SET_EXT,INDIRECT_COMMANDS_TOKEN_TYPE_PUSH_CONSTANT_EXT, orINDIRECT_COMMANDS_TOKEN_TYPE_SEQUENCE_INDEX_EXT - The
shaderStagesmust only contain stages from one of the following:- graphics stages
SHADER_STAGE_COMPUTE_BIT- mesh stages and
SHADER_STAGE_FRAGMENT_BIT - ray tracing stages
- If
shaderStagescontainsSHADER_STAGE_FRAGMENT_BIT, thenshaderStagesmust also containSHADER_STAGE_VERTEX_BITorSHADER_STAGE_MESH_BIT_EXT
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_INDIRECT_COMMANDS_LAYOUT_CREATE_INFO_EXTpNextmust beNULLor a pointer to a valid instance ofVkPipelineLayoutCreateInfo- The
sTypevalue of each struct in thepNextchain must be unique flagsmust be a valid combination ofVkIndirectCommandsLayoutUsageFlagBitsEXTvaluesshaderStagesmust be a valid combination ofVkShaderStageFlagBitsvaluesshaderStagesmust not be 0- If
pipelineLayoutis notNULL_HANDLE,pipelineLayoutmust be a validVkPipelineLayouthandle pTokensmust be a valid pointer to an array oftokenCountvalidVkIndirectCommandsLayoutTokenEXTstructurestokenCountmust be greater than 0
See Also
VkIndirectCommandsLayoutTokenEXT, CreateIndirectCommandsLayoutEXT
Layout
struct VkIndirectCommandsLayoutCreateInfoEXT {
VkStructureType sType();
void const * pNext();
VkIndirectCommandsLayoutUsageFlagsEXT flags();
VkShaderStageFlags shaderStages();
uint32_t indirectStride();
VkPipelineLayout pipelineLayout();
uint32_t tokenCount();
VkIndirectCommandsLayoutTokenEXT const * pTokens();
}-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAn array ofVkIndirectCommandsLayoutCreateInfoEXTstructs.Nested classes/interfaces inherited from class org.lwjgl.system.Struct
org.lwjgl.system.Struct.StructValidationNested classes/interfaces inherited from interface org.lwjgl.system.Pointer
org.lwjgl.system.Pointer.Default -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intThe struct alignment in bytes.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct member offsets.static final intThe struct size in bytes.static final intThe struct member offsets.static final intThe struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE -
Constructor Summary
ConstructorsConstructorDescriptionVkIndirectCommandsLayoutCreateInfoEXT(ByteBuffer container) Creates aVkIndirectCommandsLayoutCreateInfoEXTinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()Returns a newVkIndirectCommandsLayoutCreateInfoEXTinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkIndirectCommandsLayoutCreateInfoEXT.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkIndirectCommandsLayoutCreateInfoEXT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkIndirectCommandsLayoutCreateInfoEXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.create()Returns a newVkIndirectCommandsLayoutCreateInfoEXTinstance allocated withBufferUtils.create(int capacity) Returns a newVkIndirectCommandsLayoutCreateInfoEXT.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkIndirectCommandsLayoutCreateInfoEXTinstance for the specified memory address.create(long address, int capacity) Create aVkIndirectCommandsLayoutCreateInfoEXT.Bufferinstance at the specified memory.static @Nullable VkIndirectCommandsLayoutCreateInfoEXTcreateSafe(long address) static @Nullable VkIndirectCommandsLayoutCreateInfoEXT.BuffercreateSafe(long address, int capacity) intflags()a bitmask ofVkIndirectCommandsLayoutUsageFlagBitsEXTspecifying usage rules for this layout.flags(int value) Sets the specified value to theflags()field.intthe distance in bytes between sequences in the indirect bufferindirectStride(int value) Sets the specified value to theindirectStride()field.malloc()Returns a newVkIndirectCommandsLayoutCreateInfoEXTinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkIndirectCommandsLayoutCreateInfoEXT.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkIndirectCommandsLayoutCreateInfoEXT.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkIndirectCommandsLayoutCreateInfoEXTinstance allocated on the specifiedMemoryStack.static intnflags(long struct) Unsafe version offlags().static voidnflags(long struct, int value) Unsafe version offlags.static intnindirectStride(long struct) Unsafe version ofindirectStride().static voidnindirectStride(long struct, int value) Unsafe version ofindirectStride.static longnpipelineLayout(long struct) Unsafe version ofpipelineLayout().static voidnpipelineLayout(long struct, long value) Unsafe version ofpipelineLayout.static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.npTokens(long struct) Unsafe version ofpTokens().static voidnpTokens(long struct, VkIndirectCommandsLayoutTokenEXT.Buffer value) Unsafe version ofpTokens.static intnshaderStages(long struct) Unsafe version ofshaderStages().static voidnshaderStages(long struct, int value) Unsafe version ofshaderStages.static intnsType(long struct) Unsafe version ofsType().static voidnsType(long struct, int value) Unsafe version ofsType.static intntokenCount(long struct) Unsafe version oftokenCount().static voidntokenCount(long struct, int value) Sets the specified value to thetokenCountfield of the specifiedstruct.longthe optionalVkPipelineLayoutthat tokens in this layout use.pipelineLayout(long value) Sets the specified value to thepipelineLayout()field.longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.pNext(VkPipelineLayoutCreateInfo value) Prepends the specifiedVkPipelineLayoutCreateInfovalue to thepNextchain.pTokens()a pointer to an array ofVkIndirectCommandsLayoutTokenEXTdescribing each command token in detail.Sets the address of the specifiedVkIndirectCommandsLayoutTokenEXT.Bufferto thepTokens()field.set(int sType, long pNext, int flags, int shaderStages, int indirectStride, long pipelineLayout, VkIndirectCommandsLayoutTokenEXT.Buffer pTokens) Initializes this struct with the specified values.Copies the specified struct data to this struct.inttheVkShaderStageFlagsthat this layout supports.shaderStages(int value) Sets the specified value to theshaderStages()field.intsizeof()intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_INDIRECT_COMMANDS_LAYOUT_CREATE_INFO_EXTvalue to thesType()field.intthe length of the individual command sequence.static voidvalidate(long struct) Validates pointer members that should not beNULL.Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull, validate, validateMethods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toStringMethods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
FLAGS
public static final int FLAGSThe struct member offsets. -
SHADERSTAGES
public static final int SHADERSTAGESThe struct member offsets. -
INDIRECTSTRIDE
public static final int INDIRECTSTRIDEThe struct member offsets. -
PIPELINELAYOUT
public static final int PIPELINELAYOUTThe struct member offsets. -
TOKENCOUNT
public static final int TOKENCOUNTThe struct member offsets. -
PTOKENS
public static final int PTOKENSThe struct member offsets.
-
-
Constructor Details
-
VkIndirectCommandsLayoutCreateInfoEXT
Creates aVkIndirectCommandsLayoutCreateInfoEXTinstance at the current position of the specifiedByteBuffercontainer. 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:
sizeofin classorg.lwjgl.system.Struct<VkIndirectCommandsLayoutCreateInfoEXT>
-
sType
public int sType()aVkStructureTypevalue identifying this structure. -
pNext
public long pNext()NULLor a pointer to a structure extending this structure. -
flags
public int flags()a bitmask ofVkIndirectCommandsLayoutUsageFlagBitsEXTspecifying usage rules for this layout. -
shaderStages
public int shaderStages()theVkShaderStageFlagsthat this layout supports. -
indirectStride
public int indirectStride()the distance in bytes between sequences in the indirect buffer -
pipelineLayout
public long pipelineLayout()the optionalVkPipelineLayoutthat tokens in this layout use. If thedynamicGeneratedPipelineLayoutfeature is enabled,pipelineLayoutcan beNULL_HANDLEand the layout must be specified by chaining theVkPipelineLayoutCreateInfostructure off thepNext -
tokenCount
public int tokenCount()the length of the individual command sequence. -
pTokens
a pointer to an array ofVkIndirectCommandsLayoutTokenEXTdescribing each command token in detail. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_INDIRECT_COMMANDS_LAYOUT_CREATE_INFO_EXTvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
pNext
Prepends the specifiedVkPipelineLayoutCreateInfovalue to thepNextchain. -
flags
Sets the specified value to theflags()field. -
shaderStages
Sets the specified value to theshaderStages()field. -
indirectStride
Sets the specified value to theindirectStride()field. -
pipelineLayout
Sets the specified value to thepipelineLayout()field. -
pTokens
Sets the address of the specifiedVkIndirectCommandsLayoutTokenEXT.Bufferto thepTokens()field. -
set
public VkIndirectCommandsLayoutCreateInfoEXT set(int sType, long pNext, int flags, int shaderStages, int indirectStride, long pipelineLayout, VkIndirectCommandsLayoutTokenEXT.Buffer pTokens) Initializes this struct with the specified values. -
set
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
Returns a newVkIndirectCommandsLayoutCreateInfoEXTinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkIndirectCommandsLayoutCreateInfoEXTinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkIndirectCommandsLayoutCreateInfoEXTinstance allocated withBufferUtils. -
create
Returns a newVkIndirectCommandsLayoutCreateInfoEXTinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkIndirectCommandsLayoutCreateInfoEXT.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkIndirectCommandsLayoutCreateInfoEXT.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkIndirectCommandsLayoutCreateInfoEXT.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkIndirectCommandsLayoutCreateInfoEXT.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
public static @Nullable VkIndirectCommandsLayoutCreateInfoEXT.Buffer createSafe(long address, int capacity) -
malloc
Returns a newVkIndirectCommandsLayoutCreateInfoEXTinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkIndirectCommandsLayoutCreateInfoEXTinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkIndirectCommandsLayoutCreateInfoEXT.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkIndirectCommandsLayoutCreateInfoEXT.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkIndirectCommandsLayoutCreateInfoEXT.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkIndirectCommandsLayoutCreateInfoEXT.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
nsType
public static int nsType(long struct) Unsafe version ofsType(). -
npNext
public static long npNext(long struct) Unsafe version ofpNext(). -
nflags
public static int nflags(long struct) Unsafe version offlags(). -
nshaderStages
public static int nshaderStages(long struct) Unsafe version ofshaderStages(). -
nindirectStride
public static int nindirectStride(long struct) Unsafe version ofindirectStride(). -
npipelineLayout
public static long npipelineLayout(long struct) Unsafe version ofpipelineLayout(). -
ntokenCount
public static int ntokenCount(long struct) Unsafe version oftokenCount(). -
npTokens
Unsafe version ofpTokens(). -
nsType
public static void nsType(long struct, int value) Unsafe version ofsType. -
npNext
public static void npNext(long struct, long value) Unsafe version ofpNext. -
nflags
public static void nflags(long struct, int value) Unsafe version offlags. -
nshaderStages
public static void nshaderStages(long struct, int value) Unsafe version ofshaderStages. -
nindirectStride
public static void nindirectStride(long struct, int value) Unsafe version ofindirectStride. -
npipelineLayout
public static void npipelineLayout(long struct, long value) Unsafe version ofpipelineLayout. -
ntokenCount
public static void ntokenCount(long struct, int value) Sets the specified value to thetokenCountfield of the specifiedstruct. -
npTokens
Unsafe version ofpTokens. -
validate
public static void validate(long struct) Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-