Vulkan.Extensions.VK_KHR_external_memory_win32

Documentation

getMemoryWin32HandleKHR

Arguments

:: forall io. MonadIO io

=> Device

device is the logical device that created the device memory being exported.

device must be a valid Device handle

-> MemoryGetWin32HandleInfoKHR

pGetWin32HandleInfo is a pointer to a MemoryGetWin32HandleInfoKHR structure containing parameters of the export operation.

pGetWin32HandleInfo must be a valid pointer to a valid MemoryGetWin32HandleInfoKHR structure

-> io HANDLE

vkGetMemoryWin32HandleKHR - Get a Windows HANDLE for a memory object

Description

For handle types defined as NT handles, the handles returned by getMemoryWin32HandleKHR are owned by the application and hold a reference to their payload. To avoid leaking resources, the application must release ownership of them using the CloseHandle system call when they are no longer needed.

Note

Non-NT handle types do not add a reference to their associated payload. If the original object owning the payload is destroyed, all resources and handles sharing that payload will become invalid.

Return Codes

Success

• SUCCESS

Failure

• ERROR_TOO_MANY_OBJECTS
• ERROR_OUT_OF_HOST_MEMORY

See Also

Device, MemoryGetWin32HandleInfoKHR

getMemoryWin32HandlePropertiesKHR

Arguments

:: forall io. MonadIO io

=> Device

device is the logical device that will be importing handle.

device must be a valid Device handle

-> ExternalMemoryHandleTypeFlagBits

handleType is the type of the handle handle.

handleType must not be one of the handle types defined as opaque

handleType must be a valid ExternalMemoryHandleTypeFlagBits value

-> HANDLE

handle is the handle which will be imported.

handle must be an external memory handle created outside of the Vulkan API

-> io MemoryWin32HandlePropertiesKHR

vkGetMemoryWin32HandlePropertiesKHR - Get Properties of External Memory Win32 Handles

Return Codes

Success

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_INVALID_EXTERNAL_HANDLE

See Also

Device, ExternalMemoryHandleTypeFlagBits, MemoryWin32HandlePropertiesKHR

data ImportMemoryWin32HandleInfoKHR

VkImportMemoryWin32HandleInfoKHR - import Win32 memory created on the same physical device

Description

Importing memory object payloads from Windows handles does not transfer ownership of the handle to the Vulkan implementation. For handle types defined as NT handles, the application must release handle ownership using the CloseHandle system call when the handle is no longer needed. For handle types defined as NT handles, the imported memory object holds a reference to its payload.

Note

Non-NT handle import operations do not add a reference to their associated payload. If the original object owning the payload is destroyed, all resources and handles sharing that payload will become invalid.

Applications can import the same payload into multiple instances of Vulkan, into the same instance from which it was exported, and multiple times into a given Vulkan instance. In all cases, each import operation must create a distinct DeviceMemory object.

Valid Usage

• If handleType is not 0, it must be supported for import, as reported by ExternalImageFormatProperties or ExternalBufferProperties

• The memory from which handle was exported, or the memory named by name must have been created on the same underlying physical device as device
• If handleType is not 0, it must be defined as an NT handle or a global share handle
• If handleType is not EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT, EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_BIT, EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_HEAP_BIT, or EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_RESOURCE_BIT, name must be NULL
• If handleType is not 0 and handle is NULL, name must name a valid memory resource of the type specified by handleType
• If handleType is not 0 and name is NULL, handle must be a valid handle of the type specified by handleType
• if handle is not NULL, name must be NULL
• If handle is not NULL, it must obey any requirements listed for handleType in external memory handle types compatibility
• If name is not NULL, it must obey any requirements listed for handleType in external memory handle types compatibility

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_IMPORT_MEMORY_WIN32_HANDLE_INFO_KHR

• If handleType is not 0, handleType must be a valid ExternalMemoryHandleTypeFlagBits value

See Also

ExternalMemoryHandleTypeFlagBits, StructureType

Constructors

ImportMemoryWin32HandleInfoKHR

Fields

• handleType :: ExternalMemoryHandleTypeFlagBits

  handleType specifies the type of handle or name.

• handle :: HANDLE

  handle is the external handle to import, or NULL.

• name :: LPCWSTR

  name is a null-terminated UTF-16 string naming the payload to import, or NULL.

Instances

Eq ImportMemoryWin32HandleInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_memory_win32

Methods

(==) :: ImportMemoryWin32HandleInfoKHR -> ImportMemoryWin32HandleInfoKHR -> Bool

(/=) :: ImportMemoryWin32HandleInfoKHR -> ImportMemoryWin32HandleInfoKHR -> Bool

Show ImportMemoryWin32HandleInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_memory_win32

Methods

showsPrec :: Int -> ImportMemoryWin32HandleInfoKHR -> ShowS

show :: ImportMemoryWin32HandleInfoKHR -> String

showList :: [ImportMemoryWin32HandleInfoKHR] -> ShowS

Storable ImportMemoryWin32HandleInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_memory_win32

Methods

sizeOf :: ImportMemoryWin32HandleInfoKHR -> Int

alignment :: ImportMemoryWin32HandleInfoKHR -> Int

peekElemOff :: Ptr ImportMemoryWin32HandleInfoKHR -> Int -> IO ImportMemoryWin32HandleInfoKHR

pokeElemOff :: Ptr ImportMemoryWin32HandleInfoKHR -> Int -> ImportMemoryWin32HandleInfoKHR -> IO ()

peekByteOff :: Ptr b -> Int -> IO ImportMemoryWin32HandleInfoKHR

pokeByteOff :: Ptr b -> Int -> ImportMemoryWin32HandleInfoKHR -> IO ()

peek :: Ptr ImportMemoryWin32HandleInfoKHR -> IO ImportMemoryWin32HandleInfoKHR

poke :: Ptr ImportMemoryWin32HandleInfoKHR -> ImportMemoryWin32HandleInfoKHR -> IO ()

FromCStruct ImportMemoryWin32HandleInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_memory_win32

Methods

peekCStruct :: Ptr ImportMemoryWin32HandleInfoKHR -> IO ImportMemoryWin32HandleInfoKHR

ToCStruct ImportMemoryWin32HandleInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_memory_win32

Methods

withCStruct :: ImportMemoryWin32HandleInfoKHR -> (Ptr ImportMemoryWin32HandleInfoKHR -> IO b) -> IO b

pokeCStruct :: Ptr ImportMemoryWin32HandleInfoKHR -> ImportMemoryWin32HandleInfoKHR -> IO b -> IO b

withZeroCStruct :: (Ptr ImportMemoryWin32HandleInfoKHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr ImportMemoryWin32HandleInfoKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero ImportMemoryWin32HandleInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_memory_win32

Methods

zero :: ImportMemoryWin32HandleInfoKHR

data ExportMemoryWin32HandleInfoKHR

VkExportMemoryWin32HandleInfoKHR - Structure specifying additional attributes of Windows handles exported from a memory

Description

If ExportMemoryAllocateInfo is not present in the same pNext chain, this structure is ignored.

If ExportMemoryAllocateInfo is present in the pNext chain of MemoryAllocateInfo with a Windows handleType, but either ExportMemoryWin32HandleInfoKHR is not present in the pNext chain, or if it is but pAttributes is set to NULL, default security descriptor values will be used, and child processes created by the application will not inherit the handle, as described in the MSDN documentation for “Synchronization Object Security and Access Rights”1. Further, if the structure is not present, the access rights used depend on the handle type.

For handles of the following types:

EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_BIT

The implementation must ensure the access rights allow read and write access to the memory.

For handles of the following types:

EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_HEAP_BIT EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_RESOURCE_BIT

The access rights must be:

GENERIC_ALL

1

https://docs.microsoft.com/en-us/windows/win32/sync/synchronization-object-security-and-access-rights

Valid Usage

• If ExportMemoryAllocateInfo::handleTypes does not include EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT, EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_BIT, EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_HEAP_BIT, or EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_RESOURCE_BIT, a ExportMemoryWin32HandleInfoKHR structure must not be included in the pNext chain of MemoryAllocateInfo

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_EXPORT_MEMORY_WIN32_HANDLE_INFO_KHR

• If pAttributes is not NULL, pAttributes must be a valid pointer to a valid SECURITY_ATTRIBUTES value

See Also

StructureType

Constructors

ExportMemoryWin32HandleInfoKHR

Fields

• attributes :: Ptr SECURITY_ATTRIBUTES

  pAttributes is a pointer to a Windows SECURITY_ATTRIBUTES structure specifying security attributes of the handle.

• dwAccess :: DWORD

  dwAccess is a DWORD specifying access rights of the handle.

• name :: LPCWSTR

  name is a null-terminated UTF-16 string to associate with the payload referenced by NT handles exported from the created memory.

Instances

Eq ExportMemoryWin32HandleInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_memory_win32

Methods

(==) :: ExportMemoryWin32HandleInfoKHR -> ExportMemoryWin32HandleInfoKHR -> Bool

(/=) :: ExportMemoryWin32HandleInfoKHR -> ExportMemoryWin32HandleInfoKHR -> Bool

Show ExportMemoryWin32HandleInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_memory_win32

Methods

showsPrec :: Int -> ExportMemoryWin32HandleInfoKHR -> ShowS

show :: ExportMemoryWin32HandleInfoKHR -> String

showList :: [ExportMemoryWin32HandleInfoKHR] -> ShowS

Storable ExportMemoryWin32HandleInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_memory_win32

Methods

sizeOf :: ExportMemoryWin32HandleInfoKHR -> Int

alignment :: ExportMemoryWin32HandleInfoKHR -> Int

peekElemOff :: Ptr ExportMemoryWin32HandleInfoKHR -> Int -> IO ExportMemoryWin32HandleInfoKHR

pokeElemOff :: Ptr ExportMemoryWin32HandleInfoKHR -> Int -> ExportMemoryWin32HandleInfoKHR -> IO ()

peekByteOff :: Ptr b -> Int -> IO ExportMemoryWin32HandleInfoKHR

pokeByteOff :: Ptr b -> Int -> ExportMemoryWin32HandleInfoKHR -> IO ()

peek :: Ptr ExportMemoryWin32HandleInfoKHR -> IO ExportMemoryWin32HandleInfoKHR

poke :: Ptr ExportMemoryWin32HandleInfoKHR -> ExportMemoryWin32HandleInfoKHR -> IO ()

FromCStruct ExportMemoryWin32HandleInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_memory_win32

Methods

peekCStruct :: Ptr ExportMemoryWin32HandleInfoKHR -> IO ExportMemoryWin32HandleInfoKHR

ToCStruct ExportMemoryWin32HandleInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_memory_win32

Methods

withCStruct :: ExportMemoryWin32HandleInfoKHR -> (Ptr ExportMemoryWin32HandleInfoKHR -> IO b) -> IO b

pokeCStruct :: Ptr ExportMemoryWin32HandleInfoKHR -> ExportMemoryWin32HandleInfoKHR -> IO b -> IO b

withZeroCStruct :: (Ptr ExportMemoryWin32HandleInfoKHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr ExportMemoryWin32HandleInfoKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero ExportMemoryWin32HandleInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_memory_win32

Methods

zero :: ExportMemoryWin32HandleInfoKHR

data MemoryWin32HandlePropertiesKHR

VkMemoryWin32HandlePropertiesKHR - Properties of External Memory Windows Handles

Valid Usage (Implicit)

See Also

StructureType, getMemoryWin32HandlePropertiesKHR

Constructors

MemoryWin32HandlePropertiesKHR

Fields

• memoryTypeBits :: Word32

  memoryTypeBits is a bitmask containing one bit set for every memory type which the specified windows handle can be imported as.

Instances

Eq MemoryWin32HandlePropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_external_memory_win32

Methods

(==) :: MemoryWin32HandlePropertiesKHR -> MemoryWin32HandlePropertiesKHR -> Bool

(/=) :: MemoryWin32HandlePropertiesKHR -> MemoryWin32HandlePropertiesKHR -> Bool

Show MemoryWin32HandlePropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_external_memory_win32

Methods

showsPrec :: Int -> MemoryWin32HandlePropertiesKHR -> ShowS

show :: MemoryWin32HandlePropertiesKHR -> String

showList :: [MemoryWin32HandlePropertiesKHR] -> ShowS

Storable MemoryWin32HandlePropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_external_memory_win32

Methods

sizeOf :: MemoryWin32HandlePropertiesKHR -> Int

alignment :: MemoryWin32HandlePropertiesKHR -> Int

peekElemOff :: Ptr MemoryWin32HandlePropertiesKHR -> Int -> IO MemoryWin32HandlePropertiesKHR

pokeElemOff :: Ptr MemoryWin32HandlePropertiesKHR -> Int -> MemoryWin32HandlePropertiesKHR -> IO ()

peekByteOff :: Ptr b -> Int -> IO MemoryWin32HandlePropertiesKHR

pokeByteOff :: Ptr b -> Int -> MemoryWin32HandlePropertiesKHR -> IO ()

peek :: Ptr MemoryWin32HandlePropertiesKHR -> IO MemoryWin32HandlePropertiesKHR

poke :: Ptr MemoryWin32HandlePropertiesKHR -> MemoryWin32HandlePropertiesKHR -> IO ()

FromCStruct MemoryWin32HandlePropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_external_memory_win32

Methods

peekCStruct :: Ptr MemoryWin32HandlePropertiesKHR -> IO MemoryWin32HandlePropertiesKHR

ToCStruct MemoryWin32HandlePropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_external_memory_win32

Methods

withCStruct :: MemoryWin32HandlePropertiesKHR -> (Ptr MemoryWin32HandlePropertiesKHR -> IO b) -> IO b

pokeCStruct :: Ptr MemoryWin32HandlePropertiesKHR -> MemoryWin32HandlePropertiesKHR -> IO b -> IO b

withZeroCStruct :: (Ptr MemoryWin32HandlePropertiesKHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr MemoryWin32HandlePropertiesKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero MemoryWin32HandlePropertiesKHR

Defined in Vulkan.Extensions.VK_KHR_external_memory_win32

Methods

zero :: MemoryWin32HandlePropertiesKHR

data MemoryGetWin32HandleInfoKHR

VkMemoryGetWin32HandleInfoKHR - Structure describing a Win32 handle semaphore export operation

Description

The properties of the handle returned depend on the value of handleType. See ExternalMemoryHandleTypeFlagBits for a description of the properties of the defined external memory handle types.

Valid Usage

• handleType must have been included in ExportMemoryAllocateInfo::handleTypes when memory was created

• If handleType is defined as an NT handle, getMemoryWin32HandleKHR must be called no more than once for each valid unique combination of memory and handleType
• handleType must be defined as an NT handle or a global share handle

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_MEMORY_GET_WIN32_HANDLE_INFO_KHR

• pNext must be NULL
• memory must be a valid DeviceMemory handle
• handleType must be a valid ExternalMemoryHandleTypeFlagBits value

See Also

DeviceMemory, ExternalMemoryHandleTypeFlagBits, StructureType, getMemoryWin32HandleKHR

Constructors

MemoryGetWin32HandleInfoKHR

Fields

• memory :: DeviceMemory

  memory is the memory object from which the handle will be exported.

• handleType :: ExternalMemoryHandleTypeFlagBits

  handleType is the type of handle requested.

Instances

Eq MemoryGetWin32HandleInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_memory_win32

Methods

(==) :: MemoryGetWin32HandleInfoKHR -> MemoryGetWin32HandleInfoKHR -> Bool

(/=) :: MemoryGetWin32HandleInfoKHR -> MemoryGetWin32HandleInfoKHR -> Bool

Show MemoryGetWin32HandleInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_memory_win32

Methods

showsPrec :: Int -> MemoryGetWin32HandleInfoKHR -> ShowS

show :: MemoryGetWin32HandleInfoKHR -> String

showList :: [MemoryGetWin32HandleInfoKHR] -> ShowS

Storable MemoryGetWin32HandleInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_memory_win32

Methods

sizeOf :: MemoryGetWin32HandleInfoKHR -> Int

alignment :: MemoryGetWin32HandleInfoKHR -> Int

peekElemOff :: Ptr MemoryGetWin32HandleInfoKHR -> Int -> IO MemoryGetWin32HandleInfoKHR

pokeElemOff :: Ptr MemoryGetWin32HandleInfoKHR -> Int -> MemoryGetWin32HandleInfoKHR -> IO ()

peekByteOff :: Ptr b -> Int -> IO MemoryGetWin32HandleInfoKHR

pokeByteOff :: Ptr b -> Int -> MemoryGetWin32HandleInfoKHR -> IO ()

peek :: Ptr MemoryGetWin32HandleInfoKHR -> IO MemoryGetWin32HandleInfoKHR

poke :: Ptr MemoryGetWin32HandleInfoKHR -> MemoryGetWin32HandleInfoKHR -> IO ()

FromCStruct MemoryGetWin32HandleInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_memory_win32

Methods

peekCStruct :: Ptr MemoryGetWin32HandleInfoKHR -> IO MemoryGetWin32HandleInfoKHR

ToCStruct MemoryGetWin32HandleInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_memory_win32

Methods

withCStruct :: MemoryGetWin32HandleInfoKHR -> (Ptr MemoryGetWin32HandleInfoKHR -> IO b) -> IO b

pokeCStruct :: Ptr MemoryGetWin32HandleInfoKHR -> MemoryGetWin32HandleInfoKHR -> IO b -> IO b

withZeroCStruct :: (Ptr MemoryGetWin32HandleInfoKHR -> IO b) -> IO b

pokeZeroCStruct :: Ptr MemoryGetWin32HandleInfoKHR -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero MemoryGetWin32HandleInfoKHR

Defined in Vulkan.Extensions.VK_KHR_external_memory_win32

Methods

zero :: MemoryGetWin32HandleInfoKHR

type KHR_EXTERNAL_MEMORY_WIN32_SPEC_VERSION = 1

pattern KHR_EXTERNAL_MEMORY_WIN32_SPEC_VERSION :: forall a. Integral a => a

type KHR_EXTERNAL_MEMORY_WIN32_EXTENSION_NAME = "VK_KHR_external_memory_win32"

pattern KHR_EXTERNAL_MEMORY_WIN32_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a

type LPCWSTR = Ptr CWchar

type HANDLE = Ptr ()

type DWORD = Word32

data SECURITY_ATTRIBUTES