Safe Haskell	None
Language	Haskell2010

Vulkan.Extensions.VK_NV_external_compute_queue

Description

Name

VK_NV_external_compute_queue - device extension

VK_NV_external_compute_queue

Name String: VK_NV_external_compute_queue

Extension Type

Device extension

Registered Extension Number

557

Revision

1

Ratification Status

Not ratified

Extension and Version Dependencies

None

Contact

Chris Lentini @clentini%0A*Here describe the issue or question you have about the VK_NV_external_compute_queue extension*

Extension Proposal

VK_NV_external_compute_queue

Other Extension Metadata

Last Modified Date: 2025-03-24

Contributors

Chris Lentini, NVIDIA
Eric Werness, NVIDIA
James Jones, NVIDIA
Jeff Juliano, NVIDIA
Liam Middlebrook, NVIDIA
Lionel Duc, NVIDIA

Description

This extension gives applications the ability to join compatible external compute APIs to a Device. In this way, the extension allows an application to achieve simultaneous execution between work submitted from these compatible external APIs and work that has been submitted through the Vulkan API.

At device creation time, an application must supply a ExternalComputeQueueDeviceCreateInfoNV. This communicates to the implementation the maximum number of external queues that the application can create at once. This information may be used by the implementation to aid in decisions made during device creation.

After device creation, the function createExternalComputeQueueNV is used by an application to create a new ExternalComputeQueueNV object. The ExternalComputeQueueNV object holds information and reserves resources necessary for a compatible external API to be able to join a Device. This information can be queried through the getExternalComputeQueueDataNV function, returning an opaque blob of data which can be passed to compatible external APIs. The application must finally call destroyExternalComputeQueueNV when it is done in order to release the reserved resources.

This extension introduces a new properties structure, PhysicalDeviceExternalComputeQueuePropertiesNV, which can be queried through getPhysicalDeviceProperties2. The structure provides information on functional limits to the extension as well as a way of querying the size of the application allocated memory which must be passed to the getExternalComputeQueueDataNV function.

When creating a ExternalComputeQueueNV through createExternalComputeQueueNV, the ExternalComputeQueueCreateInfoNV structure requires an application to supply a Queue to aid in external compute queue creation. The supplied Queue is a strong scheduling hint about which queue it expects to submit graphics workloads to and with which it expects simultaneous execution of compute workloads submitted through the external API.

New Object Types

ExternalComputeQueueNV

New Commands

createExternalComputeQueueNV

New Structures

ExternalComputeQueueCreateInfoNV

ExternalComputeQueueDataParamsNV
Extending DeviceCreateInfo:
- ExternalComputeQueueDeviceCreateInfoNV
Extending PhysicalDeviceProperties2:
- PhysicalDeviceExternalComputeQueuePropertiesNV

New Enum Constants

NV_EXTERNAL_COMPUTE_QUEUE_EXTENSION_NAME

While the external queue is now a part of a Device, idling the device through deviceWaitIdle does not wait for the external queue. Draining the work on an external queue must be done through its own external API. External queues must be idled before destroying the associated Device.

In general, synchronization and resource sharing between the external API and Vulkan must still be accomplished via existing cross-API interop mechanisms.

Version History

Revision 1, 2024-05-20 (Chris Lentini)
- Internal revisions

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.

Synopsis

createExternalComputeQueueNV :: MonadIO io => Device -> ExternalComputeQueueCreateInfoNV -> ("allocator" ::: Maybe AllocationCallbacks) -> io ("externalQueue" ::: ExternalComputeQueueNV)
withExternalComputeQueueNV :: MonadIO io => Device -> ExternalComputeQueueCreateInfoNV -> Maybe AllocationCallbacks -> (io ExternalComputeQueueNV -> (ExternalComputeQueueNV -> io ()) -> r) -> r
destroyExternalComputeQueueNV :: MonadIO io => Device -> ("externalQueue" ::: ExternalComputeQueueNV) -> ("allocator" ::: Maybe AllocationCallbacks) -> io ()
getExternalComputeQueueDataNV :: MonadIO io => ("externalQueue" ::: ExternalComputeQueueNV) -> ("data" ::: Ptr ()) -> io ExternalComputeQueueDataParamsNV
data ExternalComputeQueueDeviceCreateInfoNV = ExternalComputeQueueDeviceCreateInfoNV {
- reservedExternalQueues :: Word32
}
data ExternalComputeQueueCreateInfoNV = ExternalComputeQueueCreateInfoNV {
- preferredQueue :: Ptr Queue_T
}
data ExternalComputeQueueDataParamsNV = ExternalComputeQueueDataParamsNV {
- deviceIndex :: Word32
}
data PhysicalDeviceExternalComputeQueuePropertiesNV = PhysicalDeviceExternalComputeQueuePropertiesNV {
- externalDataSize :: Word32
- maxExternalQueues :: Word32
}
type NV_EXTERNAL_COMPUTE_QUEUE_SPEC_VERSION = 1
pattern NV_EXTERNAL_COMPUTE_QUEUE_SPEC_VERSION :: Integral a => a
type NV_EXTERNAL_COMPUTE_QUEUE_EXTENSION_NAME = "VK_NV_external_compute_queue"
pattern NV_EXTERNAL_COMPUTE_QUEUE_EXTENSION_NAME :: (Eq a, IsString a) => a
data ExternalComputeQueueNV = ExternalComputeQueueNV {
- externalComputeQueueNVHandle :: Ptr ExternalComputeQueueNV_T
- deviceCmds :: DeviceCmds
}

Documentation

createExternalComputeQueueNV Source #

Arguments

:: MonadIO io
=> Device	`device` is the VkDevice that the external queue will be a part of.
-> ExternalComputeQueueCreateInfoNV	`pCreateInfo` is a pointer to a `ExternalComputeQueueCreateInfoNV` structure specifying configuration info for creating the external queue.
-> ("allocator" ::: Maybe AllocationCallbacks)	`pAllocator` controls host memory allocation as described in the Memory Allocation chapter.
-> io ("externalQueue" ::: ExternalComputeQueueNV)

vkCreateExternalComputeQueueNV - Create an external compute queue for use by a compatible external API.

Valid Usage (Implicit)

device must be a valid Device handle

pCreateInfo must be a valid pointer to a valid ExternalComputeQueueCreateInfoNV structure
If pAllocator is not NULL, pAllocator must be a valid pointer to a valid AllocationCallbacks structure
pExternalQueue must be a valid pointer to a ExternalComputeQueueNV handle
The device must have been created with at least 1 queue

Return Codes

Success

SUCCESS

Failure

Description

When creating a ExternalComputeQueueNV, the preferredQueue field is a strong scheduling hint as to which Queue Vulkan graphics workloads will be submitted to with the expectation that execution will overlap with execution of work submitted by the external API.

Eq ExternalComputeQueueDeviceCreateInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_compute_queue Methods (==) :: ExternalComputeQueueDeviceCreateInfoNV -> ExternalComputeQueueDeviceCreateInfoNV -> Bool # (/=) :: ExternalComputeQueueDeviceCreateInfoNV -> ExternalComputeQueueDeviceCreateInfoNV -> Bool #
Storable ExternalComputeQueueDeviceCreateInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_compute_queue Methods sizeOf :: ExternalComputeQueueDeviceCreateInfoNV -> Int # alignment :: ExternalComputeQueueDeviceCreateInfoNV -> Int # peekElemOff :: Ptr ExternalComputeQueueDeviceCreateInfoNV -> Int -> IO ExternalComputeQueueDeviceCreateInfoNV # pokeElemOff :: Ptr ExternalComputeQueueDeviceCreateInfoNV -> Int -> ExternalComputeQueueDeviceCreateInfoNV -> IO () # peekByteOff :: Ptr b -> Int -> IO ExternalComputeQueueDeviceCreateInfoNV # pokeByteOff :: Ptr b -> Int -> ExternalComputeQueueDeviceCreateInfoNV -> IO () # peek :: Ptr ExternalComputeQueueDeviceCreateInfoNV -> IO ExternalComputeQueueDeviceCreateInfoNV # poke :: Ptr ExternalComputeQueueDeviceCreateInfoNV -> ExternalComputeQueueDeviceCreateInfoNV -> IO () #
Show ExternalComputeQueueDeviceCreateInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_compute_queue Methods showsPrec :: Int -> ExternalComputeQueueDeviceCreateInfoNV -> ShowS # show :: ExternalComputeQueueDeviceCreateInfoNV -> String # showList :: [ExternalComputeQueueDeviceCreateInfoNV] -> ShowS #
FromCStruct ExternalComputeQueueDeviceCreateInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_compute_queue Methods peekCStruct :: Ptr ExternalComputeQueueDeviceCreateInfoNV -> IO ExternalComputeQueueDeviceCreateInfoNV Source #
ToCStruct ExternalComputeQueueDeviceCreateInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_compute_queue Methods withCStruct :: ExternalComputeQueueDeviceCreateInfoNV -> (Ptr ExternalComputeQueueDeviceCreateInfoNV -> IO b) -> IO b Source # pokeCStruct :: Ptr ExternalComputeQueueDeviceCreateInfoNV -> ExternalComputeQueueDeviceCreateInfoNV -> IO b -> IO b Source # withZeroCStruct :: (Ptr ExternalComputeQueueDeviceCreateInfoNV -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr ExternalComputeQueueDeviceCreateInfoNV -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero ExternalComputeQueueDeviceCreateInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_compute_queue Methods zero :: ExternalComputeQueueDeviceCreateInfoNV Source #

Eq ExternalComputeQueueCreateInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_compute_queue Methods (==) :: ExternalComputeQueueCreateInfoNV -> ExternalComputeQueueCreateInfoNV -> Bool # (/=) :: ExternalComputeQueueCreateInfoNV -> ExternalComputeQueueCreateInfoNV -> Bool #
Storable ExternalComputeQueueCreateInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_compute_queue Methods sizeOf :: ExternalComputeQueueCreateInfoNV -> Int # alignment :: ExternalComputeQueueCreateInfoNV -> Int # peekElemOff :: Ptr ExternalComputeQueueCreateInfoNV -> Int -> IO ExternalComputeQueueCreateInfoNV # pokeElemOff :: Ptr ExternalComputeQueueCreateInfoNV -> Int -> ExternalComputeQueueCreateInfoNV -> IO () # peekByteOff :: Ptr b -> Int -> IO ExternalComputeQueueCreateInfoNV # pokeByteOff :: Ptr b -> Int -> ExternalComputeQueueCreateInfoNV -> IO () # peek :: Ptr ExternalComputeQueueCreateInfoNV -> IO ExternalComputeQueueCreateInfoNV # poke :: Ptr ExternalComputeQueueCreateInfoNV -> ExternalComputeQueueCreateInfoNV -> IO () #
Show ExternalComputeQueueCreateInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_compute_queue Methods showsPrec :: Int -> ExternalComputeQueueCreateInfoNV -> ShowS # show :: ExternalComputeQueueCreateInfoNV -> String # showList :: [ExternalComputeQueueCreateInfoNV] -> ShowS #
FromCStruct ExternalComputeQueueCreateInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_compute_queue Methods peekCStruct :: Ptr ExternalComputeQueueCreateInfoNV -> IO ExternalComputeQueueCreateInfoNV Source #
ToCStruct ExternalComputeQueueCreateInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_compute_queue Methods withCStruct :: ExternalComputeQueueCreateInfoNV -> (Ptr ExternalComputeQueueCreateInfoNV -> IO b) -> IO b Source # pokeCStruct :: Ptr ExternalComputeQueueCreateInfoNV -> ExternalComputeQueueCreateInfoNV -> IO b -> IO b Source # withZeroCStruct :: (Ptr ExternalComputeQueueCreateInfoNV -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr ExternalComputeQueueCreateInfoNV -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero ExternalComputeQueueCreateInfoNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_compute_queue Methods zero :: ExternalComputeQueueCreateInfoNV Source #

Eq ExternalComputeQueueDataParamsNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_compute_queue Methods (==) :: ExternalComputeQueueDataParamsNV -> ExternalComputeQueueDataParamsNV -> Bool # (/=) :: ExternalComputeQueueDataParamsNV -> ExternalComputeQueueDataParamsNV -> Bool #
Storable ExternalComputeQueueDataParamsNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_compute_queue Methods sizeOf :: ExternalComputeQueueDataParamsNV -> Int # alignment :: ExternalComputeQueueDataParamsNV -> Int # peekElemOff :: Ptr ExternalComputeQueueDataParamsNV -> Int -> IO ExternalComputeQueueDataParamsNV # pokeElemOff :: Ptr ExternalComputeQueueDataParamsNV -> Int -> ExternalComputeQueueDataParamsNV -> IO () # peekByteOff :: Ptr b -> Int -> IO ExternalComputeQueueDataParamsNV # pokeByteOff :: Ptr b -> Int -> ExternalComputeQueueDataParamsNV -> IO () # peek :: Ptr ExternalComputeQueueDataParamsNV -> IO ExternalComputeQueueDataParamsNV # poke :: Ptr ExternalComputeQueueDataParamsNV -> ExternalComputeQueueDataParamsNV -> IO () #
Show ExternalComputeQueueDataParamsNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_compute_queue Methods showsPrec :: Int -> ExternalComputeQueueDataParamsNV -> ShowS # show :: ExternalComputeQueueDataParamsNV -> String # showList :: [ExternalComputeQueueDataParamsNV] -> ShowS #
FromCStruct ExternalComputeQueueDataParamsNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_compute_queue Methods peekCStruct :: Ptr ExternalComputeQueueDataParamsNV -> IO ExternalComputeQueueDataParamsNV Source #
ToCStruct ExternalComputeQueueDataParamsNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_compute_queue Methods withCStruct :: ExternalComputeQueueDataParamsNV -> (Ptr ExternalComputeQueueDataParamsNV -> IO b) -> IO b Source # pokeCStruct :: Ptr ExternalComputeQueueDataParamsNV -> ExternalComputeQueueDataParamsNV -> IO b -> IO b Source # withZeroCStruct :: (Ptr ExternalComputeQueueDataParamsNV -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr ExternalComputeQueueDataParamsNV -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero ExternalComputeQueueDataParamsNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_compute_queue Methods zero :: ExternalComputeQueueDataParamsNV Source #

Eq PhysicalDeviceExternalComputeQueuePropertiesNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_compute_queue Methods (==) :: PhysicalDeviceExternalComputeQueuePropertiesNV -> PhysicalDeviceExternalComputeQueuePropertiesNV -> Bool # (/=) :: PhysicalDeviceExternalComputeQueuePropertiesNV -> PhysicalDeviceExternalComputeQueuePropertiesNV -> Bool #
Storable PhysicalDeviceExternalComputeQueuePropertiesNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_compute_queue Methods sizeOf :: PhysicalDeviceExternalComputeQueuePropertiesNV -> Int # alignment :: PhysicalDeviceExternalComputeQueuePropertiesNV -> Int # peekElemOff :: Ptr PhysicalDeviceExternalComputeQueuePropertiesNV -> Int -> IO PhysicalDeviceExternalComputeQueuePropertiesNV # pokeElemOff :: Ptr PhysicalDeviceExternalComputeQueuePropertiesNV -> Int -> PhysicalDeviceExternalComputeQueuePropertiesNV -> IO () # peekByteOff :: Ptr b -> Int -> IO PhysicalDeviceExternalComputeQueuePropertiesNV # pokeByteOff :: Ptr b -> Int -> PhysicalDeviceExternalComputeQueuePropertiesNV -> IO () # peek :: Ptr PhysicalDeviceExternalComputeQueuePropertiesNV -> IO PhysicalDeviceExternalComputeQueuePropertiesNV # poke :: Ptr PhysicalDeviceExternalComputeQueuePropertiesNV -> PhysicalDeviceExternalComputeQueuePropertiesNV -> IO () #
Show PhysicalDeviceExternalComputeQueuePropertiesNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_compute_queue Methods showsPrec :: Int -> PhysicalDeviceExternalComputeQueuePropertiesNV -> ShowS # show :: PhysicalDeviceExternalComputeQueuePropertiesNV -> String # showList :: [PhysicalDeviceExternalComputeQueuePropertiesNV] -> ShowS #
FromCStruct PhysicalDeviceExternalComputeQueuePropertiesNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_compute_queue Methods peekCStruct :: Ptr PhysicalDeviceExternalComputeQueuePropertiesNV -> IO PhysicalDeviceExternalComputeQueuePropertiesNV Source #
ToCStruct PhysicalDeviceExternalComputeQueuePropertiesNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_compute_queue Methods withCStruct :: PhysicalDeviceExternalComputeQueuePropertiesNV -> (Ptr PhysicalDeviceExternalComputeQueuePropertiesNV -> IO b) -> IO b Source # pokeCStruct :: Ptr PhysicalDeviceExternalComputeQueuePropertiesNV -> PhysicalDeviceExternalComputeQueuePropertiesNV -> IO b -> IO b Source # withZeroCStruct :: (Ptr PhysicalDeviceExternalComputeQueuePropertiesNV -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr PhysicalDeviceExternalComputeQueuePropertiesNV -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero PhysicalDeviceExternalComputeQueuePropertiesNV Source #
Instance details Defined in Vulkan.Extensions.VK_NV_external_compute_queue Methods zero :: PhysicalDeviceExternalComputeQueuePropertiesNV Source #

Eq ExternalComputeQueueNV Source #
Instance details Defined in Vulkan.Extensions.Handles Methods (==) :: ExternalComputeQueueNV -> ExternalComputeQueueNV -> Bool # (/=) :: ExternalComputeQueueNV -> ExternalComputeQueueNV -> Bool #
Show ExternalComputeQueueNV Source #
Instance details Defined in Vulkan.Extensions.Handles Methods showsPrec :: Int -> ExternalComputeQueueNV -> ShowS # show :: ExternalComputeQueueNV -> String # showList :: [ExternalComputeQueueNV] -> ShowS #
HasObjectType ExternalComputeQueueNV Source #
Instance details Defined in Vulkan.Extensions.Handles Methods objectTypeAndHandle :: ExternalComputeQueueNV -> (ObjectType, Word64) Source #
IsHandle ExternalComputeQueueNV Source #
Instance details Defined in Vulkan.Extensions.Handles
Zero ExternalComputeQueueNV Source #
Instance details Defined in Vulkan.Extensions.Handles Methods zero :: ExternalComputeQueueNV Source #

Name

VK_NV_external_compute_queue

Other Extension Metadata

Description

New Object Types

New Commands

New Structures

New Enum Constants

Version History

See Also

Document Notes

Documentation

Valid Usage (Implicit)

Return Codes

See Also

Valid Usage (Implicit)

See Also

Valid Usage (Implicit)

See Also

Valid Usage (Implicit)

See Also

Instances

Description

Valid Usage (Implicit)

See Also

Instances

Valid Usage (Implicit)

See Also

Instances

Valid Usage (Implicit)

See Also

Instances

See Also

Instances

:: MonadIO io
=> Device	`device` is the logical device that destroys the external queue.
-> ("externalQueue" ::: ExternalComputeQueueNV)	`externalQueue` is the `ExternalComputeQueueNV` to destroy.
-> ("allocator" ::: Maybe AllocationCallbacks)	`pAllocator` controls host memory allocation as described in the Memory Allocation chapter.
-> io ()

:: MonadIO io
=> ("externalQueue" ::: ExternalComputeQueueNV)	`externalQueue` is the `ExternalComputeQueueNV` to query the data for. `externalQueue` must be a valid `ExternalComputeQueueNV` handle
-> ("data" ::: Ptr ())	`pData` is a pointer to application-allocated memory in which the requested data will be returned. `pData` must be at least the size specified by the externalDataSize field in the `PhysicalDeviceExternalComputeQueuePropertiesNV` structure `pData` must be a pointer value
-> io ExternalComputeQueueDataParamsNV

ExternalComputeQueueDeviceCreateInfoNV
Fields reservedExternalQueues :: Word32 `reservedExternalQueues` is the maximum number of external queues an application can create at once. This must be less than or equal to the `maxExternalQueues` value reported by `PhysicalDeviceExternalComputeQueuePropertiesNV`

ExternalComputeQueueCreateInfoNV
Fields preferredQueue :: Ptr Queue_T `preferredQueue` is a `Queue` supporting graphics commands. `preferredQueue` must be a valid `Queue` handle

ExternalComputeQueueDataParamsNV
Fields deviceIndex :: Word32 `deviceIndex` is the index of the device within a device group that the data is being queried for. This is ignored if device groups are not utilized.

PhysicalDeviceExternalComputeQueuePropertiesNV
Fields externalDataSize :: Word32 `externalDataSize` is the minimum size of the memory allocation that applications can pass to `getExternalComputeQueueDataNV`. maxExternalQueues :: Word32 `maxExternalQueues` is the maximum number of external queues that an application can create.

ExternalComputeQueueNV
Fields externalComputeQueueNVHandle :: Ptr ExternalComputeQueueNV_T deviceCmds :: DeviceCmds