1. Epic GamesDeveloper
  3. FShaderType

FShaderType

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

API > API/Runtime > API/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
Protected variable TSet< const FShaderParametersMetadata * > ReferencedUniformBuffers Cache of referenced uniform buffer structs.

Constructors

  Type Name Description
Public function  

FShaderType ( EShaderTypeForDynamicCast InShaderTypeForDynamicCast,
FTypeLayoutDesc& InTypeLayout,
const TCHAR* InName,
const TCHAR* InSourceFilename,
const TCHAR* InFunctionName,
uint32 InFrequency,
int32 TotalPermutationCount,
ConstructSerializedType InConstructSerializedRef,
ConstructCompiledType InConstructCompiledRef,
ShouldCompilePermutationType InShouldCompilePermutationRef,
ShouldPrecachePermutationType InShouldPrecachePermutationRef,
GetRayTracingPayloadTypeType InGetRayTracingPayloadTypeRef,
GetShaderBindingLayoutType InGetShaderBindingLayoutTypeRef,
ModifyCompilationEnvironmentType InModifyCompilationEnvironmentRef,
ValidateCompiledResultType InValidateCompiledResultRef,
uint32 InTypeSize,
const FShaderParametersMetadata* InRootParametersMetadata
)

 Minimal initialization constructor.

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Const void Adds include statements for uniform buffers that this shader type references.
Public function Const const FGlobalShaderType *  
Public function Const const FMaterialShaderType *  
Public function Const const FMeshMaterialShaderType *  
Public function Const const FNiagaraShaderType *  
Public function Const const FOpenColorIOShaderType *  
Public function Const FShader *  
Public function Const FShader * Constructs a new instance of the shader type for deserialization.
Public function void  
Public function FComputeKernelShaderType *  
Public function Const const FComputeKernelShaderType *  
Public function Const const FName &  
Public function Const EShaderFrequency  
Public function Const const TCHAR *  
Public function FGlobalShaderType * Dynamic casts.
Public function Const const FGlobalShaderType *  
Public function Const const FHashedName &  
Public function Const const FHashedName &  
Public function Const const FTypeLayoutDesc & Accessors.
Public function Const const FMaterialShaderType *  
Public function FMaterialShaderType *  
Public function Const const FMeshMaterialShaderType *  
Public function FMeshMaterialShaderType *  
Public function Const const TCHAR *

GetName ()

  
Public function Static TMap< FHashedName, FShaderType * > &  
Public function FNiagaraShaderType *  
Public function Const const FNiagaraShaderType *  
Public function Const int32  
Public function FOpenColorIOShaderType *  
Public function Const const FOpenColorIOShaderType *  
Public function Const int32  
Public function Const ERayTracingPayloadType

GetRayTracingPayloadType ( const int32 PermutationId
)

  
Public function Const const TSet< const TCHAR *, TStringPointerSetKeyFuncs_DEPRECATED< const TCHAR * > > &  
Public function Const const TSet< const FShaderParametersMetadata * > &  
Public function Const const FShaderParametersMetadata * Returns the meta data for the root shader parameter struct.
Public function Const const FShaderBindingLayout *  
Public function Const const TCHAR *  
Public function void  
Public function Static FShaderType *

GetShaderTypeByName ( const TCHAR* Name
)

  
Public function Static TArray< const FShaderType * >

GetShaderTypesByFilename ( const TCHAR* Filename
)

  
Public function Static const TArray< FShaderType * > &  
Public function Const const FSHAHash &

GetSourceHash ( EShaderPlatform ShaderPlatform
)

 Calculates a Hash based on this shader type's source code and includes
Public function Const EShaderTypeForDynamicCast  
Public function Static TLinkedList< FShaderType * > *&  
Public function Const uint32  
Public function Static void

Initialize ( const TMap< FString, TArray< const TCHAR* > >& ShaderFileToUniformBufferVariables
)

 Initialize FShaderType static members, this must be called before any shader types are created.
Public function Const void  
Public function Const bool  
Public function Const EShaderPermutationPrecacheRequest  
Public function Static void Uninitializes FShaderType cached data.
Public function void

UpdateReferencedUniformBufferNames ( const TMap< FString, TArray< const TCHAR* > >& ShaderFileToUniformBufferVariables
)

  
Public function Const 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
Public class FParameters Derived FShaderTypes should derive from this class to pass params to FShader constructor  

Enums

  Type Name Description
Public enum EShaderTypeForDynamicCast    

Typedefs

Name Description
ConstructCompiledType  
ConstructSerializedType  
GetRayTracingPayloadTypeType  
GetShaderBindingLayoutType  
ModifyCompilationEnvironmentType  
ShouldCompilePermutationType  
ShouldPrecachePermutationType  
ValidateCompiledResultType  

Constants

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page