Diligent::SubpassDesc struct

Render pass subpass decription.

Contents

Public functions

auto operator==(const SubpassDesc& RHS) const -> bool
Tests if two structures are equivalent.

Public variables

Uint32 InputAttachmentCount
The number of input attachments the subpass uses.
const AttachmentReference* pInputAttachments
Pointer to the array of input attachments, see Diligent::AttachmentReference.
Uint32 RenderTargetAttachmentCount
The number of color render target attachments.
const AttachmentReference* pRenderTargetAttachments
Pointer to the array of color render target attachments, see Diligent::AttachmentReference.
const AttachmentReference* pResolveAttachments
Pointer to the array of resolve attachments, see Diligent::AttachmentReference.
const AttachmentReference* pDepthStencilAttachment
Pointer to the depth-stencil attachment, see Diligent::AttachmentReference.
Uint32 PreserveAttachmentCount
The number of preserve attachments.
const Uint32* pPreserveAttachments
Pointer to the array of preserve attachments, see Diligent::AttachmentReference.

Function documentation

bool Diligent::SubpassDesc::operator==(const SubpassDesc& RHS) const

Tests if two structures are equivalent.

Parameters
RHS in - reference to the structure to perform comparison with
Returns
  • True if all members of the two structures are equal.
  • False otherwise

Variable documentation

const AttachmentReference* Diligent::SubpassDesc::pRenderTargetAttachments

Pointer to the array of color render target attachments, see Diligent::AttachmentReference.

Each element of the pRenderTargetAttachments array corresponds to an output in the pixel shader, i.e. if the shader declares an output variable decorated with a render target index X, then it uses the attachment provided in pRenderTargetAttachments[X]. If the attachment index is ATTACHMENT_UNUSED, writes to this render target are ignored.

const AttachmentReference* Diligent::SubpassDesc::pResolveAttachments

Pointer to the array of resolve attachments, see Diligent::AttachmentReference.

If pResolveAttachments is not NULL, each of its elements corresponds to a render target attachment (the element in pRenderTargetAttachments at the same index), and a multisample resolve operation is defined for each attachment. At the end of each subpass, multisample resolve operations read the subpass's color attachments, and resolve the samples for each pixel within the render area to the same pixel location in the corresponding resolve attachments, unless the resolve attachment index is ATTACHMENT_UNUSED.