Class VkGeneratedCommandsInfoEXT

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkGeneratedCommandsInfoEXT>
org.lwjgl.vulkan.VkGeneratedCommandsInfoEXT
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class VkGeneratedCommandsInfoEXT extends org.lwjgl.system.Struct<VkGeneratedCommandsInfoEXT> implements org.lwjgl.system.NativeResource
Structure specifying parameters for the generation of commands.
Description

If sequenceCountAddress is not NULL, then maxSequenceCount is the maximum number of sequences that can be executed. The actual number is min(maxSequenceCount, *sequenceCountAddress). If sequenceCountAddress is NULL, then maxSequenceCount is the exact number of sequences to execute.

If the action command token for the layout is not a COUNT-type multi-draw indirect token, maxDrawCount is ignored.

Valid Usage
Valid Usage (Implicit)
  • sType must be STRUCTURE_TYPE_GENERATED_COMMANDS_INFO_EXT
  • shaderStages must be a valid combination of VkShaderStageFlagBits values
  • shaderStages must not be 0
  • If indirectExecutionSet is not NULL_HANDLE, indirectExecutionSet must be a valid VkIndirectExecutionSetEXT handle
  • indirectCommandsLayout must be a valid VkIndirectCommandsLayoutEXT handle
  • Both of indirectCommandsLayout, and indirectExecutionSet that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same VkDevice
See Also

CmdExecuteGeneratedCommandsEXT, CmdPreprocessGeneratedCommandsEXT

Layout


 struct VkGeneratedCommandsInfoEXT {
     VkStructureType sType();
     void const * pNext();
     VkShaderStageFlags shaderStages();
     VkIndirectExecutionSetEXT indirectExecutionSet();
     VkIndirectCommandsLayoutEXT indirectCommandsLayout();
     VkDeviceAddress indirectAddress();
     VkDeviceSize indirectAddressSize();
     VkDeviceAddress preprocessAddress();
     VkDeviceSize preprocessSize();
     uint32_t maxSequenceCount();
     VkDeviceAddress sequenceCountAddress();
     uint32_t maxDrawCount();
 }
  • 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.
    • SHADERSTAGES

      public static final int SHADERSTAGES
      The struct member offsets.
    • INDIRECTEXECUTIONSET

      public static final int INDIRECTEXECUTIONSET
      The struct member offsets.
    • INDIRECTCOMMANDSLAYOUT

      public static final int INDIRECTCOMMANDSLAYOUT
      The struct member offsets.
    • INDIRECTADDRESS

      public static final int INDIRECTADDRESS
      The struct member offsets.
    • INDIRECTADDRESSSIZE

      public static final int INDIRECTADDRESSSIZE
      The struct member offsets.
    • PREPROCESSADDRESS

      public static final int PREPROCESSADDRESS
      The struct member offsets.
    • PREPROCESSSIZE

      public static final int PREPROCESSSIZE
      The struct member offsets.
    • MAXSEQUENCECOUNT

      public static final int MAXSEQUENCECOUNT
      The struct member offsets.
    • SEQUENCECOUNTADDRESS

      public static final int SEQUENCECOUNTADDRESS
      The struct member offsets.
    • MAXDRAWCOUNT

      public static final int MAXDRAWCOUNT
      The struct member offsets.
  • Constructor Details

    • VkGeneratedCommandsInfoEXT

      public VkGeneratedCommandsInfoEXT(ByteBuffer container)
      Creates a VkGeneratedCommandsInfoEXT 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<VkGeneratedCommandsInfoEXT>
    • sType

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

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

      public int shaderStages()
      the mask of shader stages used by the commands.
    • indirectExecutionSet

      public long indirectExecutionSet()
      the indirect execution set to be used for binding shaders.
    • indirectCommandsLayout

      public long indirectCommandsLayout()
      the VkIndirectCommandsLayoutEXT that specifies the command sequence data.
    • indirectAddress

      public long indirectAddress()
      an address that holds the indirect buffer data.
    • indirectAddressSize

      public long indirectAddressSize()
      the size in bytes of indirect buffer data starting at indirectAddress.
    • preprocessAddress

      public long preprocessAddress()
      specifies a physical address of the VkBuffer used for preprocessing the input data for execution. If this structure is used with CmdExecuteGeneratedCommandsEXT with its isPreprocessed set to TRUE, then the preprocessing step is skipped but data in this address may still be modified. The contents and the layout of this address are opaque to applications and must not be modified outside functions related to device-generated commands or copied to another buffer for reuse.
    • preprocessSize

      public long preprocessSize()
      the maximum byte size within preprocessAddress that is available for preprocessing.
    • maxSequenceCount

      public int maxSequenceCount()
      used to determine the number of sequences to execute.
    • sequenceCountAddress

      public long sequenceCountAddress()
      specifies an optional physical address of a single uint32_t value containing the requested number of sequences to execute.
    • maxDrawCount

      public int maxDrawCount()
      the maximum number of indirect draws that can be executed by any COUNT-type multi-draw indirect tokens. The draw count in the indirect buffer is clamped to this value for these token types.
    • sType

      public VkGeneratedCommandsInfoEXT sType(int value)
      Sets the specified value to the sType() field.
    • sType$Default

      public VkGeneratedCommandsInfoEXT sType$Default()
    • pNext

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

      Prepends the specified VkGeneratedCommandsPipelineInfoEXT value to the pNext chain.
    • pNext

      Prepends the specified VkGeneratedCommandsShaderInfoEXT value to the pNext chain.
    • shaderStages

      public VkGeneratedCommandsInfoEXT shaderStages(int value)
      Sets the specified value to the shaderStages() field.
    • indirectExecutionSet

      public VkGeneratedCommandsInfoEXT indirectExecutionSet(long value)
      Sets the specified value to the indirectExecutionSet() field.
    • indirectCommandsLayout

      public VkGeneratedCommandsInfoEXT indirectCommandsLayout(long value)
      Sets the specified value to the indirectCommandsLayout() field.
    • indirectAddress

      public VkGeneratedCommandsInfoEXT indirectAddress(long value)
      Sets the specified value to the indirectAddress() field.
    • indirectAddressSize

      public VkGeneratedCommandsInfoEXT indirectAddressSize(long value)
      Sets the specified value to the indirectAddressSize() field.
    • preprocessAddress

      public VkGeneratedCommandsInfoEXT preprocessAddress(long value)
      Sets the specified value to the preprocessAddress() field.
    • preprocessSize

      public VkGeneratedCommandsInfoEXT preprocessSize(long value)
      Sets the specified value to the preprocessSize() field.
    • maxSequenceCount

      public VkGeneratedCommandsInfoEXT maxSequenceCount(int value)
      Sets the specified value to the maxSequenceCount() field.
    • sequenceCountAddress

      public VkGeneratedCommandsInfoEXT sequenceCountAddress(long value)
      Sets the specified value to the sequenceCountAddress() field.
    • maxDrawCount

      public VkGeneratedCommandsInfoEXT maxDrawCount(int value)
      Sets the specified value to the maxDrawCount() field.
    • set

      public VkGeneratedCommandsInfoEXT set(int sType, long pNext, int shaderStages, long indirectExecutionSet, long indirectCommandsLayout, long indirectAddress, long indirectAddressSize, long preprocessAddress, long preprocessSize, int maxSequenceCount, long sequenceCountAddress, int maxDrawCount)
      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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      public static int nshaderStages(long struct)
      Unsafe version of shaderStages().
    • nindirectExecutionSet

      public static long nindirectExecutionSet(long struct)
      Unsafe version of indirectExecutionSet().
    • nindirectCommandsLayout

      public static long nindirectCommandsLayout(long struct)
      Unsafe version of indirectCommandsLayout().
    • nindirectAddress

      public static long nindirectAddress(long struct)
      Unsafe version of indirectAddress().
    • nindirectAddressSize

      public static long nindirectAddressSize(long struct)
      Unsafe version of indirectAddressSize().
    • npreprocessAddress

      public static long npreprocessAddress(long struct)
      Unsafe version of preprocessAddress().
    • npreprocessSize

      public static long npreprocessSize(long struct)
      Unsafe version of preprocessSize().
    • nmaxSequenceCount

      public static int nmaxSequenceCount(long struct)
      Unsafe version of maxSequenceCount().
    • nsequenceCountAddress

      public static long nsequenceCountAddress(long struct)
      Unsafe version of sequenceCountAddress().
    • nmaxDrawCount

      public static int nmaxDrawCount(long struct)
      Unsafe version of maxDrawCount().
    • 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.
    • nshaderStages

      public static void nshaderStages(long struct, int value)
      Unsafe version of shaderStages.
    • nindirectExecutionSet

      public static void nindirectExecutionSet(long struct, long value)
      Unsafe version of indirectExecutionSet.
    • nindirectCommandsLayout

      public static void nindirectCommandsLayout(long struct, long value)
      Unsafe version of indirectCommandsLayout.
    • nindirectAddress

      public static void nindirectAddress(long struct, long value)
      Unsafe version of indirectAddress.
    • nindirectAddressSize

      public static void nindirectAddressSize(long struct, long value)
      Unsafe version of indirectAddressSize.
    • npreprocessAddress

      public static void npreprocessAddress(long struct, long value)
      Unsafe version of preprocessAddress.
    • npreprocessSize

      public static void npreprocessSize(long struct, long value)
      Unsafe version of preprocessSize.
    • nmaxSequenceCount

      public static void nmaxSequenceCount(long struct, int value)
      Unsafe version of maxSequenceCount.
    • nsequenceCountAddress

      public static void nsequenceCountAddress(long struct, long value)
      Unsafe version of sequenceCountAddress.
    • nmaxDrawCount

      public static void nmaxDrawCount(long struct, int value)
      Unsafe version of maxDrawCount.