Safe Haskell	Safe-Inferred
Language	Haskell2010

Vulkan.Extensions.VK_EXT_border_color_swizzle

Description

Name

VK_EXT_border_color_swizzle - device extension

VK_EXT_border_color_swizzle

Name String: VK_EXT_border_color_swizzle

Extension Type

Device extension

Registered Extension Number

412

Revision

1

Ratification Status

Not ratified

Extension and Version Dependencies

VK_EXT_custom_border_color

Special Uses

Contact

Piers Daniell @pdaniell-nv%0A*Here describe the issue or question you have about the VK_EXT_border_color_swizzle extension*

Other Extension Metadata

Last Modified Date: 2021-10-12

IP Status

No known IP claims.

Contributors

Graeme Leese, Broadcom
Jan-Harald Fredriksen, Arm
Ricardo Garcia, Igalia
Shahbaz Youssefi, Google
Stu Smith, AMD

Description

After the publication of VK_EXT_custom_border_color, it was discovered that some implementations had undefined behavior when combining a sampler that uses a custom border color with image views whose component mapping is not the identity mapping.

Since VK_EXT_custom_border_color has already shipped, this new extension VK_EXT_border_color_swizzle was created to define the interaction between custom border colors and non-identity image view swizzles, and provide a work-around for implementations that must pre-swizzle the sampler border color to match the image view component mapping it is combined with.

This extension also defines the behavior between samplers with an opaque black border color and image views with a non-identity component swizzle, which was previously left undefined.

New Structures

Extending PhysicalDeviceFeatures2, DeviceCreateInfo:
- PhysicalDeviceBorderColorSwizzleFeaturesEXT

Extending SamplerCreateInfo:
- SamplerBorderColorComponentMappingCreateInfoEXT

New Enum Constants

EXT_BORDER_COLOR_SWIZZLE_EXTENSION_NAME

Issues

None.

Version History

Revision 1, 2021-10-12 (Piers Daniell)
- Internal revisions.

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 SamplerBorderColorComponentMappingCreateInfoEXT = SamplerBorderColorComponentMappingCreateInfoEXT {
- components :: ComponentMapping
- srgb :: Bool
}
data PhysicalDeviceBorderColorSwizzleFeaturesEXT = PhysicalDeviceBorderColorSwizzleFeaturesEXT {
- borderColorSwizzle :: Bool
- borderColorSwizzleFromImage :: Bool
}
type EXT_BORDER_COLOR_SWIZZLE_SPEC_VERSION = 1
pattern EXT_BORDER_COLOR_SWIZZLE_SPEC_VERSION :: forall a. Integral a => a
type EXT_BORDER_COLOR_SWIZZLE_EXTENSION_NAME = "VK_EXT_border_color_swizzle"
pattern EXT_BORDER_COLOR_SWIZZLE_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a

Documentation

data SamplerBorderColorComponentMappingCreateInfoEXT Source #

VkSamplerBorderColorComponentMappingCreateInfoEXT - Structure specifying the component mapping of the border color

Description

The ComponentMapping components member describes a remapping from components of the border color to components of the vector returned by shader image instructions when the border color is used.

Valid Usage

The borderColorSwizzle feature must be enabled

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_SAMPLER_BORDER_COLOR_COMPONENT_MAPPING_CREATE_INFO_EXT

components must be a valid ComponentMapping structure

SamplerBorderColorComponentMappingCreateInfoEXT
Fields components :: ComponentMapping `components` is a `ComponentMapping` structure specifying a remapping of the border color components. srgb :: Bool `srgb` indicates that the sampler will be combined with an image view that has an image format which is sRGB encoded.

Instances

Instances details

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

data PhysicalDeviceBorderColorSwizzleFeaturesEXT Source #

VkPhysicalDeviceBorderColorSwizzleFeaturesEXT - Structure describing whether samplers with custom border colors require the component swizzle specified in order to have defined behavior

Members

This structure describes the following features:

Description

If the PhysicalDeviceBorderColorSwizzleFeaturesEXT 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. PhysicalDeviceBorderColorSwizzleFeaturesEXT can also be used in the pNext chain of DeviceCreateInfo to selectively enable these features.

Valid Usage (Implicit)

borderColorSwizzle :: Bool
borderColorSwizzle indicates that defined values are returned by sampled image operations when used with a sampler that uses a BORDER_COLOR_FLOAT_OPAQUE_BLACK, BORDER_COLOR_INT_OPAQUE_BLACK, BORDER_COLOR_FLOAT_CUSTOM_EXT, or BORDER_COLOR_INT_CUSTOM_EXT borderColor and an image view that uses a non-identity component mapping, when either borderColorSwizzleFromImage is enabled or the SamplerBorderColorComponentMappingCreateInfoEXT is specified.
borderColorSwizzleFromImage :: Bool
borderColorSwizzleFromImage indicates that the implementation will return the correct border color values from sampled image operations under the conditions expressed above, without the application having to specify the border color component mapping when creating the sampler object. If this feature bit is not set, applications can chain a SamplerBorderColorComponentMappingCreateInfoEXT structure when creating samplers for use with image views that do not have an identity swizzle and, when those samplers are combined with image views using the same component mapping, sampled image operations that use opaque black or custom border colors will return the correct border color values.

Instances

Instances details

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