UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
TClearReplacementBase< ValueType, NumChannels, bZeroOutput, bEnableBounds > Struct Template Reference

#include <ClearReplacementShaders.h>

+ Inheritance diagram for TClearReplacementBase< ValueType, NumChannels, bZeroOutput, bEnableBounds >:

Public Member Functions

 DECLARE_INLINE_TYPE_LAYOUT (TClearReplacementBase, NonVirtual)
 
template<typename T = const FShaderParameter&>
TEnableIf<!bZeroOutput, T >::Type GetClearValueParam () const
 
template<typename T = const FShaderParameter&>
TEnableIf< bEnableBounds, T >::Type GetMinBoundsParam () const
 
template<typename T = const FShaderParameter&>
TEnableIf< bEnableBounds, T >::Type GetMaxBoundsParam () const
 
- Public Member Functions inherited from FGlobalShader
 FGlobalShader ()=default
 
RENDERCORE_API FGlobalShader (const ShaderMetaType::CompiledShaderInitializerType &Initializer)
 
template<typename TViewUniformShaderParameters >
void SetParameters (FRHIBatchedShaderParameters &BatchedParameters, FRHIUniformBuffer *ViewUniformBuffer)
 
- Public Member Functions inherited from FShader
RENDERCORE_API FShader ()
 
RENDERCORE_API FShader (const CompiledShaderInitializerType &Initializer)
 
RENDERCORE_API ~FShader ()
 
RENDERCORE_API const FSHAHashGetHash () const
 
RENDERCORE_API const FSHAHashGetVertexFactoryHash () const
 
RENDERCORE_API const FSHAHashGetOutputHash () const
 
uint32 GetSortKey () const
 
RENDERCORE_API void Finalize (const FShaderMapResourceCode *Code)
 
FShaderTypeGetType (const FShaderMapPointerTable &InPointerTable) const
 
FShaderTypeGetType (const FPointerTableBase *InPointerTable) const
 
FVertexFactoryTypeGetVertexFactoryType (const FShaderMapPointerTable &InPointerTable) const
 
FVertexFactoryTypeGetVertexFactoryType (const FPointerTableBase *InPointerTable) const
 
FShaderTypeGetTypeUnfrozen () const
 
int32 GetResourceIndex () const
 
EShaderPlatform GetShaderPlatform () const
 
EShaderFrequency GetFrequency () const
 
const FShaderTarget GetTarget () const
 
bool IsFrozen () const
 
uint32 GetNumInstructions () const
 
uint32 GetNumTextureSamplers () const
 
uint32 GetCodeSize () const
 
void SetNumInstructions (uint32 Value)
 
template<typename UniformBufferStructType >
const TShaderUniformBufferParameter< UniformBufferStructType > & GetUniformBufferParameter () const
 
const FShaderUniformBufferParameterGetUniformBufferParameter (const FShaderParametersMetadata *SearchStruct) const
 
const FShaderUniformBufferParameterGetUniformBufferParameter (const FHashedName SearchName) const
 
RENDERCORE_API const FShaderParametersMetadataFindAutomaticallyBoundUniformBufferStruct (int32 BaseIndex) const
 
RENDERCORE_API void DumpDebugInfo (const FShaderMapPointerTable &InPtrTable)
 
 LAYOUT_FIELD (FShaderParameterBindings, Bindings)
 
 LAYOUT_FIELD (FShaderParameterMapInfo, ParameterMapInfo)
 

Static Public Member Functions

static const TCHARGetSourceFilename ()
 
static void ModifyCompilationEnvironment (const FGlobalShaderPermutationParameters &Parameters, FShaderCompilerEnvironment &OutEnvironment)
 
- Static Public Member Functions inherited from FGlobalShader
static void ModifyCompilationEnvironment (const FGlobalShaderPermutationParameters &Parameters, FShaderCompilerEnvironment &Environment)
 
static bool ShouldCompilePermutation (const FShaderPermutationParameters &)
 
static EShaderPermutationPrecacheRequest ShouldPrecachePermutation (const FShaderPermutationParameters &Parameters)
 
- Static Public Member Functions inherited from FShader
static void ModifyCompilationEnvironment (const FShaderPermutationParameters &, FShaderCompilerEnvironment &)
 
static const FShaderBindingLayoutGetShaderBindingLayout (const FShaderPermutationParameters &)
 
static bool ShouldCompilePermutation (const FShaderPermutationParameters &)
 
static EShaderPermutationPrecacheRequest ShouldPrecachePermutation (const FShaderPermutationParameters &Parameters)
 
static bool ValidateCompiledResult (EShaderPlatform InPlatform, const FShaderParameterMap &InParameterMap, TArray< FString > &OutError)
 
static EShaderCompileJobPriority GetOverrideJobPriority ()
 
static ERayTracingPayloadType GetRayTracingPayloadType (const int32 PermutationId)
 
static const FShaderParametersMetadataGetRootParametersMetadata ()
 

Static Public Attributes

static constexpr bool bSupportsWrappedGroupCount = bEnableBounds
 

Protected Member Functions

 TClearReplacementBase ()
 
 TClearReplacementBase (const ShaderMetaType::CompiledShaderInitializerType &Initializer)
 
- Protected Member Functions inherited from FShader
 LAYOUT_FIELD (TMemoryImageArray< FHashedName >, UniformBufferParameterStructs)
 
 LAYOUT_FIELD (TMemoryImageArray< FShaderUniformBufferParameter >, UniformBufferParameters)
 
 LAYOUT_FIELD_EDITORONLY (FSHAHash, OutputHash)
 
 LAYOUT_FIELD_EDITORONLY (FSHAHash, VFSourceHash)
 
 LAYOUT_FIELD_EDITORONLY (FSHAHash, SourceHash)
 

Additional Inherited Members

- Public Types inherited from FGlobalShader
using ShaderMetaType = FGlobalShaderType
 
using FPermutationParameters = FGlobalShaderPermutationParameters
 
- Public Types inherited from FShader
using FPermutationDomain = FShaderPermutationNone
 
using FPermutationParameters = FShaderPermutationParameters
 
using CompiledShaderInitializerType = FShaderCompiledShaderInitializerType
 
using ShaderMetaType = FShaderType
 
using ShaderStatKeyType = FMemoryImageName
 
using FShaderStatisticMap = TMemoryImageMap< ShaderStatKeyType, FShaderStatVariant >
 

Constructor & Destructor Documentation

◆ TClearReplacementBase() [1/2]

template<EClearReplacementValueType ValueType, uint32 NumChannels, bool bZeroOutput = false, bool bEnableBounds = false>
TClearReplacementBase< ValueType, NumChannels, bZeroOutput, bEnableBounds >::TClearReplacementBase ( )
inlineprotected

◆ TClearReplacementBase() [2/2]

template<EClearReplacementValueType ValueType, uint32 NumChannels, bool bZeroOutput = false, bool bEnableBounds = false>
TClearReplacementBase< ValueType, NumChannels, bZeroOutput, bEnableBounds >::TClearReplacementBase ( const ShaderMetaType::CompiledShaderInitializerType Initializer)
inlineprotected

Member Function Documentation

◆ DECLARE_INLINE_TYPE_LAYOUT()

template<EClearReplacementValueType ValueType, uint32 NumChannels, bool bZeroOutput = false, bool bEnableBounds = false>
TClearReplacementBase< ValueType, NumChannels, bZeroOutput, bEnableBounds >::DECLARE_INLINE_TYPE_LAYOUT ( TClearReplacementBase< ValueType, NumChannels, bZeroOutput, bEnableBounds ,
NonVirtual   
)

◆ GetClearValueParam()

template<EClearReplacementValueType ValueType, uint32 NumChannels, bool bZeroOutput = false, bool bEnableBounds = false>
template<typename T = const FShaderParameter&>
TEnableIf<!bZeroOutput, T >::Type TClearReplacementBase< ValueType, NumChannels, bZeroOutput, bEnableBounds >::GetClearValueParam ( ) const
inline

◆ GetMaxBoundsParam()

template<EClearReplacementValueType ValueType, uint32 NumChannels, bool bZeroOutput = false, bool bEnableBounds = false>
template<typename T = const FShaderParameter&>
TEnableIf< bEnableBounds, T >::Type TClearReplacementBase< ValueType, NumChannels, bZeroOutput, bEnableBounds >::GetMaxBoundsParam ( ) const
inline

◆ GetMinBoundsParam()

template<EClearReplacementValueType ValueType, uint32 NumChannels, bool bZeroOutput = false, bool bEnableBounds = false>
template<typename T = const FShaderParameter&>
TEnableIf< bEnableBounds, T >::Type TClearReplacementBase< ValueType, NumChannels, bZeroOutput, bEnableBounds >::GetMinBoundsParam ( ) const
inline

◆ GetSourceFilename()

template<EClearReplacementValueType ValueType, uint32 NumChannels, bool bZeroOutput = false, bool bEnableBounds = false>
static const TCHAR * TClearReplacementBase< ValueType, NumChannels, bZeroOutput, bEnableBounds >::GetSourceFilename ( )
inlinestatic

◆ ModifyCompilationEnvironment()

template<EClearReplacementValueType ValueType, uint32 NumChannels, bool bZeroOutput = false, bool bEnableBounds = false>
static void TClearReplacementBase< ValueType, NumChannels, bZeroOutput, bEnableBounds >::ModifyCompilationEnvironment ( const FGlobalShaderPermutationParameters Parameters,
FShaderCompilerEnvironment OutEnvironment 
)
inlinestatic

Member Data Documentation

◆ bSupportsWrappedGroupCount

template<EClearReplacementValueType ValueType, uint32 NumChannels, bool bZeroOutput = false, bool bEnableBounds = false>
constexpr bool TClearReplacementBase< ValueType, NumChannels, bZeroOutput, bEnableBounds >::bSupportsWrappedGroupCount = bEnableBounds
staticconstexpr

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