mirror of
https://github.com/status-im/Vulkan-Docs.git
synced 2025-01-22 12:19:27 +00:00
256a1ef661
* Update release number to 93.
Public Issues:
* Add spec language for ename:VK_INDEX_TYPE_NONE_NV and fix up
slink:VkAccelerationStructureTypeNV (public issue 848).
* Add missing suffix in description of slink:VkSubpassDescription2KHR
parameters (public pull request 851).
* Fix miscellaneous typos (public pull request 855).
* Add driver ID for Pastel (public pull request 856).
* Add missing include directive for slink:VkMemoryWin32HandlePropertiesKHR
implicit valid usage statements (public pull request 857).
Internal Issues:
* Restrict the storage classes permitted for SPIR-V atomics to what is
actually supported, in the <<spirvenv-module-validation, Validation
Rules within a Module>> section (internal issue 1123).
* Add a missing Valid Usage statement to slink:VkRenderPassCreateInfo for
the case pname:stencilLoadOp == ename:VK_LOAD_OP_CLEAR, pname:layout ==
ename:VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL (internal issue
1408).
* Modify optimize-pdf script and Makefile to retain non-optimized original
PDF on errors (internal issue 1435).
* Add <<spirvenv-module-validation, SPIR-V validation rules>> stating that
only the listed code:BuiltIn decorations are permitted, and only when
relevante features and extensions are enabled (internal issue 1449).
* Remove some duplicated Valid Usage IDs created via cut & paste error
(internal issue 1455).
* Build HTML output for extension reference pages (internal issue 1461).
** Improve genRef.py handling of aliases defined inside other refpages.
** Emit aliases in pygenerator.py.
** Add XML noautovalidity flag for VkRenderPassCreateFlags until there
are some corresponding FlagBits defined.
** Corrected types= attribute on some refpage blocks to 'flags'
** Added refpage blocks for some missing types detected by CI tests.
* Fixed many Valid Usage statement issues in slink:VkRenderPassCreateInfo,
slink:VkSubpassDescription, slink:VkSubpassDescription2KHR,
slink:VkSubpassDependency2KHR, flink:vkCmdBeginRenderPass,
flink:vkCmdBeginRenderPass2KHR, and slink:VkRenderPassBeginInfo
discovered while adding `VK_KHR_create_renderpass2` to the validation
layers.
New Extensions:
* `VK_EXT_scalar_block_layout`
* `VK_EXT_separate_stencil_usage`
101 lines
4.1 KiB
Plaintext
101 lines
4.1 KiB
Plaintext
// Copyright (c) 2014-2018 Khronos Group. This work is licensed under a
|
|
// Creative Commons Attribution 4.0 International License; see
|
|
// http://creativecommons.org/licenses/by/4.0/
|
|
|
|
[open,refpage='VkPresentRegionsKHR',desc='Structure hint of rectangular regions changed by vkQueuePresentKHR',type='structs']
|
|
--
|
|
|
|
When the `VK_KHR_incremental_present` extension is enabled, additional
|
|
fields can: be specified that allow an application to specify that only
|
|
certain rectangular regions of the presentable images of a swapchain are
|
|
changed.
|
|
This is an optimization hint that a presentation engine may: use to only
|
|
update the region of a surface that is actually changing.
|
|
The application still must: ensure that all pixels of a presented image
|
|
contain the desired values, in case the presentation engine ignores this
|
|
hint.
|
|
An application can: provide this hint by including the
|
|
sname:VkPresentRegionsKHR structure in the pname:pNext chain of the
|
|
sname:VkPresentInfoKHR structure.
|
|
|
|
The sname:VkPresentRegionsKHR structure is defined as:
|
|
|
|
include::../../api/structs/VkPresentRegionsKHR.txt[]
|
|
|
|
* pname:sType is the type of this structure.
|
|
* pname:pNext is `NULL` or a pointer to an extension-specific structure.
|
|
* pname:swapchainCount is the number of swapchains being presented to by
|
|
this command.
|
|
* pname:pRegions is `NULL` or a pointer to an array of
|
|
sname:VkPresentRegionKHR elements with pname:swapchainCount entries.
|
|
If not `NULL`, each element of pname:pRegions contains the region that
|
|
has changed since the last present to the swapchain in the corresponding
|
|
entry in the sname:VkPresentInfoKHR::pname:pSwapchains array.
|
|
|
|
.Valid Usage
|
|
****
|
|
* [[VUID-VkPresentRegionsKHR-swapchainCount-01260]]
|
|
pname:swapchainCount must: be the same value as
|
|
sname:VkPresentInfoKHR::pname:swapchainCount, where
|
|
sname:VkPresentInfoKHR is in the pNext-chain of this
|
|
sname:VkPresentRegionsKHR structure.
|
|
****
|
|
|
|
include::../../validity/structs/VkPresentRegionsKHR.txt[]
|
|
--
|
|
|
|
[open,refpage='VkPresentRegionKHR',desc='Structure containing rectangular region changed by vkQueuePresentKHR for a given VkImage',type='structs']
|
|
--
|
|
|
|
For a given image and swapchain, the region to present is specified by the
|
|
sname:VkPresentRegionKHR structure, which is defined as:
|
|
|
|
include::../../api/structs/VkPresentRegionKHR.txt[]
|
|
|
|
* pname:rectangleCount is the number of rectangles in pname:pRectangles,
|
|
or zero if the entire image has changed and should be presented.
|
|
* pname:pRectangles is either `NULL` or a pointer to an array of
|
|
sname:VkRectLayerKHR structures.
|
|
The sname:VkRectLayerKHR structure is the framebuffer coordinates, plus
|
|
layer, of a portion of a presentable image that has changed and must: be
|
|
presented.
|
|
If non-`NULL`, each entry in pname:pRectangles is a rectangle of the
|
|
given image that has changed since the last image was presented to the
|
|
given swapchain.
|
|
|
|
include::../../validity/structs/VkPresentRegionKHR.txt[]
|
|
--
|
|
|
|
[open,refpage='VkRectLayerKHR',desc='Structure containing a rectangle, including layer, changed by vkQueuePresentKHR for a given VkImage',type='structs']
|
|
--
|
|
|
|
The sname:VkRectLayerKHR structure is defined as:
|
|
|
|
include::../../api/structs/VkRectLayerKHR.txt[]
|
|
|
|
* pname:offset is the origin of the rectangle, in pixels.
|
|
* pname:extent is the size of the rectangle, in pixels.
|
|
* pname:layer is the layer of the image.
|
|
For images with only one layer, the value of pname:layer must: be 0.
|
|
|
|
.Valid Usage
|
|
****
|
|
* [[VUID-VkRectLayerKHR-offset-01261]]
|
|
The sum of pname:offset and pname:extent must: be no greater than the
|
|
pname:imageExtent member of the sname:VkSwapchainCreateInfoKHR structure
|
|
given to flink:vkCreateSwapchainKHR.
|
|
* [[VUID-VkRectLayerKHR-layer-01262]]
|
|
pname:layer must: be less than pname:imageArrayLayers member of the
|
|
sname:VkSwapchainCreateInfoKHR structure given to
|
|
flink:vkCreateSwapchainKHR.
|
|
****
|
|
|
|
include::../../validity/structs/VkRectLayerKHR.txt[]
|
|
|
|
Some platforms allow the size of a surface to change, and then scale the
|
|
pixels of the image to fit the surface.
|
|
sname:VkRectLayerKHR specifies pixels of the swapchain's image(s), which
|
|
will be constant for the life of the swapchain.
|
|
|
|
--
|