Package org.lwjgl.vulkan

Class VkRenderPassBeginInfo

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkRenderPassBeginInfo>
org.lwjgl.vulkan.VkRenderPassBeginInfo
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class VkRenderPassBeginInfo extends org.lwjgl.system.Struct<VkRenderPassBeginInfo> implements org.lwjgl.system.NativeResource
Structure specifying render pass begin information.
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. The render area, after any transform specified by VkRenderPassTransformBeginInfoQCOM::transform is applied, must be contained within the framebuffer dimensions.

If render pass transform is enabled, then renderArea must equal the framebuffer pre-transformed dimensions. After renderArea has been transformed by VkRenderPassTransformBeginInfoQCOM::transform, the resulting render area must be equal to the framebuffer dimensions.

If multiview is enabled in renderPass, and multiviewPerViewRenderAreas feature is enabled, and there is an instance of VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM included in the pNext chain with perViewRenderAreaCount not equal to 0, then the elements of VkMultiviewPerViewRenderAreasRenderPassBeginInfoQCOM::pPerViewRenderAreas override renderArea and define a render area for each view. In this case, renderArea must be an area at least as large as the union of all the per-view render areas.

If the subpassShading feature is enabled, then renderArea must equal the framebuffer dimensions.

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
Valid Usage (Implicit)
See Also

VkClearValue, VkRect2D, CmdBeginRenderPass, CmdBeginRenderPass2, CmdBeginRenderPass2KHR

Layout


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