Graphics.Vulkan.Extensions.VK_KHR_external_memory_win32

Documentation

type LPCWSTR = Ptr CWchar

pattern VK_STRUCTURE_TYPE_IMPORT_MEMORY_WIN32_HANDLE_INFO_KHR :: VkStructureType

pattern VK_STRUCTURE_TYPE_EXPORT_MEMORY_WIN32_HANDLE_INFO_KHR :: VkStructureType

pattern VK_STRUCTURE_TYPE_MEMORY_WIN32_HANDLE_PROPERTIES_KHR :: VkStructureType

pattern VK_STRUCTURE_TYPE_MEMORY_GET_WIN32_HANDLE_INFO_KHR :: VkStructureType

pattern VK_KHR_EXTERNAL_MEMORY_WIN32_SPEC_VERSION :: Integral a => a

pattern VK_KHR_EXTERNAL_MEMORY_WIN32_EXTENSION_NAME :: (Eq a, IsString a) => a

vkGetMemoryWin32HandleKHR :: ("device" ::: VkDevice) -> ("pGetWin32HandleInfo" ::: Ptr VkMemoryGetWin32HandleInfoKHR) -> ("pHandle" ::: Ptr HANDLE) -> IO VkResult

vkGetMemoryWin32HandleKHR - Get a Windows HANDLE for a memory object

Parameters

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

• pGetWin32HandleInfo is a pointer to an instance of the VkMemoryGetWin32HandleInfoKHR structure containing parameters of the export operation.
• pHandle will return the Windows handle representing the underlying resources of the device memory object.

Description

For handle types defined as NT handles, the handles returned by vkGetMemoryWin32HandleKHR are owned by the application. To avoid leaking resources, the application must release ownership of them using the CloseHandle system call when they are no longer needed.

Valid Usage (Implicit)

• device must be a valid VkDevice handle

• pGetWin32HandleInfo must be a valid pointer to a valid VkMemoryGetWin32HandleInfoKHR structure
• pHandle must be a valid pointer to a HANDLE value

Return Codes

[Success] - VK_SUCCESS

[Failure] - VK_ERROR_TOO_MANY_OBJECTS

• VK_ERROR_OUT_OF_HOST_MEMORY

See Also

VkDevice, VkMemoryGetWin32HandleInfoKHR

vkGetMemoryWin32HandlePropertiesKHR :: ("device" ::: VkDevice) -> ("handleType" ::: VkExternalMemoryHandleTypeFlagBits) -> ("handle" ::: HANDLE) -> ("pMemoryWin32HandleProperties" ::: Ptr VkMemoryWin32HandlePropertiesKHR) -> IO VkResult

vkGetMemoryWin32HandlePropertiesKHR - Get Properties of External Memory Win32 Handles

Parameters

• device is the logical device that will be importing handle.

• handleType is the type of the handle handle.
• handle is the handle which will be imported.
• pMemoryWin32HandleProperties will return properties of handle.

Valid Usage

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

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

Valid Usage (Implicit)

• device must be a valid VkDevice handle

• handleType must be a valid VkExternalMemoryHandleTypeFlagBits value
• pMemoryWin32HandleProperties must be a valid pointer to a VkMemoryWin32HandlePropertiesKHR structure

Return Codes

[Success] - VK_SUCCESS

[Failure] - VK_ERROR_INVALID_EXTERNAL_HANDLE

See Also

VkDevice, VkExternalMemoryHandleTypeFlagBits, VkMemoryWin32HandlePropertiesKHR

data VkImportMemoryWin32HandleInfoKHR

VkImportMemoryWin32HandleInfoKHR - import Win32 memory created on the same physical device

Description

Importing memory objects 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 ownership using the CloseHandle system call when the handle is no longer needed.

Applications can import the same underlying memory 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 VkDeviceMemory object.

Valid Usage

• If handleType is not 0, it must be supported for import, as reported by VkExternalImageFormatProperties or VkExternalBufferProperties.

• 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 VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT, VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_BIT, VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_HEAP_BIT, or VK_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 VK_STRUCTURE_TYPE_IMPORT_MEMORY_WIN32_HANDLE_INFO_KHR

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

See Also

VkExternalMemoryHandleTypeFlagBits, VkStructureType

Constructors

VkImportMemoryWin32HandleInfoKHR

Fields

• vkSType :: VkStructureType

  sType is the type of this structure.

• vkPNext :: Ptr ()

  pNext is NULL or a pointer to an extension-specific structure.

• vkHandleType :: VkExternalMemoryHandleTypeFlagBits

  handleType specifies the type of handle or name.

• vkHandle :: HANDLE

  handle is the external handle to import, or NULL.

• vkName :: LPCWSTR

  name is a NULL-terminated UTF-16 string naming the underlying memory resource to import, or NULL.

Instances

Eq VkImportMemoryWin32HandleInfoKHR

Methods

(==) :: VkImportMemoryWin32HandleInfoKHR -> VkImportMemoryWin32HandleInfoKHR -> Bool

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

Show VkImportMemoryWin32HandleInfoKHR

Methods

showsPrec :: Int -> VkImportMemoryWin32HandleInfoKHR -> ShowS

show :: VkImportMemoryWin32HandleInfoKHR -> String

showList :: [VkImportMemoryWin32HandleInfoKHR] -> ShowS

Storable VkImportMemoryWin32HandleInfoKHR

Methods

sizeOf :: VkImportMemoryWin32HandleInfoKHR -> Int

alignment :: VkImportMemoryWin32HandleInfoKHR -> Int

peekElemOff :: Ptr VkImportMemoryWin32HandleInfoKHR -> Int -> IO VkImportMemoryWin32HandleInfoKHR

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

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

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

peek :: Ptr VkImportMemoryWin32HandleInfoKHR -> IO VkImportMemoryWin32HandleInfoKHR

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

data VkExportMemoryWin32HandleInfoKHR

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

Description

If this structure is not present, or if 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 will be

DXGI_SHARED_RESOURCE_READ | DXGI_SHARED_RESOURCE_WRITE

for handles of the following types:

VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_BIT

And

GENERIC_ALL

for handles of the following types:

VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_HEAP_BIT VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_RESOURCE_BIT

1

https://msdn.microsoft.com/en-us/library/windows/desktop/ms686670.aspx

Valid Usage

• If VkExportMemoryAllocateInfo::handleTypes does not include VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT, VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_BIT, VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_HEAP_BIT, or VK_EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_RESOURCE_BIT, VkExportMemoryWin32HandleInfoKHR must not be in the pNext chain of VkMemoryAllocateInfo.

Valid Usage (Implicit)

• sType must be VK_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

VkStructureType

Constructors

VkExportMemoryWin32HandleInfoKHR

Fields

• vkSType :: VkStructureType

  sType is the type of this structure.

• vkPNext :: Ptr ()

  pNext is NULL or a pointer to an extension-specific structure.

• vkPAttributes :: Ptr SECURITY_ATTRIBUTES

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

• vkDwAccess :: DWORD

  dwAccess is a DWORD specifying access rights of the handle.

• vkName :: LPCWSTR

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

Instances

Eq VkExportMemoryWin32HandleInfoKHR

Methods

(==) :: VkExportMemoryWin32HandleInfoKHR -> VkExportMemoryWin32HandleInfoKHR -> Bool

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

Show VkExportMemoryWin32HandleInfoKHR

Methods

showsPrec :: Int -> VkExportMemoryWin32HandleInfoKHR -> ShowS

show :: VkExportMemoryWin32HandleInfoKHR -> String

showList :: [VkExportMemoryWin32HandleInfoKHR] -> ShowS

Storable VkExportMemoryWin32HandleInfoKHR

Methods

sizeOf :: VkExportMemoryWin32HandleInfoKHR -> Int

alignment :: VkExportMemoryWin32HandleInfoKHR -> Int

peekElemOff :: Ptr VkExportMemoryWin32HandleInfoKHR -> Int -> IO VkExportMemoryWin32HandleInfoKHR

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

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

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

peek :: Ptr VkExportMemoryWin32HandleInfoKHR -> IO VkExportMemoryWin32HandleInfoKHR

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

data VkMemoryWin32HandlePropertiesKHR

VkMemoryWin32HandlePropertiesKHR - Properties of External Memory Windows Handles

See Also

VkStructureType, vkGetMemoryWin32HandlePropertiesKHR

Constructors

VkMemoryWin32HandlePropertiesKHR

Fields

• vkSType :: VkStructureType

  sType is the type of this structure.

• vkPNext :: Ptr ()

  pNext is NULL or a pointer to an extension-specific structure.

• vkMemoryTypeBits :: Word32

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

Instances

Eq VkMemoryWin32HandlePropertiesKHR

Methods

(==) :: VkMemoryWin32HandlePropertiesKHR -> VkMemoryWin32HandlePropertiesKHR -> Bool

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

Show VkMemoryWin32HandlePropertiesKHR

Methods

showsPrec :: Int -> VkMemoryWin32HandlePropertiesKHR -> ShowS

show :: VkMemoryWin32HandlePropertiesKHR -> String

showList :: [VkMemoryWin32HandlePropertiesKHR] -> ShowS

Storable VkMemoryWin32HandlePropertiesKHR

Methods

sizeOf :: VkMemoryWin32HandlePropertiesKHR -> Int

alignment :: VkMemoryWin32HandlePropertiesKHR -> Int

peekElemOff :: Ptr VkMemoryWin32HandlePropertiesKHR -> Int -> IO VkMemoryWin32HandlePropertiesKHR

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

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

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

peek :: Ptr VkMemoryWin32HandlePropertiesKHR -> IO VkMemoryWin32HandlePropertiesKHR

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

data VkMemoryGetWin32HandleInfoKHR

VkMemoryGetWin32HandleInfoKHR - Structure describing a Win32 handle semaphore export operation

Description

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

Valid Usage

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

• If handleType is defined as an NT handle, vkGetMemoryWin32HandleKHR 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 VK_STRUCTURE_TYPE_MEMORY_GET_WIN32_HANDLE_INFO_KHR

• pNext must be NULL
• memory must be a valid VkDeviceMemory handle
• handleType must be a valid VkExternalMemoryHandleTypeFlagBits value

See Also

VkDeviceMemory, VkExternalMemoryHandleTypeFlagBits, VkStructureType, vkGetMemoryWin32HandleKHR

Constructors

VkMemoryGetWin32HandleInfoKHR

Fields

• vkSType :: VkStructureType

  sType is the type of this structure.

• vkPNext :: Ptr ()

  pNext is NULL or a pointer to an extension-specific structure.

• vkMemory :: VkDeviceMemory

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

• vkHandleType :: VkExternalMemoryHandleTypeFlagBits

  handleType is the type of handle requested.

Instances

Eq VkMemoryGetWin32HandleInfoKHR

Methods

(==) :: VkMemoryGetWin32HandleInfoKHR -> VkMemoryGetWin32HandleInfoKHR -> Bool

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

Show VkMemoryGetWin32HandleInfoKHR

Methods

showsPrec :: Int -> VkMemoryGetWin32HandleInfoKHR -> ShowS

show :: VkMemoryGetWin32HandleInfoKHR -> String

showList :: [VkMemoryGetWin32HandleInfoKHR] -> ShowS

Storable VkMemoryGetWin32HandleInfoKHR

Methods

sizeOf :: VkMemoryGetWin32HandleInfoKHR -> Int

alignment :: VkMemoryGetWin32HandleInfoKHR -> Int

peekElemOff :: Ptr VkMemoryGetWin32HandleInfoKHR -> Int -> IO VkMemoryGetWin32HandleInfoKHR

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

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

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

peek :: Ptr VkMemoryGetWin32HandleInfoKHR -> IO VkMemoryGetWin32HandleInfoKHR

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