UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FDepthStencilBinding Struct Reference

#include <ShaderParameterMacros.h>

Public Member Functions

 FDepthStencilBinding ()=default
 
 FDepthStencilBinding (FRDGTexture *InTexture, ERenderTargetLoadAction InDepthLoadAction, ERenderTargetLoadAction InStencilLoadAction, FExclusiveDepthStencil InDepthStencilAccess)
 
 FDepthStencilBinding (FRDGTexture *InTexture, FRDGTexture *InResolveTexture, ERenderTargetLoadAction InDepthLoadAction, ERenderTargetLoadAction InStencilLoadAction, FExclusiveDepthStencil InDepthStencilAccess)
 
 FDepthStencilBinding (FRDGTexture *InTexture, ERenderTargetLoadAction InDepthLoadAction, FExclusiveDepthStencil InDepthStencilAccess)
 
 FDepthStencilBinding (FRDGTexture *InTexture, FRDGTexture *InResolveTexture, ERenderTargetLoadAction InDepthLoadAction, FExclusiveDepthStencil InDepthStencilAccess)
 
FRDGTextureGetTexture () const
 
FRDGTextureGetResolveTexture () const
 
ERenderTargetLoadAction GetDepthLoadAction () const
 
ERenderTargetLoadAction GetStencilLoadAction () const
 
FExclusiveDepthStencil GetDepthStencilAccess () const
 
bool CanMergeBefore (const FDepthStencilBinding &Other) const
 
void SetTexture (FRDGTexture *InTexture)
 
void SetResolveTexture (FRDGTexture *InTexture)
 
void SetDepthStencilAccess (FExclusiveDepthStencil InAccess)
 
void SetDepthLoadAction (ERenderTargetLoadAction InAction)
 
void SetStencilLoadAction (ERenderTargetLoadAction InAction)
 

Detailed Description

Render graph information about how to bind a depth-stencil render target.

Constructor & Destructor Documentation

◆ FDepthStencilBinding() [1/5]

FDepthStencilBinding::FDepthStencilBinding ( )
default

◆ FDepthStencilBinding() [2/5]

FDepthStencilBinding::FDepthStencilBinding ( FRDGTexture InTexture,
ERenderTargetLoadAction  InDepthLoadAction,
ERenderTargetLoadAction  InStencilLoadAction,
FExclusiveDepthStencil  InDepthStencilAccess 
)
inline

Creates a render target binding informations for a depth/stencil texture.

Notes: Load and store action are on explicit without default values, to force the user to not forget one of these.

◆ FDepthStencilBinding() [3/5]

FDepthStencilBinding::FDepthStencilBinding ( FRDGTexture InTexture,
FRDGTexture InResolveTexture,
ERenderTargetLoadAction  InDepthLoadAction,
ERenderTargetLoadAction  InStencilLoadAction,
FExclusiveDepthStencil  InDepthStencilAccess 
)
inline

◆ FDepthStencilBinding() [4/5]

FDepthStencilBinding::FDepthStencilBinding ( FRDGTexture InTexture,
ERenderTargetLoadAction  InDepthLoadAction,
FExclusiveDepthStencil  InDepthStencilAccess 
)
inline

◆ FDepthStencilBinding() [5/5]

FDepthStencilBinding::FDepthStencilBinding ( FRDGTexture InTexture,
FRDGTexture InResolveTexture,
ERenderTargetLoadAction  InDepthLoadAction,
FExclusiveDepthStencil  InDepthStencilAccess 
)
inline

Member Function Documentation

◆ CanMergeBefore()

bool FDepthStencilBinding::CanMergeBefore ( const FDepthStencilBinding Other) const
inline

◆ GetDepthLoadAction()

ERenderTargetLoadAction FDepthStencilBinding::GetDepthLoadAction ( ) const
inline

◆ GetDepthStencilAccess()

FExclusiveDepthStencil FDepthStencilBinding::GetDepthStencilAccess ( ) const
inline

◆ GetResolveTexture()

FRDGTexture * FDepthStencilBinding::GetResolveTexture ( ) const
inline

◆ GetStencilLoadAction()

ERenderTargetLoadAction FDepthStencilBinding::GetStencilLoadAction ( ) const
inline

◆ GetTexture()

FRDGTexture * FDepthStencilBinding::GetTexture ( ) const
inline

◆ SetDepthLoadAction()

void FDepthStencilBinding::SetDepthLoadAction ( ERenderTargetLoadAction  InAction)
inline

◆ SetDepthStencilAccess()

void FDepthStencilBinding::SetDepthStencilAccess ( FExclusiveDepthStencil  InAccess)
inline

◆ SetResolveTexture()

void FDepthStencilBinding::SetResolveTexture ( FRDGTexture InTexture)
inline

◆ SetStencilLoadAction()

void FDepthStencilBinding::SetStencilLoadAction ( ERenderTargetLoadAction  InAction)
inline

◆ SetTexture()

void FDepthStencilBinding::SetTexture ( FRDGTexture InTexture)
inline

The documentation for this struct was generated from the following files: