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 > FMaterial

Light Theme

Dark Theme

FMaterial

[FMaterial](API\Runtime\Engine\FMaterial) serves 3 intertwined purposes: Represents a material to the material compilation process, and provides hooks for extensibility (CompileProperty, etc) Represents a material to the renderer, with functions to access material properties Stores a cached shader map, and other transient output from a compile, which is necessary with async shader compiling (when a material finishes async compilation, the shader map and compile errors need to be stored somewhere)

Windows

MacOS

Linux

Inheritance Hierarchy

FMaterial

FMaterialResource

FMaterialResourceStats

References

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

Syntax

class FMaterial

Remarks

FMaterial serves 3 intertwined purposes: Represents a material to the material compilation process, and provides hooks for extensibility (CompileProperty, etc) Represents a material to the renderer, with functions to access material properties Stores a cached shader map, and other transient output from a compile, which is necessary with async shader compiling (when a material finishes async compilation, the shader map and compile errors need to be stored somewhere)

Variables

		Name	Description
	FUniformParamet...	TransientOverrides

Constructors

	Name	Description
	FMaterial()	Minimal initialization constructor.

Destructors

	Name	Description
	~FMaterial()	Destructor

Functions

	Name	Description
void	AddEditorLoadedMaterialResource ( FMaterial* Material )	Adds an FMaterial to the global list.
uint32	AddRef()
void	AddReferencedObjects ( FReferenceCollector& Collector )
bool	AllowNegativeEmissiveColor()
void	BackupEditorLoadedMaterialShadersToMemory ( TMap< FMaterialShaderMap*, TUn... )	Backs up any FShaders in editor loaded materials to memory through serialization and clears FShader references.
void	BeginAllowCachingStaticParameterValues()
bool	CacheShaders ( const FMaterialShaderMapId& Shader..., EShaderPlatform Platform, EMaterialShaderPrecompileMode Preco..., const ITargetPlatform* TargetP... )	Caches the material shaders for the given static parameter set and platform.
bool	CacheShaders ( EShaderPlatform Platform, EMaterialShaderPrecompileMode Preco..., const ITargetPlatform* TargetP... )	Caches the material shaders for this material on the given platform.
void	CancelCompilation()	Cancels all outstanding compilation jobs for this material.
bool	CastsRayTracedShadows()
int32	CompilePropertyAndSetMaterialProperty ( EMaterialProperty Property, FMaterialCompiler* Compiler, EShaderFrequency OverrideShaderFreq..., bool bUsePreviousFrameTime )	Entry point for compiling a specific material property. This must call SetMaterialProperty.
bool	ComputeFogPerPixel()
void	DeferredDelete ( FMaterial* Material )
void	DeferredDeleteArray ( TArray< TMaterial* >& Materia... )
void	DeferredDeleteArray ( TArray< TRefCountPtr< TMaterial >> ... )
void	DeleteMaterialsOnRenderThread ( TArray< TRefCountPtr< TMaterial >> ... )
void	DiscardShaderMap()	Discards loaded shader maps if the application can't render
void	DumpDebugInfo()
void	EndAllowCachingStaticParameterValues()
void	FinishCompilation()	Blocks until compilation has completed. Returns immediately if a compilation is not outstanding.
void	GatherCustomOutputExpressions ( TArray< class UMaterialExpressionCu... )	Gather any UMaterialExpressionCustomOutput expressions they can be compiled in turn
void	GatherExpressionsForCustomInterpolators ( TArray< class UMaterialExpression&... )	Gather any UMaterialExpressionCustomOutput expressions in the material and referenced function calls
bool	GetAllowDevelopmentShaderCompile()	Returns true if this material is allowed to make development shaders via the global CVar CompileShadersForDevelopment.
FString	GetAssetName()	Similar to GetFriendlyName, but but avoids historical behavior of the former, returning the exact asset name for material instances instead of just the material.
FName	GetAssetPath()	Allows to associate the shader resources with the asset for load order.
FString	GetBaseMaterialPathName()	Useful for debugging.
int32	GetBlendableLocation()
bool	GetBlendableOutputAlpha()
enum EBlendM...	GetBlendMode()
bool	GetCastDynamicShadowAsMasked()
const TArray...	GetCompileErrors()
FString	GetDebugName()
uint32	GetDecalBlendMode()
void	GetDependentShaderAndVFTypes ( EShaderPlatform Platform, const FPlatformTypeLayoutParameters..., TArray< FShaderType* >& OutSh..., TArray< const FShaderPipelineType&..., TArray< FVertexFactoryType* > ... )	Produces arrays of any shader and vertex factory type that this material is dependent on.
const TArray...	GetErrorExpressions()
const FStati...	GetFeatureLevel()
bool	GetForwardBlendsSkyLightCubemaps()
FString	GetFriendlyName()
FString	GetFullPath()
uint32	GetGameThreadCompilingShaderMapId()
FMaterialSha...	GetGameThreadShaderMap()
const FGuid ...	GetLegacyId()
bool	GetLoadedCookedShaderMapId()
uint32	GetMaterialDecalResponse()
EMaterialDom...	GetMaterialDomain()
bool	GetMaterialExpressionSource ( FString& OutSource )	Get user source code for the material, with a list of code snippets to highlight representing the code for each MaterialExpression
FGuid	GetMaterialId()	Gets the Guid that represents this material.
UMaterialInt...	GetMaterialInterface()
EMaterialSha...	GetMaterialShaderMapUsage()	Returns which shadermap this material is bound to.
FString	GetMaterialUsageDescription()	Returns a string that describes the material's usage for debugging purposes.
float	GetMaxDisplacement()
int32	GetNumCustomizedUVs()
float	GetOpacityMaskClipValue()
EMaterialQua...	GetQualityLevel()
uint32	GetRefCount()
TArrayView< ...	GetReferencedTextures()
float	GetRefractionDepthBiasValue()
enum ERefrac...	GetRefractionMode()
FMaterialSha...	GetRenderingThreadShaderMap()
uint8	GetRuntimeVirtualTextureOutputAttibuteMask_RenderThread()	Get the runtime virtual texture output attribute mask for the material.
TShaderRef< ...	GetShader ( FVertexFactoryType* VertexFact..., int32 PermutationId, bool bFatalIfMissing )
TShaderRef< ...	GetShader ( FVertexFactoryType* VertexFact..., const typename ShaderType::FPermuta..., bool bFatalIfMissing )	Finds the shader matching the template type and the passed in vertex factory, asserts if not found.
void	GetShaderMapId ( EShaderPlatform Platform, const ITargetPlatform* TargetP..., FMaterialShaderMapId& OutId )	Material properties.
void	GetShaderMapIDsWithUnfinishedCompilation ( TArray< int32 >& ShaderMapIds )	Fills the passed array with IDs of shader maps unfinished compilation jobs.
const FMater...	GetShaderMapToUse()	Shared code needed for GetUniformScalarParameterExpressions, GetUniformVectorParameterExpressions, GetUniformCubeTextureExpressions..
EMaterialSha...	GetShaderMapUsage()	Gets the shader map usage of the material, which will be included in the DDC key.
FShaderPipel...	GetShaderPipeline ( FShaderPipelineType* ShaderPip..., FVertexFactoryType* VertexFact..., bool bFatalIfNotFound )
FMaterialSha...	GetShadingModels()
EMaterialSha...	GetShadingRate()
void	GetStaticParameterSet ( EShaderPlatform Platform, FStaticParameterSet& OutSet )
uint32	GetStencilCompare()
uint32	GetStencilRefValue()
enum EMateri...	GetTessellationMode()
float	GetTranslucencyDirectionalLightingIntensity()
enum ETransl...	GetTranslucencyLightingMode()
float	GetTranslucentBackscatteringExponent()
FLinearColor	GetTranslucentMultipleScatteringExtinction()
float	GetTranslucentSelfShadowDensityScale()
float	GetTranslucentSelfShadowSecondDensityScale()
float	GetTranslucentSelfShadowSecondOpacity()
float	GetTranslucentShadowDensityScale()
float	GetTranslucentShadowStartOffset()
TArrayView< ...	GetUniform2DArrayTextureExpressions()
TArrayView< ...	GetUniform2DTextureExpressions()
TArrayView< ...	GetUniformCubeTextureExpressions()
const FUnifo...	GetUniformExpressions()	Accessors.
TArrayView< ...	GetUniformScalarParameterExpressions()
TArrayView< ...	GetUniformTextureExpressions ( EMaterialTextureParameterType Type )
TArrayView< ...	GetUniformVectorParameterExpressions()
TArrayView< ...	GetUniformVirtualTextureExpressions()
TArrayView< ...	GetUniformVolumeTextureExpressions()
bool	GetUsesDynamicParameter()
bool	HasAmbientOcclusionConnected()
bool	HasAnisotropyConnected()
bool	HasBaseColorConnected()
bool	HasEmissiveColorConnected()
bool	HasMaterialAttributesConnected()
bool	HasMaterialLayers()
bool	HasNormalConnected()
bool	HasPixelDepthOffsetConnected()
bool	HasRoughnessConnected()
bool	HasRuntimeVirtualTextureOutput()
bool	HasShaders ( const FMaterialShaderTypes& InType..., const FVertexFactoryType* InVe... )
bool	HasSpecularConnected()
bool	HasValidGameThreadShaderMap()	Checks if there is a valid GameThreadShaderMap, that is, the material can be rendered as intended.
bool	HasVertexPositionOffsetConnected()
bool	IsAdaptiveTessellationEnabled()
bool	IsCompilationFinished()	Checks if the compilation for this shader is finished
bool	IsCrackFreeDisplacementEnabled()
bool	IsDefaultMaterial()
bool	IsDeferredDecal()
bool	IsDistorted()
bool	IsDitheredLODTransition()
bool	IsDitherMasked()
bool	IsDualBlendingEnabled ( EShaderPlatform Platform )
bool	IsFullyRough()
bool	IsGameThreadShaderMapComplete()
bool	IsLightFunction()
bool	IsMasked()
bool	IsMobileSeparateTranslucencyEnabled()
bool	IsNonmetal()
bool	IsOwnerBeginDestroyed()
bool	IsPersistent()	Should shaders compiled for this material be saved to disk?
bool	IsRenderingThreadShaderMapComplete()
bool	IsShadingModelFromMaterialExpression()
bool	IsSky()
bool	IsSpecialEngineMaterial()
bool	IsStencilTestEnabled()
bool	IsTangentSpaceNormal()
bool	IsTranslucencyAfterDOFEnabled()
bool	IsTranslucencyWritingCustomDepth()
bool	IsTranslucencyWritingVelocity()
bool	IsTwoSided()
bool	IsUIMaterial()
bool	IsUsedWithAPEXCloth()
bool	IsUsedWithBeamTrails()
bool	IsUsedWithEditorCompositing()
bool	IsUsedWithGeometryCache()
bool	IsUsedWithGeometryCollections()
bool	IsUsedWithHairStrands()
bool	IsUsedWithInstancedStaticMeshes()
bool	IsUsedWithLandscape()
bool	IsUsedWithLidarPointCloud()
bool	IsUsedWithMeshParticles()
bool	IsUsedWithMorphTargets()
bool	IsUsedWithNiagaraMeshParticles()
bool	IsUsedWithNiagaraRibbons()
bool	IsUsedWithNiagaraSprites()
bool	IsUsedWithParticleSprites()
bool	IsUsedWithParticleSystem()
bool	IsUsedWithSkeletalMesh()
bool	IsUsedWithSplineMeshes()
bool	IsUsedWithStaticLighting()
bool	IsUsedWithUI()
bool	IsUsedWithVirtualHeightfieldMesh()
bool	IsUsedWithWater()
bool	IsUsingAlphaToCoverage()
bool	IsUsingFullPrecision()
bool	IsUsingHQForwardReflections()
bool	IsUsingPlanarForwardReflections()
bool	IsUsingPreintegratedGFForSimpleIBL()
bool	IsVolumetricPrimitive()
bool	IsWireframe()
void	LegacySerialize ( FArchive& Ar )	Serializes the material.
bool	MaterialMayModifyMeshPosition()	This function is only intended for use in deciding whether or not shader permutations are required before material translation occurs.
bool	MaterialModifiesMeshPosition_GameThread()
bool	MaterialModifiesMeshPosition_RenderThread()	Does the material modify the mesh position.
bool	MaterialUsesAnisotropy_GameThread()
bool	MaterialUsesAnisotropy_RenderThread()
bool	MaterialUsesDistanceCullFade_GameThread()	Does the material use a distance cull fade.
bool	MaterialUsesPixelDepthOffset()	Does the material use a pixel depth offset.
bool	MaterialUsesSceneDepthLookup_GameThread()
bool	MaterialUsesSceneDepthLookup_RenderThread()	Does the material use a SceneDepth lookup.
bool	NeedsGBuffer()
bool	NeedsSceneTextures()
void	NotifyCompilationFinished()	Called when compilation of an FMaterial finishes, after the GameThreadShaderMap is set and the render command to set the RenderThreadShaderMap is queued
bool	PrepareDestroy_GameThread()	Prepares to destroy the material, must be called from game thread Returns 'true' if PrepareDestroy_RenderThread() is required
void	PrepareDestroy_RenderThread()	Prepares to destroy the material, must be called from render thread, only if PrepareDestroy_GameThread() returned true
void	RegisterInlineShaderMap ( bool bLoadedByCookedMaterial )	Serializes the shader map inline in this material, including any shader dependencies.
uint32	Release()
void	ReleaseShaderMap()	Releases this material's shader map.
bool	RequiresSceneColorCopy_GameThread()
bool	RequiresSceneColorCopy_RenderThread()
bool	RequiresSynchronousCompilation()
void	RestoreEditorLoadedMaterialShadersFromMemory ( const TMap< FMaterialShaderMap*... )	Recreates FShaders in editor loaded materials from the passed in memory, handling shader key changes.
void	SaveShaderStableKeys ( EShaderPlatform TargetShaderPlatfor..., FStableShaderKeyAndValue& SaveKeyV... )
void	SerializeInlineShaderMap ( FArchive& Ar )	Serializes the shader map inline in this material, including any shader dependencies.
void	SetCompileErrors ( const TArray< FString >& InCompile... )
void	SetCompilingShaderMap ( FMaterialShaderMap* InMaterial... )
void	SetGameThreadShaderMap ( FMaterialShaderMap* InMaterial... )
void	SetInlineShaderMap ( FMaterialShaderMap* InMaterial... )
void	SetOwnerBeginDestroyed()
void	SetQualityLevelProperties ( ERHIFeatureLevel::Type InFeatureLev..., EMaterialQualityLevel::Type InQuali... )
void	SetRenderingThreadShaderMap ( TRefCountPtr< FMaterialShaderMap > ... )
void	SetShaderMapsOnMaterialResources ( const TMap< TRefCountPtr< FMaterial... )	Sets shader maps on the specified materials without blocking.
void	SetupExtaCompilationSettings ( const EShaderPlatform Platform, FExtraShaderCompilerSettings& Sett... )	Call during shader compilation jobs setup to fill additional settings that may be required by classes who inherit from this
bool	ShouldApplyCloudFogging()
bool	ShouldApplyFogging()
bool	ShouldBlockGI()
bool	ShouldCache ( EShaderPlatform Platform, const FShaderType* ShaderType, const FVertexFactoryType* Vert... )	Should the shader for this material with the given platform, shader type and vertex factory type combination be compiled
bool	ShouldCachePipeline ( EShaderPlatform Platform, const FShaderPipelineType* Pip..., const FVertexFactoryType* Vert... )
bool	ShouldCacheShaders ( const FMaterialShaderTypes& InType..., const FVertexFactoryType* InVe... )
bool	ShouldCastDynamicShadows()	Returns whether this material should be considered for casting dynamic shadows.
bool	ShouldDisableDepthTest()
bool	ShouldDoContactShadows()
bool	ShouldDoSSR()
bool	ShouldEnableResponsiveAA()
bool	ShouldGenerateSphericalParticleNormals()
bool	ShouldInjectEmissiveIntoLPV()
bool	ShouldInlineShaderCode()	Some materials may be loaded early - before the shader library - and need their code inlined
bool	ShouldWriteDepthToTranslucentMaterial()
bool	ShouldWriteOnlyAlpha()
void	SubmitCompileJobs ( EShaderCompileJobPriority Priority )
bool	TryGetShaders ( const FMaterialShaderTypes& InType..., const FVertexFactoryType* InVe..., FMaterialShaders& OutShaders )
void	UpdateEditorLoadedMaterialResources ( EShaderPlatform InShaderPlatform )	Recompiles any materials in the EditorLoadedMaterialResources list if they are not complete.
void	UpdateInlineShaderMapIsComplete()
bool	UseLmDirectionality()
bool	UseNormalCurvatureToRoughness()
bool	UsesCustomDepthStencil_GameThread()	Does the material use CustomDepth or CustomStencil lookup
bool	UsesEyeAdaptation()
bool	UsesGlobalDistanceField_GameThread()
bool	UsesWorldPositionOffset_GameThread()
bool	WritesEveryPixel ( bool bShadowPass )	Helper function to look at both IsMasked and IsDitheredLODTransition to determine if it writes every pixel

Constants

Name	Description
EditorLoadedMaterialResources	Tracks FMaterials without a corresponding UMaterialInterface in the editor, for example FExpressionPreviews.

Deprecated Functions

		Name	Description
	void	SetQualityLevelProperties ( EMaterialQualityLevel::Type InQuali..., bool bInHasQualityLevelUsage, ERHIFeatureLevel::Type InFeatureLev... )	Parameter bInHasQualityLevelUsage is depreceated

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

Take our survey

Dismiss