C Specification
Alternatively to begin a render pass, call:
// Provided by VK_VERSION_1_2
void vkCmdBeginRenderPass2(
VkCommandBuffer commandBuffer,
const VkRenderPassBeginInfo* pRenderPassBegin,
const VkSubpassBeginInfo* pSubpassBeginInfo);
Parameters
-
commandBuffer
is the command buffer in which to record the command. -
pRenderPassBegin
is a pointer to a VkRenderPassBeginInfo structure specifying the render pass to begin an instance of, and the framebuffer the instance uses. -
pSubpassBeginInfo
is a pointer to a VkSubpassBeginInfo structure containing information about the subpass which is about to begin rendering.
Description
After beginning a render pass instance, the command buffer is ready to record the commands for the first subpass of that render pass.
-
VUID-vkCmdBeginRenderPass2-framebuffer-02779
Both theframebuffer
andrenderPass
members ofpRenderPassBegin
must have been created on the same VkDevice thatcommandBuffer
was allocated on -
VUID-vkCmdBeginRenderPass2-initialLayout-03094
If any of theinitialLayout
orfinalLayout
member of theVkAttachmentDescription
structures or thelayout
member of theVkAttachmentReference
structures specified when creating the render pass specified in therenderPass
member ofpRenderPassBegin
isVK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL
then the corresponding attachment image view of the framebuffer specified in theframebuffer
member ofpRenderPassBegin
must have been created with ausage
value includingVK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT
-
VUID-vkCmdBeginRenderPass2-initialLayout-03096
If any of theinitialLayout
orfinalLayout
member of theVkAttachmentDescription
structures or thelayout
member of theVkAttachmentReference
structures specified when creating the render pass specified in therenderPass
member ofpRenderPassBegin
isVK_IMAGE_LAYOUT_DEPTH_READ_ONLY_STENCIL_ATTACHMENT_OPTIMAL
,VK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_STENCIL_READ_ONLY_OPTIMAL
,VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL
, orVK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL
then the corresponding attachment image view of the framebuffer specified in theframebuffer
member ofpRenderPassBegin
must have been created with ausage
value includingVK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
-
VUID-vkCmdBeginRenderPass2-initialLayout-02844
If any of theinitialLayout
orfinalLayout
member of theVkAttachmentDescription
structures or thelayout
member of theVkAttachmentReference
structures specified when creating the render pass specified in therenderPass
member ofpRenderPassBegin
isVK_IMAGE_LAYOUT_DEPTH_ATTACHMENT_OPTIMAL
, orVK_IMAGE_LAYOUT_DEPTH_READ_ONLY_OPTIMAL
,VK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL
, orVK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL
then the corresponding attachment image view of the framebuffer specified in theframebuffer
member ofpRenderPassBegin
must have been created with ausage
value includingVK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
-
VUID-vkCmdBeginRenderPass2-stencilInitialLayout-02845
If any of thestencilInitialLayout
orstencilFinalLayout
member of theVkAttachmentDescriptionStencilLayout
structures or thestencilLayout
member of theVkAttachmentReferenceStencilLayout
structures specified when creating the render pass specified in therenderPass
member ofpRenderPassBegin
isVK_IMAGE_LAYOUT_STENCIL_ATTACHMENT_OPTIMAL
, orVK_IMAGE_LAYOUT_STENCIL_READ_ONLY_OPTIMAL
then the corresponding attachment image view of the framebuffer specified in theframebuffer
member ofpRenderPassBegin
must have been created with ausage
value includingVK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT
-
VUID-vkCmdBeginRenderPass2-initialLayout-03097
If any of theinitialLayout
orfinalLayout
member of theVkAttachmentDescription
structures or thelayout
member of theVkAttachmentReference
structures specified when creating the render pass specified in therenderPass
member ofpRenderPassBegin
isVK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL
then the corresponding attachment image view of the framebuffer specified in theframebuffer
member ofpRenderPassBegin
must have been created with ausage
value includingVK_IMAGE_USAGE_SAMPLED_BIT
orVK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT
-
VUID-vkCmdBeginRenderPass2-initialLayout-03098
If any of theinitialLayout
orfinalLayout
member of theVkAttachmentDescription
structures or thelayout
member of theVkAttachmentReference
structures specified when creating the render pass specified in therenderPass
member ofpRenderPassBegin
isVK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL
then the corresponding attachment image view of the framebuffer specified in theframebuffer
member ofpRenderPassBegin
must have been created with ausage
value includingVK_IMAGE_USAGE_TRANSFER_SRC_BIT
-
VUID-vkCmdBeginRenderPass2-initialLayout-03099
If any of theinitialLayout
orfinalLayout
member of theVkAttachmentDescription
structures or thelayout
member of theVkAttachmentReference
structures specified when creating the render pass specified in therenderPass
member ofpRenderPassBegin
isVK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL
then the corresponding attachment image view of the framebuffer specified in theframebuffer
member ofpRenderPassBegin
must have been created with ausage
value includingVK_IMAGE_USAGE_TRANSFER_DST_BIT
-
VUID-vkCmdBeginRenderPass2-initialLayout-03100
If theinitialLayout
member of any of theVkAttachmentDescription
structures specified when creating the render pass specified in therenderPass
member ofpRenderPassBegin
is notVK_IMAGE_LAYOUT_UNDEFINED
, then each suchinitialLayout
must be equal to the current layout of the corresponding attachment image subresource of the framebuffer specified in theframebuffer
member ofpRenderPassBegin
-
VUID-vkCmdBeginRenderPass2-srcStageMask-06453
ThesrcStageMask
members of any element of thepDependencies
member of VkRenderPassCreateInfo used to createrenderPass
must be supported by the capabilities of the queue family identified by thequeueFamilyIndex
member of the VkCommandPoolCreateInfo used to create the command pool whichcommandBuffer
was allocated from -
VUID-vkCmdBeginRenderPass2-dstStageMask-06454
ThedstStageMask
members of any element of thepDependencies
member of VkRenderPassCreateInfo used to createrenderPass
must be supported by the capabilities of the queue family identified by thequeueFamilyIndex
member of the VkCommandPoolCreateInfo used to create the command pool whichcommandBuffer
was allocated from -
VUID-vkCmdBeginRenderPass2-framebuffer-02533
For any attachment inframebuffer
that is used byrenderPass
and is bound to memory locations that are also bound to another attachment used byrenderPass
, and if at least one of those uses causes either attachment to be written to, both attachments must have had theVK_ATTACHMENT_DESCRIPTION_MAY_ALIAS_BIT
set -
VUID-vkCmdBeginRenderPass2-framebuffer-09046
If any attachments specified inframebuffer
are used byrenderPass
and are bound to overlapping memory locations, there must be only one that is used as a color attachment, depth/stencil, or resolve attachment in any subpass
-
VUID-vkCmdBeginRenderPass2-commandBuffer-parameter
commandBuffer
must be a valid VkCommandBuffer handle -
VUID-vkCmdBeginRenderPass2-pRenderPassBegin-parameter
pRenderPassBegin
must be a valid pointer to a valid VkRenderPassBeginInfo structure -
VUID-vkCmdBeginRenderPass2-pSubpassBeginInfo-parameter
pSubpassBeginInfo
must be a valid pointer to a valid VkSubpassBeginInfo structure -
VUID-vkCmdBeginRenderPass2-commandBuffer-recording
commandBuffer
must be in the recording state -
VUID-vkCmdBeginRenderPass2-commandBuffer-cmdpool
TheVkCommandPool
thatcommandBuffer
was allocated from must support graphics operations -
VUID-vkCmdBeginRenderPass2-renderpass
This command must only be called outside of a render pass instance -
VUID-vkCmdBeginRenderPass2-bufferlevel
commandBuffer
must be a primaryVkCommandBuffer
-
Host access to
commandBuffer
must be externally synchronized -
Host access to the
VkCommandPool
thatcommandBuffer
was allocated from must be externally synchronized
Command Buffer Levels | Render Pass Scope | Supported Queue Types | Command Type |
---|---|---|---|
Primary |
Outside |
Graphics |
Action |
Document Notes
For more information, see the Vulkan Specification
This page is extracted from the Vulkan Specification. Fixes and changes should be made to the Specification, not directly.