1. Epic GamesDeveloper
  3. FMaterialShaderType

FMaterialShaderType

A shader meta type for material-linked shaders.

Unreal Engine C++ API Reference > Runtime > Engine

Inheritance Hierarchy

References

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

Syntax

class FMaterialShaderType : public FShaderType

Remarks

A shader meta type for material-linked shaders.

Constructors

  Type Name Description
Public function  

FMaterialShaderType ( FTypeLayoutDesc& InTypeLayout,
const TCHAR* InName,
const TCHAR* InSourceFilename,
const TCHAR* InFunctionName,
uint32 InFrequency,
int32 InTotalPermutationCount,
ConstructSerializedType InConstructSerializedRef,
ConstructCompiledType InConstructCompiledRef,
ShouldCompilePermutationType InShouldCompilePermutationRef,
GetRayTracingPayloadTypeType InGetRayTracingPayloadTypeRef,
ModifyCompilationEnvironmentType InModifyCompilationEnvironmentRef,
ValidateCompiledResultType InValidateCompiledResultRef,
uint32 InTypeSize,
const FShaderParametersMetadata* InRootParametersMetadata
)

  

Functions

  Type Name Description
Public function Const 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
)

 Enqueues a compilation for a new shader of this type.
Public function 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
)

  
Public function Const FShader *

FinishCompileShader ( const FUniformExpressionSet& UniformExpressionSet,
const FSHAHash& MaterialShaderMapHash,
const FShaderCompileJob& CurrentJob,
const FShaderPipelineType* ShaderPipeline,
const FString& InDebugDescription
)

 Either creates a new instance of this type or returns an equivalent existing shader.
Public function Const void

SetupCompileEnvironment ( EShaderPlatform Platform,
const FMaterialShaderParameters& MaterialParameters,
int32 PermutationId,
EShaderPermutationFlags Flags,
FShaderCompilerEnvironment& Environment
)

 Sets up the environment used to compile an instance of this shader type.
Public function Const bool

ShouldCompilePermutation ( EShaderPlatform Platform,
const FMaterialShaderParameters& MaterialParameters,
int32 PermutationId,
EShaderPermutationFlags Flags
)

 Checks if the shader type should be cached for a particular platform and material.
Public function Static bool

ShouldCompilePipeline ( const FShaderPipelineType* ShaderPipelineType,
EShaderPlatform Platform,
const FMaterialShaderParameters& MaterialParameters,
EShaderPermutationFlags Flags
)

  

Classes

  Type Name Description
Public struct CompiledShaderInitializerType    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page