VkWin32KeyedMutexAcquireReleaseInfoNV
When submitting work that operates on memory imported from a Direct3D 11
resource to a queue, the keyed mutex mechanism may be used in addition to
Vulkan semaphores to synchronize the work.
Keyed mutexes are a property of a properly created shareable Direct3D 11
resource.
They can only be used if the imported resource was created with the
D3D11_RESOURCE_MISC_SHARED_KEYEDMUTEX
flag.
To acquire keyed mutexes before submitted work and/or release them after,
add a VkWin32KeyedMutexAcquireReleaseInfoNV structure to the
pNext
chain of the VkSubmitInfo structure.
The VkWin32KeyedMutexAcquireReleaseInfoNV
structure is defined as:
typedef struct VkWin32KeyedMutexAcquireReleaseInfoNV {
VkStructureType sType;
const void* pNext;
uint32_t acquireCount;
const VkDeviceMemory* pAcquireSyncs;
const uint64_t* pAcquireKeys;
const uint32_t* pAcquireTimeoutMilliseconds;
uint32_t releaseCount;
const VkDeviceMemory* pReleaseSyncs;
const uint64_t* pReleaseKeys;
} VkWin32KeyedMutexAcquireReleaseInfoNV;
acquireCount
is the number of entries in thepAcquireSyncs
,pAcquireKeys
, andpAcquireTimeoutMilliseconds
arrays.pAcquireSyncs
is a pointer to an array of VkDeviceMemory objects which were imported from Direct3D 11 resources.pAcquireKeys
is a pointer to an array of mutex key values to wait for prior to beginning the submitted work. Entries refer to the keyed mutex associated with the corresponding entries inpAcquireSyncs
.pAcquireTimeoutMilliseconds
is a pointer to an array of timeout values, in millisecond units, for each acquire specified inpAcquireKeys
.releaseCount
is the number of entries in thepReleaseSyncs
andpReleaseKeys
arrays.pReleaseSyncs
is a pointer to an array of VkDeviceMemory objects which were imported from Direct3D 11 resources.pReleaseKeys
is a pointer to an array of mutex key values to set when the submitted work has completed. Entries refer to the keyed mutex associated with the corresponding entries inpReleaseSyncs
.
Valid Usage (Implicit)
VUID-VkWin32KeyedMutexAcquireReleaseInfoNV-sType-sType
sType
must be VK_STRUCTURE_TYPE_WIN32_KEYED_MUTEX_ACQUIRE_RELEASE_INFO_NV
VUID-VkWin32KeyedMutexAcquireReleaseInfoNV-pAcquireSyncs-parameter
If acquireCount
is not 0
, pAcquireSyncs
must be a valid pointer to an array of acquireCount
valid VkDeviceMemory handles
VUID-VkWin32KeyedMutexAcquireReleaseInfoNV-pAcquireKeys-parameter
If acquireCount
is not 0
, pAcquireKeys
must be a valid pointer to an array of acquireCount
uint64_t
values
VUID-VkWin32KeyedMutexAcquireReleaseInfoNV-pAcquireTimeoutMilliseconds-parameter
If acquireCount
is not 0
, pAcquireTimeoutMilliseconds
must be a valid pointer to an array of acquireCount
uint32_t
values
VUID-VkWin32KeyedMutexAcquireReleaseInfoNV-pReleaseSyncs-parameter
If releaseCount
is not 0
, pReleaseSyncs
must be a valid pointer to an array of releaseCount
valid VkDeviceMemory handles
VUID-VkWin32KeyedMutexAcquireReleaseInfoNV-pReleaseKeys-parameter
If releaseCount
is not 0
, pReleaseKeys
must be a valid pointer to an array of releaseCount
uint64_t
values
VUID-VkWin32KeyedMutexAcquireReleaseInfoNV-commonparent
Both of the elements of pAcquireSyncs
, and the elements of pReleaseSyncs
that are valid handles of non-ignored parameters must have been created, allocated, or retrieved from the same VkDevice