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

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.

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.

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.

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

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• pCreateInfo must be a valid pointer to a valid VkCuFunctionCreateInfoNVX structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks structure
• pFunction must be a valid pointer to a VkCuFunctionNVX handle

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

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

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

void vkDestroyCuFunctionNVX(
    VkDevice                                    device,
    VkCuFunctionNVX                             function,
    const VkAllocationCallbacks*                pAllocator);

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• function must be a valid VkCuFunctionNVX handle
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks 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.

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

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• pCreateInfo must be a valid pointer to a valid VkCuModuleCreateInfoNVX structure
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks structure
• pModule must be a valid pointer to a VkCuModuleNVX handle

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

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

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
• pData must be a valid pointer to an array of dataSize bytes
• dataSize must be greater than 0

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.

void vkDestroyCuModuleNVX(
    VkDevice                                    device,
    VkCuModuleNVX                               module,
    const VkAllocationCallbacks*                pAllocator);

Valid Usage (Implicit)

• device must be a valid VkDevice handle
• module must be a valid VkCuModuleNVX handle
• If pAllocator is not NULL, pAllocator must be a valid pointer to a valid VkAllocationCallbacks 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.

void vkCmdCuLaunchKernelNVX(
    VkCommandBuffer                             commandBuffer,
    const VkCuLaunchInfoNVX*                    pLaunchInfo);

Valid Usage (Implicit)

• commandBuffer must be a valid VkCommandBuffer handle
• pLaunchInfo must be a valid pointer to a valid VkCuLaunchInfoNVX structure
• commandBuffer must be in the recording state
• The VkCommandPool that commandBuffer was allocated from must support graphics, or compute operations
• This command must only be called outside of a video coding scope

Host Synchronization

• 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	Both	Outside	Graphics Compute	Action

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.

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 VkCuFunctionNVX 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

VK_NVX_binary_import

Name String

VK_NVX_binary_import

Extension Type

Device extension

Registered Extension Number

30

Revision

1

Contact

• Eric Werness ewerness-nv
• Liam Middlebrook liam-middlebrook

Other Extension Metadata

Last Modified Date

2021-04-09

Contributors

• Eric Werness, NVIDIA
• Liam Middlebrook, NVIDIA

void vkCmdCuLaunchKernelNVX(
    VkCommandBuffer                             commandBuffer,
    const VkCuLaunchInfoNVX*                    pLaunchInfo);

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

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

void vkDestroyCuFunctionNVX(
    VkDevice                                    device,
    VkCuFunctionNVX                             function,
    const VkAllocationCallbacks*                pAllocator);

void vkDestroyCuModuleNVX(
    VkDevice                                    device,
    VkCuModuleNVX                               module,
    const VkAllocationCallbacks*                pAllocator);