Diligent Engine
 
Loading...
Searching...
No Matches
Diligent::RenderPassAttachmentDesc Struct Reference

Render pass attachment description. More...

#include <RenderPass.h>

Public Member Functions

constexpr bool operator== (const RenderPassAttachmentDesc &RHS) const
 Tests if two structures are equivalent.
 

Public Attributes

TEXTURE_FORMAT Format = TEX_FORMAT_UNKNOWN
 The format of the texture view that will be used for the attachment.
 
Uint8 SampleCount = 1
 The number of samples in the texture.
 
ATTACHMENT_LOAD_OP LoadOp = ATTACHMENT_LOAD_OP_LOAD
 Load operation.
 
ATTACHMENT_STORE_OP StoreOp = ATTACHMENT_STORE_OP_STORE
 Store operation.
 
ATTACHMENT_LOAD_OP StencilLoadOp = ATTACHMENT_LOAD_OP_LOAD
 Stencil load operation.
 
ATTACHMENT_STORE_OP StencilStoreOp = ATTACHMENT_STORE_OP_STORE
 Stencil store operation.
 
RESOURCE_STATE InitialState = RESOURCE_STATE_UNKNOWN
 The state the attachment texture subresource will be in when a render pass instance begins.
 
RESOURCE_STATE FinalState = RESOURCE_STATE_UNKNOWN
 The state the attachment texture subresource will be transitioned to when a render pass instance ends.
 

Detailed Description

Render pass attachment description.

Member Function Documentation

◆ operator==()

bool Diligent::RenderPassAttachmentDesc::operator== ( const RenderPassAttachmentDesc & RHS) const
inlineconstexpr

Tests if two structures are equivalent.

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

Member Data Documentation

◆ LoadOp

ATTACHMENT_LOAD_OP Diligent::RenderPassAttachmentDesc::LoadOp = ATTACHMENT_LOAD_OP_LOAD

Load operation.

Specifies how the contents of color and depth components of the attachment are treated at the beginning of the subpass where it is first used.

◆ StencilLoadOp

ATTACHMENT_LOAD_OP Diligent::RenderPassAttachmentDesc::StencilLoadOp = ATTACHMENT_LOAD_OP_LOAD

Stencil load operation.

Specifies how the contents of the stencil component of the attachment is treated at the beginning of the subpass where it is first used. This value is ignored when the format does not have stencil component.

◆ StencilStoreOp

ATTACHMENT_STORE_OP Diligent::RenderPassAttachmentDesc::StencilStoreOp = ATTACHMENT_STORE_OP_STORE

Stencil store operation.

Defines how the contents of the stencil component of the attachment is treated at the end of the subpass where it is last used. This value is ignored when the format does not have stencil component.

◆ StoreOp

ATTACHMENT_STORE_OP Diligent::RenderPassAttachmentDesc::StoreOp = ATTACHMENT_STORE_OP_STORE

Store operation.

Defines how the contents of color and depth components of the attachment are treated at the end of the subpass where it is last used.