• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1[open,refpage='vkGetMemoryWin32HandleNV',desc='retrieve Win32 handle to a device memory object',type='protos']
2--
3
4To retrieve the handle corresponding to a device memory object created with
5slink:VkExportMemoryAllocateInfoNV::pname:handleTypes set to include
6ename:VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT_NV or
7ename:VK_EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT_NV, call:
8
9include::../../api/protos/vkGetMemoryWin32HandleNV.txt[]
10
11  * pname:device is the logical device that owns the memory.
12  * pname:memory is the slink:VkDeviceMemory object.
13  * pname:handleType is a bitmask of
14    elink:VkExternalMemoryHandleTypeFlagBitsNV containing a single bit
15    specifying the type of handle requested.
16  * pname:handle points to a Windows code:HANDLE in which the handle is
17    returned.
18
19.Valid Usage
20****
21  * [[VUID-vkGetMemoryWin32HandleNV-handleType-01326]]
22    pname:handleType must: be a flag specified in
23    slink:VkExportMemoryAllocateInfoNV::pname:handleTypes when allocating
24    pname:memory
25****
26
27include::../../validity/protos/vkGetMemoryWin32HandleNV.txt[]
28--
29