Vulkan.Extensions.VK_NVX_binary_import

Name

VK_NVX_binary_import - device extension

VK_NVX_binary_import

Name String

VK_NVX_binary_import

Extension Type

Device extension

Registered Extension Number

30

Revision

2

Ratification Status

Not ratified

Extension and Version Dependencies

None

API Interactions

• Interacts with VK_EXT_debug_report

Contact

• Eric Werness @ewerness-nv%0A*Here describe the issue or question you have about the VK_NVX_binary_import extension*

• Liam Middlebrook @liam-middlebrook%0A*Here describe the issue or question you have about the VK_NVX_binary_import extension*

Other Extension Metadata

Last Modified Date

2024-11-04

Contributors

• Eric Werness, NVIDIA

• Liam Middlebrook, NVIDIA

Description

This extension allows applications to import CuBIN binaries and execute them.

There is currently no specification language written for this extension. The links to APIs defined by the extension are to stubs that only include generated content such as API declarations and implicit valid usage statements.

New Object Types

• CuFunctionNVX

• CuModuleNVX

New Commands

• cmdCuLaunchKernelNVX

• createCuFunctionNVX

• createCuModuleNVX

• destroyCuFunctionNVX

• destroyCuModuleNVX

New Structures

• CuFunctionCreateInfoNVX

• CuLaunchInfoNVX

• CuModuleCreateInfoNVX

• Extending CuModuleCreateInfoNVX:

  • CuModuleTexturingModeCreateInfoNVX

New Enum Constants

• NVX_BINARY_IMPORT_EXTENSION_NAME

• NVX_BINARY_IMPORT_SPEC_VERSION

• Extending ObjectType:

  • OBJECT_TYPE_CU_FUNCTION_NVX

  • OBJECT_TYPE_CU_MODULE_NVX

• Extending StructureType:

  • STRUCTURE_TYPE_CU_FUNCTION_CREATE_INFO_NVX

  • STRUCTURE_TYPE_CU_LAUNCH_INFO_NVX

  • STRUCTURE_TYPE_CU_MODULE_CREATE_INFO_NVX

  • STRUCTURE_TYPE_CU_MODULE_TEXTURING_MODE_CREATE_INFO_NVX

If VK_EXT_debug_report is supported:

• Extending DebugReportObjectTypeEXT:

  • DEBUG_REPORT_OBJECT_TYPE_CU_FUNCTION_NVX_EXT

  • DEBUG_REPORT_OBJECT_TYPE_CU_MODULE_NVX_EXT

Stub API References

There is currently no specification language written for this type. This section acts only as placeholder and to avoid dead links in the specification and reference pages.

// Provided by VK_NVX_binary_import
VK_DEFINE_NON_DISPATCHABLE_HANDLE(VkCuFunctionNVX)

There is currently no specification language written for this type. This section acts only as placeholder and to avoid dead links in the specification and reference pages.

// Provided by VK_NVX_binary_import
VK_DEFINE_NON_DISPATCHABLE_HANDLE(VkCuModuleNVX)

There is currently no specification language written for this command. This section acts only as placeholder and to avoid dead links in the specification and reference pages.

// Provided by VK_NVX_binary_import
VkResult vkCreateCuFunctionNVX(
    VkDevice                                    device,
    const VkCuFunctionCreateInfoNVX*            pCreateInfo,
    const VkAllocationCallbacks*                pAllocator,
    VkCuFunctionNVX*                            pFunction);

Valid Usage (Implicit)

• device must be a valid Device handle

• pCreateInfo must be a valid pointer to a valid CuFunctionCreateInfoNVX structure

• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure

• pFunction must be a valid pointer to a CuFunctionNVX handle

• The device must have been created with at least 1 queue

Return Codes

Success

• SUCCESS

Failure

• ERROR_INITIALIZATION_FAILED

• ERROR_OUT_OF_HOST_MEMORY

• ERROR_UNKNOWN

• ERROR_VALIDATION_FAILED

There is currently no specification language written for this type. This section acts only as placeholder and to avoid dead links in the specification and reference pages.

// Provided by VK_NVX_binary_import
typedef struct VkCuFunctionCreateInfoNVX {
    VkStructureType    sType;
    const void*        pNext;
    VkCuModuleNVX      module;
    const char*        pName;
} VkCuFunctionCreateInfoNVX;

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_CU_FUNCTION_CREATE_INFO_NVX

• pNext must be NULL

• module must be a valid CuModuleNVX handle

• pName must be a null-terminated UTF-8 string

There is currently no specification language written for this command. This section acts only as placeholder and to avoid dead links in the specification and reference pages.

// Provided by VK_NVX_binary_import
void vkDestroyCuFunctionNVX(
    VkDevice                                    device,
    VkCuFunctionNVX                             function,
    const VkAllocationCallbacks*                pAllocator);

Valid Usage (Implicit)

• device must be a valid Device handle

• function must be a valid CuFunctionNVX handle

• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure

• function must have been created, allocated, or retrieved from device

There is currently no specification language written for this command. This section acts only as placeholder and to avoid dead links in the specification and reference pages.

// Provided by VK_NVX_binary_import
VkResult vkCreateCuModuleNVX(
    VkDevice                                    device,
    const VkCuModuleCreateInfoNVX*              pCreateInfo,
    const VkAllocationCallbacks*                pAllocator,
    VkCuModuleNVX*                              pModule);

Valid Usage (Implicit)

• device must be a valid Device handle

• pCreateInfo must be a valid pointer to a valid CuModuleCreateInfoNVX structure

• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure

• pModule must be a valid pointer to a CuModuleNVX handle

• The device must have been created with at least 1 queue

Return Codes

Success

• SUCCESS

Failure

• ERROR_INITIALIZATION_FAILED

• ERROR_OUT_OF_HOST_MEMORY

• ERROR_UNKNOWN

• ERROR_VALIDATION_FAILED

There is currently no specification language written for this type. This section acts only as placeholder and to avoid dead links in the specification and reference pages.

// Provided by VK_NVX_binary_import
typedef struct VkCuModuleCreateInfoNVX {
    VkStructureType    sType;
    const void*        pNext;
    size_t             dataSize;
    const void*        pData;
} VkCuModuleCreateInfoNVX;

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_CU_MODULE_CREATE_INFO_NVX

• pNext must be NULL or a pointer to a valid instance of CuModuleTexturingModeCreateInfoNVX

• The sType value of each structure in the pNext chain must be unique

• If dataSize is not 0, pData must be a valid pointer to an array of dataSize bytes

There is currently no specification language written for this type. This section acts only as placeholder and to avoid dead links in the specification and reference pages.

// Provided by VK_NVX_binary_import
typedef struct VkCuModuleTexturingModeCreateInfoNVX {
    VkStructureType    sType;
    const void*        pNext;
    VkBool32           use64bitTexturing;
} VkCuModuleTexturingModeCreateInfoNVX;

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_CU_MODULE_TEXTURING_MODE_CREATE_INFO_NVX

Structure Chaining

Extends the structure

• CuModuleCreateInfoNVX

There is currently no specification language written for this command. This section acts only as placeholder and to avoid dead links in the specification and reference pages.

// Provided by VK_NVX_binary_import
void vkDestroyCuModuleNVX(
    VkDevice                                    device,
    VkCuModuleNVX                               module,
    const VkAllocationCallbacks*                pAllocator);

Valid Usage (Implicit)

• device must be a valid Device handle

• module must be a valid CuModuleNVX handle

• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure

• module must have been created, allocated, or retrieved from device

There is currently no specification language written for this command. This section acts only as placeholder and to avoid dead links in the specification and reference pages.

// Provided by VK_NVX_binary_import
void vkCmdCuLaunchKernelNVX(
    VkCommandBuffer                             commandBuffer,
    const VkCuLaunchInfoNVX*                    pLaunchInfo);

Valid Usage (Implicit)

• commandBuffer must be a valid CommandBuffer handle

• pLaunchInfo must be a valid pointer to a valid CuLaunchInfoNVX structure

• commandBuffer must be in the recording state

• The CommandPool that commandBuffer was allocated from must support QUEUE_COMPUTE_BIT, or QUEUE_GRAPHICS_BIT operations

• This command must not be called between suspended render pass instances

• This command must only be called outside of a video coding scope

Host Synchronization

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

Command Properties

'

Conditional Rendering

vkCmdCuLaunchKernelNVX is not affected by conditional rendering

There is currently no specification language written for this type. This section acts only as placeholder and to avoid dead links in the specification and reference pages.

// Provided by VK_NVX_binary_import
typedef struct VkCuLaunchInfoNVX {
    VkStructureType        sType;
    const void*            pNext;
    VkCuFunctionNVX        function;
    uint32_t               gridDimX;
    uint32_t               gridDimY;
    uint32_t               gridDimZ;
    uint32_t               blockDimX;
    uint32_t               blockDimY;
    uint32_t               blockDimZ;
    uint32_t               sharedMemBytes;
    size_t                 paramCount;
    const void* const *    pParams;
    size_t                 extraCount;
    const void* const *    pExtras;
} VkCuLaunchInfoNVX;

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_CU_LAUNCH_INFO_NVX

• pNext must be NULL

• function must be a valid CuFunctionNVX handle

• If paramCount is not 0, pParams must be a valid pointer to an array of paramCount bytes

• If extraCount is not 0, pExtras must be a valid pointer to an array of extraCount bytes

Version History

• Revision 2, 2024-11-04 (Liam Middlebrook)

  • Add CuModuleTexturingModeCreateInfoNVX

• Revision 1, 2021-04-09 (Eric Werness)

  • Internal revisions

See Also

No cross-references are available

Document Notes

For more information, see the Vulkan Specification.

This page is a generated document. Fixes and changes should be made to the generator scripts, not directly.