Package org.lwjgl.vulkan

Class VkIndirectCommandsLayoutTokenNV

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkIndirectCommandsLayoutTokenNV>
org.lwjgl.vulkan.VkIndirectCommandsLayoutTokenNV
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class VkIndirectCommandsLayoutTokenNV extends org.lwjgl.system.Struct<VkIndirectCommandsLayoutTokenNV> implements org.lwjgl.system.NativeResource
Struct specifying the details of an indirect command layout token.
Valid Usage
Valid Usage (Implicit)
  • sType must be STRUCTURE_TYPE_INDIRECT_COMMANDS_LAYOUT_TOKEN_NV
  • pNext must be NULL
  • tokenType must be a valid VkIndirectCommandsTokenTypeNV value
  • If pushconstantPipelineLayout is not NULL_HANDLE, pushconstantPipelineLayout must be a valid VkPipelineLayout handle
  • pushconstantShaderStageFlags must be a valid combination of VkShaderStageFlagBits values
  • indirectStateFlags must be a valid combination of VkIndirectStateFlagBitsNV values
  • If indexTypeCount is not 0, pIndexTypes must be a valid pointer to an array of indexTypeCount valid VkIndexType values
  • If indexTypeCount is not 0, pIndexTypeValues must be a valid pointer to an array of indexTypeCount uint32_t values
See Also

VkIndirectCommandsLayoutCreateInfoNV

Layout


 struct VkIndirectCommandsLayoutTokenNV {
     VkStructureType sType();
     void const * pNext();
     VkIndirectCommandsTokenTypeNV tokenType();
     uint32_t stream;
     uint32_t offset();
     uint32_t vertexBindingUnit();
     VkBool32 vertexDynamicStride();
     VkPipelineLayout pushconstantPipelineLayout();
     VkShaderStageFlags pushconstantShaderStageFlags();
     uint32_t pushconstantOffset();
     uint32_t pushconstantSize();
     VkIndirectStateFlagsNV indirectStateFlags();
     uint32_t indexTypeCount();
     VkIndexType const * pIndexTypes();
     uint32_t const * pIndexTypeValues;
 }

  • 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.

    • TOKENTYPE

      public static final int TOKENTYPE
      The struct member offsets.

    • STREAM

      public static final int STREAM
      The struct member offsets.

    • OFFSET

      public static final int OFFSET
      The struct member offsets.

    • VERTEXBINDINGUNIT

      public static final int VERTEXBINDINGUNIT
      The struct member offsets.

    • VERTEXDYNAMICSTRIDE

      public static final int VERTEXDYNAMICSTRIDE
      The struct member offsets.

    • PUSHCONSTANTPIPELINELAYOUT

      public static final int PUSHCONSTANTPIPELINELAYOUT
      The struct member offsets.

    • PUSHCONSTANTSHADERSTAGEFLAGS

      public static final int PUSHCONSTANTSHADERSTAGEFLAGS
      The struct member offsets.

    • PUSHCONSTANTOFFSET

      public static final int PUSHCONSTANTOFFSET
      The struct member offsets.

    • PUSHCONSTANTSIZE

      public static final int PUSHCONSTANTSIZE
      The struct member offsets.

    • INDIRECTSTATEFLAGS

      public static final int INDIRECTSTATEFLAGS
      The struct member offsets.

    • INDEXTYPECOUNT

      public static final int INDEXTYPECOUNT
      The struct member offsets.

    • PINDEXTYPES

      public static final int PINDEXTYPES
      The struct member offsets.

    • PINDEXTYPEVALUES

      public static final int PINDEXTYPEVALUES
      The struct member offsets.

  • Constructor Details

    • VkIndirectCommandsLayoutTokenNV

      public VkIndirectCommandsLayoutTokenNV(ByteBuffer container)
      Creates a VkIndirectCommandsLayoutTokenNV 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<VkIndirectCommandsLayoutTokenNV>

    • sType

      public int sType()
      a VkStructureType value identifying this structure.

    • pNext

      public long pNext()
      NULL or a pointer to a structure extending this structure.

    • tokenType

      public int tokenType()
      a VkIndirectCommandsTokenTypeNV specifying the token command type.

    • stream$

      public int stream$()
      the index of the input stream containing the token argument data.

    • offset

      public int offset()
      a relative starting offset within the input stream memory for the token argument data.

    • vertexBindingUnit

      public int vertexBindingUnit()
      used for the vertex buffer binding command.

    • vertexDynamicStride

      public boolean vertexDynamicStride()
      sets if the vertex buffer stride is provided by the binding command rather than the current bound graphics pipeline state.

    • pushconstantPipelineLayout

      public long pushconstantPipelineLayout()
      the VkPipelineLayout used for the push constant command.

    • pushconstantShaderStageFlags

      public int pushconstantShaderStageFlags()
      are the shader stage flags used for the push constant command.

    • pushconstantOffset

      public int pushconstantOffset()
      the offset used for the push constant command.

    • pushconstantSize

      public int pushconstantSize()
      the size used for the push constant command.

    • indirectStateFlags

      public int indirectStateFlags()
      a VkIndirectStateFlagsNV bitfield indicating the active states for the state flag command.

    • indexTypeCount

      public int indexTypeCount()
      the optional size of the pIndexTypes and pIndexTypeValues array pairings. If not zero, it allows to register a custom uint32_t value to be treated as specific VkIndexType.

    • pIndexTypes

      public @Nullable IntBuffer pIndexTypes()
      the used VkIndexType for the corresponding uint32_t value entry in pIndexTypeValues.

    • pIndexTypeValues

      public @Nullable IntBuffer pIndexTypeValues()
      Returns:
      a IntBuffer view of the data pointed to by the pIndexTypeValues field.

    • sType

      public VkIndirectCommandsLayoutTokenNV sType(int value)
      Sets the specified value to the sType() field.

    • sType$Default

      public VkIndirectCommandsLayoutTokenNV sType$Default()
      Sets the STRUCTURE_TYPE_INDIRECT_COMMANDS_LAYOUT_TOKEN_NV value to the sType() field.

    • pNext

      public VkIndirectCommandsLayoutTokenNV pNext(long value)
      Sets the specified value to the pNext() field.

    • tokenType

      public VkIndirectCommandsLayoutTokenNV tokenType(int value)
      Sets the specified value to the tokenType() field.

    • stream$

      public VkIndirectCommandsLayoutTokenNV stream$(int value)
      Sets the specified value to the stream$() field.

    • offset

      public VkIndirectCommandsLayoutTokenNV offset(int value)
      Sets the specified value to the offset() field.

    • vertexBindingUnit

      public VkIndirectCommandsLayoutTokenNV vertexBindingUnit(int value)
      Sets the specified value to the vertexBindingUnit() field.

    • vertexDynamicStride

      public VkIndirectCommandsLayoutTokenNV vertexDynamicStride(boolean value)
      Sets the specified value to the vertexDynamicStride() field.

    • pushconstantPipelineLayout

      public VkIndirectCommandsLayoutTokenNV pushconstantPipelineLayout(long value)
      Sets the specified value to the pushconstantPipelineLayout() field.

    • pushconstantShaderStageFlags

      public VkIndirectCommandsLayoutTokenNV pushconstantShaderStageFlags(int value)
      Sets the specified value to the pushconstantShaderStageFlags() field.

    • pushconstantOffset

      public VkIndirectCommandsLayoutTokenNV pushconstantOffset(int value)
      Sets the specified value to the pushconstantOffset() field.

    • pushconstantSize

      public VkIndirectCommandsLayoutTokenNV pushconstantSize(int value)
      Sets the specified value to the pushconstantSize() field.

    • indirectStateFlags

      public VkIndirectCommandsLayoutTokenNV indirectStateFlags(int value)
      Sets the specified value to the indirectStateFlags() field.

    • indexTypeCount

      public VkIndirectCommandsLayoutTokenNV indexTypeCount(int value)
      Sets the specified value to the indexTypeCount() field.

    • pIndexTypes

      public VkIndirectCommandsLayoutTokenNV pIndexTypes(@Nullable IntBuffer value)
      Sets the address of the specified IntBuffer to the pIndexTypes() field.

    • pIndexTypeValues

      public VkIndirectCommandsLayoutTokenNV pIndexTypeValues(@Nullable IntBuffer value)
      Sets the address of the specified IntBuffer to the pIndexTypeValues field.

    • set

      public VkIndirectCommandsLayoutTokenNV set(int sType, long pNext, int tokenType, int stream$, int offset, int vertexBindingUnit, boolean vertexDynamicStride, long pushconstantPipelineLayout, int pushconstantShaderStageFlags, int pushconstantOffset, int pushconstantSize, int indirectStateFlags, int indexTypeCount, @Nullable IntBuffer pIndexTypes, @Nullable IntBuffer pIndexTypeValues)
      Initializes this struct with the specified values.

    • set

      public VkIndirectCommandsLayoutTokenNV set(VkIndirectCommandsLayoutTokenNV src)
      Copies the specified struct data to this struct.
      Parameters:
      src - the source struct
      Returns:
      this struct

    • malloc

      public static VkIndirectCommandsLayoutTokenNV malloc()
      Returns a new VkIndirectCommandsLayoutTokenNV instance allocated with memAlloc. The instance must be explicitly freed.

    • calloc

      public static VkIndirectCommandsLayoutTokenNV calloc()
      Returns a new VkIndirectCommandsLayoutTokenNV instance allocated with memCalloc. The instance must be explicitly freed.

    • create

      public static VkIndirectCommandsLayoutTokenNV create()
      Returns a new VkIndirectCommandsLayoutTokenNV instance allocated with BufferUtils.

    • create

      public static VkIndirectCommandsLayoutTokenNV create(long address)
      Returns a new VkIndirectCommandsLayoutTokenNV instance for the specified memory address.

    • createSafe

      public static @Nullable VkIndirectCommandsLayoutTokenNV createSafe(long address)
      Like create, but returns null if address is NULL.

    • malloc

      public static VkIndirectCommandsLayoutTokenNV.Buffer malloc(int capacity)
      Returns a new VkIndirectCommandsLayoutTokenNV.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity

    • calloc

      public static VkIndirectCommandsLayoutTokenNV.Buffer calloc(int capacity)
      Returns a new VkIndirectCommandsLayoutTokenNV.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity

    • create

      public static VkIndirectCommandsLayoutTokenNV.Buffer create(int capacity)
      Returns a new VkIndirectCommandsLayoutTokenNV.Buffer instance allocated with BufferUtils.
      Parameters:
      capacity - the buffer capacity

    • create

      public static VkIndirectCommandsLayoutTokenNV.Buffer create(long address, int capacity)
      Create a VkIndirectCommandsLayoutTokenNV.Buffer instance at the specified memory.
      Parameters:
      address - the memory address
      capacity - the buffer capacity

    • createSafe

      public static @Nullable VkIndirectCommandsLayoutTokenNV.Buffer createSafe(long address, int capacity)
      Like create, but returns null if address is NULL.

    • malloc

      public static VkIndirectCommandsLayoutTokenNV malloc(org.lwjgl.system.MemoryStack stack)
      Returns a new VkIndirectCommandsLayoutTokenNV instance allocated on the specified MemoryStack.
      Parameters:
      stack - the stack from which to allocate

    • calloc

      public static VkIndirectCommandsLayoutTokenNV calloc(org.lwjgl.system.MemoryStack stack)
      Returns a new VkIndirectCommandsLayoutTokenNV instance allocated on the specified MemoryStack and initializes all its bits to zero.
      Parameters:
      stack - the stack from which to allocate

    • malloc

      public static VkIndirectCommandsLayoutTokenNV.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new VkIndirectCommandsLayoutTokenNV.Buffer instance allocated on the specified MemoryStack.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate

    • calloc

      public static VkIndirectCommandsLayoutTokenNV.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new VkIndirectCommandsLayoutTokenNV.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().

    • ntokenType

      public static int ntokenType(long struct)
      Unsafe version of tokenType().

    • nstream$

      public static int nstream$(long struct)
      Unsafe version of stream$().

    • noffset

      public static int noffset(long struct)
      Unsafe version of offset().

    • nvertexBindingUnit

      public static int nvertexBindingUnit(long struct)
      Unsafe version of vertexBindingUnit().

    • nvertexDynamicStride

      public static int nvertexDynamicStride(long struct)
      Unsafe version of vertexDynamicStride().

    • npushconstantPipelineLayout

      public static long npushconstantPipelineLayout(long struct)
      Unsafe version of pushconstantPipelineLayout().

    • npushconstantShaderStageFlags

      public static int npushconstantShaderStageFlags(long struct)
      Unsafe version of pushconstantShaderStageFlags().

    • npushconstantOffset

      public static int npushconstantOffset(long struct)
      Unsafe version of pushconstantOffset().

    • npushconstantSize

      public static int npushconstantSize(long struct)
      Unsafe version of pushconstantSize().

    • nindirectStateFlags

      public static int nindirectStateFlags(long struct)
      Unsafe version of indirectStateFlags().

    • nindexTypeCount

      public static int nindexTypeCount(long struct)
      Unsafe version of indexTypeCount().

    • npIndexTypes

      public static @Nullable IntBuffer npIndexTypes(long struct)
      Unsafe version of pIndexTypes.

    • npIndexTypeValues

      public static @Nullable IntBuffer npIndexTypeValues(long struct)
      Unsafe version of pIndexTypeValues.

    • 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.

    • ntokenType

      public static void ntokenType(long struct, int value)
      Unsafe version of tokenType.

    • nstream$

      public static void nstream$(long struct, int value)
      Unsafe version of stream$.

    • noffset

      public static void noffset(long struct, int value)
      Unsafe version of offset.

    • nvertexBindingUnit

      public static void nvertexBindingUnit(long struct, int value)
      Unsafe version of vertexBindingUnit.

    • nvertexDynamicStride

      public static void nvertexDynamicStride(long struct, int value)
      Unsafe version of vertexDynamicStride.

    • npushconstantPipelineLayout

      public static void npushconstantPipelineLayout(long struct, long value)
      Unsafe version of pushconstantPipelineLayout.

    • npushconstantShaderStageFlags

      public static void npushconstantShaderStageFlags(long struct, int value)
      Unsafe version of pushconstantShaderStageFlags.

    • npushconstantOffset

      public static void npushconstantOffset(long struct, int value)
      Unsafe version of pushconstantOffset.

    • npushconstantSize

      public static void npushconstantSize(long struct, int value)
      Unsafe version of pushconstantSize.

    • nindirectStateFlags

      public static void nindirectStateFlags(long struct, int value)
      Unsafe version of indirectStateFlags.

    • nindexTypeCount

      public static void nindexTypeCount(long struct, int value)
      Sets the specified value to the indexTypeCount field of the specified struct.

    • npIndexTypes

      public static void npIndexTypes(long struct, @Nullable IntBuffer value)
      Unsafe version of pIndexTypes.

    • npIndexTypeValues

      public static void npIndexTypeValues(long struct, @Nullable IntBuffer value)
      Unsafe version of pIndexTypeValues.

    • validate

      public static void validate(long struct)
      Validates pointer members that should not be NULL.
      Parameters:
      struct - the struct to validate