FMaterialShaderType | Unreal Engine 5.7 Documentation

A shader meta type for material-linked shaders.


Name	FMaterialShaderType
Type	class
Header File	/Engine/Source/Runtime/Engine/Public/MaterialShaderType.h
Include Path	#include "MaterialShaderType.h"

Syntax

class FMaterialShaderType : public FShaderType

Name	Remarks	Include Path	Unreal Specifiers
FMaterialShaderType ( FTypeLayoutDesc& InTypeLayout, const TCHAR* InName, const TCHAR* InSourceFilename, const TCHAR* InFunctionName, uint32 InFrequency, int32 InTotalPermutationCount, ConstructSerializedType InConstructSerializedRef, ConstructCompiledType InConstructCompiledRef, ShouldCompilePermutationType InShouldCompilePermutationRef, ShouldPrecachePermutationType InShouldPrecachePermutationRef, GetRayTracingPayloadTypeType InGetRayTracingPayloadTypeRef, GetShaderBindingLayoutType InGetShaderBindingLayoutTypeRef, ModifyCompilationEnvironmentType InModifyCompilationEnvironmentRef, ValidateCompiledResultType InValidateCompiledResultRef, GetOverrideJobPriorityType InGetOverrideJobPriorityRef, uint32 InTypeSize, const FShaderParametersMetadata* InRootParametersMetadata, GetPermutationIdStringType InGetPermutationIdStringRef )		MaterialShaderType.h

Name	Remarks
CompiledShaderInitializerType

Name	Remarks	Include Path
void BeginCompileShader ( EShaderCompileJobPriority Priority, uint32 ShaderMapJobId, int32 PermutationId, const FMaterial* Material, const FMaterialShaderMapId& ShaderMapId, FSharedShaderCompilerEnvironment* MaterialEnvironment, EShaderPlatform Platform, EShaderPermutationFlags PermutationFlags, TArray< TRefCountPtr< FShaderCommonCompileJob > >& NewJobs, const FString& DebugGroupName, const TCHAR* DebugDescription, const TCHAR* DebugExtension ) const	Enqueues a compilation for a new shader of this type.	MaterialShaderType.h
FShader * FinishCompileShader ( const FUniformExpressionSet& UniformExpressionSet, const FSHAHash& MaterialShaderMapHash, const FShaderCompileJob& CurrentJob, const FShaderPipelineType* ShaderPipeline, const FString& InDebugDescription ) const	Either creates a new instance of this type or returns an equivalent existing shader.	MaterialShaderType.h
void SetupCompileEnvironment ( EShaderPlatform Platform, const FMaterialShaderParameters& MaterialParameters, int32 PermutationId, EShaderPermutationFlags Flags, FShaderCompilerEnvironment& Environment ) const	Sets up the environment used to compile an instance of this shader type.	MaterialShaderType.h
bool ShouldCompilePermutation ( EShaderPlatform Platform, const FMaterialShaderParameters& MaterialParameters, int32 PermutationId, EShaderPermutationFlags Flags ) const	Checks if the shader type should be cached for a particular platform and material.	MaterialShaderType.h

Name	Remarks	Include Path	Unreal Specifiers
static void BeginCompileShaderPipeline ( EShaderCompileJobPriority Priority, uint32 ShaderMapJobId, EShaderPlatform Platform, EShaderPermutationFlags PermutationFlags, const FMaterial* Material, const FMaterialShaderMapId& ShaderMapId, FSharedShaderCompilerEnvironment* MaterialEnvironment, const FShaderPipelineType* ShaderPipeline, TArray< TRefCountPtr< FShaderCommonCompileJob > >& NewJobs, const FString& DebugGroupName, const TCHAR* DebugDescription, const TCHAR* DebugExtension )		MaterialShaderType.h
static bool ShouldCompilePipeline ( const FShaderPipelineType* ShaderPipelineType, EShaderPlatform Platform, const FMaterialShaderParameters& MaterialParameters, EShaderPermutationFlags Flags )		MaterialShaderType.h