vkCmdProcessCommandsNVX - Performs the generation of commands on the device

Parameters

• commandBuffer is the primary command buffer in which the generation process takes space.

• pProcessCommandsInfo is a pointer to a CmdProcessCommandsInfoNVX structure containing parameters affecting the processing of commands.

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pProcessCommandsInfo must be a valid pointer to a valid CmdProcessCommandsInfoNVX structure
• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support graphics, or compute operations
• This command must only be called inside of a render pass instance

Host Synchronization

• Host access to commandBuffer must be externally synchronized

• Host access to the CommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

'

See Also

CmdProcessCommandsInfoNVX, CommandBuffer

vkCmdReserveSpaceForCommandsNVX - Perform a reservation of command buffer space

Parameters

• commandBuffer is the secondary command buffer in which the space for device-generated commands is reserved.

• pProcessCommandsInfo is a pointer to a CmdReserveSpaceForCommandsInfoNVX structure containing parameters affecting the reservation of command buffer space.

Valid Usage

• The provided commandBuffer must not have had a prior space reservation since its creation or the last reset.

• The state of the commandBuffer must be legal to execute all commands within the sequence provided by the indirectCommandsLayout member of pProcessCommandsInfo.

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pReserveSpaceInfo must be a valid pointer to a valid CmdReserveSpaceForCommandsInfoNVX structure
• commandBuffer must be in the recording state
• The CommandPool that commandBuffer was allocated from must support graphics, or compute operations
• This command must only be called inside of a render pass instance
• commandBuffer must be a secondary CommandBuffer

Host Synchronization

• Host access to commandBuffer must be externally synchronized

• Host access to the CommandPool that commandBuffer was allocated from must be externally synchronized

Command Properties

'

See Also

CmdReserveSpaceForCommandsInfoNVX, CommandBuffer

vkCreateIndirectCommandsLayoutNVX - Create an indirect command layout object

Parameters

• device is the logical device that creates the indirect command layout.

• pCreateInfo is a pointer to a IndirectCommandsLayoutCreateInfoNVX structure containing parameters affecting creation of the indirect command layout.
• pAllocator controls host memory allocation as described in the Memory Allocation chapter.
• pIndirectCommandsLayout is a pointer to a IndirectCommandsLayoutNVX handle in which the resulting indirect command layout is returned.

Valid Usage (Implicit)

• device must be a valid Device handle

• pCreateInfo must be a valid pointer to a valid IndirectCommandsLayoutCreateInfoNVX structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• pIndirectCommandsLayout must be a valid pointer to a IndirectCommandsLayoutNVX handle

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

AllocationCallbacks, Device, IndirectCommandsLayoutCreateInfoNVX, IndirectCommandsLayoutNVX

A safe wrapper for createIndirectCommandsLayoutNVX and destroyIndirectCommandsLayoutNVX using bracket

The allocated value must not be returned from the provided computation

vkDestroyIndirectCommandsLayoutNVX - Destroy an object table

Parameters

• device is the logical device that destroys the layout.

• indirectCommandsLayout is the table to destroy.
• pAllocator controls host memory allocation as described in the Memory Allocation chapter.

Valid Usage

• All submitted commands that refer to indirectCommandsLayout must have completed execution

• If AllocationCallbacks were provided when objectTable was created, a compatible set of callbacks must be provided here
• If no AllocationCallbacks were provided when objectTable was created, pAllocator must be NULL

Valid Usage (Implicit)

• device must be a valid Device handle

• indirectCommandsLayout must be a valid IndirectCommandsLayoutNVX handle
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• indirectCommandsLayout must have been created, allocated, or retrieved from device

See Also

AllocationCallbacks, Device, IndirectCommandsLayoutNVX

vkCreateObjectTableNVX - Create an object table

Parameters

• device is the logical device that creates the object table.

• pCreateInfo is a pointer to a ObjectTableCreateInfoNVX structure containing parameters affecting creation of the table.
• pAllocator controls host memory allocation as described in the Memory Allocation chapter.
• pObjectTable is a pointer to a ObjectTableNVX handle in which the resulting object table is returned.

Valid Usage (Implicit)

• device must be a valid Device handle

• pCreateInfo must be a valid pointer to a valid ObjectTableCreateInfoNVX structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• pObjectTable must be a valid pointer to a ObjectTableNVX handle

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

AllocationCallbacks, Device, ObjectTableCreateInfoNVX, ObjectTableNVX

A safe wrapper for createObjectTableNVX and destroyObjectTableNVX using bracket

The allocated value must not be returned from the provided computation

vkDestroyObjectTableNVX - Destroy an object table

Parameters

• device is the logical device that destroys the table.

• objectTable is the table to destroy.
• pAllocator controls host memory allocation as described in the Memory Allocation chapter.

Valid Usage

• All submitted commands that refer to objectTable must have completed execution.

• If AllocationCallbacks were provided when objectTable was created, a compatible set of callbacks must be provided here.
• If no AllocationCallbacks were provided when objectTable was created, pAllocator must be NULL.

Valid Usage (Implicit)

• device must be a valid Device handle

• objectTable must be a valid ObjectTableNVX handle
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
• objectTable must have been created, allocated, or retrieved from device

Host Synchronization

• Host access to objectTable must be externally synchronized

See Also

AllocationCallbacks, Device, ObjectTableNVX

vkRegisterObjectsNVX - Register resource bindings in an object table

Parameters

• device is the logical device that creates the object table.

• objectTable is the table for which the resources are registered.
• objectCount is the number of resources to register.
• ppObjectTableEntries provides an array for detailed binding informations. Each array element is a pointer to a structure of type ObjectTablePipelineEntryNVX, ObjectTableDescriptorSetEntryNVX, ObjectTableVertexBufferEntryNVX, ObjectTableIndexBufferEntryNVX or ObjectTablePushConstantEntryNVX (see below for details).
• pObjectIndices are the indices at which each resource is registered.

Valid Usage

• The contents of pObjectTableEntry must yield plausible bindings supported by the device.

• At any pObjectIndices there must not be a registered resource already.
• Any value inside pObjectIndices must be below the appropriate ObjectTableCreateInfoNVX::pObjectEntryCounts limits provided at objectTable creation time.

Valid Usage (Implicit)

• device must be a valid Device handle

• objectTable must be a valid ObjectTableNVX handle
• ppObjectTableEntries must be a valid pointer to an array of objectCount valid ObjectTableEntryNVX structures
• pObjectIndices must be a valid pointer to an array of objectCount uint32_t values
• objectCount must be greater than 0
• objectTable must have been created, allocated, or retrieved from device

Host Synchronization

• Host access to objectTable must be externally synchronized

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

Device, ObjectTableEntryNVX, ObjectTableNVX

A safe wrapper for registerObjectsNVX and unregisterObjectsNVX using bracket_

vkUnregisterObjectsNVX - Unregister resource bindings in an object table

Parameters

• device is the logical device that creates the object table.

• objectTable is the table from which the resources are unregistered.
• objectCount is the number of resources being removed from the object table.
• pObjectEntryType provides an array of ObjectEntryTypeNVX for the resources being removed.
• pObjectIndices provides the array of object indices to be removed.

Valid Usage

• At any pObjectIndices there must be a registered resource already.

• The pObjectEntryTypes of the resource at pObjectIndices must match.
• All operations on the device using the registered resource must have been completed.

Valid Usage (Implicit)

• device must be a valid Device handle

• objectTable must be a valid ObjectTableNVX handle
• pObjectEntryTypes must be a valid pointer to an array of objectCount valid ObjectEntryTypeNVX values
• pObjectIndices must be a valid pointer to an array of objectCount uint32_t values
• objectCount must be greater than 0
• objectTable must have been created, allocated, or retrieved from device

Host Synchronization

• Host access to objectTable must be externally synchronized

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

Device, ObjectEntryTypeNVX, ObjectTableNVX

vkGetPhysicalDeviceGeneratedCommandsPropertiesNVX - Returns device-generated commands related properties of a physical device

Parameters

• physicalDevice is the handle to the physical device whose properties will be queried.

• pFeatures is a pointer to a DeviceGeneratedCommandsFeaturesNVX structure in which features are returned.
• pLimits is a pointer to a DeviceGeneratedCommandsLimitsNVX structure in which limitations are returned.

Valid Usage (Implicit)

See Also

DeviceGeneratedCommandsFeaturesNVX, DeviceGeneratedCommandsLimitsNVX, PhysicalDevice

VkDeviceGeneratedCommandsFeaturesNVX - Structure specifying physical device support

Valid Usage (Implicit)

See Also

Bool32, StructureType, getPhysicalDeviceGeneratedCommandsPropertiesNVX

VkDeviceGeneratedCommandsLimitsNVX - Structure specifying physical device limits

Valid Usage (Implicit)

See Also

StructureType, getPhysicalDeviceGeneratedCommandsPropertiesNVX

VkIndirectCommandsTokenNVX - Structure specifying parameters for the reservation of command buffer space

Valid Usage

• The buffer’s usage flag must have the BUFFER_USAGE_INDIRECT_BUFFER_BIT bit set.

• The offset must be aligned to DeviceGeneratedCommandsLimitsNVX::minCommandsTokenBufferOffsetAlignment.

Valid Usage (Implicit)

• tokenType must be a valid IndirectCommandsTokenTypeNVX value

• buffer must be a valid Buffer handle

See Also

Buffer, CmdProcessCommandsInfoNVX, DeviceSize, IndirectCommandsTokenTypeNVX

VkIndirectCommandsLayoutTokenNVX - Struct specifying the details of an indirect command layout token

Valid Usage (Implicit)

See Also

IndirectCommandsLayoutCreateInfoNVX, IndirectCommandsTokenTypeNVX

VkIndirectCommandsLayoutCreateInfoNVX - Structure specifying the parameters of a newly created indirect commands layout object

Description

The following code illustrates some of the key flags:

void cmdProcessAllSequences(cmd, objectTable, indirectCommandsLayout, pIndirectCommandsTokens, sequencesCount, indexbuffer, indexbufferoffset)
{
  for (s = 0; s < sequencesCount; s++)
  {
    sequence = s;

    if (indirectCommandsLayout.flags & VK_INDIRECT_COMMANDS_LAYOUT_USAGE_UNORDERED_SEQUENCES_BIT_NVX) {
      sequence = incoherent_implementation_dependent_permutation[ sequence ];
    }
    if (indirectCommandsLayout.flags & VK_INDIRECT_COMMANDS_LAYOUT_USAGE_INDEXED_SEQUENCES_BIT_NVX) {
      sequence = indexbuffer.load_uint32( sequence * sizeof(uint32_t) + indexbufferoffset);
    }

    cmdProcessSequence( cmd, objectTable, indirectCommandsLayout, pIndirectCommandsTokens, sequence );
  }
}

Valid Usage

• tokenCount must be greater than 0 and below DeviceGeneratedCommandsLimitsNVX::maxIndirectCommandsLayoutTokenCount

• If the DeviceGeneratedCommandsFeaturesNVX::computeBindingPointSupport feature is not enabled, then pipelineBindPoint must not be PIPELINE_BIND_POINT_COMPUTE
• If pTokens contains an entry of INDIRECT_COMMANDS_TOKEN_TYPE_PIPELINE_NVX it must be the first element of the array and there must be only a single element of such token type.
• All state binding tokens in pTokens must occur prior work provoking tokens (INDIRECT_COMMANDS_TOKEN_TYPE_DRAW_NVX, INDIRECT_COMMANDS_TOKEN_TYPE_DRAW_INDEXED_NVX, INDIRECT_COMMANDS_TOKEN_TYPE_DISPATCH_NVX).
• The content of pTokens must include one single work provoking token that is compatible with the pipelineBindPoint.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_INDIRECT_COMMANDS_LAYOUT_CREATE_INFO_NVX

• pNext must be NULL
• pipelineBindPoint must be a valid PipelineBindPoint value
• flags must be a valid combination of IndirectCommandsLayoutUsageFlagBitsNVX values
• flags must not be 0
• pTokens must be a valid pointer to an array of tokenCount valid IndirectCommandsLayoutTokenNVX structures
• tokenCount must be greater than 0

See Also

IndirectCommandsLayoutTokenNVX, IndirectCommandsLayoutUsageFlagsNVX, PipelineBindPoint, StructureType, createIndirectCommandsLayoutNVX

VkCmdProcessCommandsInfoNVX - Structure specifying parameters for the generation of commands

Valid Usage

• The provided objectTable must include all objects referenced by the generation process

• indirectCommandsTokenCount must match the indirectCommandsLayout’s tokenCount
• The tokenType member of each entry in the pIndirectCommandsTokens array must match the values used at creation time of indirectCommandsLayout
• If targetCommandBuffer is provided, it must have reserved command space
• If targetCommandBuffer is provided, the objectTable must match the reservation’s objectTable and must have had all referenced objects registered at reservation time
• If targetCommandBuffer is provided, the indirectCommandsLayout must match the reservation’s indirectCommandsLayout
• If targetCommandBuffer is provided, the maxSequencesCount must not exceed the reservation’s maxSequencesCount
• If sequencesCountBuffer is used, its usage flag must have the BUFFER_USAGE_INDIRECT_BUFFER_BIT bit set
• If sequencesCountBuffer is used, sequencesCountOffset must be aligned to DeviceGeneratedCommandsLimitsNVX::minSequenceCountBufferOffsetAlignment
• If sequencesIndexBuffer is used, its usage flag must have the BUFFER_USAGE_INDIRECT_BUFFER_BIT bit set
• If sequencesIndexBuffer is used, sequencesIndexOffset must be aligned to DeviceGeneratedCommandsLimitsNVX::minSequenceIndexBufferOffsetAlignment

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_CMD_PROCESS_COMMANDS_INFO_NVX

• pNext must be NULL
• objectTable must be a valid ObjectTableNVX handle
• indirectCommandsLayout must be a valid IndirectCommandsLayoutNVX handle
• pIndirectCommandsTokens must be a valid pointer to an array of indirectCommandsTokenCount valid IndirectCommandsTokenNVX structures
• If targetCommandBuffer is not NULL, targetCommandBuffer must be a valid CommandBuffer handle
• If sequencesCountBuffer is not NULL_HANDLE, sequencesCountBuffer must be a valid Buffer handle
• If sequencesIndexBuffer is not NULL_HANDLE, sequencesIndexBuffer must be a valid Buffer handle
• indirectCommandsTokenCount must be greater than 0
• Each of indirectCommandsLayout, objectTable, sequencesCountBuffer, sequencesIndexBuffer, and targetCommandBuffer that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same Device

Host Synchronization

• Host access to objectTable must be externally synchronized

• Host access to targetCommandBuffer must be externally synchronized

See Also

Buffer, CommandBuffer, DeviceSize, IndirectCommandsLayoutNVX, IndirectCommandsTokenNVX, ObjectTableNVX, StructureType, cmdProcessCommandsNVX

VkCmdReserveSpaceForCommandsInfoNVX - Structure specifying parameters for the reservation of command buffer space

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_CMD_RESERVE_SPACE_FOR_COMMANDS_INFO_NVX

• pNext must be NULL
• objectTable must be a valid ObjectTableNVX handle
• indirectCommandsLayout must be a valid IndirectCommandsLayoutNVX handle
• Both of indirectCommandsLayout, and objectTable must have been created, allocated, or retrieved from the same Device

Host Synchronization

• Host access to objectTable must be externally synchronized

See Also

IndirectCommandsLayoutNVX, ObjectTableNVX, StructureType, cmdReserveSpaceForCommandsNVX

VkObjectTableCreateInfoNVX - Structure specifying the parameters of a newly created object table

Valid Usage

• If the DeviceGeneratedCommandsFeaturesNVX::computeBindingPointSupport feature is not enabled, pObjectEntryUsageFlags must not contain OBJECT_ENTRY_USAGE_COMPUTE_BIT_NVX

• Any value within pObjectEntryCounts must not exceed DeviceGeneratedCommandsLimitsNVX::maxObjectEntryCounts
• maxUniformBuffersPerDescriptor must be within the limits supported by the device.
• maxStorageBuffersPerDescriptor must be within the limits supported by the device.
• maxStorageImagesPerDescriptor must be within the limits supported by the device.
• maxSampledImagesPerDescriptor must be within the limits supported by the device.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_OBJECT_TABLE_CREATE_INFO_NVX

• pNext must be NULL
• pObjectEntryTypes must be a valid pointer to an array of objectCount valid ObjectEntryTypeNVX values
• pObjectEntryCounts must be a valid pointer to an array of objectCount uint32_t values
• pObjectEntryUsageFlags must be a valid pointer to an array of objectCount valid combinations of ObjectEntryUsageFlagBitsNVX values
• Each element of pObjectEntryUsageFlags must not be 0
• objectCount must be greater than 0

See Also

ObjectEntryTypeNVX, ObjectEntryUsageFlagsNVX, StructureType, createObjectTableNVX

VkObjectTableEntryNVX - Common parameters of an object table resource entry

Valid Usage

• If the DeviceGeneratedCommandsFeaturesNVX::computeBindingPointSupport feature is not enabled, flags must not contain OBJECT_ENTRY_USAGE_COMPUTE_BIT_NVX

Valid Usage (Implicit)

• type must be a valid ObjectEntryTypeNVX value

• flags must be a valid combination of ObjectEntryUsageFlagBitsNVX values
• flags must not be 0

See Also

ObjectEntryTypeNVX, ObjectEntryUsageFlagsNVX, registerObjectsNVX

VkObjectTablePipelineEntryNVX - Parameters of an object table pipeline entry

Valid Usage (Implicit)

See Also

ObjectEntryTypeNVX, ObjectEntryUsageFlagsNVX, Pipeline

VkObjectTableDescriptorSetEntryNVX - Parameters of an object table descriptor set entry

Valid Usage

• type must be OBJECT_ENTRY_TYPE_DESCRIPTOR_SET_NVX

Valid Usage (Implicit)

• type must be a valid ObjectEntryTypeNVX value

• flags must be a valid combination of ObjectEntryUsageFlagBitsNVX values
• flags must not be 0
• pipelineLayout must be a valid PipelineLayout handle
• descriptorSet must be a valid DescriptorSet handle
• Both of descriptorSet, and pipelineLayout must have been created, allocated, or retrieved from the same Device

See Also

DescriptorSet, ObjectEntryTypeNVX, ObjectEntryUsageFlagsNVX, PipelineLayout

VkObjectTableVertexBufferEntryNVX - Parameters of an object table vertex buffer entry

Valid Usage (Implicit)

See Also

Buffer, ObjectEntryTypeNVX, ObjectEntryUsageFlagsNVX

VkObjectTableIndexBufferEntryNVX - Parameters of an object table index buffer entry

Valid Usage (Implicit)

See Also

Buffer, IndexType, ObjectEntryTypeNVX, ObjectEntryUsageFlagsNVX

VkObjectTablePushConstantEntryNVX - Parameters of an object table push constant entry

Valid Usage (Implicit)

See Also

ObjectEntryTypeNVX, ObjectEntryUsageFlagsNVX, PipelineLayout, ShaderStageFlags

VkIndirectCommandsLayoutUsageFlagBitsNVX - Bitmask specifying allowed usage of an indirect commands layout

See Also

IndirectCommandsLayoutUsageFlagsNVX

VkObjectEntryUsageFlagBitsNVX - Bitmask specifying allowed usage of an object entry

See Also

ObjectEntryUsageFlagsNVX

VkIndirectCommandsTokenTypeNVX - Enum specifying

Description

'

Supported indirect command tokens

See Also

IndirectCommandsLayoutTokenNVX, IndirectCommandsTokenNVX

VkObjectEntryTypeNVX - Enum specifying object table entry type

See Also

ObjectTableCreateInfoNVX, ObjectTableDescriptorSetEntryNVX, ObjectTableEntryNVX, ObjectTableIndexBufferEntryNVX, ObjectTablePipelineEntryNVX, ObjectTablePushConstantEntryNVX, ObjectTableVertexBufferEntryNVX, unregisterObjectsNVX

VkObjectTableNVX - Opaque handle to an object table

See Also

CmdProcessCommandsInfoNVX, CmdReserveSpaceForCommandsInfoNVX, createObjectTableNVX, destroyObjectTableNVX, registerObjectsNVX, unregisterObjectsNVX

VkIndirectCommandsLayoutNVX - Opaque handle to an indirect commands layout object

See Also

CmdProcessCommandsInfoNVX, CmdReserveSpaceForCommandsInfoNVX, createIndirectCommandsLayoutNVX, destroyIndirectCommandsLayoutNVX