mirror of
https://github.com/status-im/Vulkan-Docs.git
synced 2025-01-23 12:49:27 +00:00
6db51e9241
* Bump API patch number and header version number to 11 for this
update.
Github Issues:
* Clarify the WSI extension language by switching from the fuzzier
"ownership" language to more-consistent "acquire" language (public
issue 117).
* Clarify that memory barriers apply to all commands in the dependency
chains in the flink:vkGetRenderAreaGranularity command and the
<<synchronization-execution-and-memory-dependencies,Execution And
Memory Dependencies>> section (public issue 132).
* Clarify that a queue family is a set of queues in the
<<fundamentals-execmodel,Execution Model>> section (public issue
166).
* Removed requirement from valid usage language that
VkPresentInfoKHR::waitSemaphoreCount must be greater than 0 (public
issue 171).
* Fix broken internal links, describe structures consistently, use
consistent style for SPIR-V codewords, and tag normative terms that
were missing asciidoc tags (public issue 183 and ancillary
markup/normative language fixes).
* Fix typos for slink:VkPhysicalDeviceLimits member names in
slink:VkImageCreateInfo validity language (public issue 184).
Internal Issues:
* Document that the requested patch version number specified as part
of slink:VkApplicationInfo::pname:apiVersion is ignored when
creating an instance (internal issue 176).
* Clarify handling of extension structs in the
<<fundamentals-validusageValid Usage>> section (internal issue 254).
* Update required slink:VkImageFormatProperties::pname:maxMipLevels to
be limited to the maximum allowed mipmap pyramid size corresponding
to the actual maximum supported size for the format (internal issue
256).
* Modify the <<features-extentperimagetype,Allowed Extent Values Based
On Image Type>> section so the allowed maximum extent is the maximum
image dimension supported for each dimension of the type of texture
being queried (internal issue 257).
* Clarify in the <<spirvenv-module-validation,Validation Rules within
a Module>> section that at least one of the code:LocalSize execution
mode or code:WorkgroupSize decoration is required for each compute
shader entry point in a shader module (internal issue 279).
* Add validity rules for formats in flink:vkCmdClearColorImage and
flink:vkCmdClearDepthStencilImage (internal issue 283).
* Clarify that slink:VkImageFormatProperties::pname:maxResourceSize is
an upper bound, and that it may not be possible to create an image
anywhere near that size (internal issue 284).
Other Commits:
* Fix various minor markup errors reported by validation scripts.
* Change copyright from Khronos Free Use License to Apache 2.0 license
on relevant script/XML/header files. This does not affect the
specification source copyright.
68 lines
1.9 KiB
Plaintext
68 lines
1.9 KiB
Plaintext
vkCmdClearDepthStencilImage(3)
|
|
==============================
|
|
|
|
Name
|
|
----
|
|
vkCmdClearDepthStencilImage - Fill regions of a combined depth-stencil image.
|
|
|
|
C Specification
|
|
---------------
|
|
|
|
include::../protos/vkCmdClearDepthStencilImage.txt[]
|
|
|
|
Parameters
|
|
----------
|
|
|
|
pname:commandBuffer::
|
|
The command buffer into which the command is to be placed.
|
|
|
|
pname:image::
|
|
The image containing the regions to be cleared.
|
|
|
|
pname:imageLayout::
|
|
The layout of the image to be cleared.
|
|
|
|
pname:pDepthStencil::
|
|
A pointer to a structure containing the values to clear the image with.
|
|
|
|
pname:rangeCount::
|
|
The number of image regions to clear.
|
|
|
|
pname:pRanges::
|
|
A pointer to an array of pname:rangeCount regions to clear.
|
|
|
|
Description
|
|
-----------
|
|
|
|
fname:vkCmdClearDepthStencilImage clears pname:rangeCount regions of a combined
|
|
depth-stencil image to the values specified in the structure whose address is
|
|
given in pname:pDepthStencil. This is a pointer to an instance of the
|
|
slink:VkClearDepthStencilValue structure, the definition of which is:
|
|
|
|
include::../structs/VkClearDepthStencilValue.txt[]
|
|
|
|
The pname:depth and pname:stencil members contain the value to clear the
|
|
depth and stencil aspects of the image to, respectively. pname:imageLayout
|
|
specifies the layout of the image being cleared. pname:pRanges points to an
|
|
array pname:rangeCount regions of the image are cleared, each of which is described
|
|
by an instance of the slink:VkImageSubresourceRange structure, the definition
|
|
of which is:
|
|
|
|
include::../structs/VkImageSubresourceRange.txt[]
|
|
|
|
include::../validity/protos/vkCmdClearDepthStencilImage.txt[]
|
|
|
|
Notes
|
|
-----
|
|
|
|
Although fname:vkCmdClearDepthStencilImage does not generate errors or return a value, enabled
|
|
validation layers may detect possible error conditions or potentially undefined
|
|
behavior and report this via some other means.
|
|
|
|
See Also
|
|
--------
|
|
|
|
flink:vkCmdClearColorImage
|
|
|
|
include::footer.txt[]
|