Graphics.Vulkan.Extensions.VK_AMD_display_native_hdr

Documentation

setLocalDimmingAMD :: forall io. MonadIO io => Device -> SwapchainKHR -> ("localDimmingEnable" ::: Bool) -> io ()

vkSetLocalDimmingAMD - Set Local Dimming

Parameters

• device is the device associated with swapChain.

• swapChain handle to enable local dimming.
• localDimmingEnable specifies whether local dimming is enabled for the swapchain.

Valid Usage (Implicit)

• device must be a valid Device handle

• swapChain must be a valid SwapchainKHR handle
• Both of device, and swapChain must have been created, allocated, or retrieved from the same Instance

Valid Usage

• It is only valid to call setLocalDimmingAMD if DisplayNativeHdrSurfaceCapabilitiesAMD::localDimmingSupport is supported

See Also

Bool32, Device, SwapchainKHR

data DisplayNativeHdrSurfaceCapabilitiesAMD

VkDisplayNativeHdrSurfaceCapabilitiesAMD - Structure describing display native HDR specific capabilities of a surface

Valid Usage (Implicit)

See Also

Bool32, StructureType

Constructors

DisplayNativeHdrSurfaceCapabilitiesAMD

Fields

• localDimmingSupport :: Bool

  localDimmingSupport specifies whether the surface supports local dimming. If this is TRUE, SwapchainDisplayNativeHdrCreateInfoAMD can be used to explicitly enable or disable local dimming for the surface. Local dimming may also be overriden by setLocalDimmingAMD during the lifetime of the swapchain.

Instances

Show DisplayNativeHdrSurfaceCapabilitiesAMD

Defined in Graphics.Vulkan.Extensions.VK_AMD_display_native_hdr

Methods

showsPrec :: Int -> DisplayNativeHdrSurfaceCapabilitiesAMD -> ShowS

show :: DisplayNativeHdrSurfaceCapabilitiesAMD -> String

showList :: [DisplayNativeHdrSurfaceCapabilitiesAMD] -> ShowS

Storable DisplayNativeHdrSurfaceCapabilitiesAMD

Defined in Graphics.Vulkan.Extensions.VK_AMD_display_native_hdr

Methods

sizeOf :: DisplayNativeHdrSurfaceCapabilitiesAMD -> Int

alignment :: DisplayNativeHdrSurfaceCapabilitiesAMD -> Int

peekElemOff :: Ptr DisplayNativeHdrSurfaceCapabilitiesAMD -> Int -> IO DisplayNativeHdrSurfaceCapabilitiesAMD

pokeElemOff :: Ptr DisplayNativeHdrSurfaceCapabilitiesAMD -> Int -> DisplayNativeHdrSurfaceCapabilitiesAMD -> IO ()

peekByteOff :: Ptr b -> Int -> IO DisplayNativeHdrSurfaceCapabilitiesAMD

pokeByteOff :: Ptr b -> Int -> DisplayNativeHdrSurfaceCapabilitiesAMD -> IO ()

peek :: Ptr DisplayNativeHdrSurfaceCapabilitiesAMD -> IO DisplayNativeHdrSurfaceCapabilitiesAMD

poke :: Ptr DisplayNativeHdrSurfaceCapabilitiesAMD -> DisplayNativeHdrSurfaceCapabilitiesAMD -> IO ()

FromCStruct DisplayNativeHdrSurfaceCapabilitiesAMD

Defined in Graphics.Vulkan.Extensions.VK_AMD_display_native_hdr

Methods

peekCStruct :: Ptr DisplayNativeHdrSurfaceCapabilitiesAMD -> IO DisplayNativeHdrSurfaceCapabilitiesAMD

ToCStruct DisplayNativeHdrSurfaceCapabilitiesAMD

Defined in Graphics.Vulkan.Extensions.VK_AMD_display_native_hdr

Methods

withCStruct :: DisplayNativeHdrSurfaceCapabilitiesAMD -> (Ptr DisplayNativeHdrSurfaceCapabilitiesAMD -> IO b) -> IO b

pokeCStruct :: Ptr DisplayNativeHdrSurfaceCapabilitiesAMD -> DisplayNativeHdrSurfaceCapabilitiesAMD -> IO b -> IO b

withZeroCStruct :: (Ptr DisplayNativeHdrSurfaceCapabilitiesAMD -> IO b) -> IO b

pokeZeroCStruct :: Ptr DisplayNativeHdrSurfaceCapabilitiesAMD -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero DisplayNativeHdrSurfaceCapabilitiesAMD

Defined in Graphics.Vulkan.Extensions.VK_AMD_display_native_hdr

Methods

zero :: DisplayNativeHdrSurfaceCapabilitiesAMD

data SwapchainDisplayNativeHdrCreateInfoAMD

VkSwapchainDisplayNativeHdrCreateInfoAMD - Structure specifying display native HDR parameters of a newly created swapchain object

Description

If the pNext chain of SwapchainCreateInfoKHR does not include this structure, the default value for localDimmingEnable is TRUE, meaning local dimming is initially enabled for the swapchain.

Valid Usage (Implicit)

• sType must be STRUCTURE_TYPE_SWAPCHAIN_DISPLAY_NATIVE_HDR_CREATE_INFO_AMD

Valid Usage

• It is only valid to set localDimmingEnable to TRUE if DisplayNativeHdrSurfaceCapabilitiesAMD::localDimmingSupport is supported

See Also

Bool32, StructureType

Constructors

SwapchainDisplayNativeHdrCreateInfoAMD

Fields

• localDimmingEnable :: Bool

  localDimmingEnable specifies whether local dimming is enabled for the swapchain.

Instances

Show SwapchainDisplayNativeHdrCreateInfoAMD

Defined in Graphics.Vulkan.Extensions.VK_AMD_display_native_hdr

Methods

showsPrec :: Int -> SwapchainDisplayNativeHdrCreateInfoAMD -> ShowS

show :: SwapchainDisplayNativeHdrCreateInfoAMD -> String

showList :: [SwapchainDisplayNativeHdrCreateInfoAMD] -> ShowS

Storable SwapchainDisplayNativeHdrCreateInfoAMD

Defined in Graphics.Vulkan.Extensions.VK_AMD_display_native_hdr

Methods

sizeOf :: SwapchainDisplayNativeHdrCreateInfoAMD -> Int

alignment :: SwapchainDisplayNativeHdrCreateInfoAMD -> Int

peekElemOff :: Ptr SwapchainDisplayNativeHdrCreateInfoAMD -> Int -> IO SwapchainDisplayNativeHdrCreateInfoAMD

pokeElemOff :: Ptr SwapchainDisplayNativeHdrCreateInfoAMD -> Int -> SwapchainDisplayNativeHdrCreateInfoAMD -> IO ()

peekByteOff :: Ptr b -> Int -> IO SwapchainDisplayNativeHdrCreateInfoAMD

pokeByteOff :: Ptr b -> Int -> SwapchainDisplayNativeHdrCreateInfoAMD -> IO ()

peek :: Ptr SwapchainDisplayNativeHdrCreateInfoAMD -> IO SwapchainDisplayNativeHdrCreateInfoAMD

poke :: Ptr SwapchainDisplayNativeHdrCreateInfoAMD -> SwapchainDisplayNativeHdrCreateInfoAMD -> IO ()

FromCStruct SwapchainDisplayNativeHdrCreateInfoAMD

Defined in Graphics.Vulkan.Extensions.VK_AMD_display_native_hdr

Methods

peekCStruct :: Ptr SwapchainDisplayNativeHdrCreateInfoAMD -> IO SwapchainDisplayNativeHdrCreateInfoAMD

ToCStruct SwapchainDisplayNativeHdrCreateInfoAMD

Defined in Graphics.Vulkan.Extensions.VK_AMD_display_native_hdr

Methods

withCStruct :: SwapchainDisplayNativeHdrCreateInfoAMD -> (Ptr SwapchainDisplayNativeHdrCreateInfoAMD -> IO b) -> IO b

pokeCStruct :: Ptr SwapchainDisplayNativeHdrCreateInfoAMD -> SwapchainDisplayNativeHdrCreateInfoAMD -> IO b -> IO b

withZeroCStruct :: (Ptr SwapchainDisplayNativeHdrCreateInfoAMD -> IO b) -> IO b

pokeZeroCStruct :: Ptr SwapchainDisplayNativeHdrCreateInfoAMD -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

Zero SwapchainDisplayNativeHdrCreateInfoAMD

Defined in Graphics.Vulkan.Extensions.VK_AMD_display_native_hdr

Methods

zero :: SwapchainDisplayNativeHdrCreateInfoAMD

type AMD_DISPLAY_NATIVE_HDR_SPEC_VERSION = 1

pattern AMD_DISPLAY_NATIVE_HDR_SPEC_VERSION :: forall a. Integral a => a

type AMD_DISPLAY_NATIVE_HDR_EXTENSION_NAME = "VK_AMD_display_native_hdr"

pattern AMD_DISPLAY_NATIVE_HDR_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a

newtype SwapchainKHR

VkSwapchainKHR - Opaque handle to a swapchain object

Description

A swapchain is an abstraction for an array of presentable images that are associated with a surface. The presentable images are represented by Image objects created by the platform. One image (which can be an array image for multiview/stereoscopic-3D surfaces) is displayed at a time, but multiple images can be queued for presentation. An application renders to the image, and then queues the image for presentation to the surface.

A native window cannot be associated with more than one non-retired swapchain at a time. Further, swapchains cannot be created for native windows that have a non-Vulkan graphics API surface associated with them.

Note

The presentation engine is an abstraction for the platform’s compositor or display engine.

The presentation engine may be synchronous or asynchronous with respect to the application and/or logical device.

Some implementations may use the device’s graphics queue or dedicated presentation hardware to perform presentation.

The presentable images of a swapchain are owned by the presentation engine. An application can acquire use of a presentable image from the presentation engine. Use of a presentable image must occur only after the image is returned by acquireNextImageKHR, and before it is presented by queuePresentKHR. This includes transitioning the image layout and rendering commands.

An application can acquire use of a presentable image with acquireNextImageKHR. After acquiring a presentable image and before modifying it, the application must use a synchronization primitive to ensure that the presentation engine has finished reading from the image. The application can then transition the image’s layout, queue rendering commands to it, etc. Finally, the application presents the image with queuePresentKHR, which releases the acquisition of the image.

The presentation engine controls the order in which presentable images are acquired for use by the application.

Note

This allows the platform to handle situations which require out-of-order return of images after presentation. At the same time, it allows the application to generate command buffers referencing all of the images in the swapchain at initialization time, rather than in its main loop.

See Also

AcquireNextImageInfoKHR, BindImageMemorySwapchainInfoKHR, ImageSwapchainCreateInfoKHR, PresentInfoKHR, SwapchainCreateInfoKHR, acquireFullScreenExclusiveModeEXT, acquireNextImageKHR, createSharedSwapchainsKHR, createSwapchainKHR, destroySwapchainKHR, getPastPresentationTimingGOOGLE, getRefreshCycleDurationGOOGLE, getSwapchainCounterEXT, getSwapchainImagesKHR, getSwapchainStatusKHR, releaseFullScreenExclusiveModeEXT, setHdrMetadataEXT, setLocalDimmingAMD

Constructors

SwapchainKHR Word64

Instances

Eq SwapchainKHR

Defined in Graphics.Vulkan.Extensions.Handles

Methods

(==) :: SwapchainKHR -> SwapchainKHR -> Bool

(/=) :: SwapchainKHR -> SwapchainKHR -> Bool

Ord SwapchainKHR

Defined in Graphics.Vulkan.Extensions.Handles

Methods

compare :: SwapchainKHR -> SwapchainKHR -> Ordering

(<) :: SwapchainKHR -> SwapchainKHR -> Bool

(<=) :: SwapchainKHR -> SwapchainKHR -> Bool

(>) :: SwapchainKHR -> SwapchainKHR -> Bool

(>=) :: SwapchainKHR -> SwapchainKHR -> Bool

max :: SwapchainKHR -> SwapchainKHR -> SwapchainKHR

min :: SwapchainKHR -> SwapchainKHR -> SwapchainKHR

Show SwapchainKHR

Defined in Graphics.Vulkan.Extensions.Handles

Methods

showsPrec :: Int -> SwapchainKHR -> ShowS

show :: SwapchainKHR -> String

showList :: [SwapchainKHR] -> ShowS

Storable SwapchainKHR

Defined in Graphics.Vulkan.Extensions.Handles

Methods

sizeOf :: SwapchainKHR -> Int

alignment :: SwapchainKHR -> Int

peekElemOff :: Ptr SwapchainKHR -> Int -> IO SwapchainKHR

pokeElemOff :: Ptr SwapchainKHR -> Int -> SwapchainKHR -> IO ()

peekByteOff :: Ptr b -> Int -> IO SwapchainKHR

pokeByteOff :: Ptr b -> Int -> SwapchainKHR -> IO ()

peek :: Ptr SwapchainKHR -> IO SwapchainKHR

poke :: Ptr SwapchainKHR -> SwapchainKHR -> IO ()

Zero SwapchainKHR

Defined in Graphics.Vulkan.Extensions.Handles

Methods

zero :: SwapchainKHR

IsHandle SwapchainKHR

Defined in Graphics.Vulkan.Extensions.Handles

newtype ColorSpaceKHR

VkColorSpaceKHR - supported color space of the presentation engine

Description

Note

In the initial release of the VK_KHR_surface and VK_KHR_swapchain extensions, the token VK_COLORSPACE_SRGB_NONLINEAR_KHR was used. Starting in the 2016-05-13 updates to the extension branches, matching release 1.0.13 of the core API specification, COLOR_SPACE_SRGB_NONLINEAR_KHR is used instead for consistency with Vulkan naming rules. The older enum is still available for backwards compatibility.

Note

In older versions of this extension COLOR_SPACE_DISPLAY_P3_LINEAR_EXT was misnamed COLOR_SPACE_DCI_P3_LINEAR_EXT. This has been updated to indicate that it uses RGB color encoding, not XYZ. The old name is deprecated but is maintained for backwards compatibility.

The color components of non-linear color space swap chain images must have had the appropriate transfer function applied. The color space selected for the swap chain image will not affect the processing of data written into the image by the implementation. Vulkan requires that all implementations support the sRGB transfer function by use of an SRGB pixel format. Other transfer functions, such as SMPTE 170M or SMPTE2084, can be performed by the application shader. This extension defines enums for ColorSpaceKHR that correspond to the following color spaces:

Name	Red Primary	Green Primary	Blue Primary	White-point	Transfer function
DCI-P3	1.000, 0.000	0.000, 1.000	0.000, 0.000	0.3333, 0.3333	DCI P3
Display-P3	0.680, 0.320	0.265, 0.690	0.150, 0.060	0.3127, 0.3290 (D65)	Display-P3
BT709	0.640, 0.330	0.300, 0.600	0.150, 0.060	0.3127, 0.3290 (D65)	ITU (SMPTE 170M)
sRGB	0.640, 0.330	0.300, 0.600	0.150, 0.060	0.3127, 0.3290 (D65)	sRGB
extended sRGB	0.640, 0.330	0.300, 0.600	0.150, 0.060	0.3127, 0.3290 (D65)	extended sRGB
HDR10_ST2084	0.708, 0.292	0.170, 0.797	0.131, 0.046	0.3127, 0.3290 (D65)	ST2084 PQ
DOLBYVISION	0.708, 0.292	0.170, 0.797	0.131, 0.046	0.3127, 0.3290 (D65)	ST2084 PQ
HDR10_HLG	0.708, 0.292	0.170, 0.797	0.131, 0.046	0.3127, 0.3290 (D65)	HLG
AdobeRGB	0.640, 0.330	0.210, 0.710	0.150, 0.060	0.3127, 0.3290 (D65)	AdobeRGB

Color Spaces and Attributes

The transfer functions are described in the “Transfer Functions” chapter of the Khronos Data Format Specification.

Except Display-P3 OETF, which is:

[begin{aligned} E & = begin{cases} 1.055 times L^{1 over 2.4} - 0.055 & text{for} 0.0030186 leq L leq 1 -- 12.92 times L & text{for} 0 leq L < 0.0030186

Constructors

ColorSpaceKHR Int32

Bundled Patterns

pattern COLOR_SPACE_SRGB_NONLINEAR_KHR :: ColorSpaceKHR

COLOR_SPACE_SRGB_NONLINEAR_KHR specifies support for the sRGB color space.

pattern COLOR_SPACE_DISPLAY_NATIVE_AMD :: ColorSpaceKHR

COLOR_SPACE_DISPLAY_NATIVE_AMD specifies support for the display’s native color space. This matches the color space expectations of AMD’s FreeSync2 standard, for displays supporting it.

pattern COLOR_SPACE_EXTENDED_SRGB_NONLINEAR_EXT :: ColorSpaceKHR

COLOR_SPACE_EXTENDED_SRGB_NONLINEAR_EXT specifies support for the extended sRGB color space to be displayed using an sRGB EOTF.

pattern COLOR_SPACE_PASS_THROUGH_EXT :: ColorSpaceKHR

COLOR_SPACE_PASS_THROUGH_EXT specifies that color components are used “as is”. This is intended to allow applications to supply data for color spaces not described here.

pattern COLOR_SPACE_ADOBERGB_NONLINEAR_EXT :: ColorSpaceKHR

COLOR_SPACE_ADOBERGB_NONLINEAR_EXT specifies support for the AdobeRGB color space to be displayed using the Gamma 2.2 EOTF.

pattern COLOR_SPACE_ADOBERGB_LINEAR_EXT :: ColorSpaceKHR

COLOR_SPACE_ADOBERGB_LINEAR_EXT specifies support for the AdobeRGB color space to be displayed using a linear EOTF.

pattern COLOR_SPACE_HDR10_HLG_EXT :: ColorSpaceKHR

COLOR_SPACE_HDR10_HLG_EXT specifies support for the HDR10 (BT2020 color space) to be displayed using the Hybrid Log Gamma (HLG) EOTF.

pattern COLOR_SPACE_DOLBYVISION_EXT :: ColorSpaceKHR

COLOR_SPACE_DOLBYVISION_EXT specifies support for the Dolby Vision (BT2020 color space), proprietary encoding, to be displayed using the SMPTE ST2084 EOTF.

pattern COLOR_SPACE_HDR10_ST2084_EXT :: ColorSpaceKHR

COLOR_SPACE_HDR10_ST2084_EXT specifies support for the HDR10 (BT2020 color) space to be displayed using the SMPTE ST2084 Perceptual Quantizer (PQ) EOTF.

pattern COLOR_SPACE_BT2020_LINEAR_EXT :: ColorSpaceKHR

COLOR_SPACE_BT2020_LINEAR_EXT specifies support for the BT2020 color space to be displayed using a linear EOTF.

pattern COLOR_SPACE_BT709_NONLINEAR_EXT :: ColorSpaceKHR

COLOR_SPACE_BT709_NONLINEAR_EXT specifies support for the BT709 color space to be displayed using the SMPTE 170M EOTF.

pattern COLOR_SPACE_BT709_LINEAR_EXT :: ColorSpaceKHR

COLOR_SPACE_BT709_LINEAR_EXT specifies support for the BT709 color space to be displayed using a linear EOTF.

pattern COLOR_SPACE_DCI_P3_NONLINEAR_EXT :: ColorSpaceKHR

COLOR_SPACE_DCI_P3_NONLINEAR_EXT specifies support for the DCI-P3 color space to be displayed using the DCI-P3 EOTF. Note that values in such an image are interpreted as XYZ encoded color data by the presentation engine.

pattern COLOR_SPACE_DISPLAY_P3_LINEAR_EXT :: ColorSpaceKHR

COLOR_SPACE_DISPLAY_P3_LINEAR_EXT specifies support for the Display-P3 color space to be displayed using a linear EOTF.

pattern COLOR_SPACE_EXTENDED_SRGB_LINEAR_EXT :: ColorSpaceKHR

COLOR_SPACE_EXTENDED_SRGB_LINEAR_EXT specifies support for the extended sRGB color space to be displayed using a linear EOTF.

pattern COLOR_SPACE_DISPLAY_P3_NONLINEAR_EXT :: ColorSpaceKHR

COLOR_SPACE_DISPLAY_P3_NONLINEAR_EXT specifies support for the Display-P3 color space to be displayed using an sRGB-like EOTF (defined below).

Instances

Eq ColorSpaceKHR

Defined in Graphics.Vulkan.Extensions.VK_EXT_swapchain_colorspace

Methods

(==) :: ColorSpaceKHR -> ColorSpaceKHR -> Bool

(/=) :: ColorSpaceKHR -> ColorSpaceKHR -> Bool

Ord ColorSpaceKHR

Defined in Graphics.Vulkan.Extensions.VK_EXT_swapchain_colorspace

Methods

compare :: ColorSpaceKHR -> ColorSpaceKHR -> Ordering

(<) :: ColorSpaceKHR -> ColorSpaceKHR -> Bool

(<=) :: ColorSpaceKHR -> ColorSpaceKHR -> Bool

(>) :: ColorSpaceKHR -> ColorSpaceKHR -> Bool

(>=) :: ColorSpaceKHR -> ColorSpaceKHR -> Bool

max :: ColorSpaceKHR -> ColorSpaceKHR -> ColorSpaceKHR

min :: ColorSpaceKHR -> ColorSpaceKHR -> ColorSpaceKHR

Read ColorSpaceKHR

Defined in Graphics.Vulkan.Extensions.VK_EXT_swapchain_colorspace

Methods

readsPrec :: Int -> ReadS ColorSpaceKHR

readList :: ReadS [ColorSpaceKHR]

readPrec :: ReadPrec ColorSpaceKHR

readListPrec :: ReadPrec [ColorSpaceKHR]

Show ColorSpaceKHR

Defined in Graphics.Vulkan.Extensions.VK_EXT_swapchain_colorspace

Methods

showsPrec :: Int -> ColorSpaceKHR -> ShowS

show :: ColorSpaceKHR -> String

showList :: [ColorSpaceKHR] -> ShowS

Storable ColorSpaceKHR

Defined in Graphics.Vulkan.Extensions.VK_EXT_swapchain_colorspace

Methods

sizeOf :: ColorSpaceKHR -> Int

alignment :: ColorSpaceKHR -> Int

peekElemOff :: Ptr ColorSpaceKHR -> Int -> IO ColorSpaceKHR

pokeElemOff :: Ptr ColorSpaceKHR -> Int -> ColorSpaceKHR -> IO ()

peekByteOff :: Ptr b -> Int -> IO ColorSpaceKHR

pokeByteOff :: Ptr b -> Int -> ColorSpaceKHR -> IO ()

peek :: Ptr ColorSpaceKHR -> IO ColorSpaceKHR

poke :: Ptr ColorSpaceKHR -> ColorSpaceKHR -> IO ()

Zero ColorSpaceKHR

Defined in Graphics.Vulkan.Extensions.VK_EXT_swapchain_colorspace

Methods

zero :: ColorSpaceKHR