UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
FCompositeCS Class Reference
+ Inheritance diagram for FCompositeCS:

Public Member Functions

 DECLARE_GLOBAL_SHADER (FCompositeCS)
 
 SHADER_USE_PARAMETER_STRUCT (FCompositeCS, FCompositeShader)
 
- Public Member Functions inherited from FCompositeShader
 FCompositeShader ()
 
 FCompositeShader (const ShaderMetaType::CompiledShaderInitializerType &Initializer)
 
- 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 FSHAHash & GetHash () const
 
RENDERCORE_API const FSHAHash & GetVertexFactoryHash () const
 
RENDERCORE_API const FSHAHash & GetOutputHash () const
 
uint32 GetSortKey () const
 
RENDERCORE_API void Finalize (const FShaderMapResourceCode *Code)
 
FShaderType * GetType (const FShaderMapPointerTable &InPointerTable) const
 
FShaderType * GetType (const FPointerTableBase *InPointerTable) const
 
FVertexFactoryType * GetVertexFactoryType (const FShaderMapPointerTable &InPointerTable) const
 
FVertexFactoryType * GetVertexFactoryType (const FPointerTableBase *InPointerTable) const
 
FShaderType * GetTypeUnfrozen () 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 FShaderUniformBufferParameter & GetUniformBufferParameter (const FShaderParametersMetadata *SearchStruct) const
 
const FShaderUniformBufferParameter & GetUniformBufferParameter (const FHashedName SearchName) const
 
RENDERCORE_API const FShaderParametersMetadata * FindAutomaticallyBoundUniformBufferStruct (int32 BaseIndex) const
 
RENDERCORE_API void DumpDebugInfo (const FShaderMapPointerTable &InPtrTable)
 
 LAYOUT_FIELD (FShaderParameterBindings, Bindings)
 
 LAYOUT_FIELD (FShaderParameterMapInfo, ParameterMapInfo)
 

Static Public Member Functions

static bool IsShaderSupported (const EShaderPlatform ShaderPlatform)
 
static bool ShouldCompilePermutation (const FGlobalShaderPermutationParameters &Parameters)
 
static void ModifyCompilationEnvironment (const FGlobalShaderPermutationParameters &Parameters, FShaderCompilerEnvironment &OutEnvironment)
 
- Static Public Member Functions inherited from FCompositeShader
static bool ShouldCompilePermutation (const FGlobalShaderPermutationParameters &Parameters)
 
- 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 FShaderBindingLayout * GetShaderBindingLayout (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 FShaderParametersMetadata * GetRootParametersMetadata ()
 

Static Public Attributes

static const uint32 NUM_THREADS_PER_GROUP = 16
 

Additional Inherited Members

- Public Types inherited from FCompositeShader
using FPermutationDomain = TShaderPermutationDomain< FSCRGBEncoding, FApplyColorDeficiency >
 
- 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 >
 
- 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)
 

Member Function Documentation

◆ DECLARE_GLOBAL_SHADER()

FCompositeCS::DECLARE_GLOBAL_SHADER ( FCompositeCS  )

◆ IsShaderSupported()

static bool FCompositeCS::IsShaderSupported ( const EShaderPlatform  ShaderPlatform)
inlinestatic

◆ ModifyCompilationEnvironment()

static void FCompositeCS::ModifyCompilationEnvironment ( const FGlobalShaderPermutationParameters &  Parameters,
FShaderCompilerEnvironment &  OutEnvironment 
)
inlinestatic

◆ SHADER_USE_PARAMETER_STRUCT()

FCompositeCS::SHADER_USE_PARAMETER_STRUCT ( FCompositeCS  ,
FCompositeShader   
)

◆ ShouldCompilePermutation()

static bool FCompositeCS::ShouldCompilePermutation ( const FGlobalShaderPermutationParameters &  Parameters)
inlinestatic

Member Data Documentation

◆ NUM_THREADS_PER_GROUP

const uint32 FCompositeCS::NUM_THREADS_PER_GROUP = 16
static
The documentation for this class was generated from the following file: