Graphics.Vulkan.Extensions.VK_NV_external_memory_win32

Documentation

type HANDLE = Ptr ()

data SECURITY_ATTRIBUTES

Opaque data

type DWORD = Word32

pattern VK_STRUCTURE_TYPE_IMPORT_MEMORY_WIN32_HANDLE_INFO_NV :: VkStructureType

pattern VK_STRUCTURE_TYPE_EXPORT_MEMORY_WIN32_HANDLE_INFO_NV :: VkStructureType

pattern VK_NV_EXTERNAL_MEMORY_WIN32_SPEC_VERSION :: Integral a => a

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

vkGetMemoryWin32HandleNV :: ("device" ::: VkDevice) -> ("memory" ::: VkDeviceMemory) -> ("handleType" ::: VkExternalMemoryHandleTypeFlagsNV) -> ("pHandle" ::: Ptr HANDLE) -> IO VkResult

vkGetMemoryWin32HandleNV - retrieve Win32 handle to a device memory object

Parameters

• device is the logical device that owns the memory.

• memory is the VkDeviceMemory object.
• handleType is a bitmask of VkExternalMemoryHandleTypeFlagBitsNV containing a single bit specifying the type of handle requested.
• handle points to a Windows HANDLE in which the handle is returned.

Valid Usage

• handleType must be a flag specified in VkExportMemoryAllocateInfoNV::handleTypes when allocating memory

Valid Usage (Implicit)

• device must be a valid VkDevice handle

• memory must be a valid VkDeviceMemory handle
• handleType must be a valid combination of VkExternalMemoryHandleTypeFlagBitsNV values
• handleType must not be 0
• pHandle must be a valid pointer to a HANDLE value
• memory must have been created, allocated, or retrieved from device

Return Codes

[Success] - VK_SUCCESS

[Failure] - VK_ERROR_TOO_MANY_OBJECTS

• VK_ERROR_OUT_OF_HOST_MEMORY

See Also

VkDevice, VkDeviceMemory, VkExternalMemoryHandleTypeFlagsNV

data VkImportMemoryWin32HandleInfoNV

VkImportMemoryWin32HandleInfoNV - import Win32 memory created on the same physical device

Description

If handleType is 0, this structure is ignored by consumers of the VkMemoryAllocateInfo structure it is chained from.

Valid Usage

• handleType must not have more than one bit set.

• handle must be a valid handle to memory, obtained as specified by handleType.

Valid Usage (Implicit)

• sType must be VK_STRUCTURE_TYPE_IMPORT_MEMORY_WIN32_HANDLE_INFO_NV

• handleType must be a valid combination of VkExternalMemoryHandleTypeFlagBitsNV values

See Also

VkExternalMemoryHandleTypeFlagsNV, VkStructureType

Constructors

VkImportMemoryWin32HandleInfoNV

Fields

• vkSType :: VkStructureType

  sType is the type of this structure.

• vkPNext :: Ptr ()

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

• vkHandleType :: VkExternalMemoryHandleTypeFlagsNV

  handleType is 0 or a VkExternalMemoryHandleTypeFlagBitsNV value specifying the type of memory handle in handle.

• vkHandle :: HANDLE

  handle is a Windows HANDLE referring to the memory.

Instances

Eq VkImportMemoryWin32HandleInfoNV

Methods

(==) :: VkImportMemoryWin32HandleInfoNV -> VkImportMemoryWin32HandleInfoNV -> Bool

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

Show VkImportMemoryWin32HandleInfoNV

Methods

showsPrec :: Int -> VkImportMemoryWin32HandleInfoNV -> ShowS

show :: VkImportMemoryWin32HandleInfoNV -> String

showList :: [VkImportMemoryWin32HandleInfoNV] -> ShowS

Storable VkImportMemoryWin32HandleInfoNV

Methods

sizeOf :: VkImportMemoryWin32HandleInfoNV -> Int

alignment :: VkImportMemoryWin32HandleInfoNV -> Int

peekElemOff :: Ptr VkImportMemoryWin32HandleInfoNV -> Int -> IO VkImportMemoryWin32HandleInfoNV

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

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

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

peek :: Ptr VkImportMemoryWin32HandleInfoNV -> IO VkImportMemoryWin32HandleInfoNV

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

data VkExportMemoryWin32HandleInfoNV

VkExportMemoryWin32HandleInfoNV - specify security attributes and access rights for Win32 memory handles

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

1

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

Valid Usage (Implicit)

• sType must be VK_STRUCTURE_TYPE_EXPORT_MEMORY_WIN32_HANDLE_INFO_NV

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

See Also

VkStructureType

Constructors

VkExportMemoryWin32HandleInfoNV

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.

Instances

Eq VkExportMemoryWin32HandleInfoNV

Methods

(==) :: VkExportMemoryWin32HandleInfoNV -> VkExportMemoryWin32HandleInfoNV -> Bool

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

Show VkExportMemoryWin32HandleInfoNV

Methods

showsPrec :: Int -> VkExportMemoryWin32HandleInfoNV -> ShowS

show :: VkExportMemoryWin32HandleInfoNV -> String

showList :: [VkExportMemoryWin32HandleInfoNV] -> ShowS

Storable VkExportMemoryWin32HandleInfoNV

Methods

sizeOf :: VkExportMemoryWin32HandleInfoNV -> Int

alignment :: VkExportMemoryWin32HandleInfoNV -> Int

peekElemOff :: Ptr VkExportMemoryWin32HandleInfoNV -> Int -> IO VkExportMemoryWin32HandleInfoNV

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

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

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

peek :: Ptr VkExportMemoryWin32HandleInfoNV -> IO VkExportMemoryWin32HandleInfoNV

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