mirror of
https://github.com/status-im/Vulkan-Docs.git
synced 2025-02-16 16:26:26 +00:00
5abf83f95d
* Update release number to 107.
Public Issues:
* Fix revision date for the `<<VK_AMD_gpu_shader_half_float>>` appendix
(public issue 617).
* Make <<synchronization-pipeline-barriers-subpass-self-dependencies,
subpass self-dependencies>> less restrictive (public issue 777).
* Fix the `<<VK_EXT_full_screen_exclusive>>` dependency on
`<<VK_KHR_win32_surface>>` in `vk.xml` (public pull request 849).
* Remove single-page (`apispec.html`) refpage sub-targets from the
Makefile `allman` target and the build instructions. The target is still
present in the Makefile, but we have not been actively maintaining the
single-page document and do not promise it will work. The full
Specification and the individual API reference pages are what we support
and publish at present (public issue 949).
Internal Issues:
* De-duplicate common valid usage statements shared by multiple commands
or structures by using asciidoctor includes and dynamically assigning
part of the valid usage ID based on which command or structure they're
being applied to (internal issue 779).
* Add reference pages for constructs not part of the formal API, such as
platform calling convention macros, and script changes supporting them
This required suppressing some check_spec_links warning classes in order
to pass CI, until a more sophisticated fix can be done (internal issue
888).
* Change math notation for the elink:VkPrimitiveTopology descriptions to
use short forms `v` and `p` instead of `vertex` and `primitive`,
increasing legibility (internal issue 1611).
* Rewrite generated file includes relative to a globally specified path,
fixing some issues with refpage generation (internal issue 1630).
* Update contributor list for `<<VK_EXT_calibrated_timestamps>>`.
* Fix use of pathlin in `scripts/generator.py` so the script will work on
Windows under Python 3.5 (internal merge request 3107).
* Add missing conditionals around the
<<descriptorsets-accelerationstructure, Acceleration Structure>>
section (internal merge request 3108).
* More script synchronization with OpenXR spec repository (internal merge
request 3109).
* Mark the `<<VK_AMD_gpu_shader_half_float>>` and
`<<VK_AMD_gpu_shader_int16>>` extensions as deprecated in `vk.xml` and
the corresponding extension appendices (internal merge request 3112).
New Extensions:
* `<<VK_EXT_headless_surface>>`
83 lines
3.5 KiB
Plaintext
83 lines
3.5 KiB
Plaintext
// Copyright (c) 2014-2019 Khronos Group. This work is licensed under a
|
||
// Creative Commons Attribution 4.0 International License; see
|
||
// http://creativecommons.org/licenses/by/4.0/
|
||
|
||
If a swapchain is created with pname:presentMode set to either
|
||
ename:VK_PRESENT_MODE_SHARED_DEMAND_REFRESH_KHR or
|
||
ename:VK_PRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHR, a single presentable
|
||
image can: be acquired, referred to as a shared presentable image.
|
||
A shared presentable image may: be concurrently accessed by the application
|
||
and the presentation engine, without transitioning the image's layout after
|
||
it is initially presented.
|
||
|
||
* With ename:VK_PRESENT_MODE_SHARED_DEMAND_REFRESH_KHR, the presentation
|
||
engine is only required to update to the latest contents of a shared
|
||
presentable image after a present.
|
||
The application must: call fname:vkQueuePresentKHR to guarantee an
|
||
update.
|
||
However, the presentation engine may: update from it at any time.
|
||
* With ename:VK_PRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHR, the
|
||
presentation engine will automatically present the latest contents of a
|
||
shared presentable image during every refresh cycle.
|
||
The application is only required to make one initial call to
|
||
fname:vkQueuePresentKHR, after which the presentation engine will update
|
||
from it without any need for further present calls.
|
||
The application can: indicate the image contents have been updated by
|
||
calling fname:vkQueuePresentKHR, but this does not guarantee the timing
|
||
of when updates will occur.
|
||
|
||
The presentation engine may: access a shared presentable image at any time
|
||
after it is first presented.
|
||
To avoid tearing, an application should: coordinate access with the
|
||
presentation engine.
|
||
This requires presentation engine timing information through
|
||
platform-specific mechanisms and ensuring that color attachment writes are
|
||
made available during the portion of the presentation engine’s refresh cycle
|
||
they are intended for.
|
||
|
||
[NOTE]
|
||
.Note
|
||
====
|
||
The `VK_KHR_shared_presentable_image` extension does not provide
|
||
functionality for determining the timing of the presentation engine's
|
||
refresh cycles.
|
||
====
|
||
|
||
[open,refpage='vkGetSwapchainStatusKHR',desc='Get a swapchain\'s status',type='protos']
|
||
--
|
||
|
||
In order to query a swapchain's status when rendering to a shared
|
||
presentable image, call:
|
||
include::{generated}/api/protos/vkGetSwapchainStatusKHR.txt[]
|
||
|
||
* pname:device is the device associated with pname:swapchain.
|
||
* pname:swapchain is the swapchain to query.
|
||
|
||
include::{generated}/validity/protos/vkGetSwapchainStatusKHR.txt[]
|
||
--
|
||
|
||
The possible return values for fname:vkGetSwapchainStatusKHR should: be
|
||
interpreted as follows:
|
||
|
||
* ename:VK_SUCCESS specifies the presentation engine is presenting the
|
||
contents of the shared presentable image, as per the swapchain's
|
||
elink:VkPresentModeKHR.
|
||
* ename:VK_SUBOPTIMAL_KHR the swapchain no longer matches the surface
|
||
properties exactly, but the presentation engine is presenting the
|
||
contents of the shared presentable image, as per the swapchain's
|
||
elink:VkPresentModeKHR.
|
||
* ename:VK_ERROR_OUT_OF_DATE_KHR the surface has changed in such a way
|
||
that it is no longer compatible with the swapchain.
|
||
* ename:VK_ERROR_SURFACE_LOST_KHR the surface is no longer available.
|
||
|
||
[NOTE]
|
||
.Note
|
||
====
|
||
The swapchain state may: be cached by implementations, so applications
|
||
should: regularly call fname:vkGetSwapchainStatusKHR when using a swapchain
|
||
with elink:VkPresentModeKHR set to
|
||
ename:VK_PRESENT_MODE_SHARED_CONTINUOUS_REFRESH_KHR.
|
||
====
|
||
|
||
|