Package org.lwjgl.vulkan

Class VkRenderPassBeginInfo

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

    public class VkRenderPassBeginInfo
extends Struct
    Khronos Reference Page
    Vulkan Specification

    Indicates the render pass to begin an instance of, and the framebuffer the instance uses.

    Valid Usage
    • sType must be STRUCTURE_TYPE_RENDER_PASS_BEGIN_INFO
    • pNext must be NULL
    • renderPass must be a valid VkRenderPass handle
    • framebuffer must be a valid VkFramebuffer handle
    • If clearValueCount is not 0, pClearValues must be a pointer to an array of clearValueCount VkClearValue unions
    • Each of renderPass and framebuffer must have been created, allocated or retrieved from the same VkDevice
    • clearValueCount must be greater than or equal to the number of attachments in renderPass that specify a loadOp of ATTACHMENT_LOAD_OP_CLEAR

    Member documentation

    • sType – the type of this structure. Must be: STRUCTURE_TYPE_RENDER_PASS_BEGIN_INFO
    • pNext – reserved for use by extensions
    • 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
    • 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. 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;
    const void * pNext;
    VkRenderPass renderPass;
    VkFramebuffer framebuffer;
    VkRect2D renderArea;
    uint32_t clearValueCount;
    const VkClearValue * pClearValues;
}