Package org.lwjgl.vulkan
Class VkIndirectCommandsLayoutCreateInfoNV
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkIndirectCommandsLayoutCreateInfoNV
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkIndirectCommandsLayoutCreateInfoNV extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceStructure specifying the parameters of a newly created indirect commands layout object.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 ); } }Valid Usage
- The
pipelineBindPointmust bePIPELINE_BIND_POINT_GRAPHICS 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_STATE_FLAGS_NVthere must be only a single element of such token type - All state tokens in
pTokensmust occur prior work provoking tokens (INDIRECT_COMMANDS_TOKEN_TYPE_DRAW_NV,INDIRECT_COMMANDS_TOKEN_TYPE_DRAW_INDEXED_NV,INDIRECT_COMMANDS_TOKEN_TYPE_DRAW_TASKS_NV) - The content of
pTokensmust include one single work provoking 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
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,CreateIndirectCommandsLayoutNVLayout
struct VkIndirectCommandsLayoutCreateInfoNV { VkStructureTypesType(); void const *pNext(); VkIndirectCommandsLayoutUsageFlagsNVflags(); VkPipelineBindPointpipelineBindPoint(); uint32_ttokenCount();VkIndirectCommandsLayoutTokenNVconst *pTokens(); uint32_tstreamCount(); uint32_t const *pStreamStrides(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkIndirectCommandsLayoutCreateInfoNV.BufferAn array ofVkIndirectCommandsLayoutCreateInfoNVstructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intFLAGS
PIPELINEBINDPOINT
PNEXT
PSTREAMSTRIDES
PTOKENSThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSTREAMCOUNT
STYPE
TOKENCOUNTThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkIndirectCommandsLayoutCreateInfoNV(java.nio.ByteBuffer container)Creates aVkIndirectCommandsLayoutCreateInfoNVinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static VkIndirectCommandsLayoutCreateInfoNVcalloc()Returns a newVkIndirectCommandsLayoutCreateInfoNVinstance allocated withmemCalloc.static VkIndirectCommandsLayoutCreateInfoNV.Buffercalloc(int capacity)Returns a newVkIndirectCommandsLayoutCreateInfoNV.Bufferinstance allocated withmemCalloc.static VkIndirectCommandsLayoutCreateInfoNV.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkIndirectCommandsLayoutCreateInfoNV.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkIndirectCommandsLayoutCreateInfoNVcalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkIndirectCommandsLayoutCreateInfoNVinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkIndirectCommandsLayoutCreateInfoNVcreate()Returns a newVkIndirectCommandsLayoutCreateInfoNVinstance allocated withBufferUtils.static VkIndirectCommandsLayoutCreateInfoNV.Buffercreate(int capacity)Returns a newVkIndirectCommandsLayoutCreateInfoNV.Bufferinstance allocated withBufferUtils.static VkIndirectCommandsLayoutCreateInfoNVcreate(long address)Returns a newVkIndirectCommandsLayoutCreateInfoNVinstance for the specified memory address.static VkIndirectCommandsLayoutCreateInfoNV.Buffercreate(long address, int capacity)Create aVkIndirectCommandsLayoutCreateInfoNV.Bufferinstance at the specified memory.static VkIndirectCommandsLayoutCreateInfoNVcreateSafe(long address)static VkIndirectCommandsLayoutCreateInfoNV.BuffercreateSafe(long address, int capacity)intflags()a bitmask ofVkIndirectCommandsLayoutUsageFlagBitsNVspecifying usage hints of this layout.VkIndirectCommandsLayoutCreateInfoNVflags(int value)Sets the specified value to theflags()field.static VkIndirectCommandsLayoutCreateInfoNVmalloc()Returns a newVkIndirectCommandsLayoutCreateInfoNVinstance allocated withmemAlloc.static VkIndirectCommandsLayoutCreateInfoNV.Buffermalloc(int capacity)Returns a newVkIndirectCommandsLayoutCreateInfoNV.Bufferinstance allocated withmemAlloc.static VkIndirectCommandsLayoutCreateInfoNV.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkIndirectCommandsLayoutCreateInfoNV.Bufferinstance allocated on the specifiedMemoryStack.static VkIndirectCommandsLayoutCreateInfoNVmalloc(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 java.nio.IntBuffernpStreamStrides(long struct)Unsafe version ofpStreamStrides.static voidnpStreamStrides(long struct, java.nio.IntBuffer value)Unsafe version ofpStreamStrides.static VkIndirectCommandsLayoutTokenNV.BuffernpTokens(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.intpipelineBindPoint()theVkPipelineBindPointthat this layout targets.VkIndirectCommandsLayoutCreateInfoNVpipelineBindPoint(int value)Sets the specified value to thepipelineBindPoint()field.longpNext()NULLor a pointer to a structure extending this structure.VkIndirectCommandsLayoutCreateInfoNVpNext(long value)Sets the specified value to thepNext()field.java.nio.IntBufferpStreamStrides()an array defining the byte stride for each input stream.VkIndirectCommandsLayoutCreateInfoNVpStreamStrides(java.nio.IntBuffer value)Sets the address of the specifiedIntBufferto thepStreamStrides()field.VkIndirectCommandsLayoutTokenNV.BufferpTokens()an array describing each command token in detail.VkIndirectCommandsLayoutCreateInfoNVpTokens(VkIndirectCommandsLayoutTokenNV.Buffer value)Sets the address of the specifiedVkIndirectCommandsLayoutTokenNV.Bufferto thepTokens()field.VkIndirectCommandsLayoutCreateInfoNVset(int sType, long pNext, int flags, int pipelineBindPoint, VkIndirectCommandsLayoutTokenNV.Buffer pTokens, java.nio.IntBuffer pStreamStrides)Initializes this struct with the specified values.VkIndirectCommandsLayoutCreateInfoNVset(VkIndirectCommandsLayoutCreateInfoNV src)Copies the specified struct data to this struct.intsizeof()intstreamCount()the number of streams used to provide the token inputs.intsType()the type of this structure.VkIndirectCommandsLayoutCreateInfoNVsType(int value)Sets the specified value to thesType()field.VkIndirectCommandsLayoutCreateInfoNVsType$Default()Sets theSTRUCTURE_TYPE_INDIRECT_COMMANDS_LAYOUT_CREATE_INFO_NVvalue to thesType()field.inttokenCount()the length of the individual command sequence.static voidvalidate(long struct)Validates pointer members that should not beNULL.
-
-
-
Constructor Detail
-
VkIndirectCommandsLayoutCreateInfoNV
public VkIndirectCommandsLayoutCreateInfoNV(java.nio.ByteBuffer container)
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 Detail
-
sizeof
public int sizeof()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
sType
public int sType()
the type of 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
public VkIndirectCommandsLayoutTokenNV.Buffer 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
public java.nio.IntBuffer pStreamStrides()
an array defining the byte stride for each input stream.
-
sType
public VkIndirectCommandsLayoutCreateInfoNV sType(int value)
Sets the specified value to thesType()field.
-
sType$Default
public VkIndirectCommandsLayoutCreateInfoNV sType$Default()
Sets theSTRUCTURE_TYPE_INDIRECT_COMMANDS_LAYOUT_CREATE_INFO_NVvalue to thesType()field.
-
pNext
public VkIndirectCommandsLayoutCreateInfoNV pNext(long value)
Sets the specified value to thepNext()field.
-
flags
public VkIndirectCommandsLayoutCreateInfoNV flags(int value)
Sets the specified value to theflags()field.
-
pipelineBindPoint
public VkIndirectCommandsLayoutCreateInfoNV pipelineBindPoint(int value)
Sets the specified value to thepipelineBindPoint()field.
-
pTokens
public VkIndirectCommandsLayoutCreateInfoNV pTokens(VkIndirectCommandsLayoutTokenNV.Buffer value)
Sets the address of the specifiedVkIndirectCommandsLayoutTokenNV.Bufferto thepTokens()field.
-
pStreamStrides
public VkIndirectCommandsLayoutCreateInfoNV pStreamStrides(java.nio.IntBuffer value)
Sets the address of the specifiedIntBufferto thepStreamStrides()field.
-
set
public VkIndirectCommandsLayoutCreateInfoNV set(int sType, long pNext, int flags, int pipelineBindPoint, VkIndirectCommandsLayoutTokenNV.Buffer pTokens, java.nio.IntBuffer pStreamStrides)
Initializes this struct with the specified values.
-
set
public VkIndirectCommandsLayoutCreateInfoNV set(VkIndirectCommandsLayoutCreateInfoNV src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkIndirectCommandsLayoutCreateInfoNV malloc()
Returns a newVkIndirectCommandsLayoutCreateInfoNVinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkIndirectCommandsLayoutCreateInfoNV calloc()
Returns a newVkIndirectCommandsLayoutCreateInfoNVinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkIndirectCommandsLayoutCreateInfoNV create()
Returns a newVkIndirectCommandsLayoutCreateInfoNVinstance allocated withBufferUtils.
-
create
public static VkIndirectCommandsLayoutCreateInfoNV create(long address)
Returns a newVkIndirectCommandsLayoutCreateInfoNVinstance for the specified memory address.
-
createSafe
@Nullable public static VkIndirectCommandsLayoutCreateInfoNV createSafe(long address)
-
malloc
public static VkIndirectCommandsLayoutCreateInfoNV.Buffer malloc(int capacity)
Returns a newVkIndirectCommandsLayoutCreateInfoNV.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkIndirectCommandsLayoutCreateInfoNV.Buffer calloc(int capacity)
Returns a newVkIndirectCommandsLayoutCreateInfoNV.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkIndirectCommandsLayoutCreateInfoNV.Buffer create(int capacity)
Returns a newVkIndirectCommandsLayoutCreateInfoNV.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkIndirectCommandsLayoutCreateInfoNV.Buffer create(long address, int capacity)
Create aVkIndirectCommandsLayoutCreateInfoNV.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkIndirectCommandsLayoutCreateInfoNV.Buffer createSafe(long address, int capacity)
-
malloc
public static VkIndirectCommandsLayoutCreateInfoNV malloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkIndirectCommandsLayoutCreateInfoNVinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static VkIndirectCommandsLayoutCreateInfoNV calloc(org.lwjgl.system.MemoryStack stack)
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:
stack- the stack from which to allocatecapacity- the buffer capacity
-
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:
stack- the stack from which to allocatecapacity- the buffer capacity
-
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
public static VkIndirectCommandsLayoutTokenNV.Buffer npTokens(long struct)
Unsafe version ofpTokens().
-
nstreamCount
public static int nstreamCount(long struct)
Unsafe version ofstreamCount().
-
npStreamStrides
public static java.nio.IntBuffer npStreamStrides(long struct)
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
public static void npTokens(long struct, VkIndirectCommandsLayoutTokenNV.Buffer value)Unsafe version ofpTokens.
-
nstreamCount
public static void nstreamCount(long struct, int value)Sets the specified value to thestreamCountfield of the specifiedstruct.
-
npStreamStrides
public static void npStreamStrides(long struct, java.nio.IntBuffer value)Unsafe version ofpStreamStrides.
-
validate
public static void validate(long struct)
Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-
-