Package org.lwjgl.vulkan

Class NVDeviceGeneratedCommandsCompute

java.lang.Object

org.lwjgl.vulkan.NVDeviceGeneratedCommandsCompute

public class NVDeviceGeneratedCommandsCompute
extends Object

This extension allows the device to generate commands for binding compute pipelines, setting push constants and launching compute dispatches.

Name String

VK_NV_device_generated_commands_compute

Extension Type

Device extension

Registered Extension Number

429

Revision

2

Extension and Version Dependencies

VK_NV_device_generated_commands

Contact

• Vikram Kushwaha vkushwaha-nv

Other Extension Metadata

Last Modified Date

2023-07-21

Contributors

• Vikram Kushwaha, NVIDIA
• Jeff Bolz, NVIDIA
• Christoph Kubisch, NVIDIA
• Piers Daniell, NVIDIA
• Daniel Koch, NVIDIA
• Hans-Kristian Arntzen, Valve
• Mike Blumenkrantz, VALVE

Field Summary

Fields

Modifier and Type	Field	Description
static final int	VK_DESCRIPTOR_SET_LAYOUT_CREATE_INDIRECT_BINDABLE_BIT_NV	Extends VkDescriptorSetLayoutCreateFlagBits.
static final int	VK_INDIRECT_COMMANDS_TOKEN_TYPE_DISPATCH_NV	Extends VkIndirectCommandsTokenTypeNV.
static final int	VK_INDIRECT_COMMANDS_TOKEN_TYPE_PIPELINE_NV	Extends VkIndirectCommandsTokenTypeNV.
static final String	VK_NV_DEVICE_GENERATED_COMMANDS_COMPUTE_EXTENSION_NAME	The extension name.
static final int	VK_NV_DEVICE_GENERATED_COMMANDS_COMPUTE_SPEC_VERSION	The extension specification version.
static final int	VK_STRUCTURE_TYPE_COMPUTE_PIPELINE_INDIRECT_BUFFER_INFO_NV	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_DEVICE_GENERATED_COMMANDS_COMPUTE_FEATURES_NV	Extends VkStructureType.
static final int	VK_STRUCTURE_TYPE_PIPELINE_INDIRECT_DEVICE_ADDRESS_INFO_NV	Extends VkStructureType.

Method Summary

Modifier and Type	Method	Description
static long	nvkGetPipelineIndirectDeviceAddressNV(org.lwjgl.vulkan.VkDevice device, long pInfo)	Unsafe version of: GetPipelineIndirectDeviceAddressNV
static void	nvkGetPipelineIndirectMemoryRequirementsNV(org.lwjgl.vulkan.VkDevice device, long pCreateInfo, long pMemoryRequirements)	Unsafe version of: GetPipelineIndirectMemoryRequirementsNV
static void	vkCmdUpdatePipelineIndirectBufferNV(org.lwjgl.vulkan.VkCommandBuffer commandBuffer, int pipelineBindPoint, long pipeline)	Update the indirect compute pipeline’s metadata.
static long	vkGetPipelineIndirectDeviceAddressNV(org.lwjgl.vulkan.VkDevice device, VkPipelineIndirectDeviceAddressInfoNV pInfo)	Get pipeline’s 64-bit device address.
static void	vkGetPipelineIndirectMemoryRequirementsNV(org.lwjgl.vulkan.VkDevice device, VkComputePipelineCreateInfo pCreateInfo, VkMemoryRequirements2 pMemoryRequirements)	Get the memory requirements for the compute indirect pipeline.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

VK_NV_DEVICE_GENERATED_COMMANDS_COMPUTE_SPEC_VERSION

public static final int VK_NV_DEVICE_GENERATED_COMMANDS_COMPUTE_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

VK_NV_DEVICE_GENERATED_COMMANDS_COMPUTE_EXTENSION_NAME

public static final String VK_NV_DEVICE_GENERATED_COMMANDS_COMPUTE_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_DEVICE_GENERATED_COMMANDS_COMPUTE_FEATURES_NV

public static final int VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_DEVICE_GENERATED_COMMANDS_COMPUTE_FEATURES_NV

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_DEVICE_GENERATED_COMMANDS_COMPUTE_FEATURES_NV
• STRUCTURE_TYPE_COMPUTE_PIPELINE_INDIRECT_BUFFER_INFO_NV
• STRUCTURE_TYPE_PIPELINE_INDIRECT_DEVICE_ADDRESS_INFO_NV

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_COMPUTE_PIPELINE_INDIRECT_BUFFER_INFO_NV

public static final int VK_STRUCTURE_TYPE_COMPUTE_PIPELINE_INDIRECT_BUFFER_INFO_NV

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_DEVICE_GENERATED_COMMANDS_COMPUTE_FEATURES_NV
• STRUCTURE_TYPE_COMPUTE_PIPELINE_INDIRECT_BUFFER_INFO_NV
• STRUCTURE_TYPE_PIPELINE_INDIRECT_DEVICE_ADDRESS_INFO_NV

See Also:

• Constant Field Values

VK_STRUCTURE_TYPE_PIPELINE_INDIRECT_DEVICE_ADDRESS_INFO_NV

public static final int VK_STRUCTURE_TYPE_PIPELINE_INDIRECT_DEVICE_ADDRESS_INFO_NV

Extends VkStructureType.

Enum values:

• STRUCTURE_TYPE_PHYSICAL_DEVICE_DEVICE_GENERATED_COMMANDS_COMPUTE_FEATURES_NV
• STRUCTURE_TYPE_COMPUTE_PIPELINE_INDIRECT_BUFFER_INFO_NV
• STRUCTURE_TYPE_PIPELINE_INDIRECT_DEVICE_ADDRESS_INFO_NV

See Also:

• Constant Field Values

VK_INDIRECT_COMMANDS_TOKEN_TYPE_PIPELINE_NV

public static final int VK_INDIRECT_COMMANDS_TOKEN_TYPE_PIPELINE_NV

Extends VkIndirectCommandsTokenTypeNV.

Enum values:

• INDIRECT_COMMANDS_TOKEN_TYPE_PIPELINE_NV
• INDIRECT_COMMANDS_TOKEN_TYPE_DISPATCH_NV

See Also:

• Constant Field Values

VK_INDIRECT_COMMANDS_TOKEN_TYPE_DISPATCH_NV

public static final int VK_INDIRECT_COMMANDS_TOKEN_TYPE_DISPATCH_NV

Extends VkIndirectCommandsTokenTypeNV.

Enum values:

• INDIRECT_COMMANDS_TOKEN_TYPE_PIPELINE_NV
• INDIRECT_COMMANDS_TOKEN_TYPE_DISPATCH_NV

See Also:

• Constant Field Values

VK_DESCRIPTOR_SET_LAYOUT_CREATE_INDIRECT_BINDABLE_BIT_NV

public static final int VK_DESCRIPTOR_SET_LAYOUT_CREATE_INDIRECT_BINDABLE_BIT_NV

Extends VkDescriptorSetLayoutCreateFlagBits.

See Also:

• Constant Field Values

Method Details

nvkGetPipelineIndirectMemoryRequirementsNV

public static void nvkGetPipelineIndirectMemoryRequirementsNV(org.lwjgl.vulkan.VkDevice device,
 long pCreateInfo,
 long pMemoryRequirements)

Unsafe version of: GetPipelineIndirectMemoryRequirementsNV

vkGetPipelineIndirectMemoryRequirementsNV

public static void vkGetPipelineIndirectMemoryRequirementsNV(org.lwjgl.vulkan.VkDevice device,
 VkComputePipelineCreateInfo pCreateInfo,
 VkMemoryRequirements2 pMemoryRequirements)

Get the memory requirements for the compute indirect pipeline.

C Specification

To determine the memory requirements for a compute pipeline’s metadata, call:

 void vkGetPipelineIndirectMemoryRequirementsNV(
     VkDevice                                    device,
     const VkComputePipelineCreateInfo*          pCreateInfo,
     VkMemoryRequirements2*                      pMemoryRequirements);

Description

If pCreateInfo→pNext chain includes a pointer to a VkComputePipelineIndirectBufferInfoNV structure, then the contents of that structure are ignored.

Valid Usage

• The VkPhysicalDeviceDeviceGeneratedCommandsComputeFeaturesNV::deviceGeneratedComputePipelines feature must be enabled
• pCreateInfo→flags must include PIPELINE_CREATE_INDIRECT_BINDABLE_BIT_NV

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• pCreateInfo must be a valid pointer to a valid VkComputePipelineCreateInfo structure
• pMemoryRequirements must be a valid pointer to a VkMemoryRequirements2 structure

See Also

VkComputePipelineCreateInfo, VkMemoryRequirements2

Parameters:

device - the logical device that owns the buffer.

pCreateInfo - a VkComputePipelineCreateInfo structure specifying the creation parameters of the compute pipeline whose memory requirements are being queried.

pMemoryRequirements - a pointer to a VkMemoryRequirements2 structure in which the requested pipeline’s memory requirements are returned.

vkCmdUpdatePipelineIndirectBufferNV

public static void vkCmdUpdatePipelineIndirectBufferNV(org.lwjgl.vulkan.VkCommandBuffer commandBuffer,
 int pipelineBindPoint,
 long pipeline)

Update the indirect compute pipeline’s metadata.

C Specification

To save a compute pipeline’s metadata at a device address call:

 void vkCmdUpdatePipelineIndirectBufferNV(
     VkCommandBuffer                             commandBuffer,
     VkPipelineBindPoint                         pipelineBindPoint,
     VkPipeline                                  pipeline);

Description

vkCmdUpdatePipelineIndirectBufferNV is only allowed outside of a render pass. This command is treated as a “transfer” operation for the purposes of synchronization barriers. The writes to the address must be synchronized using stages PIPELINE_STAGE_2_COPY_BIT and PIPELINE_STAGE_COMMAND_PREPROCESS_BIT_NV and with access masks ACCESS_MEMORY_WRITE_BIT and ACCESS_COMMAND_PREPROCESS_READ_BIT_NV respectively before using the results in preprocessing.

Valid Usage

• pipelineBindPoint must be PIPELINE_BIND_POINT_COMPUTE
• pipeline must have been created with PIPELINE_CREATE_INDIRECT_BINDABLE_BIT_NV flag set
• pipeline must have been created with VkComputePipelineIndirectBufferInfoNV structure specifying a valid address where its metadata will be saved
• The VkPhysicalDeviceDeviceGeneratedCommandsComputeFeaturesNV::deviceGeneratedComputePipelines feature must be enabled

Valid Usage (Implicit)

• commandBuffer must be a valid VkCommandBuffer handle
• pipelineBindPoint must be a valid VkPipelineBindPoint value
• pipeline must be a valid VkPipeline handle
• commandBuffer must be in the recording state
• The VkCommandPool that commandBuffer was allocated from must support transfer, graphics, or compute operations
• This command must only be called outside of a render pass instance
• This command must only be called outside of a video coding scope
• Both of commandBuffer, and pipeline must have been created, allocated, or retrieved from the same VkDevice

Host Synchronization

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

Command Properties

Command Buffer Levels	Render Pass Scope	Video Coding Scope	Supported Queue Types	Command Type
Primary Secondary	Outside	Outside	Transfer Graphics Compute	Action

Parameters:

commandBuffer - the command buffer into which the command will be recorded.

pipelineBindPoint - a VkPipelineBindPoint value specifying the type of pipeline whose metadata will be saved.

pipeline - the pipeline whose metadata will be saved.

nvkGetPipelineIndirectDeviceAddressNV

public static long nvkGetPipelineIndirectDeviceAddressNV(org.lwjgl.vulkan.VkDevice device,
 long pInfo)

Unsafe version of: GetPipelineIndirectDeviceAddressNV

vkGetPipelineIndirectDeviceAddressNV

public static long vkGetPipelineIndirectDeviceAddressNV(org.lwjgl.vulkan.VkDevice device,
 VkPipelineIndirectDeviceAddressInfoNV pInfo)

Get pipeline’s 64-bit device address.

C Specification

To query a compute pipeline’s 64-bit device address, call:

 VkDeviceAddress vkGetPipelineIndirectDeviceAddressNV(
     VkDevice                                    device,
     const VkPipelineIndirectDeviceAddressInfoNV* pInfo);

Valid Usage

• The VkPhysicalDeviceDeviceGeneratedCommandsComputeFeaturesNV::deviceGeneratedComputePipelines feature must be enabled

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• pInfo must be a valid pointer to a valid VkPipelineIndirectDeviceAddressInfoNV structure

See Also

VkPipelineIndirectDeviceAddressInfoNV

Parameters:

device - the logical device on which the pipeline was created.

pInfo - a pointer to a VkPipelineIndirectDeviceAddressInfoNV structure specifying the pipeline to retrieve the address for.