Class VkRenderPassBeginInfo

  • All Implemented Interfaces:
    java.lang.AutoCloseable, NativeResource, Pointer

    public class VkRenderPassBeginInfo
    extends Struct
    implements NativeResource
    Structure specifying render pass begin info.
    Description

    renderArea is the render area that is affected by the render pass instance. The effects of attachment load, store and multisample resolve operations are restricted to the pixels whose x and y coordinates fall within the render area on all attachments. The render area extends to all layers of framebuffer. The application must ensure (using scissor if necessary) that all rendering is contained within the render area, otherwise the pixels outside of the render area become undefined and shader side effects may occur for fragments outside the render area. The render area must be contained within the framebuffer dimensions.

    When multiview is enabled, the resolve operation at the end of a subpass applies to all views in the view mask.

    Note

    There may be a performance cost for using a render area smaller than the framebuffer, unless it matches the render area granularity for the render pass.

    Valid Usage
    • clearValueCount must be greater than the largest attachment index in renderPass that specifies a loadOp (or stencilLoadOp, if the attachment has a depth/stencil format) of ATTACHMENT_LOAD_OP_CLEAR
    • If clearValueCount is not 0, pClearValues must be a valid pointer to an array of clearValueCount valid VkClearValue unions
    • renderPass must be compatible with the renderPass member of the VkFramebufferCreateInfo structure specified when creating framebuffer.
    Valid Usage (Implicit)
    See Also

    VkClearValue, VkRect2D, CmdBeginRenderPass, CmdBeginRenderPass2KHR

    Member documentation

    • sType – the type of this structure.
    • pNextNULL or a pointer to an extension-specific structure.
    • renderPass – the render pass to begin an instance of.
    • framebuffer – the framebuffer containing the attachments that are used with the render pass.
    • renderArea – the render area that is affected by the render pass instance, and is described in more detail below.
    • clearValueCount – the number of elements in pClearValues.
    • pClearValues – an array of VkClearValue structures that contains clear values for each attachment, if the attachment uses a loadOp value of ATTACHMENT_LOAD_OP_CLEAR or if the attachment has a depth/stencil format and uses a stencilLoadOp value of ATTACHMENT_LOAD_OP_CLEAR. The array is indexed by attachment number. Only elements corresponding to cleared attachments are used. Other elements of pClearValues are ignored.

    Layout

    
     struct VkRenderPassBeginInfo {
         VkStructureType sType;
         void const * pNext;
         VkRenderPass renderPass;
         VkFramebuffer framebuffer;
         VkRect2D renderArea;
         uint32_t clearValueCount;
         VkClearValue const * pClearValues;
     }