1. Epic GamesDeveloper
  3. FMeshMaterialShaderType

FMeshMaterialShaderType

A shader meta type for material-linked shaders which use a vertex factory.

API > API/Runtime > API/Runtime/Engine

A shader meta type for material-linked shaders which use a vertex factory.

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

Syntax

class FMeshMaterialShaderType : public FShaderType

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FMeshMaterialShaderType ( 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
)

   MeshMaterialShaderType.h  

Structs

Name Remarks
CompiledShaderInitializerType  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void BeginCompileShader ( EShaderCompileJobPriority Priority,
uint32 ShaderMapJobId,
int32 PermutationId,
EShaderPlatform Platform,
EShaderPermutationFlags PermutationFlags,
const FMaterial* Material,
const FMaterialShaderMapId& ShaderMapId,
FSharedShaderCompilerEnvironment* MaterialEnvironment,
const FVertexFactoryType* VertexFactoryType,
TArray< TRefCountPtr< FShaderCommonCompileJob > >& NewJobs,
const FString& DebugGroupName,
const TCHAR* DebugDescription,
const TCHAR* DebugExtension
) const

 Enqueues a compilation for a new shader of this type. MeshMaterialShaderType.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. MeshMaterialShaderType.h  

void SetupCompileEnvironment ( EShaderPlatform Platform,
const FMaterialShaderParameters& MaterialParameters,
const FVertexFactoryType* VertexFactoryType,
int32 PermutationId,
EShaderPermutationFlags PermutationFlags,
FShaderCompilerEnvironment& Environment
) const

 Sets up the environment used to compile an instance of this shader type. MeshMaterialShaderType.h  

bool ShouldCompilePermutation ( EShaderPlatform Platform,
const FMaterialShaderParameters& MaterialParameters,
const FVertexFactoryType* VertexFactoryType,
int32 PermutationId,
EShaderPermutationFlags Flags
) const

 Checks if the shader type should be cached for a particular platform, material, and vertex factory type. MeshMaterialShaderType.h  

Static

Name Remarks Include Path Unreal Specifiers

static void BeginCompileShaderPipeline ( EShaderCompileJobPriority Priority,
uint32 ShaderMapJobId,
int32 PermutationId,
EShaderPlatform Platform,
EShaderPermutationFlags PermutationFlags,
const FMaterial* Material,
const FMaterialShaderMapId& ShaderMapId,
FSharedShaderCompilerEnvironment* MaterialEnvironment,
const FVertexFactoryType* VertexFactoryType,
const FShaderPipelineType* ShaderPipeline,
TArray< TRefCountPtr< FShaderCommonCompileJob > >& NewJobs,
const FString& DebugGroupName,
const TCHAR* DebugDescription,
const TCHAR* DebugExtension
)

   MeshMaterialShaderType.h  

static bool ShouldCompilePipeline ( const FShaderPipelineType* ShaderPipelineType,
EShaderPlatform Platform,
const FMaterialShaderParameters& MaterialParameters,
const FVertexFactoryType* VertexFactoryType,
EShaderPermutationFlags Flags
)

   MeshMaterialShaderType.h  

static bool ShouldCompileVertexFactoryPermutation ( EShaderPlatform Platform,
const FMaterialShaderParameters& MaterialParameters,
const FVertexFactoryType* VertexFactoryType,
const FShaderType* ShaderType,
EShaderPermutationFlags Flags
)

   MeshMaterialShaderType.h  

static bool ShouldCompileVertexFactoryPipeline ( const FShaderPipelineType* ShaderPipelineType,
EShaderPlatform Platform,
const FMaterialShaderParameters& MaterialParameters,
const FVertexFactoryType* VertexFactoryType,
EShaderPermutationFlags Flags
)

   MeshMaterialShaderType.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page