// 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/

vkCmdBeginRenderPass(3)
=======================

Name
----
vkCmdBeginRenderPass - Begin a new render pass.

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

// refBegin vkCmdBeginRenderPass Begin a new render pass.

To begin a render pass instance, call:

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


Parameters
----------

  * pname:commandBuffer is the command buffer in which to record the
    command.
  * pname:pRenderPassBegin is a pointer to a slink:VkRenderPassBeginInfo
    structure (defined below) which indicates the render pass to begin an
    instance of, and the framebuffer the instance uses.
  * pname:contents specifies how the commands in the first subpass will be
    provided, and is one of the values:
+
--
// refBegin VkSubpassContents - specify how commands in the first subpass of a render pass are provided
include::../api/enums/VkSubpassContents.txt[]
--
+
If pname:contents is ename:VK_SUBPASS_CONTENTS_INLINE, the contents of the
subpass will be recorded inline in the primary command buffer, and secondary
command buffers mustnot: be executed within the subpass. If pname:contents
is ename:VK_SUBPASS_CONTENTS_SECONDARY_COMMAND_BUFFERS, the contents are
recorded in secondary command buffers that will be called from the primary
command buffer, and fname:vkCmdExecuteCommands is the only valid command on
the command buffer until fname:vkCmdNextSubpass or fname:vkCmdEndRenderPass.


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

After beginning a render pass instance, the command buffer is ready to
record the commands for the first subpass of that render pass.

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


See Also
--------

slink:VkCommandBuffer, slink:VkRenderPassBeginInfo, elink:VkSubpassContents


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

For more information, see the Vulkan Specification at URL

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

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

include::footer.txt[]