Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
Name
VK_KHR_external_memory_win32 - device extension
VK_KHR_external_memory_win32
- Name String
VK_KHR_external_memory_win32
- Extension Type
- Device extension
- Registered Extension Number
- 74
- Revision
- 1
- Ratification Status
- Ratified
- Extension and Version Dependencies
- VK_KHR_external_memory
- 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
An application may wish to reference device memory in multiple Vulkan logical devices or instances, in multiple processes, and/or in multiple APIs. This extension enables an application to export Windows handles from Vulkan memory objects and to import Vulkan memory objects from Windows handles exported from other Vulkan memory objects or from similar resources in other APIs.
New Commands
New Structures
New Enum Constants
Issues
1) Do applications need to call CloseHandle
() on the values returned
from getMemoryWin32HandleKHR
when handleType
is
EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT_KHR
?
RESOLVED: Yes, unless it is passed back in to another driver instance to import the object. A successful get call transfers ownership of the handle to the application. Destroying the memory object will not destroy the handle or the handle’s reference to the underlying memory resource.
2) Should the language regarding KMT/Windows 7 handles be moved to a separate extension so that it can be deprecated over time?
RESOLVED: No. Support for them can be deprecated by drivers if they choose, by no longer returning them in the supported handle types of the instance level queries.
3) How should the valid size and memory type for windows memory handles created outside of Vulkan be specified?
RESOLVED: The valid memory types are queried directly from the external handle. The size is determined by the associated image or buffer memory requirements for external handle types that require dedicated allocations, and by the size specified when creating the object from which the handle was exported for other external handle types.
Version History
Revision 1, 2016-10-21 (James Jones)
- Initial revision
See Also
ExportMemoryWin32HandleInfoKHR
, ImportMemoryWin32HandleInfoKHR
,
MemoryGetWin32HandleInfoKHR
, MemoryWin32HandlePropertiesKHR
,
getMemoryWin32HandleKHR
, getMemoryWin32HandlePropertiesKHR
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
- getMemoryWin32HandleKHR :: forall io. MonadIO io => Device -> MemoryGetWin32HandleInfoKHR -> io HANDLE
- getMemoryWin32HandlePropertiesKHR :: forall io. MonadIO io => Device -> ExternalMemoryHandleTypeFlagBits -> HANDLE -> io MemoryWin32HandlePropertiesKHR
- data ImportMemoryWin32HandleInfoKHR = ImportMemoryWin32HandleInfoKHR {}
- data ExportMemoryWin32HandleInfoKHR = ExportMemoryWin32HandleInfoKHR {}
- data MemoryWin32HandlePropertiesKHR = MemoryWin32HandlePropertiesKHR {}
- data MemoryGetWin32HandleInfoKHR = 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
Documentation
getMemoryWin32HandleKHR Source #
:: forall io. MonadIO io | |
=> Device |
|
-> MemoryGetWin32HandleInfoKHR |
|
-> 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
See Also
VK_KHR_external_memory_win32,
Device
, MemoryGetWin32HandleInfoKHR
getMemoryWin32HandlePropertiesKHR Source #
:: forall io. MonadIO io | |
=> Device |
|
-> ExternalMemoryHandleTypeFlagBits |
|
-> HANDLE |
|
-> io MemoryWin32HandlePropertiesKHR |
vkGetMemoryWin32HandlePropertiesKHR - Get Properties of External Memory Win32 Handles
Return Codes
See Also
VK_KHR_external_memory_win32,
Device
,
ExternalMemoryHandleTypeFlagBits
,
MemoryWin32HandlePropertiesKHR
data ImportMemoryWin32HandleInfoKHR Source #
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 not0
, it must be supported for import, as reported byExternalImageFormatProperties
orExternalBufferProperties
- The memory from
which
handle
was exported, or the memory named byname
must have been created on the same underlying physical device asdevice
- If
handleType
is not0
, it must be defined as an NT handle or a global share handle - If
handleType
is notEXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT
,EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_TEXTURE_BIT
,EXTERNAL_MEMORY_HANDLE_TYPE_D3D12_HEAP_BIT
, orEXTERNAL_MEMORY_HANDLE_TYPE_D3D12_RESOURCE_BIT
,name
must beNULL
- If
handleType
is not0
andhandle
isNULL
,name
must name a valid memory resource of the type specified byhandleType
- If
handleType
is not0
andname
isNULL
,handle
must be a valid handle of the type specified byhandleType
- If
handle
is notNULL
,name
must beNULL
- If
handle
is notNULL
, it must obey any requirements listed forhandleType
in external memory handle types compatibility - If
name
is notNULL
, it must obey any requirements listed forhandleType
in external memory handle types compatibility
Valid Usage (Implicit)
-
sType
must beSTRUCTURE_TYPE_IMPORT_MEMORY_WIN32_HANDLE_INFO_KHR
- If
handleType
is not0
,handleType
must be a validExternalMemoryHandleTypeFlagBits
value
See Also
VK_KHR_external_memory_win32,
ExternalMemoryHandleTypeFlagBits
,
StructureType
ImportMemoryWin32HandleInfoKHR | |
|
Instances
data ExportMemoryWin32HandleInfoKHR Source #
VkExportMemoryWin32HandleInfoKHR - Structure specifying additional attributes of Windows handles exported from a memory
Description
If
ExportMemoryAllocateInfo
is not included in the same pNext
chain, this structure is ignored.
If
ExportMemoryAllocateInfo
is included in the pNext
chain of
MemoryAllocateInfo
with a Windows handleType
,
but either ExportMemoryWin32HandleInfoKHR
is not included in the
pNext
chain, or it is included 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:
The implementation must ensure the access rights allow read and write access to the memory.
Valid Usage
- If
ExportMemoryAllocateInfo
::handleTypes
does not includeEXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT
, aExportMemoryWin32HandleInfoKHR
structure must not be included in thepNext
chain ofMemoryAllocateInfo
Valid Usage (Implicit)
-
sType
must beSTRUCTURE_TYPE_EXPORT_MEMORY_WIN32_HANDLE_INFO_KHR
- If
pAttributes
is notNULL
,pAttributes
must be a valid pointer to a validSECURITY_ATTRIBUTES
value
See Also
ExportMemoryWin32HandleInfoKHR | |
|
Instances
data MemoryWin32HandlePropertiesKHR Source #
VkMemoryWin32HandlePropertiesKHR - Properties of External Memory Windows Handles
Valid Usage (Implicit)
See Also
VK_KHR_external_memory_win32,
StructureType
,
getMemoryWin32HandlePropertiesKHR
MemoryWin32HandlePropertiesKHR | |
|
Instances
data MemoryGetWin32HandleInfoKHR Source #
VkMemoryGetWin32HandleInfoKHR - Structure describing a Win32 handle memory 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 inExportMemoryAllocateInfo
::handleTypes
whenmemory
was created
- If
handleType
is defined as an NT handle,getMemoryWin32HandleKHR
must be called no more than once for each valid unique combination ofmemory
andhandleType
-
handleType
must be defined as an NT handle or a global share handle
Valid Usage (Implicit)
-
sType
must beSTRUCTURE_TYPE_MEMORY_GET_WIN32_HANDLE_INFO_KHR
-
pNext
must beNULL
-
memory
must be a validDeviceMemory
handle -
handleType
must be a validExternalMemoryHandleTypeFlagBits
value
See Also
VK_KHR_external_memory_win32,
DeviceMemory
,
ExternalMemoryHandleTypeFlagBits
,
StructureType
,
getMemoryWin32HandleKHR
MemoryGetWin32HandleInfoKHR | |
|
Instances
pattern KHR_EXTERNAL_MEMORY_WIN32_SPEC_VERSION :: forall a. Integral a => a Source #
type KHR_EXTERNAL_MEMORY_WIN32_EXTENSION_NAME = "VK_KHR_external_memory_win32" Source #
pattern KHR_EXTERNAL_MEMORY_WIN32_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a Source #
data SECURITY_ATTRIBUTES Source #