Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > FMaterialShaderMap

Light Theme

Dark Theme

FMaterialShaderMap

The set of material shaders for a single material.

Windows

MacOS

Linux

Inheritance Hierarchy

TShaderMap

FDeferredCleanupInterface

FMaterialShaderMap

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

	Name	Description
	FMaterialShaderMap()

Destructors

	Name	Description
	~FMaterialShaderMap()

Functions

	Name	Description
void	AddRef()	Reference counting.
TArray< uint...	BackupShadersToMemory()	Backs up any FShaders in this shader map to memory through serialization and clears FShader references.
void	Compile ( FMaterial* Material, const FMaterialShaderMapId& Shader..., TRefCountPtr< FShaderCompilerEnviro..., const FMaterialCompilationOutput& ..., EShaderPlatform Platform, bool bSynchronousCompile )	Compiles the shaders for a material and caches them in this shader map.
bool	CompiledSuccessfully()
void	CountNumShaders ( int32& NumShaders, int32& NumPipelines )
void	DumpDebugInfo()
void	FinalizeContent()
TRefCountPtr...	FindId ( const FMaterialShaderMapId& Shader..., EShaderPlatform Platform )	Finds the shader map for a material.
void	FlushShadersByShaderPipelineType ( const FShaderPipelineType* Sha... )	Removes all entries in the cache with exceptions based on a shader pipeline type
void	FlushShadersByShaderType ( const FShaderType* ShaderType )	Removes all entries in the cache with exceptions based on a shader type
void	FlushShadersByVertexFactoryType ( const FVertexFactoryType* Vert... )	Removes all entries in the cache with exceptions based on a vertex factory type
void	FlushShaderTypes ( TArray< const FShaderType* >&..., TArray< const FShaderPipelineType&..., TArray< const FVertexFactoryType&#... )	Flushes the given shader types from any loaded FMaterialShaderMap's.
void	GetAllOutdatedTypes ( TArray< const FShaderType* >&..., TArray< const FShaderPipelineType&..., TArray< const FVertexFactoryType&#... )	Gets outdated types from all loaded material shader maps
uint32	GetCompilingId()
const TCHAR ...	GetDebugDescription()
void	GetEstimatedNumTextureSamples ( uint32& VSSamples, uint32& PSSamples )
uint32	GetEstimatedNumVirtualTextureLookups()
const TCHAR ...	GetFriendlyName()
const TCHAR ...	GetMaterialPath()
uint32	GetMaxNumInstructionsForShader ( FShaderType* ShaderType )
uint32	GetMaxTextureSamplers()	Returns the maximum number of texture samplers used by any shader in this shader map.
FMeshMateria...	GetMeshShaderMap ( const FHashedName& VertexFactoryTy... )
FMeshMateria...	GetMeshShaderMap ( FVertexFactoryType* VertexFact... )	Accessors.
int32	GetNumRefs()
uint32	GetNumUsedCustomInterpolatorScalars()
uint32	GetNumUsedUVScalars()
uint32	GetNumVirtualTextureStacks()
int32	GetRefCount()
uint8	GetRuntimeVirtualTextureOutputAttributeMask()
TShaderRef< ...	GetShader ( FShaderType* ShaderType, int32 PermutationId )
TShaderRef< ...	GetShader ( const typename ShaderType::FPermuta... )
TShaderRef< ...	GetShader ( int32 PermutationId )
void	GetShaderList ( TMap< FHashedName, TShaderRef< FSha... )	Builds a list of the shaders in a shader map. Key is FShaderType::TypeName
void	GetShaderList ( TMap< FShaderId, TShaderRef< FShade... )	Builds a list of the shaders in a shader map.
const FMater...	GetShaderMapBeingCompiled ( const FMaterial* Material )	Finds a shader map currently being compiled that was enqueued for the given material.
const FMater...	GetShaderMapId()
uint32	GetShaderNum()	Number of Shaders in Shadermap
void	GetShaderPipelineList ( TArray< FShaderPipelineRef >& OutS... )	Builds a list of the shader pipelines in a shader map.
const FMemor...	GetShaderSource ( const FName ShaderTypeName )
const FUnifo...	GetUniformExpressionSet()
bool	IsCompilationFinalized()
bool	IsComplete ( const FMaterial* Material, bool bSilent )	Checks whether the material shader map is missing any shader types necessary for the given material.
bool	IsValidForRendering ( bool bFailOnInvalid )
void	LoadForRemoteRecompile ( FArchive& Ar, EShaderPlatform ShaderPlatform, const TArray< FString >& Materials... )
void	LoadFromDerivedDataCache ( const FMaterial* Material, const FMaterialShaderMapId& Shader..., EShaderPlatform Platform, const ITargetPlatform* TargetP..., TRefCountPtr< FMaterialShaderMap > ... )	Attempts to load the shader map for the given material from the Derived Data Cache.
void	LoadMissingShadersFromMemory ( const FMaterial* Material )	Attempts to load missing shaders from memory.
bool	ModifiesMeshPosition()
bool	NeedsGBuffer()
bool	NeedsSceneTextures()
bool	ProcessCompilationResults ( const TArray< TSharedRef< FShaderCo..., int32& ResultIndex, float& TimeBudget, TMap< const FVertexFactoryType*... )	Sorts the incoming compiled jobs into the appropriate mesh shader maps, and finalizes this shader map so that it can be used for rendering.
void	Register ( EShaderPlatform InShaderPlatform )	Registers a material shader map in the global map so it can be used by materials.
void	Release()
void	RemovePendingMaterial ( FMaterial* Material )	Removes a material from ShaderMapsBeingCompiled.
bool	RequiresSceneColorCopy()
void	RestoreShadersFromMemory ( const TArray< uint8 >& ShaderData )	Recreates FShaders from the passed in memory, handling shader key changes.
void	SaveForRemoteRecompile ( FArchive& Ar, const TMap< FString, TArray< TRefCo... )	Serializes a shader map to an archive (used with recompiling shaders for a remote console)
void	SaveShaderStableKeys ( EShaderPlatform TargetShaderPlatfor..., const FStableShaderKeyAndValue& Sa... )
void	SaveToDerivedDataCache ( const ITargetPlatform* TargetP... )	Saves this shader map to the derived data cache.
bool	Serialize ( FArchive& Ar, bool bInlineShaderResources, bool bLoadedByCookedMaterial )	Serializes the shader map.
bool	TryToAddToExistingCompilationTask ( FMaterial* Material )	Checks to see if the shader map is already being compiled for another material, and if so adds the specified material to the list to be applied to once the compile finishes.
bool	UsesDistanceCullFade()
bool	UsesEyeAdaptation()
bool	UsesGlobalDistanceField()
bool	UsesPixelDepthOffset()
bool	UsesSceneDepthLookup()
bool	UsesSceneTexture ( uint32 TexId )
bool	UsesVelocitySceneTexture()
bool	UsesWorldPositionOffset()

Typedefs

Name	Description
Super

Constants

Name	Description
AllMaterialShaderMaps	All material shader maps in memory.
GIdToMaterialShaderMap	A global map from a material's static parameter set to any shader map cached for that material.
GIdToMaterialShaderMapCS
ShaderMapsBeingCompiled	Tracks material resources and their shader maps that need to be compiled but whose compilation is being deferred.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss