FShaderType | Unreal Engine 4.27 Documentation

Unreal Engine C++ API Reference > Runtime > RenderCore

Inheritance Hierarchy

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

	Type	Name	Description
	TSet< const TCHAR , TStringPointerSetKeyFuncs_DEPRECATED< const TCHAR > >	ReferencedUniformBufferNames	Cache of referenced uniform buffer includes.

Constructors

	Type	Name	Description
		FShaderType ( EShaderTypeForDynamicCast InShaderTypeForDynamicCast, FTypeLayoutDesc& InTypeLayout, const TCHAR* InName, const TCHAR* InSourceFilename, const TCHAR* InFunctionName, uint32 InFrequency, int32 TotalPermutationCount, ConstructSerializedType InConstructSerializedRef, ConstructCompiledType InConstructCompiledRef, ShouldCompilePermutationType InShouldCompilePermutationRef, GetRayTracingPayloadTypeType InGetRayTracingPayloadTypeRef, ModifyCompilationEnvironmentType InModifyCompilationEnvironmentRef, ValidateCompiledResultType InValidateCompiledResultRef, uint32 InTypeSize, const FShaderParametersMetadata* InRootParametersMetadata )	Minimal initialization constructor.

Destructors

	Type	Name	Description
		~FShaderType ()

Functions

Type	Name	Description
void	AddUniformBufferIncludesToEnvironment ( FShaderCompilerEnvironment& OutEnvironment, EShaderPlatform Platform )	Adds include statements for uniform buffers that this shader type references.
const FGlobalShaderType *	AsGlobalShaderType ()
const FMaterialShaderType *	AsMaterialShaderType ()
const FMeshMaterialShaderType *	AsMeshMaterialShaderType ()
const FNiagaraShaderType *	AsNiagaraShaderType ()
const FOpenColorIOShaderType *	AsOpenColorIOShaderType ()
FShader *	ConstructCompiled ( const FShader::CompiledShaderInitializerType& Initializer )
FShader *	ConstructForDeserialization ()	Constructs a new instance of the shader type for deserialization.
void	DumpDebugInfo ()
FComputeKernelShaderType *	GetComputeKernelShaderType ()
const FComputeKernelShaderType *	GetComputeKernelShaderType ()
const FName &	GetFName ()
EShaderFrequency	GetFrequency ()
const TCHAR *	GetFunctionName ()
const FGlobalShaderType *	GetGlobalShaderType ()
FGlobalShaderType *	GetGlobalShaderType ()	Dynamic casts.
const FHashedName &	GetHashedName ()
const FHashedName &	GetHashedShaderFilename ()
const FTypeLayoutDesc &	GetLayout ()	Accessors.
const FMaterialShaderType *	GetMaterialShaderType ()
FMaterialShaderType *	GetMaterialShaderType ()
const FMeshMaterialShaderType *	GetMeshMaterialShaderType ()
FMeshMaterialShaderType *	GetMeshMaterialShaderType ()
const TCHAR *	GetName ()
TMap< FHashedName, FShaderType * > &	GetNameToTypeMap ()
FNiagaraShaderType *	GetNiagaraShaderType ()
const FNiagaraShaderType *	GetNiagaraShaderType ()
int32	GetNumShaders ()
FOpenColorIOShaderType *	GetOpenColorIOShaderType ()
const FOpenColorIOShaderType *	GetOpenColorIOShaderType ()
int32	GetPermutationCount ()
ERayTracingPayloadType	GetRayTracingPayloadType ( const int32 PermutationId )
const TSet< const TCHAR , TStringPointerSetKeyFuncs_DEPRECATED< const TCHAR > > &	GetReferencedUniformBufferNames ()
const FShaderParametersMetadata *	GetRootParametersMetadata ()	Returns the meta data for the root shader parameter struct.
const TCHAR *	GetShaderFilename ()
void	GetShaderStableKeyParts ( FStableShaderKeyAndValue& SaveKeyVal )
FShaderType *	GetShaderTypeByName ( const TCHAR* Name )
TArray< const FShaderType * >	GetShaderTypesByFilename ( const TCHAR* Filename )
const TArray< FShaderType * > &	GetSortedTypes ( EShaderTypeForDynamicCast Type )
const FSHAHash &	GetSourceHash ( EShaderPlatform ShaderPlatform )	Calculates a Hash based on this shader type's source code and includes
EShaderTypeForDynamicCast	GetTypeForDynamicCast ()
TLinkedList< FShaderType * > *&	GetTypeList ()
uint32	GetTypeSize ()
void	Initialize ( const TMap< FString, TArray< const TCHAR* > >& ShaderFileToUniformBufferVariables )	Initialize FShaderType static members, this must be called before any shader types are created.
void	ModifyCompilationEnvironment ( const FShaderPermutationParameters& Parameters, FShaderCompilerEnvironment& OutEnvironment )
bool	ShouldCompilePermutation ( const FShaderPermutationParameters& Parameters )
void	Uninitialize ()	Uninitializes FShaderType cached data.
void	UpdateReferencedUniformBufferNames ( const TMap< FString, TArray< const TCHAR* >>& ShaderFileToUniformBufferVariables )
bool	ValidateCompiledResult ( EShaderPlatform Platform, const FShaderParameterMap& ParameterMap, TArray< FString >& OutError )	Checks if the shader type should pass compilation for a particular set of parameters.

Classes

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

Enums

	Type	Name	Description
	EShaderTypeForDynamicCast

Typedefs

Name	Description
ConstructCompiledType
ConstructSerializedType
GetRayTracingPayloadTypeType
ModifyCompilationEnvironmentType
ShouldCompilePermutationType
ValidateCompiledResultType

Constants

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

Deprecated Functions

	Type	Name	Description
	void	AddReferencedUniformBufferIncludes ( FShaderCompilerEnvironment& OutEnvironment, FString& OutSourceFilePrefix, EShaderPlatform Platform )	AddReferencedUniformBufferIncludes has moved to AddUniformBufferIncludesToEnvironment and no longer takes a prefix argument.
	void	FlushShaderFileCache ( const TMap< FString, TArray< const TCHAR* > >& ShaderFileToUniformBufferVariables )	FlushShaderFileCache is deprecated. UpdateReferencedUniformBufferNames should be used to flush any uniform buffer changes

Navigation