mirror of
https://github.com/status-im/Vulkan-Docs.git
synced 2025-01-12 23:14:20 +00:00
43f1fd5550
* Bump API patch number and header version number to 44 for this update.
Github Issues:
* Fix description of <<features-extentperimagetype, Allowed Extent Values
Based On Image Type>> (public issue 290).
* Better specify VK_DEVICE_LOST behavior around flink:vkQueueSubmit,
flink:vkWaitForFences, and flink:vkGetFenceStatus (public issue 423).
* Clarify definition of flink:vkGetQueryPoolResults::pname:queryCount
(public issue 441).
* Simplify and clean up normative language. Remove shall and replace
recommend and variants with should wherever possible (public issue 448).
* Fix all dangling internal cross-references in the 1.0-extensions
specification, and add scripts/checkXrefs to find these in the future
(public issue 456).
* Reverse order of ChangeLog.txt entries so the most recent version is
documented first (public issue 463)
* Removes "become invalid" which clashes with invalid state for command
buffers. (public issue 467)
* Disallowed pending state in spec text for vkResetCommandBuffer, matching
valid usage (public issue 468)
* Removes sentence describing invalid state "like initial state". (public
issue 469)
* Disallows begin command buffer from resetting command buffers in the
"recording" state. (public issue 470)
* Removes mention of state from description of
VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT (public issue 471)
* Removed extra valid usage statement in VkSubmitInfo (public issue 472)
Internal Issues:
* Clarify description of the pname:imageLayout member of
sname:VkDescriptorImageInfo.
* Fix typos where etext:VK_VIEW_TYPE* was used instead of
etext:VK_IMAGE_VIEW_TYPE.
* Removed the <<VK_KHR_display>> and <<VK_KHR_display_swapchain>> example
code from the specification and noted it has been moved to the Vulkan
SDK cube demo (internal issue 179).
* Reorder VkExternalMemoryHandleTypeFlagBitsNV description (internal issue
480).
* Clarify than an implementation is
<<fundamentals-validusage-flags,permitted to return 'undefined' bit
flags>> in a bitfield (internal issue 640).
* Break Valid Usage statements describing unrelated parameters into
separate statements, and add a style guide entry to follow this approach
(internal issue 685).
* Move valid usage statement for slink:VkImageCreateInfo from spec body to
the explicit valid usage block (internal issue 693).
* Fix typos in the descriptions of slink:VkDisplaySurfaceCreateInfoKHR,
flink:vkCreateDisplayModeKHR, and
flink:vkGetDisplayPlaneSupportedDisplaysKHR in the <<display,Presenting
Directly to Display Devices>> section (internal issue 698, 704, 716).
* Clarified that mandatory depth/stencil formats are only a requirement
for 2D images (internal issue 719).
* Clarify that variables decorated with DeviceIndex/ViewIndex must be in
the Input storage class (internal issue 733).
* Work around generator script problem with removal of Unicode literals
from Python 3.0-3.2 using `future` package (internal issue 737).
* Remove nonexistent structure type enums from vk.xml (internal issue
738).
* Fix validextensionstructs attributes for structures in the pname:pNext
chain for VkPresentInfoKHR, fixing implicit valid usage statements for
those structures (internal issue 740).
New Extensions:
122 lines
3.8 KiB
Plaintext
122 lines
3.8 KiB
Plaintext
// Copyright (c) 2014-2017 The Khronos Group Inc.
|
|
// Copyright notice at https://www.khronos.org/registry/speccopyright.html
|
|
|
|
[[VK_KHR_wayland_surface]]
|
|
== VK_KHR_wayland_surface
|
|
|
|
*Name String*::
|
|
+VK_KHR_wayland_surface+
|
|
*Extension Type*::
|
|
Instance extension
|
|
*Registered Extension Number*::
|
|
7
|
|
*Last Modified Date*::
|
|
2015-11-28
|
|
*Revision*::
|
|
6
|
|
*IP Status*::
|
|
No known IP claims.
|
|
*Dependencies*::
|
|
- This extension is written against version 1.0 of the Vulkan API.
|
|
- This extension requires +VK_KHR_surface+.
|
|
*Contributors*::
|
|
- Patrick Doane, Blizzard
|
|
- Jason Ekstrand, Intel
|
|
- Ian Elliott, LunarG
|
|
- Courtney Goeltzenleuchter, LunarG
|
|
- Jesse Hall, Google
|
|
- James Jones, NVIDIA
|
|
- Antoine Labour, Google
|
|
- Jon Leech, Khronos
|
|
- David Mao, AMD
|
|
- Norbert Nopper, Freescale
|
|
- Alon Or-bach, Samsung
|
|
- Daniel Rakos, AMD
|
|
- Graham Sellers, AMD
|
|
- Ray Smith, ARM
|
|
- Jeff Vigil, Qualcomm
|
|
- Chia-I Wu, LunarG
|
|
*Contacts*::
|
|
- Jesse Hall, Google
|
|
- Ian Elliott, LunarG
|
|
|
|
|
|
The +VK_KHR_wayland_surface+ extension is an instance extension.
|
|
It provides a mechanism to create a slink:VkSurfaceKHR object (defined by
|
|
the +VK_KHR_surface+ extension) that refers to a Wayland code:wl_surface, as
|
|
well as a query to determine support for rendering to a Wayland compositor.
|
|
|
|
=== New Object Types
|
|
|
|
None
|
|
|
|
=== New Enum Constants
|
|
|
|
* Extending ename:VkStructureType:
|
|
** ename:VK_STRUCTURE_TYPE_WAYLAND_SURFACE_CREATE_INFO_KHR
|
|
|
|
=== New Enums
|
|
|
|
None
|
|
|
|
=== New Structures
|
|
|
|
* slink:VkWaylandSurfaceCreateInfoKHR
|
|
|
|
=== New Functions
|
|
|
|
* flink:vkCreateWaylandSurfaceKHR
|
|
* flink:vkGetPhysicalDeviceWaylandPresentationSupportKHR
|
|
|
|
=== Issues
|
|
|
|
1) Does Wayland need a way to query for compatibility between a particular
|
|
physical device and a specific Wayland display? This would be a more general
|
|
query than flink:vkGetPhysicalDeviceSurfaceSupportKHR: if the
|
|
Wayland-specific query returned true for a (slink:VkPhysicalDevice, struct
|
|
wl_display*) pair, then the physical device could be assumed to support
|
|
presentation to any slink:VkSurfaceKHR for surfaces on the display.
|
|
|
|
*RESOLVED*: Yes.
|
|
flink:vkGetPhysicalDeviceWaylandPresentationSupportKHR was added to address
|
|
this issue.
|
|
|
|
2) Should we require surfaces created with flink:vkCreateWaylandSurfaceKHR
|
|
to support the ename:VK_PRESENT_MODE_MAILBOX_KHR present mode?
|
|
|
|
*RESOLVED*: Yes.
|
|
Wayland is an inherently mailbox window system and mailbox support is
|
|
required for some Wayland compositor interactions to work as expected.
|
|
While handling these interactions may be possible with
|
|
ename:VK_PRESENT_MODE_FIFO_KHR, it is much more difficult to do without
|
|
deadlock and requiring all Wayland applications to be able to support
|
|
implementations which only support ename:VK_PRESENT_MODE_FIFO_KHR would be
|
|
an onerous restriction on application developers.
|
|
|
|
=== Version History
|
|
|
|
* Revision 1, 2015-09-23 (Jesse Hall)
|
|
- Initial draft, based on the previous contents of VK_EXT_KHR_swapchain
|
|
(later renamed VK_EXT_KHR_surface).
|
|
|
|
* Revision 2, 2015-10-02 (James Jones)
|
|
- Added vkGetPhysicalDeviceWaylandPresentationSupportKHR() to resolve
|
|
issue #1.
|
|
- Adjusted wording of issue #1 to match the agreed-upon solution.
|
|
- Renamed "window" parameters to "surface" to match Wayland conventions.
|
|
|
|
* Revision 3, 2015-10-26 (Ian Elliott)
|
|
- Renamed from VK_EXT_KHR_wayland_surface to VK_KHR_wayland_surface.
|
|
|
|
* Revision 4, 2015-11-03 (Daniel Rakos)
|
|
- Added allocation callbacks to vkCreateWaylandSurfaceKHR.
|
|
|
|
* Revision 5, 2015-11-28 (Daniel Rakos)
|
|
- Updated the surface create function to take a pCreateInfo structure.
|
|
|
|
* Revision 6, 2017-02-08 (Jason Ekstrand)
|
|
- Added the requirement that implementations support
|
|
ename:VK_PRESENT_MODE_MAILBOX_KHR.
|
|
- Added wording about interactions between flink:vkQueuePresentKHR and
|
|
the Wayland requests sent to the compositor.
|