FGlobalShader Class Reference

#include <GlobalShader.h>

Inheritance diagram for FGlobalShader:

Public Types
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 >

Public Member Functions
	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 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 ()

Additional Inherited Members
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)

Detailed Description

FGlobalShader

Global shaders derive from this class to set their default recompile group as a global one

Member Typedef Documentation

FPermutationParameters

using FGlobalShader::FPermutationParameters = FGlobalShaderPermutationParameters

ShaderMetaType

using FGlobalShader::ShaderMetaType = FGlobalShaderType

Constructor & Destructor Documentation

FGlobalShader() [1/2]

FGlobalShader::FGlobalShader ( )

default

FGlobalShader() [2/2]

FGlobalShader::FGlobalShader

(

const ShaderMetaType::CompiledShaderInitializerType &

Initializer

)

Member Function Documentation

ModifyCompilationEnvironment()

static void FGlobalShader::ModifyCompilationEnvironment ( const FGlobalShaderPermutationParameters &  Parameters, FShaderCompilerEnvironment &  Environment  )

inlinestatic

SetParameters()

template<typename TViewUniformShaderParameters >

void FGlobalShader::SetParameters ( FRHIBatchedShaderParameters &  BatchedParameters, FRHIUniformBuffer *  ViewUniformBuffer  )

inline

ShouldCompilePermutation()

static bool FShader::ShouldCompilePermutation ( const FShaderPermutationParameters &  )

inlinestatic

Can be overridden by FShader subclasses to determine whether a specific permutation should be compiled.

ShouldPrecachePermutation()

static EShaderPermutationPrecacheRequest FShader::ShouldPrecachePermutation ( const FShaderPermutationParameters &  Parameters )

inlinestatic

Can be overridden by FShader subclasses to determine whether a specific permutation should be precached.

---

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

• Engine/Source/Runtime/RenderCore/Public/GlobalShader.h
• Engine/Source/Runtime/RenderCore/Private/GlobalShader.cpp