Add VK_EXT_disable_wayland_color_management

Fixes #2307
KhronosGroup · Aug 23, 2024 · 9dc46c9 · 9dc46c9
1 parent 55255e2
commit 9dc46c9
Show file tree

Hide file tree

Showing 5 changed files with 72 additions and 10 deletions.
diff --git a/appendices/VK_EXT_disable_wayland_color_management.adoc b/appendices/VK_EXT_disable_wayland_color_management.adoc
@@ -0,0 +1,31 @@
+// Copyright 2016-2024 The Khronos Group Inc.
+//
+// SPDX-License-Identifier: CC-BY-4.0
+
+include::{generated}/meta/{refprefix}VK_EXT_disable_wayland_color_management.adoc[]
+
+=== Other Extension Metadata
+
+*Last Modified Date*::
+    2024-08-16
+*IP Status*::
+    No known IP claims.
+*Contributors*::
+    Colin Marc
+
+=== Description
+
+This extension expands tlink:VkWaylandSurfaceCreateFlagsKHR to allow
+applications to request that implementations avoid using the
+`wp_color_management` protocol when creating or managing the surface.
+
+include::{generated}/interfaces/VK_EXT_disable_wayland_color_management.adoc[]
+
+=== Issues
+
+None.
+
+=== Version History
+
+  * Revision 1, 2024-08-16 (Colin Marc)
+  ** Initial draft
diff --git a/appendices/VK_KHR_wayland_surface.adoc b/appendices/VK_KHR_wayland_surface.adoc
@@ -90,3 +90,6 @@ an onerous restriction on application developers.
      ename:VK_PRESENT_MODE_MAILBOX_KHR.
   ** Added wording about interactions between flink:vkQueuePresentKHR and
      the Wayland requests sent to the compositor.
+
+  * Revision 7, 2024-08-16 (Colin Marc)
+  ** Added VkWaylandSurfaceCreateFlagBits.
diff --git a/chapters/VK_KHR_swapchain/wsi.adoc b/chapters/VK_KHR_swapchain/wsi.adoc
@@ -418,6 +418,14 @@ endif::VK_KHR_shared_presentable_image[]
     and pname:colorSpace members, respectively, of one of the
     sname:VkSurfaceFormatKHR structures returned by
     fname:vkGetPhysicalDeviceSurfaceFormatsKHR for the surface
+ifdef::VK_EXT_disable_wayland_color_management[]
+  * [[VUID-VkSwapchainCreateInfoKHR-imageColorSpace-00000]]
+    If pname:surface was created using flink:vkCreateWaylandSurfaceKHR and
+    sname:VkWaylandSurfaceCreateInfoKHR::pname:flags containing
+    ename:VK_WAYLAND_SURFACE_CREATE_DISABLE_COLOR_MANAGEMENT, then
+    sname:VkSwapchainCreateInfoKHR:pname:imageColorSpace must: be
+    ename:VK_COLOR_SPACE_PASS_THROUGH_EXT
+endif::VK_EXT_disable_wayland_color_management[]
   * [[VUID-VkSwapchainCreateInfoKHR-pNext-07781]]
 ifdef::VK_EXT_swapchain_maintenance1[]
     If a slink:VkSwapchainPresentScalingCreateInfoEXT structure was not

diff --git a/chapters/VK_KHR_wayland_surface/platformCreateSurface_wayland.adoc b/chapters/VK_KHR_wayland_surface/platformCreateSurface_wayland.adoc
@@ -35,7 +35,8 @@ include::{generated}/api/structs/VkWaylandSurfaceCreateInfoKHR.adoc[]
   * pname:sType is a elink:VkStructureType value identifying this structure.
   * pname:pNext is `NULL` or a pointer to a structure extending this
     structure.
-  * pname:flags is reserved for future use.
+  * pname:flags is a bitmask of elink:VkWaylandSurfaceCreateFlagBitsKHR
+    specifying additional surface creation parameters.
   * pname:display and pname:surface are pointers to the Wayland
     code:wl_display and code:wl_surface to associate the surface with.
 
@@ -87,10 +88,25 @@ If the application wishes to synchronize any window changes with a
 particular frame, such requests must: be sent to the Wayland display server
 prior to calling flink:vkQueuePresentKHR.
 
-[open,refpage='VkWaylandSurfaceCreateFlagsKHR',desc='Reserved for future use',type='flags']
+[open,refpage='VkWaylandSurfaceCreateFlagBitsKHR',desc='Bitmask specifying additional parameters for the Wayland surface.',type='enums',xrefs='VkWaylandSurfaceCreateInfoKHR']
+--
+include::{generated}/api/enums/VkWaylandSurfaceCreateFlagBitsKHR.adoc[]
+--
+
+ifdef::VK_EXT_disable_wayland_color_management[]
+Possible values of the pname:flags member of
+slink:VkWaylandSurfaceCreateInfoKHR are:
+
+  * ename:VK_WAYLAND_SURFACE_CREATE_DISABLE_COLOR_MANAGEMENT specifies that the
+    implementation should avoid using the `wp_color_management` protocol
+    manage the surface.
+endif::VK_EXT_disable_wayland_color_management[]
+
+
+[open,refpage='VkWaylandSurfaceCreateFlagsKHR',desc='Bitmask of VkWaylandSurfaceCreateFlagBitsKHR',type='flags']
 --
 include::{generated}/api/flags/VkWaylandSurfaceCreateFlagsKHR.adoc[]
 
-tname:VkWaylandSurfaceCreateFlagsKHR is a bitmask type for setting a mask,
-but is currently reserved for future use.
+tname:VkWaylandSurfaceCreateFlagsKHR is a bitmask type for setting a mask of
+zero or more elink:VkWaylandSurfaceCreateFlagBitsKHR.
 --
diff --git a/xml/vk.xml b/xml/vk.xml
@@ -402,7 +402,7 @@ typedef void* <name>MTLSharedEvent_id</name>;
         <type                                             category="bitmask">typedef <type>VkFlags</type> <name>VkDisplaySurfaceCreateFlagsKHR</name>;</type>
         <type                                             category="bitmask">typedef <type>VkFlags</type> <name>VkAndroidSurfaceCreateFlagsKHR</name>;</type>
         <type                                             category="bitmask">typedef <type>VkFlags</type> <name>VkViSurfaceCreateFlagsNN</name>;</type>
-        <type                                             category="bitmask">typedef <type>VkFlags</type> <name>VkWaylandSurfaceCreateFlagsKHR</name>;</type>
+        <type requires= "VkWaylandSurfaceCreateFlagBitsKHR" category="bitmask">typedef <type>VkFlags</type> <name>VkWaylandSurfaceCreateFlagsKHR</name>;</type>
         <type                                             category="bitmask">typedef <type>VkFlags</type> <name>VkWin32SurfaceCreateFlagsKHR</name>;</type>
         <type                                             category="bitmask">typedef <type>VkFlags</type> <name>VkXlibSurfaceCreateFlagsKHR</name>;</type>
         <type                                             category="bitmask">typedef <type>VkFlags</type> <name>VkXcbSurfaceCreateFlagsKHR</name>;</type>
@@ -877,6 +877,7 @@ typedef void* <name>MTLSharedEvent_id</name>;
         <type name="VkOutOfBandQueueTypeNV" category="enum"/>
         <type name="VkPhysicalDeviceSchedulingControlsFlagBitsARM" category="enum"/>
         <type name="VkMemoryUnmapFlagBitsKHR" category="enum"/>
+        <type name="VkWaylandSurfaceCreateFlagBitsKHR" category="enum"/>
 
             <comment>Enumerated types in the header, but not used by the API</comment>
         <type name="VkVendorId" category="enum"/>
@@ -11322,6 +11323,8 @@ typedef void* <name>MTLSharedEvent_id</name>;
     </enums>
     <enums name="VkMemoryUnmapFlagBitsKHR" type="bitmask">
     </enums>
+    <enums name="VkWaylandSurfaceCreateFlagBitsKHR" type="bitmask">
+    </enums>
 
     <commands comment="Vulkan command definitions">
         <command successcodes="VK_SUCCESS" errorcodes="VK_ERROR_OUT_OF_HOST_MEMORY,VK_ERROR_OUT_OF_DEVICE_MEMORY,VK_ERROR_INITIALIZATION_FAILED,VK_ERROR_LAYER_NOT_PRESENT,VK_ERROR_EXTENSION_NOT_PRESENT,VK_ERROR_INCOMPATIBLE_DRIVER">
@@ -17026,10 +17029,11 @@ typedef void* <name>MTLSharedEvent_id</name>;
         </extension>
         <extension name="VK_KHR_wayland_surface" number="7" type="instance" depends="VK_KHR_surface" platform="wayland" author="KHR" contact="Jesse Hall @critsec,Ian Elliott @ianelliottus" supported="vulkan" ratified="vulkan">
             <require>
-                <enum value="6"                                                 name="VK_KHR_WAYLAND_SURFACE_SPEC_VERSION"/>
+                <enum value="7"                                                 name="VK_KHR_WAYLAND_SURFACE_SPEC_VERSION"/>
                 <enum value="&quot;VK_KHR_wayland_surface&quot;"                name="VK_KHR_WAYLAND_SURFACE_EXTENSION_NAME"/>
                 <enum offset="0" extends="VkStructureType"                      name="VK_STRUCTURE_TYPE_WAYLAND_SURFACE_CREATE_INFO_KHR"/>
                 <type name="VkWaylandSurfaceCreateFlagsKHR"/>
+                <type name="VkWaylandSurfaceCreateFlagBitsKHR"/>
                 <type name="VkWaylandSurfaceCreateInfoKHR"/>
                 <command name="vkCreateWaylandSurfaceKHR"/>
                 <command name="vkGetPhysicalDeviceWaylandPresentationSupportKHR"/>
@@ -24648,11 +24652,11 @@ typedef void* <name>MTLSharedEvent_id</name>;
                 <enum bitpos="17" extends="VkExternalMemoryHandleTypeFlagBits" name="VK_EXTERNAL_MEMORY_HANDLE_TYPE_603_BIT_2_EXT"/>
             </require>
         </extension>
-        <extension name="VK_EXT_extension_604" number="604" author="EXT" contact="Colin Marc @colinmarc" supported="disabled">
+        <extension name="VK_EXT_disable_wayland_color_management" number="604" type="instance" depends="VK_KHR_wayland_surface+VK_EXT_swapchain_colorspace" author="EXT" contact="Colin Marc @colinmarc" supported="vulkan">
             <require>
-                <enum value="0"                                              name="VK_EXT_EXTENSION_604_SPEC_VERSION"/>
-                <enum value="&quot;VK_EXT_extension_604&quot;"               name="VK_EXT_EXTENSION_604_EXTENSION_NAME"/>
-                <enum bitpos="0" extends="VkWaylandSurfaceCreateFlagBitsKHR" name="VK_WAYLAND_SURFACE_CREATE_DISABLE_COLOR_MANAGEMENT"/>
+                <enum value="1"                                                   name="VK_EXT_DISABLE_WAYLAND_COLOR_MANAGEMENT_SPEC_VERSION"/>
+                <enum value="&quot;VK_EXT_disable_wayland_color_management&quot;" name="VK_EXT_DISABLE_WAYLAND_COLOR_MANAGEMENT_EXTENSION_NAME"/>
+                <enum bitpos="0" extends="VkWaylandSurfaceCreateFlagBitsKHR"      name="VK_WAYLAND_SURFACE_CREATE_DISABLE_COLOR_MANAGEMENT"/>
             </require>
         </extension>
     </extensions>