UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
TClearReplacementCS< ResourceType, BaseType > Class Template Reference

#include <ClearReplacementShaders.h>

+ Inheritance diagram for TClearReplacementCS< ResourceType, BaseType >:

Public Member Functions

 TClearReplacementCS ()
 
 TClearReplacementCS (const ShaderMetaType::CompiledShaderInitializerType &Initializer)
 
const FShaderResourceParameterGetClearResourceParam () const
 
uint32 GetResourceParamIndex () const
 

Static Public Member Functions

static bool ShouldCompilePermutation (const FGlobalShaderPermutationParameters &Parameters)
 
static void ModifyCompilationEnvironment (const FGlobalShaderPermutationParameters &Parameters, FShaderCompilerEnvironment &OutEnvironment)
 
static const TCHARGetFunctionName ()
 
static FIntVector GetGroupCount (uint32 SizeX, uint32 SizeY, uint32 SizeZ)
 

Static Public Attributes

static constexpr uint32 ThreadGroupSizeX = ClearReplacementCS::TThreadGroupSize<ResourceType>::X
 
static constexpr uint32 ThreadGroupSizeY = ClearReplacementCS::TThreadGroupSize<ResourceType>::Y
 
static constexpr uint32 ThreadGroupSizeZ = ClearReplacementCS::TThreadGroupSize<ResourceType>::Z
 
static constexpr bool bUseWrappedGroupCount = (ThreadGroupSizeY == 1) && (ThreadGroupSizeZ == 1) && BaseType::bSupportsWrappedGroupCount
 

Constructor & Destructor Documentation

◆ TClearReplacementCS() [1/2]

template<EClearReplacementResourceType ResourceType, typename BaseType >
TClearReplacementCS< ResourceType, BaseType >::TClearReplacementCS ( )
inline

◆ TClearReplacementCS() [2/2]

template<EClearReplacementResourceType ResourceType, typename BaseType >
TClearReplacementCS< ResourceType, BaseType >::TClearReplacementCS ( const ShaderMetaType::CompiledShaderInitializerType &  Initializer)
inline

Member Function Documentation

◆ GetClearResourceParam()

template<EClearReplacementResourceType ResourceType, typename BaseType >
const FShaderResourceParameter & TClearReplacementCS< ResourceType, BaseType >::GetClearResourceParam ( ) const
inline

◆ GetFunctionName()

template<EClearReplacementResourceType ResourceType, typename BaseType >
static const TCHAR * TClearReplacementCS< ResourceType, BaseType >::GetFunctionName ( )
inlinestatic

◆ GetGroupCount()

template<EClearReplacementResourceType ResourceType, typename BaseType >
static FIntVector TClearReplacementCS< ResourceType, BaseType >::GetGroupCount ( uint32  SizeX,
uint32  SizeY,
uint32  SizeZ 
)
inlinestatic

◆ GetResourceParamIndex()

template<EClearReplacementResourceType ResourceType, typename BaseType >
uint32 TClearReplacementCS< ResourceType, BaseType >::GetResourceParamIndex ( ) const
inline

◆ ModifyCompilationEnvironment()

template<EClearReplacementResourceType ResourceType, typename BaseType >
static void TClearReplacementCS< ResourceType, BaseType >::ModifyCompilationEnvironment ( const FGlobalShaderPermutationParameters Parameters,
FShaderCompilerEnvironment OutEnvironment 
)
inlinestatic

◆ ShouldCompilePermutation()

template<EClearReplacementResourceType ResourceType, typename BaseType >
static bool TClearReplacementCS< ResourceType, BaseType >::ShouldCompilePermutation ( const FGlobalShaderPermutationParameters Parameters)
inlinestatic

Member Data Documentation

◆ bUseWrappedGroupCount

template<EClearReplacementResourceType ResourceType, typename BaseType >
constexpr bool TClearReplacementCS< ResourceType, BaseType >::bUseWrappedGroupCount = (ThreadGroupSizeY == 1) && (ThreadGroupSizeZ == 1) && BaseType::bSupportsWrappedGroupCount
staticconstexpr

◆ ThreadGroupSizeX

template<EClearReplacementResourceType ResourceType, typename BaseType >
constexpr uint32 TClearReplacementCS< ResourceType, BaseType >::ThreadGroupSizeX = ClearReplacementCS::TThreadGroupSize<ResourceType>::X
staticconstexpr

◆ ThreadGroupSizeY

template<EClearReplacementResourceType ResourceType, typename BaseType >
constexpr uint32 TClearReplacementCS< ResourceType, BaseType >::ThreadGroupSizeY = ClearReplacementCS::TThreadGroupSize<ResourceType>::Y
staticconstexpr

◆ ThreadGroupSizeZ

template<EClearReplacementResourceType ResourceType, typename BaseType >
constexpr uint32 TClearReplacementCS< ResourceType, BaseType >::ThreadGroupSizeZ = ClearReplacementCS::TThreadGroupSize<ResourceType>::Z
staticconstexpr

The documentation for this class was generated from the following file: