Safe Haskell	Safe-Inferred
Language	Haskell2010

Vulkan.Extensions.VK_KHR_portability_subset

Description

Name

VK_KHR_portability_subset - device extension

VK_KHR_portability_subset

Name String: VK_KHR_portability_subset

Extension Type

Device extension

Registered Extension Number

164

Revision

1

Ratification Status

Ratified

Extension and Version Dependencies

VK_KHR_get_physical_device_properties2

__This is a provisional extension and must be used with caution. See the description of provisional header files for enablement and stability details.__

Contact

Bill Hollings @billhollings%0A*Here describe the issue or question you have about the VK_KHR_portability_subset extension*

Other Extension Metadata

Last Modified Date: 2020-07-21

IP Status

No known IP claims.

Contributors

Bill Hollings, The Brenwill Workshop Ltd.
Daniel Koch, NVIDIA
Dzmitry Malyshau, Mozilla
Chip Davis, CodeWeavers
Dan Ginsburg, Valve
Mike Weiblen, LunarG
Neil Trevett, NVIDIA
Alexey Knyazev, Independent

Description

The VK_KHR_portability_subset extension allows a non-conformant Vulkan implementation to be built on top of another non-Vulkan graphics API, and identifies differences between that implementation and a fully-conformant native Vulkan implementation.

This extension provides Vulkan implementations with the ability to mark otherwise-required capabilities as unsupported, or to establish additional properties and limits that the application should adhere to in order to guarantee portable behaviour and operation across platforms, including platforms where Vulkan is not natively supported.

The goal of this specification is to document, and make queryable, capabilities which are required to be supported by a fully-conformant Vulkan 1.0 implementation, but may be optional for an implementation of the Vulkan 1.0 Portability Subset.

The intent is that this extension will be advertised only on implementations of the Vulkan 1.0 Portability Subset, and not on conformant implementations of Vulkan 1.0. Fully-conformant Vulkan implementations provide all the required capabilities, and so will not provide this extension. Therefore, the existence of this extension can be used to determine that an implementation is likely not fully conformant with the Vulkan spec.

If this extension is supported by the Vulkan implementation, the application must enable this extension.

This extension defines several new structures that can be chained to the existing structures used by certain standard Vulkan calls, in order to query for non-conformant portable behavior.

New Structures

Extending PhysicalDeviceFeatures2, DeviceCreateInfo:
- PhysicalDevicePortabilitySubsetFeaturesKHR

Extending PhysicalDeviceProperties2:
- PhysicalDevicePortabilitySubsetPropertiesKHR

New Enum Constants

KHR_PORTABILITY_SUBSET_EXTENSION_NAME

Issues

None.

Version History

Revision 1, 2020-07-21 (Bill Hollings)
- Initial draft.

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

data PhysicalDevicePortabilitySubsetFeaturesKHR = PhysicalDevicePortabilitySubsetFeaturesKHR {
- constantAlphaColorBlendFactors :: Bool
- events :: Bool
- imageViewFormatReinterpretation :: Bool
- imageViewFormatSwizzle :: Bool
- imageView2DOn3DImage :: Bool
- multisampleArrayImage :: Bool
- mutableComparisonSamplers :: Bool
- pointPolygons :: Bool
- samplerMipLodBias :: Bool
- separateStencilMaskRef :: Bool
- shaderSampleRateInterpolationFunctions :: Bool
- tessellationIsolines :: Bool
- tessellationPointMode :: Bool
- triangleFans :: Bool
- vertexAttributeAccessBeyondStride :: Bool
}
data PhysicalDevicePortabilitySubsetPropertiesKHR = PhysicalDevicePortabilitySubsetPropertiesKHR {
- minVertexInputBindingStrideAlignment :: Word32
}
type KHR_PORTABILITY_SUBSET_SPEC_VERSION = 1
pattern KHR_PORTABILITY_SUBSET_SPEC_VERSION :: forall a. Integral a => a
type KHR_PORTABILITY_SUBSET_EXTENSION_NAME = "VK_KHR_portability_subset"
pattern KHR_PORTABILITY_SUBSET_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a

Documentation

data PhysicalDevicePortabilitySubsetFeaturesKHR Source #

VkPhysicalDevicePortabilitySubsetFeaturesKHR - Structure describing the features that may not be supported by an implementation of the Vulkan 1.0 Portability Subset

Members

This structure describes the following features:

Description

If the PhysicalDevicePortabilitySubsetFeaturesKHR structure is included in the pNext chain of the PhysicalDeviceFeatures2 structure passed to getPhysicalDeviceFeatures2, it is filled in to indicate whether each corresponding feature is supported. PhysicalDevicePortabilitySubsetFeaturesKHR can also be used in the pNext chain of DeviceCreateInfo to selectively enable these features.

Valid Usage (Implicit)

constantAlphaColorBlendFactors :: Bool
constantAlphaColorBlendFactors indicates whether this implementation supports constant alpha https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#framebuffer-blendfactors used as source or destination color https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#framebuffer-blending.
events :: Bool
events indicates whether this implementation supports synchronization using https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#synchronization-events.
imageViewFormatReinterpretation :: Bool
imageViewFormatReinterpretation indicates whether this implementation supports a ImageView being created with a texel format containing a different number of components, or a different number of bits in each component, than the texel format of the underlying Image.
imageViewFormatSwizzle :: Bool
imageViewFormatSwizzle indicates whether this implementation supports remapping format components using ImageViewCreateInfo::components.
imageView2DOn3DImage :: Bool
imageView2DOn3DImage indicates whether this implementation supports a Image being created with the IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT flag set, permitting a 2D or 2D array image view to be created on a 3D Image.
multisampleArrayImage :: Bool
multisampleArrayImage indicates whether this implementation supports a Image being created as a 2D array with multiple samples per texel.
mutableComparisonSamplers :: Bool
mutableComparisonSamplers indicates whether this implementation allows descriptors with comparison samplers to be updated.
pointPolygons :: Bool
pointPolygons indicates whether this implementation supports https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#primsrast using a point https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#primsrast-polygonmode.
samplerMipLodBias :: Bool
samplerMipLodBias indicates whether this implementation supports setting a mipmap LOD bias value when creating a sampler.
separateStencilMaskRef :: Bool
separateStencilMaskRef indicates whether this implementation supports separate front and back https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#fragops-stencil reference values.
shaderSampleRateInterpolationFunctions :: Bool
shaderSampleRateInterpolationFunctions indicates whether this implementation supports fragment shaders which use the InterpolationFunction capability and the extended instructions InterpolateAtCentroid, InterpolateAtOffset, and InterpolateAtSample from the GLSL.std.450 extended instruction set. This member is only meaningful if the sampleRateShading feature is supported.
tessellationIsolines :: Bool
tessellationIsolines indicates whether this implementation supports isoline output from the https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#tessellation stage of a graphics pipeline. This member is only meaningful if tessellationShader are supported.
tessellationPointMode :: Bool
tessellationPointMode indicates whether this implementation supports point output from the https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#tessellation stage of a graphics pipeline. This member is only meaningful if tessellationShader are supported.
triangleFans :: Bool
triangleFans indicates whether this implementation supports https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#drawing-triangle-fans primitive topology.
vertexAttributeAccessBeyondStride :: Bool
vertexAttributeAccessBeyondStride indicates whether this implementation supports accessing a vertex input attribute beyond the stride of the corresponding vertex input binding.

Instances

Instances details

Storable PhysicalDevicePortabilitySubsetFeaturesKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_portability_subset Methods sizeOf :: PhysicalDevicePortabilitySubsetFeaturesKHR -> Int # alignment :: PhysicalDevicePortabilitySubsetFeaturesKHR -> Int # peekElemOff :: Ptr PhysicalDevicePortabilitySubsetFeaturesKHR -> Int -> IO PhysicalDevicePortabilitySubsetFeaturesKHR # pokeElemOff :: Ptr PhysicalDevicePortabilitySubsetFeaturesKHR -> Int -> PhysicalDevicePortabilitySubsetFeaturesKHR -> IO () # peekByteOff :: Ptr b -> Int -> IO PhysicalDevicePortabilitySubsetFeaturesKHR # pokeByteOff :: Ptr b -> Int -> PhysicalDevicePortabilitySubsetFeaturesKHR -> IO () # peek :: Ptr PhysicalDevicePortabilitySubsetFeaturesKHR -> IO PhysicalDevicePortabilitySubsetFeaturesKHR # poke :: Ptr PhysicalDevicePortabilitySubsetFeaturesKHR -> PhysicalDevicePortabilitySubsetFeaturesKHR -> IO () #
Show PhysicalDevicePortabilitySubsetFeaturesKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_portability_subset Methods showsPrec :: Int -> PhysicalDevicePortabilitySubsetFeaturesKHR -> ShowS # show :: PhysicalDevicePortabilitySubsetFeaturesKHR -> String # showList :: [PhysicalDevicePortabilitySubsetFeaturesKHR] -> ShowS #
Eq PhysicalDevicePortabilitySubsetFeaturesKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_portability_subset Methods (==) :: PhysicalDevicePortabilitySubsetFeaturesKHR -> PhysicalDevicePortabilitySubsetFeaturesKHR -> Bool # (/=) :: PhysicalDevicePortabilitySubsetFeaturesKHR -> PhysicalDevicePortabilitySubsetFeaturesKHR -> Bool #
FromCStruct PhysicalDevicePortabilitySubsetFeaturesKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_portability_subset Methods peekCStruct :: Ptr PhysicalDevicePortabilitySubsetFeaturesKHR -> IO PhysicalDevicePortabilitySubsetFeaturesKHR Source #
ToCStruct PhysicalDevicePortabilitySubsetFeaturesKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_portability_subset Methods withCStruct :: PhysicalDevicePortabilitySubsetFeaturesKHR -> (Ptr PhysicalDevicePortabilitySubsetFeaturesKHR -> IO b) -> IO b Source # pokeCStruct :: Ptr PhysicalDevicePortabilitySubsetFeaturesKHR -> PhysicalDevicePortabilitySubsetFeaturesKHR -> IO b -> IO b Source # withZeroCStruct :: (Ptr PhysicalDevicePortabilitySubsetFeaturesKHR -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr PhysicalDevicePortabilitySubsetFeaturesKHR -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero PhysicalDevicePortabilitySubsetFeaturesKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_portability_subset Methods zero :: PhysicalDevicePortabilitySubsetFeaturesKHR Source #

data PhysicalDevicePortabilitySubsetPropertiesKHR Source #

VkPhysicalDevicePortabilitySubsetPropertiesKHR - Structure describing additional properties supported by a portable implementation

Description

If the PhysicalDevicePortabilitySubsetPropertiesKHR structure is included in the pNext chain of the PhysicalDeviceProperties2 structure passed to getPhysicalDeviceProperties2, it is filled in with each corresponding implementation-dependent property.

Valid Usage (Implicit)

PhysicalDevicePortabilitySubsetPropertiesKHR
Fields minVertexInputBindingStrideAlignment :: Word32 `minVertexInputBindingStrideAlignment` indicates the minimum alignment for vertex input strides. `VertexInputBindingDescription`::`stride` must be a multiple of, and at least as large as, this value. The value must be a power of two.

Instances

Instances details

Storable PhysicalDevicePortabilitySubsetPropertiesKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_portability_subset Methods sizeOf :: PhysicalDevicePortabilitySubsetPropertiesKHR -> Int # alignment :: PhysicalDevicePortabilitySubsetPropertiesKHR -> Int # peekElemOff :: Ptr PhysicalDevicePortabilitySubsetPropertiesKHR -> Int -> IO PhysicalDevicePortabilitySubsetPropertiesKHR # pokeElemOff :: Ptr PhysicalDevicePortabilitySubsetPropertiesKHR -> Int -> PhysicalDevicePortabilitySubsetPropertiesKHR -> IO () # peekByteOff :: Ptr b -> Int -> IO PhysicalDevicePortabilitySubsetPropertiesKHR # pokeByteOff :: Ptr b -> Int -> PhysicalDevicePortabilitySubsetPropertiesKHR -> IO () # peek :: Ptr PhysicalDevicePortabilitySubsetPropertiesKHR -> IO PhysicalDevicePortabilitySubsetPropertiesKHR # poke :: Ptr PhysicalDevicePortabilitySubsetPropertiesKHR -> PhysicalDevicePortabilitySubsetPropertiesKHR -> IO () #
Show PhysicalDevicePortabilitySubsetPropertiesKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_portability_subset Methods showsPrec :: Int -> PhysicalDevicePortabilitySubsetPropertiesKHR -> ShowS # show :: PhysicalDevicePortabilitySubsetPropertiesKHR -> String # showList :: [PhysicalDevicePortabilitySubsetPropertiesKHR] -> ShowS #
Eq PhysicalDevicePortabilitySubsetPropertiesKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_portability_subset Methods (==) :: PhysicalDevicePortabilitySubsetPropertiesKHR -> PhysicalDevicePortabilitySubsetPropertiesKHR -> Bool # (/=) :: PhysicalDevicePortabilitySubsetPropertiesKHR -> PhysicalDevicePortabilitySubsetPropertiesKHR -> Bool #
FromCStruct PhysicalDevicePortabilitySubsetPropertiesKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_portability_subset Methods peekCStruct :: Ptr PhysicalDevicePortabilitySubsetPropertiesKHR -> IO PhysicalDevicePortabilitySubsetPropertiesKHR Source #
ToCStruct PhysicalDevicePortabilitySubsetPropertiesKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_portability_subset Methods withCStruct :: PhysicalDevicePortabilitySubsetPropertiesKHR -> (Ptr PhysicalDevicePortabilitySubsetPropertiesKHR -> IO b) -> IO b Source # pokeCStruct :: Ptr PhysicalDevicePortabilitySubsetPropertiesKHR -> PhysicalDevicePortabilitySubsetPropertiesKHR -> IO b -> IO b Source # withZeroCStruct :: (Ptr PhysicalDevicePortabilitySubsetPropertiesKHR -> IO b) -> IO b Source # pokeZeroCStruct :: Ptr PhysicalDevicePortabilitySubsetPropertiesKHR -> IO b -> IO b Source # cStructSize :: Int Source # cStructAlignment :: Int Source #
Zero PhysicalDevicePortabilitySubsetPropertiesKHR Source #
Instance details Defined in Vulkan.Extensions.VK_KHR_portability_subset Methods zero :: PhysicalDevicePortabilitySubsetPropertiesKHR Source #