HORIZON HASKELLDocslts/ghc-10.0.x8174fa42026-10-11Search names, modules, packages, or :: a typeCtrl K

GHC 10.0.0.20260917 · lts/ghc-10.0.x · 8174fa4 · 2026-10-11

Modulevulkan-3.27GHC2021

Vulkan.Extensions.VK_KHR_get_display_properties2

Name

VK_KHR_get_display_properties2 - instance extension

VK_KHR_get_display_properties2

Name String

VK_KHR_get_display_properties2

Extension Type

Instance extension

Registered Extension Number

122

Revision

1

Ratification Status

Ratified

Extension and Version Dependencies

VK_KHR_display

Contact

Other Extension Metadata

Last Modified Date

2017-02-21

IP Status

No known IP claims.

Contributors

  • Ian Elliott, Google

  • James Jones, NVIDIA

Description

This extension provides new queries for device display properties and capabilities that can be easily extended by other extensions, without introducing any further queries. This extension can be considered the VK_KHR_display equivalent of the VK_KHR_get_physical_device_properties2 extension.

New Commands

New Structures

New Enum Constants

Issues

1) What should this extension be named?

RESOLVED: VK_KHR_get_display_properties2. Other alternatives:

  • VK_KHR_display2

  • One extension, combined with VK_KHR_surface_capabilites2.

2) Should extensible input structs be added for these new functions:

RESOLVED:

3) Should additional display query functions be extended?

RESOLVED:

Version History

  • Revision 1, 2017-02-21 (James Jones)

    • Initial draft.

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.

  • 18 types
  • 4 values
  • Packagevulkan-3.27
  • Exports37
  • LanguageGHC2021
  • LicenceBSD-3-Clause
  • SourceVK_KHR_get_display_properties2.hs
valuegetPhysicalDeviceDisplayProperties2KHR
  1. :: MonadIO io
  2. => PhysicalDevice

    physicalDevice is a physical device.

  3. -> io (Result, "properties" ::: Vector DisplayProperties2KHR)
#

vkGetPhysicalDeviceDisplayProperties2KHR - Query information about the available displays

Description

getPhysicalDeviceDisplayProperties2KHR behaves similarly to getPhysicalDeviceDisplayPropertiesKHR, with the ability to return extended information via chained output structures.

Valid Usage (Implicit)

  • pPropertyCount must be a valid pointer to a uint32_t value

  • If the value referenced by pPropertyCount is not 0, and pProperties is not NULL, pProperties must be a valid pointer to an array of pPropertyCount DisplayProperties2KHR structures

Return Codes

Success
Failure

See Also

VK_KHR_get_display_properties2, DisplayProperties2KHR, PhysicalDevice

valuegetPhysicalDeviceDisplayPlaneProperties2KHR
  1. :: MonadIO io
  2. => PhysicalDevice

    physicalDevice is a physical device.

  3. -> io (Result, "properties" ::: Vector DisplayPlaneProperties2KHR)
#

vkGetPhysicalDeviceDisplayPlaneProperties2KHR - Query information about the available display planes.

Description

getPhysicalDeviceDisplayPlaneProperties2KHR behaves similarly to getPhysicalDeviceDisplayPlanePropertiesKHR, with the ability to return extended information via chained output structures.

Valid Usage (Implicit)

  • pPropertyCount must be a valid pointer to a uint32_t value

  • If the value referenced by pPropertyCount is not 0, and pProperties is not NULL, pProperties must be a valid pointer to an array of pPropertyCount DisplayPlaneProperties2KHR structures

Return Codes

Success
Failure

See Also

VK_KHR_get_display_properties2, DisplayPlaneProperties2KHR, PhysicalDevice

valuegetDisplayModeProperties2KHR
  1. :: (Extendss DisplayModeProperties2KHR a, PokeChain a, PeekChain a, MonadIO io)
  2. => PhysicalDevice

    physicalDevice is the physical device associated with display.

  3. -> DisplayKHR

    display is the display to query.

  4. -> io (Result, "properties" ::: Vector (DisplayModeProperties2KHR a))
#

vkGetDisplayModeProperties2KHR - Query information about the available display modes.

Description

getDisplayModeProperties2KHR behaves similarly to getDisplayModePropertiesKHR, with the ability to return extended information via chained output structures.

Valid Usage (Implicit)

  • display must be a valid DisplayKHR handle

  • pPropertyCount must be a valid pointer to a uint32_t value

  • If the value referenced by pPropertyCount is not 0, and pProperties is not NULL, pProperties must be a valid pointer to an array of pPropertyCount DisplayModeProperties2KHR structures

  • display must have been created, allocated, or retrieved from physicalDevice

Return Codes

Success
Failure

See Also

VK_KHR_get_display_properties2, DisplayKHR, DisplayModeProperties2KHR, PhysicalDevice

valuegetDisplayPlaneCapabilities2KHR
  1. :: MonadIO io
  2. => PhysicalDevice

    physicalDevice is the physical device associated with pDisplayPlaneInfo.

    physicalDevice must be a valid PhysicalDevice handle

  3. -> DisplayPlaneInfo2KHR

    pDisplayPlaneInfo is a pointer to a DisplayPlaneInfo2KHR structure describing the plane and mode.

    pDisplayPlaneInfo must be a valid pointer to a valid DisplayPlaneInfo2KHR structure

  4. -> io DisplayPlaneCapabilities2KHR
#

vkGetDisplayPlaneCapabilities2KHR - Query capabilities of a mode and plane combination

Description

getDisplayPlaneCapabilities2KHR behaves similarly to getDisplayPlaneCapabilitiesKHR, with the ability to specify extended inputs via chained input structures, and to return extended information via chained output structures.

Return Codes

Success
Failure

See Also

VK_KHR_get_display_properties2, DisplayPlaneCapabilities2KHR, DisplayPlaneInfo2KHR, PhysicalDevice

datadata DisplayProperties2KHR
#

VkDisplayProperties2KHR - Structure describing an available display device

Valid Usage (Implicit)

See Also

VK_KHR_get_display_properties2, DisplayPropertiesKHR, StructureType, getPhysicalDeviceDisplayProperties2KHR

Constructors

Instances4Show, FromCStruct, ToCStruct, Zero
datadata DisplayPlaneProperties2KHR
#

VkDisplayPlaneProperties2KHR - Structure describing an available display plane

Valid Usage (Implicit)

See Also

VK_KHR_get_display_properties2, DisplayPlanePropertiesKHR, StructureType, getPhysicalDeviceDisplayPlaneProperties2KHR

Constructors

Instances5Show, Storable, FromCStruct, ToCStruct, Zero
datadata DisplayModeProperties2KHR (es :: [Type])
#

VkDisplayModeProperties2KHR - Structure describing an available display mode

Valid Usage (Implicit)

  • pNext must be NULL or a pointer to a valid instance of DisplayModeStereoPropertiesNV

  • The sType value of each structure in the pNext chain must be unique

See Also

VK_KHR_get_display_properties2, DisplayModePropertiesKHR, StructureType, getDisplayModeProperties2KHR

Constructors

Instances5Extensible, Show, FromCStruct, ToCStruct, Zero
datadata DisplayPlaneInfo2KHR
#

VkDisplayPlaneInfo2KHR - Structure defining the intended configuration of a display plane

Description

This parameter also implicitly specifies a display.

  • planeIndex is the plane which the application intends to use with the display.

The members of DisplayPlaneInfo2KHR correspond to the arguments to getDisplayPlaneCapabilitiesKHR, with sType and pNext added for extensibility.

Valid Usage (Implicit)

Host Synchronization

  • Host access to mode must be externally synchronized

See Also

VK_KHR_get_display_properties2, DisplayModeKHR, StructureType, getDisplayPlaneCapabilities2KHR

Constructors

Instances6Eq, Show, Storable, FromCStruct, ToCStruct, Zero
datadata DisplayPlaneCapabilities2KHR
#

VkDisplayPlaneCapabilities2KHR - Structure describing the capabilities of a mode and plane combination

Valid Usage (Implicit)

See Also

VK_KHR_get_display_properties2, DisplayPlaneCapabilitiesKHR, StructureType, getDisplayPlaneCapabilities2KHR

Constructors

Instances5Show, Storable, FromCStruct, ToCStruct, Zero
newtypenewtype DisplayKHR
#

VkDisplayKHR - Opaque handle to a display object

See Also

VK_DEFINE_NON_DISPATCHABLE_HANDLE, VK_KHR_display, DisplayPlanePropertiesKHR, DisplayPropertiesKHR, acquireDrmDisplayEXT, acquireWinrtDisplayNV, acquireXlibDisplayEXT, createDisplayModeKHR, displayPowerControlEXT, getDisplayModeProperties2KHR, getDisplayModePropertiesKHR, getDisplayPlaneSupportedDisplaysKHR, getDrmDisplayEXT, getRandROutputDisplayEXT, getWinrtDisplayNV, registerDisplayEventEXT, releaseDisplayEXT

Constructors

Instances7Eq, Ord, Show, Storable, HasObjectType, IsHandle, …
newtypenewtype DisplayModeKHR
#

VkDisplayModeKHR - Opaque handle to a display mode object

See Also

VK_DEFINE_NON_DISPATCHABLE_HANDLE, VK_KHR_display, DisplayModePropertiesKHR, DisplayPlaneInfo2KHR, DisplaySurfaceCreateInfoKHR, createDisplayModeKHR, getDisplayPlaneCapabilitiesKHR

Constructors

Instances7Eq, Ord, Show, Storable, HasObjectType, IsHandle, …
datadata DisplayPropertiesKHR
#

VkDisplayPropertiesKHR - Structure describing an available display device

Description

For devices which have no natural value to return here, implementations should return the maximum resolution supported.

Persistent presents may have higher latency, and may use less power when the screen content is updated infrequently, or when only a portion of the screen needs to be updated in most frames.

See Also

VK_KHR_display, Bool32, DisplayKHR, DisplayProperties2KHR, Extent2D, SurfaceTransformFlagsKHR, getPhysicalDeviceDisplayPropertiesKHR

Constructors

  • DisplayPropertiesKHR
    • display :: DisplayKHR

      display is a handle that is used to refer to the display described here. This handle will be valid for the lifetime of the Vulkan instance.

    • displayName :: ByteString

      displayName is NULL or a pointer to a null-terminated UTF-8 string containing the name of the display. Generally, this will be the name provided by the display’s EDID. If NULL, no suitable name is available. If not NULL, the string pointed to must remain accessible and unmodified as long as display is valid.

    • physicalDimensions :: Extent2D

      physicalDimensions describes the physical width and height of the visible portion of the display, in millimeters.

    • physicalResolution :: Extent2D

      physicalResolution describes the physical, native, or preferred resolution of the display.

    • supportedTransforms :: SurfaceTransformFlagsKHR

      supportedTransforms is a bitmask of SurfaceTransformFlagBitsKHR describing which transforms are supported by this display.

    • planeReorderPossible :: Bool

      planeReorderPossible tells whether the planes on this display can have their z order changed. If this is TRUE, the application can re-arrange the planes on this display in any order relative to each other.

    • persistentContent :: Bool

      persistentContent tells whether the display supports self-refresh/internal buffering. If this is true, the application can submit persistent present operations on swapchains created against this display.

Instances4Show, FromCStruct, ToCStruct, Zero
datadata DisplayPlanePropertiesKHR
#

VkDisplayPlanePropertiesKHR - Structure describing display plane properties

See Also

VK_KHR_display, DisplayKHR, DisplayPlaneProperties2KHR, getPhysicalDeviceDisplayPlanePropertiesKHR

Constructors

Instances6Eq, Show, Storable, FromCStruct, ToCStruct, Zero
datadata DisplayModeParametersKHR
#

VkDisplayModeParametersKHR - Structure describing display parameters associated with a display mode

Description

For example, a 60Hz display mode would report a refreshRate of 60,000.

Valid Usage

  • The width member of visibleRegion must be greater than 0

  • The height member of visibleRegion must be greater than 0

  • refreshRate must be greater than 0

See Also

VK_KHR_display, DisplayModeCreateInfoKHR, DisplayModePropertiesKHR, Extent2D

Constructors

Instances5Show, Storable, FromCStruct, ToCStruct, Zero
datadata DisplayModePropertiesKHR
#

VkDisplayModePropertiesKHR - Structure describing display mode properties

See Also

VK_KHR_display, DisplayModeKHR, DisplayModeParametersKHR, DisplayModeProperties2KHR, getDisplayModePropertiesKHR

Constructors

Instances5Show, Storable, FromCStruct, ToCStruct, Zero
datadata DisplayPlaneCapabilitiesKHR
#

VkDisplayPlaneCapabilitiesKHR - Structure describing capabilities of a mode and plane combination

Description

The minimum and maximum position and extent fields describe the implementation limits, if any, as they apply to the specified display mode and plane. Vendors may support displaying a subset of a swapchain’s presentable images on the specified display plane. This is expressed by returning minSrcPosition, maxSrcPosition, minSrcExtent, and maxSrcExtent values that indicate a range of possible positions and sizes which may be used to specify the region within the presentable images that source pixels will be read from when creating a swapchain on the specified display mode and plane.

Vendors may also support mapping the presentable images’ content to a subset or superset of the visible region in the specified display mode. This is expressed by returning minDstPosition, maxDstPosition, minDstExtent and maxDstExtent values that indicate a range of possible positions and sizes which may be used to describe the region within the display mode that the source pixels will be mapped to.

Other vendors may support only a 1-1 mapping between pixels in the presentable images and the display mode. This may be indicated by returning (0,0) for minSrcPosition, maxSrcPosition, minDstPosition, and maxDstPosition, and (display mode width, display mode height) for minSrcExtent, maxSrcExtent, minDstExtent, and maxDstExtent.

The value supportedAlpha must contain at least one valid DisplayPlaneAlphaFlagBitsKHR bit.

These values indicate the limits of the implementation’s individual fields. Not all combinations of values within the offset and extent ranges returned in DisplayPlaneCapabilitiesKHR are guaranteed to be supported. Presentation requests specifying unsupported combinations may fail.

See Also

VK_KHR_display, DisplayPlaneAlphaFlagsKHR, DisplayPlaneCapabilities2KHR, Extent2D, Offset2D, getDisplayPlaneCapabilitiesKHR

Constructors

Instances5Show, Storable, FromCStruct, ToCStruct, Zero
newtypenewtype DisplayPlaneAlphaFlagBitsKHR
#

VkDisplayPlaneAlphaFlagBitsKHR - Alpha blending type

Description

See Also

VK_KHR_display, DisplayPlaneAlphaFlagsKHR, DisplaySurfaceCreateInfoKHR

Constructors

Instances8Eq, Ord, Read, Show, Bits, FiniteBits, …
newtypenewtype SurfaceTransformFlagBitsKHR
#

VkSurfaceTransformFlagBitsKHR - Presentation transforms supported on a device

Description

See Also

VK_KHR_surface, CommandBufferInheritanceRenderPassTransformInfoQCOM, CopyCommandTransformInfoQCOM, DisplaySurfaceCreateInfoKHR, RenderPassTransformBeginInfoQCOM, SurfaceCapabilities2EXT, SurfaceCapabilitiesKHR, SurfaceTransformFlagsKHR, SwapchainCreateInfoKHR

Constructors

Instances8Eq, Ord, Read, Show, Bits, FiniteBits, …