1. Epic GamesDeveloper
  3. FMaterialShaderMap

FMaterialShaderMap

The set of material shaders for a single material.

Unreal Engine C++ API Reference > Runtime > Engine

Inheritance Hierarchy

References

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

Syntax

class FMaterialShaderMap :  
    public TShaderMap< FMaterialShaderMapContent, FShaderMapPointerTable >,  
    public FDeferredCleanupInterface

Remarks

The set of material shaders for a single material.

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function uint32  
Public function FMaterialShaderMap *  
Public function FMeshMaterialShaderMap *

AcquireMeshShaderMap ( const FVertexFactoryType* VertexFactoryType
)

  
Public function FMeshMaterialShaderMap *

AcquireMeshShaderMap ( const FHashedName& VertexFactoryTypeName
)

  
Public function void  
Public function void

AddRef ()

 Reference counting.
Public function TArray< uint8 > * Backs up any FShaders in this shader map to memory through serialization and clears FShader references.
Public function Static TSharedRef< FAsyncLoadContext >

BeginLoadFromDerivedDataCache ( const FMaterial* Material,
const FMaterialShaderMapId& ShaderMapId,
EShaderPlatform Platform,
const ITargetPlatform* TargetPlatform,
TRefCountPtr< FMaterialShaderMap >& InOutShaderMap,
FString& OutDDCKeyDesc
)

 Begin an attempts to load the shader map for the given material from the Derived Data Cache.
Public function FPSOPrecacheRequestResultArray

CollectPSOs ( const FMaterialPSOPrecacheParams& PrecacheParams
)

 Collect all possible PSO's which can be used with this material shader map for given parameters - PSOs will be async precached
Public function void

Compile ( FMaterial* Material,
const FMaterialShaderMapId& ShaderMapId,
const TRefCountPtr< FSharedShaderCompilerEnvironment >& MaterialEnvironment,
const FMaterialCompilationOutput& InMaterialCompilationOutput,
EShaderPlatform Platform,
EMaterialShaderPrecompileMode PrecompileMode
)

 Compiles the shaders for a material and caches them in this shader map.
Public function Const bool  
Public function Const void

CountNumShaders ( int32& NumShaders,
int32& NumPipelines
)

  
Public function Const void

DumpDebugInfo ( FOutputDevice& OutputDevice
)

  
Public function Static FMaterialShaderMap *

FindCompilingShaderMap ( uint32 CompilingId
)

  
Public function Static TRefCountPtr< FMaterialShaderMap >

FindId ( const FMaterialShaderMapId& ShaderMapId,
EShaderPlatform Platform
)

 Finds the shader map for a material. Finds the shader map for a material.
Public function Static void

GetAllOutdatedTypes ( TArray< const FShaderType* >& OutdatedShaderTypes,
TArray< const FShaderPipelineType* >& OutdatedShaderPipelineTypes,
TArray< const FVertexFactoryType* >& OutdatedFactoryTypes
)

 Gets outdated types from all loaded material shader maps
Public function Const uint32  
Public function Const const TCHAR *  
Public function Const TStaticArray< uint16,(int) ELWCFunctionKind::Max >  
Public function Const void

GetEstimatedNumTextureSamples ( uint32& VSSamples,
uint32& PSSamples
)

  
Public function Const uint32  
Public function Const FMaterialShaderMap *  
Public function Const const TCHAR *  
Public function Const const TCHAR *  
Public function Const uint32  
Public function Const uint32 Returns the maximum number of texture samplers used by any shader in this shader map.
Public function Const const FMeshMaterialShaderMap *

GetMeshShaderMap ( const FVertexFactoryType* VertexFactoryType
)

 Accessors.
Public function Const const FMeshMaterialShaderMap *

GetMeshShaderMap ( const FHashedName& VertexFactoryTypeName
)

  
Public function Const int32  
Public function Const uint32  
Public function Const uint32  
Public function Const uint32  
Public function Const void

GetOutdatedTypes ( TArray< const FShaderType* >& OutdatedShaderTypes,
TArray< const FShaderPipelineType* >& OutdatedShaderPipelineTypes,
TArray< const FVertexFactoryType* >& OutdatedFactoryTypes
)

  
Public function Const const TRefCountPtr< FSharedShaderCompilerEnvironment > &  
Public function Const int32  
Public function Const uint8  
Public function Const TShaderRef< ShaderType >

GetShader ( const typename ShaderType::FPermutationDomain& PermutationVector
)

  
Public function Const TShaderRef< FShader >

GetShader ( FShaderType* ShaderType,
int32 PermutationId
)

  
Public function Const TShaderRef< ShaderType >

GetShader ( int32 PermutationId
)

  
Public function Const const FSHAHash &  
Public function Const void

GetShaderList ( TMap< FShaderId, TShaderRef< FShader >>& OutShaders
)

 Builds a list of the shaders in a shader map.
Public function Const void

GetShaderList ( TMap< FHashedName, TShaderRef< FShader >>& OutShaders
)

 Builds a list of the shaders in a shader map. Key is FShaderType::TypeName
Public function Const const FMaterialShaderMapId &  
Public function Const uint32 Number of Shaders in Shadermap
Public function Const void

GetShaderPipelineList ( TArray< FShaderPipelineRef >& OutShaderPipelines
)

 Builds a list of the shader pipelines in a shader map.
Public function Const const FMemoryImageString *

GetShaderSource ( const FVertexFactoryType* VertexFactoryType,
const FShaderType* ShaderType,
int32 PermutationId
)

  
Public function Const uint8  
Public function Const const FStrataMaterialCompilationOutput &  
Public function Const uint8  
Public function Const uint8  
Public function Const bool  
Public function Const const FRHIUniformBufferLayout *  
Public function Const const FUniformExpressionSet &  
Public function void

InitalizeForODSC ( EShaderPlatform TargetShaderPlatform,
const FMaterialCompilationOutput& NewCompilationOutput
)

  
Public function Const bool  
Public function bool

IsComplete ( const FMaterial* Material,
bool bSilent
)

 Checks whether the material shader map is missing any shader types necessary for the given material.
Public function Const bool

IsValidForRendering ( bool bFailOnInvalid
)

  
Public function Static void

LoadForRemoteRecompile ( FArchive& Ar,
EShaderPlatform ShaderPlatform,
TArray< UMaterialInterface* >& OutLoadedMaterials
)

  
Public function Static void

LoadFromDerivedDataCache ( const FMaterial* Material,
const FMaterialShaderMapId& ShaderMapId,
EShaderPlatform Platform,
const ITargetPlatform* TargetPlatform,
TRefCountPtr< FMaterialShaderMap >& InOutShaderMap,
FString& OutDDCKeyDesc
)

 Attempts to load the shader map for the given material from the Derived Data Cache.
Public function void Attempts to load missing shaders from memory.
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function void

ProcessCompilationResults ( const TArray< TRefCountPtr< FShaderCommonCompileJob >>& ICompilationResults,
int32& InOutJobIndex,
float& TimeBudget
)

 Sorts the incoming compiled jobs into the appropriate mesh shader maps
Public function void

Register ( EShaderPlatform InShaderPlatform
)

 Registers a material shader map in the global map so it can be used by materials.
Public function void

Release ()

  
Public function void  
Public function void  
Public function Const bool  
Public function void

RestoreShadersFromMemory ( const TArray< uint8 >& ShaderData
)

 Recreates FShaders from the passed in memory, handling shader key changes.
Public function Static void

SaveForRemoteRecompile ( FArchive& Ar,
const TMap< FString, TArray< TRefCountPtr< FMaterialShaderMap > > >& CompiledShaderMaps
)

 Serializes a shader map to an archive (used with recompiling shaders for a remote console)
Public function void

SaveShaderStableKeys ( EShaderPlatform TargetShaderPlatform,
const FStableShaderKeyAndValue& SaveKeyVal
)

  
Public function void Saves this shader map to the derived data cache.
Public function bool

Serialize ( FArchive& Ar,
bool bInlineShaderResources,
bool bLoadedByCookedMaterial,
bool bInlineShaderCode
)

 Serializes the shader map.
Public function void

SetCompiledSuccessfully ( bool bSuccess
)

  
Public function Const int32

SubmitCompileJobs ( uint32 CompilingShaderMapId,
const FMaterial* Material,
const TRefCountPtr< FSharedShaderCompilerEnvironment >& MaterialEnvironment,
EShaderCompileJobPriority Priority
)

 Submits compile jobs for this shadermap, returns number of jobs submitted.
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool

UsesPathTracingBufferTexture ( uint32 TexId
)

  
Public function Const bool  
Public function Const bool  
Public function Const bool

UsesSceneTexture ( uint32 TexId
)

  
Public function Const bool  
Public function Const bool  

Overridden from FShaderMapBase

  Type Name Description
Protected function Virtual void  

Classes

  Type Name Description
Public struct FAsyncLoadContext A context returned by BeginLoadFromDerivedDataCache that can be queried to know the state of the async request.  

Typedefs

Name Description
Super  

Constants

Name Description
AllMaterialShaderMaps All material shader maps in memory.
AllMaterialShaderMapsGuard Guards access to AllMaterialShaderMaps, which can be written to from an async loading thread.
GIdToMaterialShaderMap A global map from a material's static parameter set to any shader map cached for that material.
GIdToMaterialShaderMapCS  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page