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

Light Theme

Dark Theme

UMaterialInterface

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UMaterialInterface

UMaterial

UPreviewMaterial

UMaterialInstance

UMaterialInstanceConstant

ULandscapeMaterialInstanceConstant

UMaterialInstanceDynamic

References

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

Syntax

class UMaterialInterface :
    public UObject,
    public IBlendableInterface,
    public IInterface_AssetUserData

Variables

	Name	Description
UAssetImportDat...	AssetImportData	Importing data and options used for this material
TArray< UAssetU...	AssetUserData	Array of user data stored with the asset
bool	bTextureStreamingDataSorted	Because of redirector, the texture names need to be resorted at each load in case they changed.
TMap< FString, ...	LayerParameterExpansion
FLightmassMater...	LightmassSettings	The Lightmass settings for this object.
TMap< FString, ...	ParameterOverviewExpansion
FRenderCommandF...	ParentRefFence	A fence to track when the primitive is no longer used as a parent
FSoftObjectPath	PreviewMesh	The mesh used by the material editor to preview the material.
USubsurfaceProf...	SubsurfaceProfile	SubsurfaceProfile, for Screen Space Subsurface Scattering
TArray< FMateri...	TextureStreamingData	Data used by the texture streaming to know how each texture is sampled by the material.
TArray< FMateri...	TextureStreamingDataMissingEntries	List of all used but missing texture indices in TextureStreamingData.
int32	TextureStreamingDataVersion
UThumbnailInfo ...	ThumbnailInfo	Information for thumbnail rendering

Constructors

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

Functions

	Name	Description
void	AnalyzeMaterialProperty ( EMaterialProperty InProperty, int32& OutNumTextureCoordinates, bool& bOutRequiresVertexData )	Return number of used texture coordinates and whether or not the Vertex data is used in the shader graph
void	AssertDefaultMaterialsExist()	Asserts if any default material does not exist.
void	AssertDefaultMaterialsPostLoaded()	Asserts if any default material has not been post-loaded.
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	CompileProperty ( FMaterialCompiler* Compiler, EMaterialProperty Property, uint32 ForceCastFlags )	Compiles a material property.
int32	CompilePropertyEx ( FMaterialCompiler* Compiler, const FGuid& AttributeID )	Allows material properties to be compiled with the option of being overridden by the material attributes input.
bool	FindTextureStreamingDataIndexRange ( FName TextureName, int32& LowerIndex, int32& HigherIndex )	Find entries within TextureStreamingData that match the given name.
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 )
UMaterial &#...	GetBaseMaterial()	Walks up parent chain and finds the base Material that this is an instance of.
EBlendMode	GetBlendMode()
bool	GetCastDynamicShadowAsMasked()
bool	GetCastShadowAsMasked()
void	GetDependentFunctions ( TArray< class UMaterialFunctionInte... )
float	GetDiffuseBoost()
float	GetEmissiveBoost()
float	GetExportResolutionScale()
uint32	GetFeatureLevelsToCompileForAllMaterials()	Get bitfield indicating which feature levels should be compiled by default
uint32	GetFeatureLevelsToCompileForRendering()	Returns a bitfield indicating which feature levels should be compiled for rendering.
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& GroupName )
bool	GetGroupSortPriority ( const FString& InGroupName, int32& OutSortPriority )	Get the sort priority index of the given parameter group
int32	GetHeight()
int32	GetLayerParameterIndex ( EMaterialParameterAssociation Assoc..., UMaterialFunctionInterface* La... )
const FGuid ...	GetLightingGuid()
void	GetLightingGuidChain ( bool bIncludeTextures, TArray< FGuid >& OutGuids )	Returns all the Guids related to this material.
bool	GetLinearColorCurveParameterValue ( const FHashedMaterialParameterInfo ..., FInterpCurveLinearColor& OutValue )
bool	GetLinearColorParameterValue ( const FHashedMaterialParameterInfo ..., FLinearColor& OutValue )
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	GetOverrideCastShadowAsMasked()
bool	GetOverrideDiffuseBoost()
bool	GetOverrideEmissiveBoost()
bool	GetOverrideExportResolutionScale()
bool	GetParameterDesc ( const FHashedMaterialParameterInfo ..., FString& OutDesc, const TArray< struct FStaticMateria... )
FMaterialPar...	GetParameterInfo ( EMaterialParameterAssociation Assoc..., FName ParameterName, UMaterialFunctionInterface* La... )
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()	Get textures referenced by expressions, including nested functions.
void	GetReferencedTexturesAndOverrides ( TSet< const UTexture* >& InOu... )	Add to the set any texture referenced by expressions, including nested functions, as well as any overrides from parameters.
bool	GetRefractionSettings ( float& OutBiasValue )
FMaterialRel...	GetRelevance ( ERHIFeatureLevel::Type InFeatureLev... )
FMaterialRel...	GetRelevance_Concurrent ( ERHIFeatureLevel::Type InFeatureLev... )
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 )
UEnum *	GetSamplerTypeEnum()	Access the cached uenum type information for material sampler type
bool	GetScalarCurveParameterValue ( const FHashedMaterialParameterInfo ..., FInterpCurveFloat& OutValue )
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	GetStaticComponentMaskParameterValue ( const FHashedMaterialParameterInfo ..., bool& R, bool& G, bool& B, bool& A, FGuid& OutExpressionGuid, bool bOveriddenOnly, bool bCheckParent )	Get the value of the given static component mask parameter
bool	GetStaticSwitchParameterDefaultValue ( const FHashedMaterialParameterInfo ..., bool& OutValue, FGuid& OutExpressionGuid, bool bCheckOwnedGlobalOverrides )
bool	GetStaticSwitchParameterValue ( const FHashedMaterialParameterInfo ..., bool& OutValue, FGuid& OutExpressionGuid, bool bOveriddenOnly, bool bCheckParent )	Get the value of the given static switch parameter
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).
const TArray...	GetTextureStreamingData()	Accessor to the data.
TArray< FMat...	GetTextureStreamingData()
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	GetVectorCurveParameterValue ( const FHashedMaterialParameterInfo ..., FInterpCurveVector& OutValue )
bool	GetVectorParameterChannelNames ( const FHashedMaterialParameterInfo ..., FParameterChannelNames& OutValue )
bool	GetVectorParameterDefaultValue ( const FHashedMaterialParameterInfo ..., FLinearColor& OutValue, bool bOveriddenOnly, bool bCheckOwnedGlobalOverrides )
bool	GetVectorParameterValue ( const FHashedMaterialParameterInfo ..., FLinearColor& OutValue, bool bOveriddenOnly )
int32	GetWidth()
bool	HasTextureStreamingData()	Returns whether there is any streaming data in the component.
void	InitDefaultMaterials()	Initializes all default materials.
bool	IsDeferredDecal()
bool	IsDependent ( UMaterialInterface* TestDepend... )	Test this material for dependency on a given material.
bool	IsDependent_Concurrent ( UMaterialInterface* TestDepend..., TMicRecursionGuard RecursionGuard )	Same as above, but can be called concurrently
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	IsTextureReferencedByProperty ( EMaterialProperty InProperty, const UTexture* InTexture )	Checks to see if the given property references the texture
bool	IsTranslucencyWritingCustomDepth()
bool	IsTranslucencyWritingVelocity()
bool	IsTwoSided()
bool	IsVectorParameterUsedAsChannelMask ( const FHashedMaterialParameterInfo ..., bool& OutValue )
bool	IterateDependentFunctions ( TFunctionRef< bool... )
void	IterateOverActiveFeatureLevels ( FunctionType InHandler )	Iterate over all feature levels currently marked as active
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	RecacheAllMaterialUniformExpressions ( bool bRecreateUniformBuffer )	Re-caches uniform expressions for all material interfaces Set bRecreateUniformBuffer to true if uniform buffer layout will change (e.g. FMaterial is being recompiled).
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... )
void	SetCastShadowAsMasked ( bool InCastShadowAsMasked )
void	SetDiffuseBoost ( float InDiffuseBoost )
void	SetEmissiveBoost ( float InEmissiveBoost )
void	SetExportResolutionScale ( float InExportResolutionScale )
void	SetFeatureLevelToCompile ( ERHIFeatureLevel::Type FeatureLevel, bool bShouldCompile )	Set which feature levels this material instance should compile.
void	SetForceMipLevelsToBeResident ( bool OverrideForceMiplevelsToBeResi..., bool bForceMiplevelsToBeResidentVal..., float ForceDuration, int32 CinematicTextureGroups, bool bFastResponse )	Force the streaming system to disregard the normal logic for the specified duration and instead always load all mip-levels for all textures used by this material.
void	SetGlobalRequiredFeatureLevel ( ERHIFeatureLevel::Type FeatureLevel, bool bShouldCompile )	Set which feature levels all materials should compile to. GMaxRHIFeatureLevel is always compiled.
void	SetLightingGuid()
void	SetOverrideCastShadowAsMasked ( bool bInOverrideCastShadowAsMasked )
void	SetOverrideDiffuseBoost ( bool bInOverrideDiffuseBoost )
void	SetOverrideEmissiveBoost ( bool bInOverrideEmissiveBoost )
void	SetOverrideExportResolutionScale ( bool bInOverrideExportResolutionSca... )
void	SetShouldForcePlanePreview ( const bool bInShouldForcePlanePrevi... )	Set whether or not this Material Interface should force a plane preview
void	SetTextureStreamingData ( const TArray< FMaterialTextureInfo ... )	Set new texture streaming data.
bool	ShouldForcePlanePreview()	True if this Material Interface should force a plane preview
void	SortTextureStreamingData ( bool bForceSort, bool bFinalSort )	Sort the texture streaming data by names to accelerate search. Only sorts if required.
bool	UpdateLightmassTextureTracking()	Check if the textures have changed since the last time the material was serialized for Lightmass...
void	UpdateMaterialRenderProxy ( FMaterialRenderProxy& Proxy )
bool	UseAnyStreamingTexture()	Return whether this material refer to any streaming textures.

Overridden from UObject

	Name	Description
void	BeginDestroy()	Called before destroying the object.
void	GetAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTa... )	Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects
bool	IsReadyForFinishDestroy()	Called to check if the object is ready for FinishDestroy.
void	PostCDOContruct()	Called after the C++ constructor has run on the CDO for a class.
void	PostDuplicate ( bool bDuplicateForPIE )	Called after duplication & serialization and before PostLoad.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	PreSave ( const ITargetPlatform* TargetP... )	Presave function.

Overridden from IBlendableInterface

		Name	Description
	void	OverrideBlendableSettings ( FSceneView& View, float Weight )

Overridden from IInterface_AssetUserData

		Name	Description
	void	AddAssetUserData ( UAssetUserData* InUserData )
	UAssetUserDa...	GetAssetUserDataOfClass ( TSubclassOf< UAssetUserData > InUse... )
	void	RemoveUserDataOfClass ( TSubclassOf< UAssetUserData > InUse... )

Constants

Name	Description
FeatureLevelsForAllMaterials	Feature level bitfield to compile for all materials
SamplerTypeEnum	Cached type information for the sampler type enumeration.

Deprecated Functions

		Name	Description
	float	GetScalarParameterDefault ( const FHashedMaterialParameterInfo ..., ERHIFeatureLevel::Type FeatureLevel )	This function is deprecated. Use GetScalarParameterDefaultValue instead.

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

Take our survey

Dismiss