vulkan-3.8.1: Bindings to the Vulkan graphics API.
Safe HaskellNone
LanguageHaskell2010

Vulkan.Extensions.VK_KHR_swapchain_mutable_format

Description

Name

VK_KHR_swapchain_mutable_format - device extension

VK_KHR_swapchain_mutable_format

Name String
VK_KHR_swapchain_mutable_format
Extension Type
Device extension
Registered Extension Number
201
Revision
1
Extension and Version Dependencies
  • Requires Vulkan 1.0
  • Requires VK_KHR_swapchain
  • Requires VK_KHR_maintenance2
  • Requires VK_KHR_image_format_list
Contact

Other Extension Metadata

Last Modified Date
2018-03-28
IP Status
No known IP claims.
Contributors
  • Jason Ekstrand, Intel
  • Jan-Harald Fredriksen, ARM
  • Jesse Hall, Google
  • Daniel Rakos, AMD
  • Ray Smith, ARM

Description

This extension allows processing of swapchain images as different formats to that used by the window system, which is particularly useful for switching between sRGB and linear RGB formats.

It adds a new swapchain creation flag that enables creating image views from presentable images with a different format than the one used to create the swapchain.

New Enum Constants

Issues

1) Are there any new capabilities needed?

RESOLVED: No. It is expected that all implementations exposing this extension support swapchain image format mutability.

2) Do we need a separate VK_SWAPCHAIN_CREATE_EXTENDED_USAGE_BIT_KHR?

RESOLVED: No. This extension requires VK_KHR_maintenance2 and presentable images of swapchains created with SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR are created internally in a way equivalent to specifying both IMAGE_CREATE_MUTABLE_FORMAT_BIT and IMAGE_CREATE_EXTENDED_USAGE_BIT_KHR.

3) Do we need a separate structure to allow specifying an image format list for swapchains?

RESOLVED: No. We simply use the same ImageFormatListCreateInfoKHR structure introduced by VK_KHR_image_format_list. The structure is required to be included in the pNext chain of SwapchainCreateInfoKHR for swapchains created with SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR.

Version History

  • Revision 1, 2018-03-28 (Daniel Rakos)

    • Internal revisions.

See Also

No cross-references are available

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

Documentation

type KHR_SWAPCHAIN_MUTABLE_FORMAT_SPEC_VERSION = 1 Source #

pattern KHR_SWAPCHAIN_MUTABLE_FORMAT_SPEC_VERSION :: forall a. Integral a => a Source #

type KHR_SWAPCHAIN_MUTABLE_FORMAT_EXTENSION_NAME = "VK_KHR_swapchain_mutable_format" Source #

pattern KHR_SWAPCHAIN_MUTABLE_FORMAT_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a Source #

newtype SwapchainCreateFlagBitsKHR Source #

VkSwapchainCreateFlagBitsKHR - Bitmask controlling swapchain creation

See Also

SwapchainCreateFlagsKHR

Constructors

SwapchainCreateFlagBitsKHR Flags 

Bundled Patterns

pattern SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR :: SwapchainCreateFlagBitsKHR

SWAPCHAIN_CREATE_MUTABLE_FORMAT_BIT_KHR specifies that the images of the swapchain can be used to create a ImageView with a different format than what the swapchain was created with. The list of allowed image view formats are specified by adding a ImageFormatListCreateInfo structure to the pNext chain of SwapchainCreateInfoKHR. In addition, this flag also specifies that the swapchain can be created with usage flags that are not supported for the format the swapchain is created with but are supported for at least one of the allowed image view formats.

pattern SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR :: SwapchainCreateFlagBitsKHR

SWAPCHAIN_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT_KHR specifies that images created from the swapchain (i.e. with the swapchain member of ImageSwapchainCreateInfoKHR set to this swapchain’s handle) must use IMAGE_CREATE_SPLIT_INSTANCE_BIND_REGIONS_BIT.

pattern SWAPCHAIN_CREATE_PROTECTED_BIT_KHR :: SwapchainCreateFlagBitsKHR

SWAPCHAIN_CREATE_PROTECTED_BIT_KHR specifies that images created from the swapchain are protected images.

Instances

Instances details
Eq SwapchainCreateFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

(==) :: SwapchainCreateFlagBitsKHR -> SwapchainCreateFlagBitsKHR -> Bool #

(/=) :: SwapchainCreateFlagBitsKHR -> SwapchainCreateFlagBitsKHR -> Bool #

Ord SwapchainCreateFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

compare :: SwapchainCreateFlagBitsKHR -> SwapchainCreateFlagBitsKHR -> Ordering #

(<) :: SwapchainCreateFlagBitsKHR -> SwapchainCreateFlagBitsKHR -> Bool #

(<=) :: SwapchainCreateFlagBitsKHR -> SwapchainCreateFlagBitsKHR -> Bool #

(>) :: SwapchainCreateFlagBitsKHR -> SwapchainCreateFlagBitsKHR -> Bool #

(>=) :: SwapchainCreateFlagBitsKHR -> SwapchainCreateFlagBitsKHR -> Bool #

max :: SwapchainCreateFlagBitsKHR -> SwapchainCreateFlagBitsKHR -> SwapchainCreateFlagBitsKHR #

min :: SwapchainCreateFlagBitsKHR -> SwapchainCreateFlagBitsKHR -> SwapchainCreateFlagBitsKHR #

Read SwapchainCreateFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

readsPrec :: Int -> ReadS SwapchainCreateFlagBitsKHR #

readList :: ReadS [SwapchainCreateFlagBitsKHR] #

readPrec :: ReadPrec SwapchainCreateFlagBitsKHR #

readListPrec :: ReadPrec [SwapchainCreateFlagBitsKHR] #

Show SwapchainCreateFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

showsPrec :: Int -> SwapchainCreateFlagBitsKHR -> ShowS #

show :: SwapchainCreateFlagBitsKHR -> String #

showList :: [SwapchainCreateFlagBitsKHR] -> ShowS #

Storable SwapchainCreateFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

sizeOf :: SwapchainCreateFlagBitsKHR -> Int #

alignment :: SwapchainCreateFlagBitsKHR -> Int #

peekElemOff :: Ptr SwapchainCreateFlagBitsKHR -> Int -> IO SwapchainCreateFlagBitsKHR #

pokeElemOff :: Ptr SwapchainCreateFlagBitsKHR -> Int -> SwapchainCreateFlagBitsKHR -> IO () #

peekByteOff :: Ptr b -> Int -> IO SwapchainCreateFlagBitsKHR #

pokeByteOff :: Ptr b -> Int -> SwapchainCreateFlagBitsKHR -> IO () #

peek :: Ptr SwapchainCreateFlagBitsKHR -> IO SwapchainCreateFlagBitsKHR #

poke :: Ptr SwapchainCreateFlagBitsKHR -> SwapchainCreateFlagBitsKHR -> IO () #

Bits SwapchainCreateFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

(.&.) :: SwapchainCreateFlagBitsKHR -> SwapchainCreateFlagBitsKHR -> SwapchainCreateFlagBitsKHR #

(.|.) :: SwapchainCreateFlagBitsKHR -> SwapchainCreateFlagBitsKHR -> SwapchainCreateFlagBitsKHR #

xor :: SwapchainCreateFlagBitsKHR -> SwapchainCreateFlagBitsKHR -> SwapchainCreateFlagBitsKHR #

complement :: SwapchainCreateFlagBitsKHR -> SwapchainCreateFlagBitsKHR #

shift :: SwapchainCreateFlagBitsKHR -> Int -> SwapchainCreateFlagBitsKHR #

rotate :: SwapchainCreateFlagBitsKHR -> Int -> SwapchainCreateFlagBitsKHR #

zeroBits :: SwapchainCreateFlagBitsKHR #

bit :: Int -> SwapchainCreateFlagBitsKHR #

setBit :: SwapchainCreateFlagBitsKHR -> Int -> SwapchainCreateFlagBitsKHR #

clearBit :: SwapchainCreateFlagBitsKHR -> Int -> SwapchainCreateFlagBitsKHR #

complementBit :: SwapchainCreateFlagBitsKHR -> Int -> SwapchainCreateFlagBitsKHR #

testBit :: SwapchainCreateFlagBitsKHR -> Int -> Bool #

bitSizeMaybe :: SwapchainCreateFlagBitsKHR -> Maybe Int #

bitSize :: SwapchainCreateFlagBitsKHR -> Int #

isSigned :: SwapchainCreateFlagBitsKHR -> Bool #

shiftL :: SwapchainCreateFlagBitsKHR -> Int -> SwapchainCreateFlagBitsKHR #

unsafeShiftL :: SwapchainCreateFlagBitsKHR -> Int -> SwapchainCreateFlagBitsKHR #

shiftR :: SwapchainCreateFlagBitsKHR -> Int -> SwapchainCreateFlagBitsKHR #

unsafeShiftR :: SwapchainCreateFlagBitsKHR -> Int -> SwapchainCreateFlagBitsKHR #

rotateL :: SwapchainCreateFlagBitsKHR -> Int -> SwapchainCreateFlagBitsKHR #

rotateR :: SwapchainCreateFlagBitsKHR -> Int -> SwapchainCreateFlagBitsKHR #

popCount :: SwapchainCreateFlagBitsKHR -> Int #

FiniteBits SwapchainCreateFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

finiteBitSize :: SwapchainCreateFlagBitsKHR -> Int #

countLeadingZeros :: SwapchainCreateFlagBitsKHR -> Int #

countTrailingZeros :: SwapchainCreateFlagBitsKHR -> Int #

Zero SwapchainCreateFlagBitsKHR Source # 
Instance details

Defined in Vulkan.Extensions.VK_KHR_swapchain

Methods

zero :: SwapchainCreateFlagBitsKHR Source #

type SwapchainCreateFlagsKHR = SwapchainCreateFlagBitsKHR Source #