/ appendices / VK_KHR_get_display_properties2.txt
VK_KHR_get_display_properties2.txt
 1  // Copyright (c) 2017-2019 Khronos Group. This work is licensed under a
 2  // Creative Commons Attribution 4.0 International License; see
 3  // http://creativecommons.org/licenses/by/4.0/
 4  
 5  include::meta/VK_KHR_get_display_properties2.txt[]
 6  
 7  *Last Modified Date*::
 8      2017-02-21
 9  *IP Status*::
10      No known IP claims.
11  *Contributors*::
12    - Ian Elliott, Google
13    - James Jones, NVIDIA
14  
15  This extension provides new entry points to query device display properties
16  and capabilities in a way that can be easily extended by other extensions,
17  without introducing any further entry points.
18  This extension can be considered the <<VK_KHR_display,VK_KHR_display>>
19  equivalent of the <<VK_KHR_get_physical_device_properties2,
20  VK_KHR_get_physical_device_properties2>> extension.
21  
22  === New Object Types
23  
24  None.
25  
26  === New Enum Constants
27  
28    * Extending elink:VkStructureType:
29    ** ename:VK_STRUCTURE_TYPE_DISPLAY_PROPERTIES_2_KHR
30    ** ename:VK_STRUCTURE_TYPE_DISPLAY_PLANE_PROPERTIES_2_KHR
31    ** ename:VK_STRUCTURE_TYPE_DISPLAY_MODE_PROPERTIES_2_KHR
32    ** ename:VK_STRUCTURE_TYPE_DISPLAY_PLANE_INFO_2_KHR
33    ** ename:VK_STRUCTURE_TYPE_DISPLAY_PLANE_CAPABILITIES_2_KHR
34  
35  === New Enums
36  
37  None.
38  
39  === New Structures
40  
41    * slink:VkDisplayProperties2KHR
42    * slink:VkDisplayPlaneProperties2KHR
43    * slink:VkDisplayModeProperties2KHR
44    * slink:VkDisplayPlaneInfo2KHR
45    * slink:VkDisplayPlaneCapabilities2KHR
46  
47  === New Functions
48  
49    * flink:vkGetPhysicalDeviceDisplayProperties2KHR
50    * flink:vkGetPhysicalDeviceDisplayPlaneProperties2KHR
51    * flink:vkGetDisplayModeProperties2KHR
52    * flink:vkGetDisplayPlaneCapabilities2KHR
53  
54  === Issues
55  
56  1) What should this extension be named?
57  
58  *RESOLVED*: `VK_KHR_get_display_properties2`.
59  Other alternatives:
60  
61    * `VK_KHR_display2`
62    * One extension, combined with `VK_KHR_surface_capabilites2`.
63  
64  2) Should extensible input structs be added for these new functions:
65  
66  *RESOLVED*:
67  
68    * flink:vkGetPhysicalDeviceDisplayProperties2KHR: No.
69      The only current input is a slink:VkPhysicalDevice.
70      Other inputs wouldn't make sense.
71    * flink:vkGetPhysicalDeviceDisplayPlaneProperties2KHR: No.
72      The only current input is a slink:VkPhysicalDevice.
73      Other inputs wouldn't make sense.
74    * flink:vkGetDisplayModeProperties2KHR: No.
75      The only current inputs are a slink:VkPhysicalDevice and a
76      slink:VkDisplayModeKHR.
77      Other inputs wouldn't make sense.
78  
79  3) Should additional display query functions be extended?
80  
81  *RESOLVED*:
82  
83    * flink:vkGetDisplayPlaneSupportedDisplaysKHR: No.
84      Extensions should instead extend
85      flink:vkGetDisplayPlaneCapabilitiesKHR().
86  
87  === Version History
88  
89   * Revision 1, 2017-02-21 (James Jones)
90     - Initial draft.