Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
Name
VK_NV_external_memory_capabilities - instance extension
VK_NV_external_memory_capabilities
- Name String
VK_NV_external_memory_capabilities
- Extension Type
- Instance extension
- Registered Extension Number
- 56
- Revision
- 1
- Ratification Status
- Not ratified
- Extension and Version Dependencies; Deprecation State
Deprecated by
VK_KHR_external_memory_capabilities
extension- Which in turn was promoted to Vulkan 1.1
- Contact
Other Extension Metadata
- Last Modified Date
- 2016-08-19
- IP Status
- No known IP claims.
- Interactions and External Dependencies
- Interacts with Vulkan 1.1.
- Interacts with
VK_KHR_dedicated_allocation
. - Interacts with
VK_NV_dedicated_allocation
.
- Contributors
- James Jones, NVIDIA
Description
Applications may wish to import memory from the Direct 3D API, or export memory to other Vulkan instances. This extension provides a set of capability queries that allow applications determine what types of win32 memory handles an implementation supports for a given set of use cases.
New Commands
New Structures
New Enums
New Bitmasks
New Enum Constants
Issues
1) Why do so many external memory capabilities need to be queried on a per-memory-handle-type basis?
RESOLVED: This is because some handle types are based on OS-native objects that have far more limited capabilities than the very generic Vulkan memory objects. Not all memory handle types can name memory objects that support 3D images, for example. Some handle types cannot even support the deferred image and memory binding behavior of Vulkan and require specifying the image when allocating or importing the memory object.
2) Does the ExternalImageFormatPropertiesNV
struct need to include a
list of memory type bits that support the given handle type?
RESOLVED: No. The memory types that do not support the handle types
will simply be filtered out of the results returned by
getImageMemoryRequirements
when a set
of handle types was specified at image creation time.
3) Should the non-opaque handle types be moved to their own extension?
RESOLVED: Perhaps. However, defining the handle type bits does very little and does not require any platform-specific types on its own, and it is easier to maintain the bitmask values in a single extension for now. Presumably more handle types could be added by separate extensions though, and it would be midly weird to have some platform-specific ones defined in the core spec and some in extensions
Version History
Revision 1, 2016-08-19 (James Jones)
- Initial version
See Also
ExternalImageFormatPropertiesNV
, ExternalMemoryFeatureFlagBitsNV
,
ExternalMemoryFeatureFlagsNV
, ExternalMemoryHandleTypeFlagBitsNV
,
ExternalMemoryHandleTypeFlagsNV
,
getPhysicalDeviceExternalImageFormatPropertiesNV
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
- getPhysicalDeviceExternalImageFormatPropertiesNV :: forall io. MonadIO io => PhysicalDevice -> Format -> ImageType -> ImageTiling -> ImageUsageFlags -> ImageCreateFlags -> ("externalHandleType" ::: ExternalMemoryHandleTypeFlagsNV) -> io ExternalImageFormatPropertiesNV
- data ExternalImageFormatPropertiesNV = ExternalImageFormatPropertiesNV {}
- type ExternalMemoryHandleTypeFlagsNV = ExternalMemoryHandleTypeFlagBitsNV
- newtype ExternalMemoryHandleTypeFlagBitsNV where
- ExternalMemoryHandleTypeFlagBitsNV Flags
- pattern EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT_NV :: ExternalMemoryHandleTypeFlagBitsNV
- pattern EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT_NV :: ExternalMemoryHandleTypeFlagBitsNV
- pattern EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_IMAGE_BIT_NV :: ExternalMemoryHandleTypeFlagBitsNV
- pattern EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_IMAGE_KMT_BIT_NV :: ExternalMemoryHandleTypeFlagBitsNV
- type ExternalMemoryFeatureFlagsNV = ExternalMemoryFeatureFlagBitsNV
- newtype ExternalMemoryFeatureFlagBitsNV where
- type NV_EXTERNAL_MEMORY_CAPABILITIES_SPEC_VERSION = 1
- pattern NV_EXTERNAL_MEMORY_CAPABILITIES_SPEC_VERSION :: forall a. Integral a => a
- type NV_EXTERNAL_MEMORY_CAPABILITIES_EXTENSION_NAME = "VK_NV_external_memory_capabilities"
- pattern NV_EXTERNAL_MEMORY_CAPABILITIES_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a
Documentation
getPhysicalDeviceExternalImageFormatPropertiesNV Source #
:: forall io. MonadIO io | |
=> PhysicalDevice |
|
-> Format |
|
-> ImageType |
|
-> ImageTiling |
|
-> ImageUsageFlags |
|
-> ImageCreateFlags |
|
-> ("externalHandleType" ::: ExternalMemoryHandleTypeFlagsNV) |
|
-> io ExternalImageFormatPropertiesNV |
vkGetPhysicalDeviceExternalImageFormatPropertiesNV - Determine image capabilities compatible with external memory handle types
Description
If externalHandleType
is 0,
pExternalImageFormatProperties->imageFormatProperties
will return the
same values as a call to
getPhysicalDeviceImageFormatProperties
,
and the other members of pExternalImageFormatProperties
will all be 0.
Otherwise, they are filled in as described for
ExternalImageFormatPropertiesNV
.
Return Codes
See Also
VK_NV_external_memory_capabilities,
ExternalImageFormatPropertiesNV
, ExternalMemoryHandleTypeFlagsNV
,
Format
,
ImageCreateFlags
,
ImageTiling
,
ImageType
,
ImageUsageFlags
,
PhysicalDevice
data ExternalImageFormatPropertiesNV Source #
VkExternalImageFormatPropertiesNV - Structure specifying external image format properties
See Also
VK_NV_external_memory_capabilities,
ExternalMemoryFeatureFlagsNV
, ExternalMemoryHandleTypeFlagsNV
,
ImageFormatProperties
,
getPhysicalDeviceExternalImageFormatPropertiesNV
ExternalImageFormatPropertiesNV | |
|
Instances
newtype ExternalMemoryHandleTypeFlagBitsNV Source #
VkExternalMemoryHandleTypeFlagBitsNV - Bitmask specifying external memory handle types
See Also
VK_NV_external_memory_capabilities,
ExternalMemoryHandleTypeFlagsNV
pattern EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_BIT_NV :: ExternalMemoryHandleTypeFlagBitsNV |
|
pattern EXTERNAL_MEMORY_HANDLE_TYPE_OPAQUE_WIN32_KMT_BIT_NV :: ExternalMemoryHandleTypeFlagBitsNV |
|
pattern EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_IMAGE_BIT_NV :: ExternalMemoryHandleTypeFlagBitsNV |
|
pattern EXTERNAL_MEMORY_HANDLE_TYPE_D3D11_IMAGE_KMT_BIT_NV :: ExternalMemoryHandleTypeFlagBitsNV |
|
Instances
newtype ExternalMemoryFeatureFlagBitsNV Source #
VkExternalMemoryFeatureFlagBitsNV - Bitmask specifying external memory features
See Also
VK_NV_external_memory_capabilities,
ExternalImageFormatPropertiesNV
, ExternalMemoryFeatureFlagsNV
,
getPhysicalDeviceExternalImageFormatPropertiesNV
pattern EXTERNAL_MEMORY_FEATURE_DEDICATED_ONLY_BIT_NV :: ExternalMemoryFeatureFlagBitsNV |
|
pattern EXTERNAL_MEMORY_FEATURE_EXPORTABLE_BIT_NV :: ExternalMemoryFeatureFlagBitsNV |
|
pattern EXTERNAL_MEMORY_FEATURE_IMPORTABLE_BIT_NV :: ExternalMemoryFeatureFlagBitsNV |
|
Instances
pattern NV_EXTERNAL_MEMORY_CAPABILITIES_SPEC_VERSION :: forall a. Integral a => a Source #
type NV_EXTERNAL_MEMORY_CAPABILITIES_EXTENSION_NAME = "VK_NV_external_memory_capabilities" Source #
pattern NV_EXTERNAL_MEMORY_CAPABILITIES_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a Source #