vulkan-3.26.1: Bindings to the Vulkan graphics API.
Safe HaskellSafe-Inferred
LanguageHaskell2010

Vulkan.Extensions.VK_KHR_win32_keyed_mutex

Description

Name

VK_KHR_win32_keyed_mutex - device extension

VK_KHR_win32_keyed_mutex

Name String
VK_KHR_win32_keyed_mutex
Extension Type
Device extension
Registered Extension Number
76
Revision
1
Ratification Status
Ratified
Extension and Version Dependencies
VK_KHR_external_memory_win32
Contact

Other Extension Metadata

Last Modified Date
2016-10-21
IP Status
No known IP claims.
Contributors
  • James Jones, NVIDIA
  • Jeff Juliano, NVIDIA
  • Carsten Rohde, NVIDIA

Description

Applications that wish to import Direct3D 11 memory objects into the Vulkan API may wish to use the native keyed mutex mechanism to synchronize access to the memory between Vulkan and Direct3D. This extension provides a way for an application to access the keyed mutex associated with an imported Vulkan memory object when submitting command buffers to a queue.

New Structures

New Enum Constants

Version History

  • Revision 1, 2016-10-21 (James Jones)

    • Initial revision

See Also

Win32KeyedMutexAcquireReleaseInfoKHR

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

Documentation

data Win32KeyedMutexAcquireReleaseInfoKHR Source #

VkWin32KeyedMutexAcquireReleaseInfoKHR - Use the Windows keyed mutex mechanism to synchronize work

Valid Usage

Valid Usage (Implicit)

  • If acquireCount is not 0, pAcquireSyncs must be a valid pointer to an array of acquireCount valid DeviceMemory handles
  • If acquireCount is not 0, pAcquireKeys must be a valid pointer to an array of acquireCount uint64_t values
  • If acquireCount is not 0, pAcquireTimeouts must be a valid pointer to an array of acquireCount uint32_t values
  • If releaseCount is not 0, pReleaseSyncs must be a valid pointer to an array of releaseCount valid DeviceMemory handles
  • If releaseCount is not 0, pReleaseKeys must be a valid pointer to an array of releaseCount uint64_t values
  • 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 Device

See Also

VK_KHR_win32_keyed_mutex, DeviceMemory, StructureType

Constructors

Win32KeyedMutexAcquireReleaseInfoKHR 

Fields

  • acquireSyncs :: Vector DeviceMemory

    pAcquireSyncs is a pointer to an array of DeviceMemory objects which were imported from Direct3D 11 resources.

  • acquireKeys :: Vector Word64

    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 in pAcquireSyncs.

  • acquireTimeouts :: Vector Word32

    pAcquireTimeouts is a pointer to an array of timeout values, in millisecond units, for each acquire specified in pAcquireKeys.

  • releaseSyncs :: Vector DeviceMemory

    pReleaseSyncs is a pointer to an array of DeviceMemory objects which were imported from Direct3D 11 resources.

  • releaseKeys :: Vector Word64

    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 in pReleaseSyncs.

Instances

Instances details
Show Win32KeyedMutexAcquireReleaseInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_win32_keyed_mutex

Methods

showsPrec :: Int -> Win32KeyedMutexAcquireReleaseInfoKHR -> ShowS #

show :: Win32KeyedMutexAcquireReleaseInfoKHR -> String #

showList :: [Win32KeyedMutexAcquireReleaseInfoKHR] -> ShowS #

FromCStruct Win32KeyedMutexAcquireReleaseInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_win32_keyed_mutex

Methods

peekCStruct :: Ptr Win32KeyedMutexAcquireReleaseInfoKHR -> IO Win32KeyedMutexAcquireReleaseInfoKHR Source #

ToCStruct Win32KeyedMutexAcquireReleaseInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_win32_keyed_mutex

Methods

withCStruct :: Win32KeyedMutexAcquireReleaseInfoKHR -> (Ptr Win32KeyedMutexAcquireReleaseInfoKHR -> IO b) -> IO b Source #

pokeCStruct :: Ptr Win32KeyedMutexAcquireReleaseInfoKHR -> Win32KeyedMutexAcquireReleaseInfoKHR -> IO b -> IO b Source #

withZeroCStruct :: (Ptr Win32KeyedMutexAcquireReleaseInfoKHR -> IO b) -> IO b Source #

pokeZeroCStruct :: Ptr Win32KeyedMutexAcquireReleaseInfoKHR -> IO b -> IO b Source #

cStructSize :: Int Source #

cStructAlignment :: Int Source #

Zero Win32KeyedMutexAcquireReleaseInfoKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_win32_keyed_mutex

Methods

zero :: Win32KeyedMutexAcquireReleaseInfoKHR Source #

type KHR_WIN32_KEYED_MUTEX_SPEC_VERSION = 1 Source #

pattern KHR_WIN32_KEYED_MUTEX_SPEC_VERSION :: forall a. Integral a => a Source #

type KHR_WIN32_KEYED_MUTEX_EXTENSION_NAME = "VK_KHR_win32_keyed_mutex" Source #

pattern KHR_WIN32_KEYED_MUTEX_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a Source #