vkGetPhysicalDeviceDisplayProperties2KHR - Query information about the available displays

Parameters

• PhysicalDevice is a physical device.

• pPropertyCount is a pointer to an integer related to the number of display devices available or queried, as described below.
• pProperties is either NULL or a pointer to an array of DisplayProperties2KHR structures.

Description

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

Valid Usage (Implicit)

• PhysicalDevice must be a valid PhysicalDevice 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 DisplayProperties2KHR structures

Return Codes

Success

• SUCCESS
• INCOMPLETE

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

DisplayProperties2KHR, PhysicalDevice

vkGetPhysicalDeviceDisplayPlaneProperties2KHR - Query information about the available display planes.

Parameters

• PhysicalDevice is a physical device.

• pPropertyCount is a pointer to an integer related to the number of display planes available or queried, as described below.
• pProperties is either NULL or a pointer to an array of DisplayPlaneProperties2KHR structures.

Description

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

Valid Usage (Implicit)

• PhysicalDevice must be a valid PhysicalDevice 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 DisplayPlaneProperties2KHR structures

Return Codes

Success

• SUCCESS
• INCOMPLETE

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

DisplayPlaneProperties2KHR, PhysicalDevice

vkGetDisplayModeProperties2KHR - Query information about the available display modes.

Parameters

• PhysicalDevice is the physical device associated with Display.

• Display is the display to query.
• pPropertyCount is a pointer to an integer related to the number of display modes available or queried, as described below.
• pProperties is either NULL or a pointer to an array of DisplayModeProperties2KHR structures.

Description

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

Valid Usage (Implicit)

• PhysicalDevice must be a valid PhysicalDevice handle

• 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

• SUCCESS
• INCOMPLETE

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

DisplayKHR, DisplayModeProperties2KHR, PhysicalDevice

vkGetDisplayPlaneCapabilities2KHR - Query capabilities of a mode and plane combination

Parameters

• PhysicalDevice is the physical device associated with pDisplayPlaneInfo.

• pDisplayPlaneInfo is a pointer to a DisplayPlaneInfo2KHR structure describing the plane and mode.
• pCapabilities is a pointer to a DisplayPlaneCapabilities2KHR structure in which the capabilities are returned.

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

• SUCCESS

Failure

• ERROR_OUT_OF_HOST_MEMORY
• ERROR_OUT_OF_DEVICE_MEMORY

See Also

DisplayPlaneCapabilities2KHR, DisplayPlaneInfo2KHR, PhysicalDevice

VkDisplayProperties2KHR - Structure describing an available display device

Valid Usage (Implicit)

See Also

DisplayPropertiesKHR, StructureType, getPhysicalDeviceDisplayProperties2KHR

VkDisplayPlaneProperties2KHR - Structure describing an available display plane

Valid Usage (Implicit)

See Also

DisplayPlanePropertiesKHR, StructureType, getPhysicalDeviceDisplayPlaneProperties2KHR

VkDisplayModeProperties2KHR - Structure describing an available display mode

Valid Usage (Implicit)

See Also

DisplayModePropertiesKHR, StructureType, getDisplayModeProperties2KHR

VkDisplayPlaneInfo2KHR - Structure defining the intended configuration of a display plane

Description

Note

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)

• sType must be STRUCTURE_TYPE_DISPLAY_PLANE_INFO_2_KHR

• pNext must be NULL
• mode must be a valid DisplayModeKHR handle

Host Synchronization

• Host access to mode must be externally synchronized

See Also

DisplayModeKHR, StructureType, getDisplayPlaneCapabilities2KHR

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

Valid Usage (Implicit)

See Also

DisplayPlaneCapabilitiesKHR, StructureType, getDisplayPlaneCapabilities2KHR

VkDisplayKHR - Opaque handle to a display object

See Also

DisplayPlanePropertiesKHR, DisplayPropertiesKHR, acquireXlibDisplayEXT, createDisplayModeKHR, displayPowerControlEXT, getDisplayModeProperties2KHR, getDisplayModePropertiesKHR, getDisplayPlaneSupportedDisplaysKHR, getRandROutputDisplayEXT, registerDisplayEventEXT, releaseDisplayEXT

VkDisplayModeKHR - Opaque handle to a display mode object

See Also

DisplayModePropertiesKHR, DisplayPlaneInfo2KHR, DisplaySurfaceCreateInfoKHR, createDisplayModeKHR, getDisplayPlaneCapabilitiesKHR

VkDisplayPropertiesKHR - Structure describing an available display device

Description

Note

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

Note

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

Bool32, DisplayKHR, DisplayProperties2KHR, Extent2D, SurfaceTransformFlagsKHR, getPhysicalDeviceDisplayPropertiesKHR

VkDisplayPlanePropertiesKHR - Structure describing display plane properties

See Also

DisplayKHR, DisplayPlaneProperties2KHR, getPhysicalDeviceDisplayPlanePropertiesKHR

VkDisplayModeParametersKHR - Structure describing display parameters associated with a display mode

Description

Note

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

DisplayModeCreateInfoKHR, DisplayModePropertiesKHR, Extent2D

VkDisplayModePropertiesKHR - Structure describing display mode properties

See Also

DisplayModeKHR, DisplayModeParametersKHR, DisplayModeProperties2KHR, getDisplayModePropertiesKHR

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 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 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.

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

DisplayPlaneAlphaFlagsKHR, DisplayPlaneCapabilities2KHR, Extent2D, Offset2D, getDisplayPlaneCapabilitiesKHR

VkDisplayPlaneAlphaFlagBitsKHR - Alpha blending type

See Also

DisplayPlaneAlphaFlagsKHR, DisplaySurfaceCreateInfoKHR

VkSurfaceTransformFlagBitsKHR - presentation transforms supported on a device

See Also

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