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 > Materials > UMaterialInstance

Light Theme

Dark Theme

UMaterialInstance

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UMaterialInterface

UMaterialInstance

UMaterialInstanceConstant

ULandscapeMaterialInstanceConstant

UMaterialInstanceDynamic

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/Materials/MaterialInstance.h
Include	#include "Materials/MaterialInstance.h"

Syntax

class UMaterialInstance : public UMaterialInterface

Variables

	Name	Description
FMaterialInstan...	BasePropertyOverrides
uint8: 1	bCastDynamicShadowAsMasked
uint8: 1	bHasStaticPermutationResource	Indicates whether the instance has static permutation resources (which are required when static parameters are present) Read directly from the rendering thread, can only be modified with the use of a FMaterialUpdateContext.
uint8: 1	bIsShadingModelFromMaterialExpression
TEnumAsByte< EB...	BlendMode
uint8: 1	bOverrideSubsurfaceProfile	Defines if SubsurfaceProfile from this instance is used or it uses the parent one.
uint8: 1	DitheredLODTransition
TArray< struct ...	FontParameterValues	Font parameters.
float	OpacityMaskClipValue	Cached copies of the base property overrides or the value from the parent to avoid traversing the parent chain for each access.
UMaterialInterf...	Parent	Parent material.
UPhysicalMateri...	PhysicalMaterialMap	Physical material map used with physical material mask, when it exists.
UPhysicalMateri...	PhysMaterial	Physical material to use for this graphics material. Used for sounds, effects etc.
bool[2]	ReentrantFlag	Flag to detect cycles in the material instance graph.
FMaterialInstan...	Resource	FMaterialRenderProxy derivative that represent this material instance to the renderer, when the renderer needs to fetch parameter values.
TArray< struct ...	RuntimeVirtualTextureParameterValues	RuntimeVirtualTexture parameters.
TArray< struct ...	ScalarParameterValues	Scalar parameters.
FMaterialShadin...	ShadingModels
TArray< struct ...	TextureParameterValues	Texture parameters.
uint8: 1	TwoSided
TArray< struct ...	VectorParameterValues	Vector parameters.

Constructors

	Name	Description
	UMaterialInstance ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	AddReferencedObjects ( UObject* InThis, FReferenceCollector& Collector )
void	AllMaterialsCacheResourceShadersForRendering ( bool bUpdateProgressDialog )	For all materials instances, UMaterialInstance::CacheResourceShadersForRendering.
FMaterialRes...	AllocatePermutationResource()
void	BeginAllowCachingStaticParameterValues()
void	CacheResourceShadersForCooking ( EShaderPlatform ShaderPlatform, TArray< FMaterialResource* >&..., const ITargetPlatform* TargetP... )	Cache resource shaders for rendering on the given shader platform.
void	CacheResourceShadersForRendering()	Cache resource shaders for rendering on the given shader platform.
void	CacheShadersForResources ( EShaderPlatform ShaderPlatform, const TArray< FMaterialResource..., const ITargetPlatform* TargetP... )	Caches shader maps for an array of material resources.
void	ClearParameterValuesInternal ( const bool bAllParameters )
void	CopyMaterialInstanceParameters ( UMaterialInterface* Source )	Copies over material instance parameters from the base material given a material interface.
void	CopyMaterialUniformParametersInternal ( UMaterialInterface* Source )	Copies the uniform parameters (scalar, vector and texture) from a material or instance hierarchy.
void	DumpDebugInfo()
void	EndAllowCachingStaticParameterValues()
bool	Equivalent ( const UMaterialInstance* Compa... )
void	GetAllParameterInfo ( TArray< FMaterialParameterInfo >& ..., TArray< FGuid >& OutParameterIds )	Builds a composited set of parameter names, including inherited and overridden values
void	GetAllParametersOfType ( EMaterialParameterType Type, TArray< FMaterialParameterInfo >& ..., TArray< FGuid >& OutParameterIds )
void	GetAllShaderMaps ( TArray< FMaterialShaderMap* > ... )	Gathers actively used shader maps from all material resources used by this material instance Note - not refcounting the shader maps so the references must not be used after material resources are modified (compilation, loading, etc)
void	GetBasePropertyOverridesHash ( FSHAHash& OutHash )	Properties of the base material. Can now be overridden by instances.
bool	GetReentrantFlag()
const FStati...	GetStaticParameters()	Gets static parameter set for this material.
void	GetStaticParameterValues ( FStaticParameterSet& OutStaticPara... )	Builds a composited set of static parameters, including inherited and overridden values
void	GetTextureExpressionValues ( const FMaterialResource* Mater..., TArray< UTexture* >& OutTextu..., TArray< TArray< int32 > >* Out... )
bool	HasOverridenBaseProperties()
void	InitResources()	Initialize the material instance's resources.
void	InitStaticPermutation()	Recompiles static permutations if necessary.
bool	IsChildOf ( const UMaterialInterface* Mate... )	Determine whether this Material Instance is a child of another Material
void	PropagateDataToMaterialProxy()	To share code between PostLoad() and PostEditChangeProperty()
void	SaveShaderStableKeys ( const ITargetPlatform* TP )
void	SetFontParameterValueInternal ( const FMaterialParameterInfo& Para..., UFont* FontValue, int32 FontPage )
void	SetParentInternal ( UMaterialInterface* NewParent, bool RecacheShaders )
void	SetReentrantFlag ( const bool bValue )
void	SetRuntimeVirtualTextureParameterValueInternal ( const FMaterialParameterInfo& Para..., URuntimeVirtualTexture* Value )
void	SetScalarParameterAtlasInternal ( const FMaterialParameterInfo& Para..., FScalarParameterAtlasInstanceData A... )
bool	SetScalarParameterByIndexInternal ( int32 ParameterIndex, float Value )
void	SetScalarParameterValueInternal ( const FMaterialParameterInfo& Para..., float Value )
void	SetTextureParameterValueInternal ( const FMaterialParameterInfo& Para..., UTexture* Value )
bool	SetVectorParameterByIndexInternal ( int32 ParameterIndex, FLinearColor Value )
void	SetVectorParameterValueInternal ( const FMaterialParameterInfo& Para..., FLinearColor Value )	Internal interface for setting / updating values for material instances.
void	SwapLayerParameterIndices ( int32 OriginalIndex, int32 NewIndex )
void	UpdateCachedLayerParameters()
bool	UpdateMaterialLayersParameterValue ( const FHashedMaterialParameterInfo ..., const FMaterialLayersFunctions& La..., const bool bOverridden, const FGuid& GUID )
void	UpdateOverridableBaseProperties()
void	UpdateParameterNames()	Refresh parameter names using the stored reference to the expression object for the parameter.
bool	UpdateParameters()	Updates parameter names on the material instance, returns true if parameters have changed.
void	UpdatePermutationAllocations ( FMaterialResourceDeferredDeletionAr... )	Updates StaticPermutationMaterialResources based on the value of bHasStaticPermutationResource This is a helper used when recompiling MI's with static parameters.
void	UpdateStaticPermutation ( const FStaticParameterSet& NewPara..., FMaterialUpdateContext* Materi... )	Sets new static parameter overrides on the instance and recompiles the static permutation resources if needed.
void	UpdateStaticPermutation()	Ensure's static permutations for current parameters and overrides are upto date.
void	UpdateStaticPermutation ( const FStaticParameterSet& NewPara..., FMaterialInstanceBasePropertyOverri..., const bool bForceStaticPermutationU..., FMaterialUpdateContext* Materi... )	Sets new static parameter overrides on the instance and recompiles the static permutation resources if needed (can be forced with bForceRecompile).
void	ValidateTextureOverrides ( ERHIFeatureLevel::Type InFeatureLev... )

Overridden from UMaterialInterface

	Name	Description
bool	CastsRayTracedShadows()
bool	CheckMaterialUsage ( const EMaterialUsage Usage )	Checks if the material can be used with the given usage flag.
bool	CheckMaterialUsage_Concurrent ( const EMaterialUsage Usage )	Same as above but is valid to call from any thread.
int32	CompilePropertyEx ( FMaterialCompiler* Compiler, const FGuid& AttributeID )	Allows material properties to be compiled with the option of being overridden by the material attributes input.
void	ForceRecompileForRendering()	Clears the shader cache and recompiles the shader for rendering.
void	GetAllFontParameterInfo ( TArray< FMaterialParameterInfo >& ..., TArray< FGuid >& OutParameterIds )
void	GetAllMaterialLayersParameterInfo ( TArray< FMaterialParameterInfo >& ..., TArray< FGuid >& OutParameterIds )
void	GetAllRuntimeVirtualTextureParameterInfo ( TArray< FMaterialParameterInfo >& ..., TArray< FGuid >& OutParameterIds )
void	GetAllScalarParameterInfo ( TArray< FMaterialParameterInfo >& ..., TArray< FGuid >& OutParameterIds )
void	GetAllStaticComponentMaskParameterInfo ( TArray< FMaterialParameterInfo >& ..., TArray< FGuid >& OutParameterIds )
void	GetAllStaticSwitchParameterInfo ( TArray< FMaterialParameterInfo >& ..., TArray< FGuid >& OutParameterIds )
void	GetAllTextureParameterInfo ( TArray< FMaterialParameterInfo >& ..., TArray< FGuid >& OutParameterIds )
void	GetAllVectorParameterInfo ( TArray< FMaterialParameterInfo >& ..., TArray< FGuid >& OutParameterIds )
EBlendMode	GetBlendMode()
bool	GetCastShadowAsMasked()
void	GetDependentFunctions ( TArray< class UMaterialFunctionInte... )
float	GetDiffuseBoost()
float	GetEmissiveBoost()
float	GetExportResolutionScale()
bool	GetFontParameterDefaultValue ( const FHashedMaterialParameterInfo ..., UFont*& OutFontValue, int32& OutFontPage, bool bCheckOwnedGlobalOverrides )
bool	GetFontParameterValue ( const FHashedMaterialParameterInfo ..., UFont*& OutFontValue, int32& OutFontPage, bool bOveriddenOnly )
bool	GetGroupName ( const FHashedMaterialParameterInfo ..., FName& OutGroup )
bool	GetGroupSortPriority ( const FString& InGroupName, int32& OutSortPriority )	Get the sort priority index of the given parameter group
int32	GetLayerParameterIndex ( EMaterialParameterAssociation Assoc..., UMaterialFunctionInterface* La... )
void	GetLightingGuidChain ( bool bIncludeTextures, TArray< FGuid >& OutGuids )	Returns all the Guids related to this material.
const UMater...	GetMaterial()	Get the material which we are instancing.
UMaterial &#...	GetMaterial()	Get the material which we are instancing.
const UMater...	GetMaterial_Concurrent ( TMicRecursionGuard RecursionGuard )	Same as above, but can be called concurrently
bool	GetMaterialLayersParameterValue ( const FHashedMaterialParameterInfo ..., FMaterialLayersFunctions& OutLayer..., FGuid& OutExpressionGuid, bool bCheckParent )	Get the value of the given static material layers parameter
FMaterialRes...	GetMaterialResource ( ERHIFeatureLevel::Type InFeatureLev..., EMaterialQualityLevel::Type Quality... )	Get the static permutation resource if the instance has one
const FMater...	GetMaterialResource ( ERHIFeatureLevel::Type InFeatureLev..., EMaterialQualityLevel::Type Quality... )	Get the static permutation resource if the instance has one
float	GetOpacityMaskClipValue()	Access to overridable properties of the base material.
bool	GetParameterDesc ( const FHashedMaterialParameterInfo ..., FString& OutDesc, const TArray< struct FStaticMateria... )
bool	GetParameterSortPriority ( const FHashedMaterialParameterInfo ..., int32& OutSortPriority, const TArray< struct FStaticMateria... )	Get the sort priority index of the given parameter
UPhysicalMat...	GetPhysicalMaterial()	Return a pointer to the physical material used by this material instance.
UPhysicalMat...	GetPhysicalMaterialFromMap ( int32 Index )	Return a pointer to the physical material from mask map at given index.
UPhysicalMat...	GetPhysicalMaterialMask()	Return a pointer to the physical material mask used by this material instance.
TArrayView< ...	GetReferencedTextures()	Appends textures referenced by expressions, including nested functions.
bool	GetRefractionSettings ( float& OutBiasValue )
FMaterialRen...	GetRenderProxy()	Return a pointer to the FMaterialRenderProxy used for rendering.
bool	GetRuntimeVirtualTextureParameterDefaultValue ( const FHashedMaterialParameterInfo ..., URuntimeVirtualTexture*& OutVa..., bool bCheckOwnedGlobalOverrides )
bool	GetRuntimeVirtualTextureParameterValue ( const FHashedMaterialParameterInfo ..., URuntimeVirtualTexture*& OutVa..., bool bOveriddenOnly )
bool	GetScalarParameterDefaultValue ( const FHashedMaterialParameterInfo ..., float& OutValue, bool bOveriddenOnly, bool bCheckOwnedGlobalOverrides )
bool	GetScalarParameterSliderMinMax ( const FHashedMaterialParameterInfo ..., float& OutSliderMin, float& OutSliderMax )
bool	GetScalarParameterValue ( const FHashedMaterialParameterInfo ..., float& OutValue, bool bOveriddenOnly )
FMaterialSha...	GetShadingModels()
bool	GetStaticComponentMaskParameterDefaultValue ( const FHashedMaterialParameterInfo ..., bool& OutR, bool& OutG, bool& OutB, bool& OutA, FGuid& OutExpressionGuid, bool bCheckOwnedGlobalOverrides )
bool	GetStaticComponentMaskParameterValues ( FStaticParamEvaluationContext& Eva..., TBitArray<>& OutRGBAOrderedValues, FGuid* OutExpressionGuids, bool bCheckParent )	Get the values of the given set of static component mask parameters
bool	GetStaticSwitchParameterDefaultValue ( const FHashedMaterialParameterInfo ..., bool& OutValue, FGuid& OutExpressionGuid, bool bCheckOwnedGlobalOverrides )
bool	GetStaticSwitchParameterValues ( FStaticParamEvaluationContext& Eva..., TBitArray<>& OutValues, FGuid* OutExpressionGuids, bool bCheckParent )	Get the values of the given set of static switch parameters.
USubsurfaceP...	GetSubsurfaceProfile_Internal()
bool	GetTerrainLayerWeightParameterValue ( const FHashedMaterialParameterInfo ..., int32& OutWeightmapIndex, FGuid& OutExpressionGuid )	Get the weightmap index of the given terrain layer weight parameter
float	GetTextureDensity ( FName TextureName, const FMeshUVChannelInfo& UVChanne... )	Returns the density of a texture in (LocalSpace Unit / Texture).
bool	GetTextureParameterChannelNames ( const FHashedMaterialParameterInfo ..., FParameterChannelNames& OutValue )
bool	GetTextureParameterDefaultValue ( const FHashedMaterialParameterInfo ..., UTexture*& OutValue, bool bCheckOwnedGlobalOverrides )
bool	GetTextureParameterValue ( const FHashedMaterialParameterInfo ..., UTexture*& OutValue, bool bOveriddenOnly )
bool	GetTexturesInPropertyChain ( EMaterialProperty InProperty, TArray< UTexture* >& OutTextu..., TArray< FName >* OutTexturePar..., FStaticParameterSet* InStaticP..., ERHIFeatureLevel::Type InFeatureLev..., EMaterialQualityLevel::Type InQuali... )	Get all of the textures in the expression chain for the given property (ie fill in the given array with all textures in the chain).
void	GetUsedTextures ( TArray< UTexture* >& OutTextu..., EMaterialQualityLevel::Type Quality..., bool bAllQualityLevels, ERHIFeatureLevel::Type FeatureLevel, bool bAllFeatureLevels )	Return the textures used to render this material.
void	GetUsedTexturesAndIndices ( TArray< UTexture* >& OutTextu..., TArray< TArray< int32 > >& OutIndi..., EMaterialQualityLevel::Type Quality..., ERHIFeatureLevel::Type FeatureLevel )	Return the textures used to render this material and the material indices bound to each.
bool	GetVectorParameterChannelNames ( const FHashedMaterialParameterInfo ..., FParameterChannelNames& OutValue )
bool	GetVectorParameterDefaultValue ( const FHashedMaterialParameterInfo ..., FLinearColor& OutValue, bool bOveriddenOnly, bool bCheckOwnedGlobalOverrides )
bool	GetVectorParameterValue ( const FHashedMaterialParameterInfo ..., FLinearColor& OutValue, bool bOveriddenOnly )
bool	IsDependent ( UMaterialInterface* TestDepend... )	Test this material for dependency on a given material.
bool	IsDitheredLODTransition()
bool	IsMasked()
bool	IsPropertyActive ( EMaterialProperty InProperty )	Checks to see if an input property should be active, based on the state of the material
bool	IsScalarParameterUsedAsAtlasPosition ( const FHashedMaterialParameterInfo ..., bool& OutValue, TSoftObjectPtr< class UCurveLinearC..., TSoftObjectPtr< class UCurveLinearC... )
bool	IsShadingModelFromMaterialExpression()
bool	IsTwoSided()
bool	IsVectorParameterUsedAsChannelMask ( const FHashedMaterialParameterInfo ..., bool& OutValue )
bool	IterateDependentFunctions ( TFunctionRef< bool... )
void	LogMaterialsAndTextures ( FOutputDevice& Ar, int32 Indent )	Output to the log which materials and textures are used by this material.
void	OverrideScalarParameterDefault ( const FHashedMaterialParameterInfo ..., float Value, bool bOverride, ERHIFeatureLevel::Type FeatureLevel )
void	OverrideTexture ( const UTexture* InTextureToOve..., UTexture* OverrideTexture, ERHIFeatureLevel::Type InFeatureLev... )	Override a specific texture (transient)
void	OverrideVectorParameterDefault ( const FHashedMaterialParameterInfo ..., const FLinearColor& Value, bool bOverride, ERHIFeatureLevel::Type FeatureLevel )	Overrides the default value of the given parameter (transient).
void	RecacheUniformExpressions ( bool bRecreateUniformBuffer )	Re-caches uniform expressions for this material interface Set bRecreateUniformBuffer to true if uniform buffer layout will change (e.g. FMaterial is being recompiled).
void	SaveShaderStableKeysInner ( const ITargetPlatform* TP, const FStableShaderKeyAndValue& Sa... )
bool	UpdateLightmassTextureTracking()	Check if the textures have changed since the last time the material was serialized for Lightmass...

Overridden from UObject

	Name	Description
void	BeginCacheForCookedPlatformData ( const ITargetPlatform* TargetP... )	Starts caching of platform specific data for the target platform Called when cooking before serialization so that object can prepare platform specific data Not called during normal loading of objects
void	BeginDestroy()	Called before destroying the object.
void	ClearAllCachedCookedPlatformData()	Clear all cached cooked platform data
void	ClearCachedCookedPlatformData ( const ITargetPlatform* TargetP... )	Clears cached cooked platform data for specific platform
void	FinishDestroy()	Called to finish destroying the object.
void	GetResourceSizeEx ( FResourceSizeEx& CumulativeResourc... )	Get the size of the object/resource for use in memory tools or to display to artists/LDs in the Editor This is the extended version which separates up the used memory into different memory regions (the actual definition of which may be platform specific).
bool	IsCachedCookedPlatformDataLoaded ( const ITargetPlatform* TargetP... )	Have we finished loading all the cooked platform data for the target platforms requested in BeginCacheForCookedPlatformData
bool	IsReadyForFinishDestroy()	Called to check if the object is ready for FinishDestroy.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	PreSave ( const ITargetPlatform* TargetP... )	Presave function.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Typedefs

Name	Description
FCustomParameterSetUpdaterDelegate	Delegate for custom static parameters updater.
FCustomStaticParametersGetterDelegate	Delegate for custom static parameters getter.

Constants

Name	Description
CustomParameterSetUpdaters	An array of custom parameter set updaters.
CustomStaticParametersGetters	Custom static parameters getter delegate.

Deprecated Variables

		Name	Description
	bool	bOverrideBaseProperties_DEPRECATED

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

Take our survey

Dismiss