mirror of
https://github.com/status-im/Vulkan-Docs.git
synced 2025-02-25 20:45:12 +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>>`
75 lines
2.8 KiB
Plaintext
75 lines
2.8 KiB
Plaintext
// This section is included inside VK_KHR_swapchain
|
|
|
|
== Hdr Metadata
|
|
|
|
To improve color reproduction of content it is useful to have information
|
|
that can be used to better reproduce the colors as seen on the mastering
|
|
display.
|
|
That information can be provided to an implementation by calling
|
|
fname:vkSetHdrMetadataEXT.
|
|
The metadata will be applied to the specified sname:VkSwapchainKHR objects
|
|
at the next fname:vkQueuePresentKHR call using that sname:VkSwapchainKHR
|
|
object.
|
|
The metadata will persist until a subsequent fname:vkSetHdrMetadataEXT
|
|
changes it.
|
|
The definitions below are from the associated SMPTE 2086, CTA 861.3 and CIE
|
|
15:2004 specifications.
|
|
|
|
The definition of fname:vkSetHdrMetadataEXT is:
|
|
|
|
[open,refpage='vkSetHdrMetadataEXT',desc='function to set Hdr metadata',type='protos']
|
|
--
|
|
include::{generated}/api/protos/vkSetHdrMetadataEXT.txt[]
|
|
|
|
* pname:device is the logical device where the swapchain(s) were created.
|
|
* pname:swapchainCount is the number of swapchains included in
|
|
pname:pSwapchains.
|
|
* pname:pSwapchains is a pointer to the array of pname:swapchainCount
|
|
sname:VkSwapchainKHR handles.
|
|
* pname:pMetadata is a pointer to the array of pname:swapchainCount
|
|
sname:VkHdrMetadataEXT structures.
|
|
|
|
include::{generated}/validity/protos/vkSetHdrMetadataEXT.txt[]
|
|
--
|
|
|
|
[open,refpage='VkXYColorEXT',desc='structure to specify X,Y chromaticity coordinates',type='structs']
|
|
--
|
|
include::{generated}/api/structs/VkXYColorEXT.txt[]
|
|
Chromaticity coordinates x and y are as specified in CIE 15:2004
|
|
"`Calculation of chromaticity coordinates`" (Section 7.3) and are limited to
|
|
between 0 and 1 for real colors for the mastering display.
|
|
|
|
--
|
|
|
|
[open,refpage='VkHdrMetadataEXT',desc='structure to specify Hdr metadata',type='structs']
|
|
--
|
|
include::{generated}/api/structs/VkHdrMetadataEXT.txt[]
|
|
|
|
* pname:sType is the type of this structure.
|
|
* pname:pNext is `NULL` or a pointer to an extension-specific structure.
|
|
* pname:displayPrimaryRed is the mastering display's red primary in
|
|
chromaticity coordinates
|
|
* pname:displayPrimaryGreen is the mastering display's green primary in
|
|
chromaticity coordinates
|
|
* pname:displayPrimaryBlue is the mastering display's blue primary in
|
|
chromaticity coordinates
|
|
* pname:whitePoint is the mastering display's white-point in chromaticity
|
|
coordinates
|
|
* pname:maxLuminance is the maximum luminance of the mastering display in
|
|
nits
|
|
* pname:minLuminance is the minimum luminance of the mastering display in
|
|
nits
|
|
* pname:maxContentLightLevel is content's maximum luminance in nits
|
|
* pname:maxFrameAverageLightLevel is the maximum frame average light level
|
|
in nits
|
|
|
|
include::{generated}/validity/structs/VkHdrMetadataEXT.txt[]
|
|
|
|
[NOTE]
|
|
.Note
|
|
====
|
|
The validity and use of this data is outside the scope of Vulkan.
|
|
====
|
|
|
|
--
|