FShaderType

An object which is used to serialize/deserialize, compile, and cache a particular shader class.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FShaderType

	FGlobalShaderType
	FMaterialShaderType
	FMeshMaterialShaderType
	FNiagaraShaderType
	FOpenColorIOShaderType

References

Module	RenderCore
Header	/Engine/Source/Runtime/RenderCore/Public/Shader.h
Include	#include "Shader.h"

Syntax

class FShaderType

Remarks

An object which is used to serialize/deserialize, compile, and cache a particular shader class.

A shader type can manage multiple instance of FShader across mutiple dimensions such as EShaderPlatform, or permutation id. The number of permutation of a shader type is simply given by GetPermutationCount().

Variables

		Name	Description
	std::atomic< ES...	CachedUniformBufferPlatform	Tracks what platforms ReferencedUniformBufferStructsCache has had declarations cached for.
	TMap< const TCH...	ReferencedUniformBufferStructsCache	Cache of referenced uniform buffer includes.

Constructors

	Name	Description
	FShaderType ( EShaderTypeForDynamicCast InShaderT..., FTypeLayoutDesc& InTypeLayout, const TCHAR* InName, const TCHAR* InSourceFilename, const TCHAR* InFunctionName, uint32 InFrequency, int32 TotalPermutationCount, ConstructSerializedType InConstruct..., ConstructCompiledType InConstructCo..., ModifyCompilationEnvironmentType In..., ShouldCompilePermutationType InShou..., ValidateCompiledResultType InValida..., uint32 InTypeSize, const FShaderParametersMetadata... )	Minimal initialization constructor.

Destructors

	Name	Description
	~FShaderType()

Functions

	Name	Description
void	AddReferencedUniformBufferIncludes ( FShaderCompilerEnvironment& OutEnv..., FString& OutSourceFilePrefix, EShaderPlatform Platform )	Adds include statements for uniform buffers that this shader type references, and builds a prefix for the shader file with the include statements.
const FGloba...	AsGlobalShaderType()
const FMater...	AsMaterialShaderType()
const FMeshM...	AsMeshMaterialShaderType()
const FNiaga...	AsNiagaraShaderType()
const FOpenC...	AsOpenColorIOShaderType()
FShader *...	ConstructCompiled ( const FShader::CompiledShaderInitia... )
FShader *...	ConstructForDeserialization()	Constructs a new instance of the shader type for deserialization.
void	DumpDebugInfo()
void	FlushShaderFileCache ( const TMap< FString, TArray< const ... )
FComputeKern...	GetComputeKernelShaderType()
const FCompu...	GetComputeKernelShaderType()
const FName ...	GetFName()
EShaderFrequ...	GetFrequency()
const TCHAR ...	GetFunctionName()
FGlobalShade...	GetGlobalShaderType()	Dynamic casts.
const FGloba...	GetGlobalShaderType()
const FHashe...	GetHashedName()
const FHashe...	GetHashedShaderFilename()
const FTypeL...	GetLayout()	Accessors.
const FMater...	GetMaterialShaderType()
FMaterialSha...	GetMaterialShaderType()
const FMeshM...	GetMeshMaterialShaderType()
FMeshMateria...	GetMeshMaterialShaderType()
const TCHAR ...	GetName()
TMap< FHashe...	GetNameToTypeMap()
FNiagaraShad...	GetNiagaraShaderType()
const FNiaga...	GetNiagaraShaderType()
int32	GetNumShaders()
FOpenColorIO...	GetOpenColorIOShaderType()
const FOpenC...	GetOpenColorIOShaderType()
int32	GetPermutationCount()
const TMap< ...	GetReferencedUniformBufferStructsCache()
const FShade...	GetRootParametersMetadata()	Returns the meta data for the root shader parameter struct.
const TCHAR ...	GetShaderFilename()
void	GetShaderStableKeyParts ( FStableShaderKeyAndValue& SaveKeyV... )
FShaderType ...	GetShaderTypeByName ( const TCHAR* Name )
TArray< cons...	GetShaderTypesByFilename ( const TCHAR* Filename )
const TArray...	GetSortedTypes ( EShaderTypeForDynamicCast Type )
const FSHAHa...	GetSourceHash ( EShaderPlatform ShaderPlatform )	Calculates a Hash based on this shader type's source code and includes
EShaderTypeF...	GetTypeForDynamicCast()
TLinkedList<...	GetTypeList()
uint32	GetTypeSize()
void	Initialize ( const TMap< FString, TArray< const ... )	Initialize FShaderType static members, this must be called before any shader types are created.
void	ModifyCompilationEnvironment ( const FShaderPermutationParameters ..., FShaderCompilerEnvironment& OutEnv... )
bool	ShouldCompilePermutation ( const FShaderPermutationParameters ... )
void	Uninitialize()	Uninitializes FShaderType cached data.
bool	ValidateCompiledResult ( EShaderPlatform Platform, const FShaderParameterMap& Paramet..., TArray< FString >& OutError )	Checks if the shader type should pass compilation for a particular set of parameters.

Classes

	Name	Description
	FParameters	Derived FShaderTypes should derive from this class to pass params to FShader constructor

Enums

	Name	Description
	EShaderTypeForDynamicCast

Typedefs

Name	Description
ConstructCompiledType
ConstructSerializedType
ModifyCompilationEnvironmentType
ShouldCompilePermutationType
ValidateCompiledResultType

Constants

Name	Description
bInitializedSerializationHistory	Tracks whether serialization history for all shader types has been initialized.