mirror of
https://github.com/status-im/Vulkan-Docs.git
synced 2025-03-03 07:20:27 +00:00
685295031d
* Bump API patch number and header version number to 49 for this update.
Github Issues:
* Modify reference page extraction script to make internal links to spec
anchors refer to the core specification instead of being dangling links
(public issue 455).
* Fix GL_KHR_vulkan_glsl typo and add a nor-normative mapping to the newly
published StorageBuffer class (public issue 466).
* Both flink:vkEnumerateInstanceExtensionProperties and
flink:vkEnumerateDeviceExtensionProperties return
ename:VK_ERROR_LAYER_NOT_PRESENT, which covers the error case of an
application providing a layer name that wasn't returned by
ftext:vkEnumerate{Instance|Device}LayerProperties (public issue 487).
* The specification for flink:VkApplicationInfo::apiVersion says that the
driver must return ename:VK_ERROR_INCOMPATIBLE_DRIVER in the case that
pname:apiVersion specifies a non-supported version. That means that the
valid usage should not also state that, and so the VU statement is
removed. The VU had language about "`an effective substitute`" that
would have been lost, and so it was moved to the pname:apiVersion
description (public issue 488).
Internal Issues:
* Modify implicit validity generator script to assign asciidoc anchors to
all valid usage statements it generates, and reflow.py script to insert
Valid Usage ID (VUID) tags into the specification source files for
explicit valid usage statements. This has no semantic effects on the
specification, but will support the validation layer's detection of
valid usage violations and allow it to link into the corresponding part
of the specification (internal issue 583).
* Assign VUID tags to all explicit VU statements and document
the process and tag format in the style guide (internal issue 583).
* Clarify the rules of whether to structure new functionality as instance
extensions, device extensions, or both in the
<<extended-functionality-instance-extensions-and-devices, Instance
Extensions and Device Extensions>> section (internal issue 749).
* Require that SPIR-V run-time arrays are only used with the
code:BufferBlock decoration (internal issue 750).
* Fix implicit and explicit valid usage statements for
slink:VkWriteDescriptorSet::pname:dstSet (internal issue 767)
* Fix SPIR-V code sample for ename:VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER
in the <<descriptorsets-uniformtexelbuffer, Uniform Texel Buffer>>
section (internal issue 770).
* Clarify that disabling depth testing also disables depth writes in the
<<fragops-ds-state, Depth and Stencil Operations>> section (internal
issue 775).
* flink:VkDescriptorImageInfo::pname:imageLayout must match the actual
imageLayout at the time the image is accessed. This was in the spec
text, but needed an associated valid usage statement.
* Note that only 32-bit atomic operations are supported in the
<<spirvenv-module-validation, Validation Rules within a Module>>
section.
* Note that code:UniformConstant variables must not have initializers in
the <<spirvenv-module-validation, Validation Rules within a Module>>
section.
* Add a new elink:VkObjectType enumeration to the core API, promoted from
elink:VkDebugObjectTypeEXT, since it is used for much more than just the
debug_report extension.
New Extensions:
* `VK_KHR_get_surface_capabilities2`
* `VK_KHR_shared_presentable_image`
92 lines
4.0 KiB
Plaintext
92 lines
4.0 KiB
Plaintext
// Copyright (c) 2014-2017 The Khronos Group Inc.
|
|
// Copyright notice at https://www.khronos.org/registry/speccopyright.html
|
|
|
|
// refBegin VkPresentRegionsKHR - Structure hint of rectangular regions changed by vkQueuePresentKHR
|
|
|
|
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[]
|
|
|
|
// refBegin VkPresentRegionKHR - Structure containing rectangular region changed by vkQueuePresentKHR for a given VkImage
|
|
|
|
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[]
|
|
|
|
// refBegin VkRectLayerKHR - Structure containing a rectangle, including layer, changed by vkQueuePresentKHR for a given VkImage
|
|
|
|
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.
|
|
VkRectLayerKHR specifies pixels of the swapchain's image(s), which will be
|
|
constant for the life of the swapchain.
|
|
|
|
// refEnd VkRectLayerKHR
|