Diligent::BeginRenderPassAttribs Struct Reference

BeginRenderPass command attributes. More...

#include <DeviceContext.h>

Public Attributes
IRenderPass *	pRenderPass = nullptr
	Render pass to begin.
IFramebuffer *	pFramebuffer = nullptr
	Framebuffer containing the attachments that are used with the render pass.
Uint32	ClearValueCount = 0
	The number of elements in pClearValues array.
OptimizedClearValue *	pClearValues = nullptr
	Clear values for the attachments.
RESOURCE_STATE_TRANSITION_MODE	StateTransitionMode = RESOURCE_STATE_TRANSITION_MODE_NONE
	Framebuffer attachments state transition mode before the render pass begins.

Detailed Description

BeginRenderPass command attributes.

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

Member Data Documentation

pClearValues

OptimizedClearValue* Diligent::BeginRenderPassAttribs::pClearValues = nullptr

Clear values for the attachments.

A pointer to an array of ClearValueCount OptimizedClearValue structures that contains clear values for each attachment, if the attachment uses a LoadOp value of Diligent::ATTACHMENT_LOAD_OP_CLEAR or if the attachment has a depth/stencil format and uses a StencilLoadOp value of Diligent::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.

StateTransitionMode

RESOURCE_STATE_TRANSITION_MODE Diligent::BeginRenderPassAttribs::StateTransitionMode = RESOURCE_STATE_TRANSITION_MODE_NONE

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 Diligent::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 Diligent::RESOURCE_STATE_TRANSITION_MODE_NONE or Diligent::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.