UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Static Public Member Functions | List of all members
TStaticDepthStencilState< bEnableDepthWrite, DepthTest, bEnableFrontFaceStencil, FrontFaceStencilTest, FrontFaceStencilFailStencilOp, FrontFaceDepthFailStencilOp, FrontFacePassStencilOp, bEnableBackFaceStencil, BackFaceStencilTest, BackFaceStencilFailStencilOp, BackFaceDepthFailStencilOp, BackFacePassStencilOp, StencilReadMask, StencilWriteMask > Class Template Reference

#include <RHIStaticStates.h>

+ Inheritance diagram for TStaticDepthStencilState< bEnableDepthWrite, DepthTest, bEnableFrontFaceStencil, FrontFaceStencilTest, FrontFaceStencilFailStencilOp, FrontFaceDepthFailStencilOp, FrontFacePassStencilOp, bEnableBackFaceStencil, BackFaceStencilTest, BackFaceStencilFailStencilOp, BackFaceDepthFailStencilOp, BackFacePassStencilOp, StencilReadMask, StencilWriteMask >:

Static Public Member Functions

static FDepthStencilStateRHIRef CreateRHI ()
 
- Static Public Member Functions inherited from TStaticStateRHI< InitializerType, RHIRefType, RHIParamRefType >
static RHIParamRefType GetRHI ()
 

Detailed Description

template<bool bEnableDepthWrite = true, ECompareFunction DepthTest = CF_DepthNearOrEqual, bool bEnableFrontFaceStencil = false, ECompareFunction FrontFaceStencilTest = CF_Always, EStencilOp FrontFaceStencilFailStencilOp = SO_Keep, EStencilOp FrontFaceDepthFailStencilOp = SO_Keep, EStencilOp FrontFacePassStencilOp = SO_Keep, bool bEnableBackFaceStencil = false, ECompareFunction BackFaceStencilTest = CF_Always, EStencilOp BackFaceStencilFailStencilOp = SO_Keep, EStencilOp BackFaceDepthFailStencilOp = SO_Keep, EStencilOp BackFacePassStencilOp = SO_Keep, uint8 StencilReadMask = 0xFF, uint8 StencilWriteMask = 0xFF>
class TStaticDepthStencilState< bEnableDepthWrite, DepthTest, bEnableFrontFaceStencil, FrontFaceStencilTest, FrontFaceStencilFailStencilOp, FrontFaceDepthFailStencilOp, FrontFacePassStencilOp, bEnableBackFaceStencil, BackFaceStencilTest, BackFaceStencilFailStencilOp, BackFaceDepthFailStencilOp, BackFacePassStencilOp, StencilReadMask, StencilWriteMask >

A static RHI stencil state resource. TStaticStencilStateRHI<...>::GetStaticState() will return a FDepthStencilStateRHIRef to a stencil state with the desired settings. Should only be used from the rendering thread.

Member Function Documentation

◆ CreateRHI()

template<bool bEnableDepthWrite = true, ECompareFunction DepthTest = CF_DepthNearOrEqual, bool bEnableFrontFaceStencil = false, ECompareFunction FrontFaceStencilTest = CF_Always, EStencilOp FrontFaceStencilFailStencilOp = SO_Keep, EStencilOp FrontFaceDepthFailStencilOp = SO_Keep, EStencilOp FrontFacePassStencilOp = SO_Keep, bool bEnableBackFaceStencil = false, ECompareFunction BackFaceStencilTest = CF_Always, EStencilOp BackFaceStencilFailStencilOp = SO_Keep, EStencilOp BackFaceDepthFailStencilOp = SO_Keep, EStencilOp BackFacePassStencilOp = SO_Keep, uint8 StencilReadMask = 0xFF, uint8 StencilWriteMask = 0xFF>
static FDepthStencilStateRHIRef TStaticDepthStencilState< bEnableDepthWrite, DepthTest, bEnableFrontFaceStencil, FrontFaceStencilTest, FrontFaceStencilFailStencilOp, FrontFaceDepthFailStencilOp, FrontFacePassStencilOp, bEnableBackFaceStencil, BackFaceStencilTest, BackFaceStencilFailStencilOp, BackFaceDepthFailStencilOp, BackFacePassStencilOp, StencilReadMask, StencilWriteMask >::CreateRHI ( )
inlinestatic
The documentation for this class was generated from the following file: