VK_KHR_get_display_properties2(3)

# VK_KHR_get_display_properties2(3) Manual Page

## Name

VK_KHR_get_display_properties2 - instance extension

Loading… please wait.

## Registered Extension Number

122

## Revision

1

## Ratification Status

Ratified

## Extension and Version Dependencies

VK_KHR_display

## Contact

- James Jones cubanismo

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

- vkGetDisplayModeProperties2KHR

- vkGetDisplayPlaneCapabilities2KHR

- vkGetPhysicalDeviceDisplayPlaneProperties2KHR

- vkGetPhysicalDeviceDisplayProperties2KHR

## New Structures

- VkDisplayModeProperties2KHR

- VkDisplayPlaneCapabilities2KHR

- VkDisplayPlaneInfo2KHR

- VkDisplayPlaneProperties2KHR

- VkDisplayProperties2KHR

## New Enum Constants

- `VK_KHR_GET_DISPLAY_PROPERTIES_2_EXTENSION_NAME`

- `VK_KHR_GET_DISPLAY_PROPERTIES_2_SPEC_VERSION`

- Extending VkStructureType:

  - `VK_STRUCTURE_TYPE_DISPLAY_MODE_PROPERTIES_2_KHR`

  - `VK_STRUCTURE_TYPE_DISPLAY_PLANE_CAPABILITIES_2_KHR`

  - `VK_STRUCTURE_TYPE_DISPLAY_PLANE_INFO_2_KHR`

  - `VK_STRUCTURE_TYPE_DISPLAY_PLANE_PROPERTIES_2_KHR`

  - `VK_STRUCTURE_TYPE_DISPLAY_PROPERTIES_2_KHR`

## 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:

- vkGetPhysicalDeviceDisplayProperties2KHR: No. The only current input is a VkPhysicalDevice. Other inputs would not make sense.

- vkGetPhysicalDeviceDisplayPlaneProperties2KHR: No. The only current input is a VkPhysicalDevice. Other inputs would not make sense.

- vkGetDisplayModeProperties2KHR: No. The only current inputs are a VkPhysicalDevice and a VkDisplayModeKHR. Other inputs would not make sense.

3) Should additional display query functions be extended?

RESOLVED:

- vkGetDisplayPlaneSupportedDisplaysKHR: No. Extensions should instead extend vkGetDisplayPlaneCapabilitiesKHR().

## Version History

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

  - Initial draft.

## See Also

VkDisplayModeProperties2KHR, VkDisplayPlaneCapabilities2KHR, VkDisplayPlaneInfo2KHR, VkDisplayPlaneProperties2KHR, VkDisplayProperties2KHR, vkGetDisplayModeProperties2KHR, vkGetDisplayPlaneCapabilities2KHR, vkGetPhysicalDeviceDisplayPlaneProperties2KHR, vkGetPhysicalDeviceDisplayProperties2KHR

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

## Copyright

Copyright 2014-2023 The Khronos Group Inc.

SPDX-License-Identifier: CC-BY-4.0