// Copyright (c) 2014-2016 Khronos Group. This work is licensed under a
// Creative Commons Attribution 4.0 International License; see
// http://creativecommons.org/licenses/by/4.0/

vkCmdClearAttachments(3)
========================

Name
----
vkCmdClearAttachments - Clear regions within currently bound framebuffer attachments.

C Specification
---------------

// refBegin vkCmdClearAttachments Clear regions within currently bound framebuffer attachments.

To clear one or more regions of color and depth/stencil attachments inside a
render pass instance, call:

include::../api/protos/vkCmdClearAttachments.txt[]


Parameters
----------

  * pname:commandBuffer is the command buffer into which the command will be
    recorded.
  * pname:attachmentCount is the number of entries in the pname:pAttachments
    array.
  * pname:pAttachments is a pointer to an array of slink:VkClearAttachment
    structures defining the attachments to clear and the clear values to
    use.
  * pname:rectCount is the number of entries in the pname:pRects array.
  * pname:pRects points to an array of slink:VkClearRect structures defining
    regions within each selected attachment to clear.


Description
-----------

fname:vkCmdClearAttachments can: clear multiple regions of each attachment
used in the current subpass of a render pass instance. This command must: be
called only inside a render pass instance, and implicitly selects the images
to clear based on the current framebuffer attachments and the command
parameters.

include::../validity/protos/vkCmdClearAttachments.txt[]


See Also
--------

slink:VkClearAttachment, slink:VkClearRect, slink:VkCommandBuffer


Document Notes
--------------

For more information, see the Vulkan Specification at URL

https://www.khronos.org/registry/vulkan/specs/1.0/xhtml/vkspec.html#vkCmdClearAttachments

This page is extracted from the Vulkan Specification.
Fixes and changes should be made to the Specification,not directly.

include::footer.txt[]