Diligent::BeginRenderPassAttribs struct

BeginRenderPass command attributes.

Contents

This structure is used by IDeviceContext::BeginRenderPass().

Public variables

IRenderPass* pRenderPass
Render pass to begin.
IFramebuffer* pFramebuffer
Framebuffer containing the attachments that are used with the render pass.
Uint32 ClearValueCount
The number of elements in pClearValues array.
OptimizedClearValue* pClearValues
A pointer to an array of ClearValueCount OptimizedClearValue 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.
RESOURCE_STATE_TRANSITION_MODE StateTransitionMode
Framebuffer attachments state transition mode before the render pass begins.

Variable documentation

RESOURCE_STATE_TRANSITION_MODE Diligent::BeginRenderPassAttribs::StateTransitionMode

Framebuffer attachments state transition mode before the render pass begins.

This parameter also indicates how attachment states should be handled when transitioning between subpasses as well as after the render pass ends. When RESOURCE_STATE_TRANSITION_MODE_TRANSITION is used, attachment states will be updated so that they match the state in the current subpass as well as the final states specified by the render pass when the pass ends. Note that resources are always transitioned. The flag only indicates if the internal state variables should be updated. When RESOURCE_STATE_TRANSITION_MODE_NONE or RESOURCE_STATE_TRANSITION_MODE_VERIFY is used, internal state variables are not updated and it is the application responsibility to set them manually to match the actual states.