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

#include <RHI.h>

Public Member Functions

 FDepthStencilStateInitializerRHI (bool bInEnableDepthWrite=true, ECompareFunction InDepthTest=CF_LessEqual, bool bInEnableFrontFaceStencil=false, ECompareFunction InFrontFaceStencilTest=CF_Always, EStencilOp InFrontFaceStencilFailStencilOp=SO_Keep, EStencilOp InFrontFaceDepthFailStencilOp=SO_Keep, EStencilOp InFrontFacePassStencilOp=SO_Keep, bool bInEnableBackFaceStencil=false, ECompareFunction InBackFaceStencilTest=CF_Always, EStencilOp InBackFaceStencilFailStencilOp=SO_Keep, EStencilOp InBackFaceDepthFailStencilOp=SO_Keep, EStencilOp InBackFacePassStencilOp=SO_Keep, uint8 InStencilReadMask=0xFF, uint8 InStencilWriteMask=0xFF)
 
RHI_API FString ToString () const
 
RHI_API void FromString (const FString &Src)
 
RHI_API void FromString (const FStringView &Src)
 

Public Attributes

bool bEnableDepthWrite
 
TEnumAsByte< ECompareFunctionDepthTest
 
bool bEnableFrontFaceStencil
 
TEnumAsByte< ECompareFunctionFrontFaceStencilTest
 
TEnumAsByte< EStencilOpFrontFaceStencilFailStencilOp
 
TEnumAsByte< EStencilOpFrontFaceDepthFailStencilOp
 
TEnumAsByte< EStencilOpFrontFacePassStencilOp
 
bool bEnableBackFaceStencil
 
TEnumAsByte< ECompareFunctionBackFaceStencilTest
 
TEnumAsByte< EStencilOpBackFaceStencilFailStencilOp
 
TEnumAsByte< EStencilOpBackFaceDepthFailStencilOp
 
TEnumAsByte< EStencilOpBackFacePassStencilOp
 
uint8 StencilReadMask
 
uint8 StencilWriteMask
 

Friends

FArchiveoperator<< (FArchive &Ar, FDepthStencilStateInitializerRHI &DepthStencilStateInitializer)
 
RHI_API friend uint32 GetTypeHash (const FDepthStencilStateInitializerRHI &Initializer)
 
RHI_API friend bool operator== (const FDepthStencilStateInitializerRHI &A, const FDepthStencilStateInitializerRHI &B)
 

Constructor & Destructor Documentation

◆ FDepthStencilStateInitializerRHI()

FDepthStencilStateInitializerRHI::FDepthStencilStateInitializerRHI ( bool  bInEnableDepthWrite = true,
ECompareFunction  InDepthTest = CF_LessEqual,
bool  bInEnableFrontFaceStencil = false,
ECompareFunction  InFrontFaceStencilTest = CF_Always,
EStencilOp  InFrontFaceStencilFailStencilOp = SO_Keep,
EStencilOp  InFrontFaceDepthFailStencilOp = SO_Keep,
EStencilOp  InFrontFacePassStencilOp = SO_Keep,
bool  bInEnableBackFaceStencil = false,
ECompareFunction  InBackFaceStencilTest = CF_Always,
EStencilOp  InBackFaceStencilFailStencilOp = SO_Keep,
EStencilOp  InBackFaceDepthFailStencilOp = SO_Keep,
EStencilOp  InBackFacePassStencilOp = SO_Keep,
uint8  InStencilReadMask = 0xFF,
uint8  InStencilWriteMask = 0xFF 
)
inline

Member Function Documentation

◆ FromString() [1/2]

void FDepthStencilStateInitializerRHI::FromString ( const FString &  Src)

◆ FromString() [2/2]

void FDepthStencilStateInitializerRHI::FromString ( const FStringView Src)

◆ ToString()

FString FDepthStencilStateInitializerRHI::ToString ( ) const

Friends And Related Symbol Documentation

◆ GetTypeHash

RHI_API friend uint32 GetTypeHash ( const FDepthStencilStateInitializerRHI Initializer)
friend

◆ operator<<

FArchive & operator<< ( FArchive Ar,
FDepthStencilStateInitializerRHI DepthStencilStateInitializer 
)
friend

◆ operator==

RHI_API friend bool operator== ( const FDepthStencilStateInitializerRHI A,
const FDepthStencilStateInitializerRHI B 
)
friend

Member Data Documentation

◆ BackFaceDepthFailStencilOp

TEnumAsByte<EStencilOp> FDepthStencilStateInitializerRHI::BackFaceDepthFailStencilOp

◆ BackFacePassStencilOp

TEnumAsByte<EStencilOp> FDepthStencilStateInitializerRHI::BackFacePassStencilOp

◆ BackFaceStencilFailStencilOp

TEnumAsByte<EStencilOp> FDepthStencilStateInitializerRHI::BackFaceStencilFailStencilOp

◆ BackFaceStencilTest

TEnumAsByte<ECompareFunction> FDepthStencilStateInitializerRHI::BackFaceStencilTest

◆ bEnableBackFaceStencil

bool FDepthStencilStateInitializerRHI::bEnableBackFaceStencil

◆ bEnableDepthWrite

bool FDepthStencilStateInitializerRHI::bEnableDepthWrite

◆ bEnableFrontFaceStencil

bool FDepthStencilStateInitializerRHI::bEnableFrontFaceStencil

◆ DepthTest

TEnumAsByte<ECompareFunction> FDepthStencilStateInitializerRHI::DepthTest

◆ FrontFaceDepthFailStencilOp

TEnumAsByte<EStencilOp> FDepthStencilStateInitializerRHI::FrontFaceDepthFailStencilOp

◆ FrontFacePassStencilOp

TEnumAsByte<EStencilOp> FDepthStencilStateInitializerRHI::FrontFacePassStencilOp

◆ FrontFaceStencilFailStencilOp

TEnumAsByte<EStencilOp> FDepthStencilStateInitializerRHI::FrontFaceStencilFailStencilOp

◆ FrontFaceStencilTest

TEnumAsByte<ECompareFunction> FDepthStencilStateInitializerRHI::FrontFaceStencilTest

◆ StencilReadMask

uint8 FDepthStencilStateInitializerRHI::StencilReadMask

◆ StencilWriteMask

uint8 FDepthStencilStateInitializerRHI::StencilWriteMask

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