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:
160 lines
5.2 KiB
Plaintext
160 lines
5.2 KiB
Plaintext
// Copyright (c) 2014-2017 The Khronos Group Inc.
|
|
// Copyright notice at https://www.khronos.org/registry/speccopyright.html
|
|
|
|
[[VK_KHR_display_swapchain]]
|
|
== VK_KHR_display_swapchain
|
|
|
|
*Name String*::
|
|
+VK_KHR_display_swapchain+
|
|
*Extension Type*::
|
|
Device extension
|
|
*Registered Extension Number*::
|
|
4
|
|
*Status*::
|
|
Draft.
|
|
*Last Modified Date*::
|
|
2017-03-13
|
|
*Revision*::
|
|
10
|
|
*IP Status*::
|
|
No known IP claims.
|
|
*Dependencies*::
|
|
- This extension is written against version 1.0 of the Vulkan API.
|
|
- Requires +VK_KHR_swapchain+.
|
|
- Requires +VK_KHR_display+.
|
|
*Contributors*::
|
|
- James Jones, NVIDIA
|
|
- Jeff Vigil, Qualcomm
|
|
- Jesse Hall, Google
|
|
*Contacts*::
|
|
- James Jones (jajones 'at' nvidia.com)
|
|
|
|
This extension provides an API to create a swapchain directly on a device's
|
|
display without any underlying window system.
|
|
|
|
=== New Object Types
|
|
|
|
None
|
|
|
|
=== New Enum Constants
|
|
|
|
* Extending ename:VkStructureType:
|
|
** ename:VK_STRUCTURE_TYPE_DISPLAY_PRESENT_INFO_KHR
|
|
* Extending ename:VkResult:
|
|
** ename:VK_ERROR_INCOMPATIBLE_DISPLAY_KHR
|
|
|
|
=== New Enums
|
|
|
|
None
|
|
|
|
=== New Structures
|
|
|
|
* slink:VkDisplayPresentInfoKHR
|
|
|
|
=== New Functions
|
|
|
|
* flink:vkCreateSharedSwapchainsKHR
|
|
|
|
=== Issues
|
|
|
|
1) Should swapchains sharing images each hold a reference to the images, or
|
|
should it be up to the application to destroy the swapchains and images in
|
|
an order that avoids the need for reference counting?
|
|
|
|
*RESOLVED*: Take a reference.
|
|
The lifetime of presentable images is already complex enough.
|
|
|
|
2) Should the srcRect/dstRect parameters be specified as part of the present
|
|
command, or at swapchain creation time?
|
|
|
|
*RESOLVED*: As part of the presentation command.
|
|
This allows moving and scaling the image on the screen without the need to
|
|
respecify the mode or create a new swapchain and presentable images.
|
|
|
|
3) Should srcRect/dstRect be specified as rects, or separate offset/extent
|
|
values?
|
|
|
|
*RESOLVED*: As rects.
|
|
Specifying them separately might make it easier for hardware to expose
|
|
support for one but not the other, but in such cases applications must just
|
|
take care to obey the reported capabilities and not use non-zero offsets or
|
|
extents that require scaling, as appropriate.
|
|
|
|
4) How can applications create multiple swapchains that use the same images?
|
|
|
|
*RESOLVED*: By calling flink:vkCreateSharedSwapchainsKHR.
|
|
|
|
An earlier resolution used flink:vkCreateSwapchainKHR, chaining multiple
|
|
slink:VkSwapchainCreateInfoKHR structures through pname:pNext.
|
|
In order to allow each swapchain to also allow other extension structs, a
|
|
level of indirection was used: slink:VkSwapchainCreateInfoKHR::pname:pNext
|
|
pointed to a different structure, which had both an pname:sType/pname:pNext
|
|
for additional extensions, and also had a pointer to the next
|
|
slink:VkSwapchainCreateInfoKHR structure.
|
|
The number of swapchains to be created could only be found by walking this
|
|
linked list of alternating structures, and the pSwapchains out parameter was
|
|
reinterpreted to be an array of slink:VkSwapchainKHR handles.
|
|
|
|
Another option considered was a method to specify a "`shared`" swapchain
|
|
when creating a new swapchain, such that groups of swapchains using the same
|
|
images could be built up one at a time.
|
|
This was deemed unusable because drivers need to know all of the displays an
|
|
image will be used on when determining which internal formats and layouts to
|
|
use for that image.
|
|
|
|
=== Examples
|
|
|
|
[NOTE]
|
|
.Note
|
|
====
|
|
The example code for the +VK_KHR_display+ and +VK_KHR_display_swapchain+
|
|
extensions was removed from the appendix after revision 1.0.43.
|
|
The display swapchain creation example code was ported to the cube demo that
|
|
is shipped with the official Khronos SDK, and is being kept up-to-date in
|
|
that location (see:
|
|
https://github.com/KhronosGroup/Vulkan-LoaderAndValidationLayers/blob/master/demos/cube.c).
|
|
====
|
|
|
|
=== Version History
|
|
|
|
* Revision 1, 2015-07-29 (James Jones)
|
|
- Initial draft
|
|
|
|
* Revision 2, 2015-08-21 (Ian Elliott)
|
|
- Renamed this extension and all of its enumerations, types, functions,
|
|
etc.
|
|
This makes it compliant with the proposed standard for Vulkan
|
|
extensions.
|
|
- Switched from "revision" to "version", including use of the
|
|
VK_MAKE_VERSION macro in the header file.
|
|
|
|
* Revision 3, 2015-09-01 (James Jones)
|
|
- Restore single-field revision number.
|
|
|
|
* Revision 4, 2015-09-08 (James Jones)
|
|
- Allow creating multiple swap chains that share the same images using a
|
|
single call to vkCreateSwapChainKHR().
|
|
|
|
* Revision 5, 2015-09-10 (Alon Or-bach)
|
|
- Removed underscores from SWAP_CHAIN in two enums.
|
|
|
|
* Revision 6, 2015-10-02 (James Jones)
|
|
- Added support for smart panels/buffered displays.
|
|
|
|
* Revision 7, 2015-10-26 (Ian Elliott)
|
|
- Renamed from VK_EXT_KHR_display_swapchain to VK_KHR_display_swapchain.
|
|
|
|
* Revision 8, 2015-11-03 (Daniel Rakos)
|
|
- Updated sample code based on the changes to VK_KHR_swapchain.
|
|
|
|
* Revision 9, 2015-11-10 (Jesse Hall)
|
|
- Replaced ftext:VkDisplaySwapchainCreateInfoKHR with
|
|
vkCreateSharedSwapchainsKHR, changing resolution of issue #4.
|
|
|
|
* Revision 10, 2017-03-13 (James Jones)
|
|
- Closed all remaining issues.
|
|
The specification and implementations have been shipping with the
|
|
proposed resolutions for some time now.
|
|
- Removed the sample code and noted it has been integrated into the
|
|
official Vulkan SDK cube demo.
|