Class VkIndirectCommandsLayoutCreateInfoNV
- All Implemented Interfaces:
AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
Description
The following code illustrates some of the flags:
void cmdProcessAllSequences(cmd, pipeline, indirectCommandsLayout, pIndirectCommandsTokens, sequencesCount, indexbuffer, indexbufferOffset)
{
for (s = 0; s < sequencesCount; s++)
{
sUsed = s;
if (indirectCommandsLayout.flags & VK_INDIRECT_COMMANDS_LAYOUT_USAGE_INDEXED_SEQUENCES_BIT_NV) {
sUsed = indexbuffer.load_uint32( sUsed * sizeof(uint32_t) + indexbufferOffset);
}
if (indirectCommandsLayout.flags & VK_INDIRECT_COMMANDS_LAYOUT_USAGE_UNORDERED_SEQUENCES_BIT_NV) {
sUsed = incoherent_implementation_dependent_permutation[ sUsed ];
}
cmdProcessSequence( cmd, pipeline, indirectCommandsLayout, pIndirectCommandsTokens, 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 VkPhysicalDeviceDeviceGeneratedCommandsPropertiesNV::minIndirectCommandsBufferOffsetAlignment, whichever is lower.
Note
A minIndirectCommandsBufferOffsetAlignment of 4 allows VkDeviceAddress to be packed as uvec2 with scalar layout instead of uint64_t with 8 byte alignment. This enables direct compatibility with D3D12 command signature layouts.
Valid Usage
- The
pipelineBindPointmust bePIPELINE_BIND_POINT_GRAPHICSorPIPELINE_BIND_POINT_COMPUTE tokenCountmust be greater than 0 and less than or equal toVkPhysicalDeviceDeviceGeneratedCommandsPropertiesNV::maxIndirectCommandsTokenCount- If
pTokenscontains an entry ofINDIRECT_COMMANDS_TOKEN_TYPE_SHADER_GROUP_NVit must be the first element of the array and there must be only a single element of such token type - If
pTokenscontains an entry ofINDIRECT_COMMANDS_TOKEN_TYPE_PIPELINE_NVit must be the first element of the array and there must be only a single element of such token type - If
pTokenscontains an entry ofINDIRECT_COMMANDS_TOKEN_TYPE_STATE_FLAGS_NVthere must be only a single element of such token type - All state tokens in
pTokensmust occur before any action command tokens (INDIRECT_COMMANDS_TOKEN_TYPE_DRAW_NV,INDIRECT_COMMANDS_TOKEN_TYPE_DRAW_INDEXED_NV,INDIRECT_COMMANDS_TOKEN_TYPE_DRAW_TASKS_NV,INDIRECT_COMMANDS_TOKEN_TYPE_DRAW_MESH_TASKS_NV,INDIRECT_COMMANDS_TOKEN_TYPE_DISPATCH_NV) - The content of
pTokensmust include one single action command token that is compatible with thepipelineBindPoint streamCountmust be greater than 0 and less or equal toVkPhysicalDeviceDeviceGeneratedCommandsPropertiesNV::maxIndirectCommandsStreamCount- each element of
pStreamStridesmust be greater than 0 and less than or equal toVkPhysicalDeviceDeviceGeneratedCommandsPropertiesNV::maxIndirectCommandsStreamStride. Furthermore the alignment of each token input must be ensured - If
pipelineBindPointisPIPELINE_BIND_POINT_COMPUTEthen theVkPhysicalDeviceDeviceGeneratedCommandsComputeFeaturesNV::deviceGeneratedComputefeature must be enabled - If
pipelineBindPointisPIPELINE_BIND_POINT_COMPUTEthen the state tokens inpTokensmust only includeINDIRECT_COMMANDS_TOKEN_TYPE_DISPATCH_NV,INDIRECT_COMMANDS_TOKEN_TYPE_PIPELINE_NV, orINDIRECT_COMMANDS_TOKEN_TYPE_PUSH_CONSTANT_NV - If
pipelineBindPointisPIPELINE_BIND_POINT_COMPUTEandpTokensincludesINDIRECT_COMMANDS_TOKEN_TYPE_PIPELINE_NV, then theVkPhysicalDeviceDeviceGeneratedCommandsComputeFeaturesNV::deviceGeneratedComputePipelinesfeature must be enabled
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_INDIRECT_COMMANDS_LAYOUT_CREATE_INFO_NVpNextmust beNULLflagsmust be a valid combination ofVkIndirectCommandsLayoutUsageFlagBitsNVvaluespipelineBindPointmust be a validVkPipelineBindPointvaluepTokensmust be a valid pointer to an array oftokenCountvalidVkIndirectCommandsLayoutTokenNVstructurespStreamStridesmust be a valid pointer to an array ofstreamCountuint32_tvaluestokenCountmust be greater than 0streamCountmust be greater than 0
See Also
VkIndirectCommandsLayoutTokenNV, CreateIndirectCommandsLayoutNV
Layout
struct VkIndirectCommandsLayoutCreateInfoNV {
VkStructureType sType();
void const * pNext();
VkIndirectCommandsLayoutUsageFlagsNV flags();
VkPipelineBindPoint pipelineBindPoint();
uint32_t tokenCount();
VkIndirectCommandsLayoutTokenNV const * pTokens();
uint32_t streamCount();
uint32_t const * pStreamStrides();
}-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classAn array ofVkIndirectCommandsLayoutCreateInfoNVstructs.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 size in bytes.static final intThe struct member offsets.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
ConstructorsConstructorDescriptionVkIndirectCommandsLayoutCreateInfoNV(ByteBuffer container) Creates aVkIndirectCommandsLayoutCreateInfoNVinstance at the current position of the specifiedByteBuffercontainer. -
Method Summary
Modifier and TypeMethodDescriptioncalloc()Returns a newVkIndirectCommandsLayoutCreateInfoNVinstance allocated withmemCalloc.calloc(int capacity) Returns a newVkIndirectCommandsLayoutCreateInfoNV.Bufferinstance allocated withmemCalloc.calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkIndirectCommandsLayoutCreateInfoNV.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.calloc(org.lwjgl.system.MemoryStack stack) Returns a newVkIndirectCommandsLayoutCreateInfoNVinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.create()Returns a newVkIndirectCommandsLayoutCreateInfoNVinstance allocated withBufferUtils.create(int capacity) Returns a newVkIndirectCommandsLayoutCreateInfoNV.Bufferinstance allocated withBufferUtils.create(long address) Returns a newVkIndirectCommandsLayoutCreateInfoNVinstance for the specified memory address.create(long address, int capacity) Create aVkIndirectCommandsLayoutCreateInfoNV.Bufferinstance at the specified memory.static @Nullable VkIndirectCommandsLayoutCreateInfoNVcreateSafe(long address) static @Nullable VkIndirectCommandsLayoutCreateInfoNV.BuffercreateSafe(long address, int capacity) intflags()a bitmask ofVkIndirectCommandsLayoutUsageFlagBitsNVspecifying usage hints of this layout.flags(int value) Sets the specified value to theflags()field.malloc()Returns a newVkIndirectCommandsLayoutCreateInfoNVinstance allocated withmemAlloc.malloc(int capacity) Returns a newVkIndirectCommandsLayoutCreateInfoNV.Bufferinstance allocated withmemAlloc.malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkIndirectCommandsLayoutCreateInfoNV.Bufferinstance allocated on the specifiedMemoryStack.malloc(org.lwjgl.system.MemoryStack stack) Returns a newVkIndirectCommandsLayoutCreateInfoNVinstance allocated on the specifiedMemoryStack.static intnflags(long struct) Unsafe version offlags().static voidnflags(long struct, int value) Unsafe version offlags.static intnpipelineBindPoint(long struct) Unsafe version ofpipelineBindPoint().static voidnpipelineBindPoint(long struct, int value) Unsafe version ofpipelineBindPoint.static longnpNext(long struct) Unsafe version ofpNext().static voidnpNext(long struct, long value) Unsafe version ofpNext.static IntBuffernpStreamStrides(long struct) Unsafe version ofpStreamStrides.static voidnpStreamStrides(long struct, IntBuffer value) Unsafe version ofpStreamStrides.npTokens(long struct) Unsafe version ofpTokens().static voidnpTokens(long struct, VkIndirectCommandsLayoutTokenNV.Buffer value) Unsafe version ofpTokens.static intnstreamCount(long struct) Unsafe version ofstreamCount().static voidnstreamCount(long struct, int value) Sets the specified value to thestreamCountfield of the specifiedstruct.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.inttheVkPipelineBindPointthat this layout targets.pipelineBindPoint(int value) Sets the specified value to thepipelineBindPoint()field.longpNext()NULLor a pointer to a structure extending this structure.pNext(long value) Sets the specified value to thepNext()field.an array defining the byte stride for each input stream.pStreamStrides(IntBuffer value) Sets the address of the specifiedIntBufferto thepStreamStrides()field.pTokens()an array describing each command token in detail.Sets the address of the specifiedVkIndirectCommandsLayoutTokenNV.Bufferto thepTokens()field.set(int sType, long pNext, int flags, int pipelineBindPoint, VkIndirectCommandsLayoutTokenNV.Buffer pTokens, IntBuffer pStreamStrides) Initializes this struct with the specified values.Copies the specified struct data to this struct.intsizeof()intthe number of streams used to provide the token inputs.intsType()aVkStructureTypevalue identifying this structure.sType(int value) Sets the specified value to thesType()field.Sets theSTRUCTURE_TYPE_INDIRECT_COMMANDS_LAYOUT_CREATE_INFO_NVvalue 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. -
PIPELINEBINDPOINT
public static final int PIPELINEBINDPOINTThe struct member offsets. -
TOKENCOUNT
public static final int TOKENCOUNTThe struct member offsets. -
PTOKENS
public static final int PTOKENSThe struct member offsets. -
STREAMCOUNT
public static final int STREAMCOUNTThe struct member offsets. -
PSTREAMSTRIDES
public static final int PSTREAMSTRIDESThe struct member offsets.
-
-
Constructor Details
-
VkIndirectCommandsLayoutCreateInfoNV
Creates aVkIndirectCommandsLayoutCreateInfoNVinstance 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<VkIndirectCommandsLayoutCreateInfoNV>
-
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 ofVkIndirectCommandsLayoutUsageFlagBitsNVspecifying usage hints of this layout. -
pipelineBindPoint
public int pipelineBindPoint()theVkPipelineBindPointthat this layout targets. -
tokenCount
public int tokenCount()the length of the individual command sequence. -
pTokens
an array describing each command token in detail. SeeVkIndirectCommandsTokenTypeNVandVkIndirectCommandsLayoutTokenNVbelow for details. -
streamCount
public int streamCount()the number of streams used to provide the token inputs. -
pStreamStrides
an array defining the byte stride for each input stream. -
sType
Sets the specified value to thesType()field. -
sType$Default
Sets theSTRUCTURE_TYPE_INDIRECT_COMMANDS_LAYOUT_CREATE_INFO_NVvalue to thesType()field. -
pNext
Sets the specified value to thepNext()field. -
flags
Sets the specified value to theflags()field. -
pipelineBindPoint
Sets the specified value to thepipelineBindPoint()field. -
pTokens
Sets the address of the specifiedVkIndirectCommandsLayoutTokenNV.Bufferto thepTokens()field. -
pStreamStrides
Sets the address of the specifiedIntBufferto thepStreamStrides()field. -
set
public VkIndirectCommandsLayoutCreateInfoNV set(int sType, long pNext, int flags, int pipelineBindPoint, VkIndirectCommandsLayoutTokenNV.Buffer pTokens, IntBuffer pStreamStrides) 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 newVkIndirectCommandsLayoutCreateInfoNVinstance allocated withmemAlloc. The instance must be explicitly freed. -
calloc
Returns a newVkIndirectCommandsLayoutCreateInfoNVinstance allocated withmemCalloc. The instance must be explicitly freed. -
create
Returns a newVkIndirectCommandsLayoutCreateInfoNVinstance allocated withBufferUtils. -
create
Returns a newVkIndirectCommandsLayoutCreateInfoNVinstance for the specified memory address. -
createSafe
-
malloc
Returns a newVkIndirectCommandsLayoutCreateInfoNV.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
Returns a newVkIndirectCommandsLayoutCreateInfoNV.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
Returns a newVkIndirectCommandsLayoutCreateInfoNV.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
Create aVkIndirectCommandsLayoutCreateInfoNV.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
public static @Nullable VkIndirectCommandsLayoutCreateInfoNV.Buffer createSafe(long address, int capacity) -
malloc
Returns a newVkIndirectCommandsLayoutCreateInfoNVinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
Returns a newVkIndirectCommandsLayoutCreateInfoNVinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkIndirectCommandsLayoutCreateInfoNV.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkIndirectCommandsLayoutCreateInfoNV.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
capacity- the buffer capacitystack- the stack from which to allocate
-
calloc
public static VkIndirectCommandsLayoutCreateInfoNV.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack) Returns a newVkIndirectCommandsLayoutCreateInfoNV.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(). -
npipelineBindPoint
public static int npipelineBindPoint(long struct) Unsafe version ofpipelineBindPoint(). -
ntokenCount
public static int ntokenCount(long struct) Unsafe version oftokenCount(). -
npTokens
Unsafe version ofpTokens(). -
nstreamCount
public static int nstreamCount(long struct) Unsafe version ofstreamCount(). -
npStreamStrides
Unsafe version ofpStreamStrides. -
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. -
npipelineBindPoint
public static void npipelineBindPoint(long struct, int value) Unsafe version ofpipelineBindPoint. -
ntokenCount
public static void ntokenCount(long struct, int value) Sets the specified value to thetokenCountfield of the specifiedstruct. -
npTokens
Unsafe version ofpTokens. -
nstreamCount
public static void nstreamCount(long struct, int value) Sets the specified value to thestreamCountfield of the specifiedstruct. -
npStreamStrides
Unsafe version ofpStreamStrides. -
validate
public static void validate(long struct) Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-