To clear one or more subranges of a depth/stencil image, call:
void vkCmdClearDepthStencilImage( VkCommandBuffer commandBuffer, VkImage image, VkImageLayout imageLayout, const VkClearDepthStencilValue* pDepthStencil, uint32_t rangeCount, const VkImageSubresourceRange* pRanges);
commandBufferis the command buffer into which the command will be recorded.
imageis the image to be cleared.
imageLayoutspecifies the current layout of the image subresource ranges to be cleared, and must be
pDepthStencilis a pointer to a VkClearDepthStencilValue structure that contains the values the depth and stencil image subresource ranges will be cleared to (see ../../html/vkspec.html#clears-values below).
rangeCountis the number of image subresource range structures in
pRangespoints to an array of VkImageSubresourceRange structures that describe a range of mipmap levels, array layers, and aspects to be cleared, as described in Image Views. The
aspectMaskof each image subresource range in
VK_IMAGE_ASPECT_DEPTH_BITif the image format has a depth component, and
VK_IMAGE_ASPECT_STENCIL_BITif the image format has a stencil component.
For more information, see the Vulkan Specification at URL
This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification, not directly.
Copyright (c) 2014-2018 Khronos Group. This work is licensed under a Creative Commons Attribution 4.0 International License.