1. Epic GamesDeveloper
  3. UMaterialInstance

UMaterialInstance

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Materials

Inheritance Hierarchy

References

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

Syntax

class UMaterialInstance : public UMaterialInterface

Variables

  Type Name Description
Public variable FMaterialInstanceBasePropertyOverrides BasePropertyOverrides  
Public variable uint8: 1 bCastDynamicShadowAsMasked  
Public variable bool bDisallowStaticParameterPermutations Whether static parameter permutations should be disabled (e.g. due to having a restricted parent material)
Public variable 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.
Public variable uint8: 1 bIsShadingModelFromMaterialExpression  
Public variable uint8: 1 bIsThinSurface  
Public variable TEnumAsByte< EBlendMode > BlendMode  
Protected variable uint8: 1 bLoadedCachedData  
Public variable uint8: 1 bOutputTranslucentVelocity  
Public variable uint8: 1 bOverrideSubsurfaceProfile Defines if SubsurfaceProfile from this instance is used or it uses the parent one.
Protected variable TUniquePtr< FMaterialInstanceCachedData > CachedData  
Public variable FDisplacementScaling DisplacementScaling  
Public variable uint8: 1 DitheredLODTransition  
Public variable TArray< struct FDoubleVectorParameterValue > DoubleVectorParameterValues DoubleVector parameters.
Public variable TArray< struct FFontParameterValue > FontParameterValues Font parameters.
Public variable float MaxWorldPositionOffsetDisplacement  
Public variable FMaterialOverrideNanite NaniteOverrideMaterial An override material which will be used instead of this one when rendering with Nanite.
Public variable float OpacityMaskClipValue Cached copies of the base property overrides or the value from the parent to avoid traversing the parent chain for each access.
Public variable TObjectPtr< class UMaterialInterface > Parent Parent material.
Public variable TObjectPtr< class UPhysicalMaterial >[EPhysicalMaterialMaskColor::MAX] PhysicalMaterialMap Physical material map used with physical material mask, when it exists.
Public variable TObjectPtr< class UPhysicalMaterial > PhysMaterial Physical material to use for this graphics material. Used for sounds, effects etc.
Public variable bool[2] ReentrantFlag Flag to detect cycles in the material instance graph, this is only used at content creation time where the hierarchy can be changed.
Public variable FMaterialInstanceResource * Resource FMaterialRenderProxy derivative that represent this material instance to the renderer, when the renderer needs to fetch parameter values.
Public variable TArray< struct FRuntimeVirtualTextureParameterValue > RuntimeVirtualTextureParameterValues RuntimeVirtualTexture parameters.
Public variable TArray< struct FScalarParameterValue > ScalarParameterValues Scalar parameters.
Public variable FMaterialShadingModelField ShadingModels  
Public variable TArray< struct FSparseVolumeTextureParameterValue > SparseVolumeTextureParameterValues Sparse Volume Texture parameters.
Public variable TArray< struct FTextureParameterValue > TextureParameterValues Texture parameters.
Public variable uint8: 1 TwoSided  
Public variable TArray< struct FVectorParameterValue > VectorParameterValues Vector parameters.

Constructors

  Type Name Description
Public function  

UMaterialInstance ( const FObjectInitializer& ObjectInitializer
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Protected function void

AddParameterValueInternal ( const FMaterialParameterInfo& ParameterInfo,
const FMaterialParameterMetadata& Meta,
EMaterialSetParameterValueFlags Flags
)

  
Public function Static void  
Public function Static void

AllMaterialsCacheResourceShadersForRendering ( bool bUpdateProgressDialog,
bool bCacheAllRemainingShaders
)

 For all materials instances, UMaterialInstance::CacheResourceShadersForRendering.
Public function Virtual FMaterialResource *  
Public function void  
Protected function void

BeginCacheShadersForResources ( EShaderPlatform ShaderPlatform,
const TArray< FMaterialResource* >& ResourcesToCache,
EMaterialShaderPrecompileMode PrecompileMode,
const ITargetPlatform* TargetPlatform
)

 Initiates caching for this shader resource that will be finished when each material resource IsCompilationFinished returns true.
Public function void

CacheResourceShadersForCooking ( EShaderPlatform ShaderPlatform,
TArray< FMaterialResource* >& OutCachedMaterialResources,
EMaterialShaderPrecompileMode PrecompileMode,
const ITargetPlatform* TargetPlatform,
bool bBlocking
)

 Cache resource shaders for rendering on the given shader platform.
Protected function void

CacheResourceShadersForRendering ( EMaterialShaderPrecompileMode PrecompileMode,
FMaterialResourceDeferredDeletionArray& OutResourcesToFree
)

 Cache resource shaders for rendering on the given shader platform.
Protected function void

CacheResourceShadersForRendering ( EMaterialShaderPrecompileMode PrecompileMode
)

 Cache resource shaders for rendering on the given shader platform.
Protected function void

CacheShadersForResources ( EShaderPlatform ShaderPlatform,
const TArray< FMaterialResource* >& ResourcesToCache,
EMaterialShaderPrecompileMode PrecompileMode,
const ITargetPlatform* TargetPlatform
)

 Caches shader maps for an array of material resources.
Protected function void

ClearParameterValuesInternal ( EMaterialInstanceClearParameterFlag Flags
)

  
Protected function void Copies over material instance parameters from the base material given a material interface.
Protected function void Copies the uniform parameters (scalar, vector and texture) from a material or instance hierarchy.
Public function Static void

DeclareConstructClasses ( TArray< FTopLevelAssetPath >& OutConstructClasses,
const UClass* SpecificSubclass
)

  
Public function void  
Public function Const bool

Equivalent ( const UMaterialInstance* CompareTo
)

  
Public function Const void  
Public function void

GetAllShaderMaps ( TArray< FMaterialShaderMap* >& OutShaderMaps
)

 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)
Public function Const void Properties of the base material. Can now be overridden by instances.
Public function Const FString  
Public function Const const FMaterialInstanceCachedData &  
Public function Const const FStaticParameterSetEditorOnlyData &  
Public function Const bool

GetParameterOverrideValue ( EMaterialParameterType Type,
const FMemoryImageMaterialParameterInfo& ParameterInfo,
FMaterialParameterMetadata& OutValue
)

  
Public function Const bool

GetReentrantFlag ( bool bIsInGameThread
)

  
Public function Const FStaticParameterSet  
Protected function Const void

GetTextureExpressionValues ( const FMaterialResource* MaterialResource,
TArray< UTexture* >& OutTextures,
TArray< TArray< int32 > >* OutIndices
)

  
Public function Virtual Const bool  
Public function Const bool Gets static parameter set for this material.
Protected function void Initialize the material instance's resources.
Public function void

InitStaticPermutation ( EMaterialShaderPrecompileMode PrecompileMode
)

 Recompiles static permutations if necessary.
Public function Const bool

IsChildOf ( const UMaterialInterface* Material
)

 Determine whether this Material Instance is a child of another Material
Public function Virtual Const bool Returns true if using this material instance would be equivalent to using its parent.
Public function Const bool Returns this material instance is allowed to override static parameters and introduce a new shader permutation when it derives from `CandidateParent_.
Public function Virtual FGraphEventArray

PrecachePSOs ( const FPSOPrecacheVertexFactoryDataList& VertexFactoryDataList,
const FPSOPrecacheParams& PreCacheParams,
EPSOPrecachePriority Priority,
TArray< FMaterialPSOPrecacheRequestID >& OutMaterialPSORequestIDs
)

  
Protected function void To share code between PostLoad() and PostEditChangeProperty()
Public function void

RemoveLayerParameterIndex ( int32 Index
)

  
Protected function void

ReserveParameterValuesInternal ( EMaterialParameterType Type,
int32 Capacity
)

 Internal interface for setting / updating values for material instances.
Public function void  
Protected function void

SetDoubleVectorParameterValueInternal ( const FMaterialParameterInfo& ParameterInfo,
FVector4d Value
)

  
Protected function void

SetFontParameterValueInternal ( const FMaterialParameterInfo& ParameterInfo,
UFont* FontValue,
int32 FontPage
)

  
Public function bool  
Protected function void

SetParameterValueInternal ( const FMaterialParameterInfo& ParameterInfo,
const FMaterialParameterMetadata& Meta,
EMaterialSetParameterValueFlags Flags
)

  
Protected function bool

SetParentInternal ( UMaterialInterface* NewParent,
bool RecacheShaders
)

  
Public function void

SetReentrantFlag ( const bool bValue,
bool bIsInGameThread
)

  
Protected function void  
Protected function void  
Protected function bool

SetScalarParameterByIndexInternal ( int32 ParameterIndex,
float Value
)

  
Protected function void

SetScalarParameterValueInternal ( const FMaterialParameterInfo& ParameterInfo,
float Value,
bool bUseAtlas,
FScalarParameterAtlasInstanceData AtlasData
)

  
Protected function void  
Public function void  
Protected function void  
Protected function bool

SetVectorParameterByIndexInternal ( int32 ParameterIndex,
FLinearColor Value
)

  
Protected function void  
Public function Const void Tracking of in-flight uniform expression cache update operations for the material instance, for thread safety destroying the resource.
Public function void

SwapLayerParameterIndices ( int32 OriginalIndex,
int32 NewIndex
)

  
Public function Virtual void  
Public function void  
Protected function void Refresh parameter names using the stored reference to the expression object for the parameter.
Protected function bool Updates parameter names on the material instance, returns true if parameters have changed.
Public function void

UpdateStaticPermutation ( const FStaticParameterSet& NewParameters,
FMaterialUpdateContext* MaterialUpdateContext
)

 Sets new static parameter overrides on the instance and recompiles the static permutation resources if needed.
Public function void

UpdateStaticPermutation ( FMaterialUpdateContext* MaterialUpdateContext
)

 Ensure's static permutations for current parameters and overrides are upto date.
Public function void

UpdateStaticPermutation ( const FStaticParameterSet& NewParameters,
FMaterialInstanceBasePropertyOverrides& NewBasePropertyOverrides,
const bool bForceStaticPermutationUpdate,
FMaterialUpdateContext* MaterialUpdateContext
)

 Sets new static parameter overrides on the instance and recompiles the static permutation resources if needed (can be forced with bForceRecompile).
Public function void Ensures that current parent is a valid for this material instance and if not, it resets the parent to null.
Public function Const void  

Overridden from UMaterialInterface

  Type Name Description
Public function Virtual void

CacheGivenTypesForCooking ( EShaderPlatform Platform,
ERHIFeatureLevel::Type InFeatureLevel,
EMaterialQualityLevel::Type QualityLevel,
const TArray< const FVertexFactoryType* >& VFTypes,
const TArray< const FShaderPipelineType* > PipelineTypes,
const TArray< const FShaderType* >& ShaderTypes
)

  
Public function Virtual void

CacheShaders ( EMaterialShaderPrecompileMode CompileMode
)

 Submits remaining shaders for recompilation.
Public function Virtual Const bool  
Public function Virtual bool

CheckMaterialUsage ( const EMaterialUsage Usage
)

 Checks if the material can be used with the given usage flag.
Public function Virtual Const bool

CheckMaterialUsage_Concurrent ( const EMaterialUsage Usage
)

 Same as above but is valid to call from any thread.
Public function Virtual int32

CompilePropertyEx ( FMaterialCompiler* Compiler,
const FGuid& AttributeID
)

 Allows material properties to be compiled with the option of being overridden by the material attributes input.
Public function Virtual Const void

DumpDebugInfo ( FOutputDevice& OutputDevice
)

  
Public function Virtual void Clears the shader cache and recompiles the shader for rendering.
Public function Virtual Const void

GetAllParametersOfType ( EMaterialParameterType Type,
TMap< FMaterialParameterInfo, FMaterialParameterMetadata >& OutParameters
)

  
Public function Virtual Const EBlendMode  
Public function Virtual Const const FMaterialCachedExpressionData &

GetCachedExpressionData ( TMicRecursionGuard RecursionGuard
)

  
Public function Virtual Const const FMaterialCachedHLSLTree &

GetCachedHLSLTree ( TMicRecursionGuard RecursionGuard
)

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

GetDependencies ( TSet< UMaterialInterface* >& Dependencies
)

 Get this material dependencies.
Public function Virtual Const void

GetDependentFunctions ( TArray< class UMaterialFunctionInterface* >& DependentFunctions
)

  
Public function Virtual Const float  
Public function Virtual Const FDisplacementScaling  
Public function Virtual UMaterialInstanceEditorOnlyData *  
Public function Virtual Const const UMaterialInstanceEditorOnlyData *  
Public function Virtual Const const UClass *  
Public function Virtual Const float  
Public function Virtual Const float  
Public function Virtual Const bool

GetGroupSortPriority ( const FString& InGroupName,
int32& OutSortPriority
)

 Get the sort priority index of the given parameter group
Public function Virtual Const void

GetLightingGuidChain ( bool bIncludeTextures,
TArray< FGuid >& OutGuids
)

 Returns all the Guids related to this material.
Public function Virtual Const const UMaterial * Get the material which we are instancing.
Public function Virtual UMaterial * Get the material which we are instancing.
Public function Virtual Const const UMaterial *

GetMaterial_Concurrent ( TMicRecursionGuard RecursionGuard
)

 Same as above, but can be called concurrently
Public function Virtual Const void  
Public function Virtual Const bool

GetMaterialLayers ( FMaterialLayersFunctions& OutLayers,
TMicRecursionGuard RecursionGuard
)

 Get the material layers stack
Public function Virtual Const const FMaterialResource * Get the static permutation resource if the instance has one
Public function Virtual FMaterialResource * Get the static permutation resource if the instance has one
Public function Virtual Const float  
Public function Virtual Const UMaterialInterface *

GetNaniteOverride ( TMicRecursionGuard RecursionGuard
)

 Get the associated nanite override material
Public function Virtual Const float Access to overridable properties of the base material.
Public function Virtual Const bool

GetParameterValue ( EMaterialParameterType Type,
const FMemoryImageMaterialParameterInfo& ParameterInfo,
FMaterialParameterMetadata& OutValue,
EMaterialGetParameterValueFlags Flags
)

  
Public function Virtual Const UPhysicalMaterial * Return a pointer to the physical material used by this material instance.
Public function Virtual Const UPhysicalMaterial *

GetPhysicalMaterialFromMap ( int32 Index
)

 Return a pointer to the physical material from mask map at given index.
Public function Virtual Const UPhysicalMaterialMask * Return a pointer to the physical material mask used by this material instance.
Public function Virtual Const void

GetReferencedTexturesAndOverrides ( TSet< const UTexture* >& InOutTextures
)

 Add to the set any texture referenced by expressions, including nested functions, as well as any overrides from parameters.
Public function Virtual Const bool

GetRefractionSettings ( float& OutBiasValue
)

  
Public function Virtual Const FMaterialRenderProxy * Return a pointer to the FMaterialRenderProxy used for rendering.
Public function Virtual void

GetShaderTypes ( EShaderPlatform Platform,
const ITargetPlatform* TargetPlatform,
TArray< FDebugShaderTypeInfo >& OutShaderInfo
)

 Gathers a list of shader types sorted by vertex factory types that should be cached for this material.
Public function Virtual Const FMaterialShadingModelField  
Public function Virtual Const USubsurfaceProfile *  
Public function Virtual Const float

GetTextureDensity ( FName TextureName,
const FMeshUVChannelInfo& UVChannelData
)

 Returns the density of a texture in (LocalSpace Unit / Texture).
Public function Virtual Const bool

GetTextureParameterValue ( const FHashedMaterialParameterInfo& ParameterInfo,
UTexture*& OutValue,
bool bOveriddenOnly
)

  
Public function Virtual bool

GetTexturesInPropertyChain ( EMaterialProperty InProperty,
TArray< UTexture* >& OutTextures,
TArray< FName >* OutTextureParamNames,
FStaticParameterSet* InStaticParameterSet,
ERHIFeatureLevel::Type InFeatureLevel,
EMaterialQualityLevel::Type InQuality
)

 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).
Public function Virtual Const void

GetUsedTextures ( TArray< UTexture* >& OutTextures,
EMaterialQualityLevel::Type QualityLevel,
bool bAllQualityLevels,
ERHIFeatureLevel::Type FeatureLevel,
bool bAllFeatureLevels
)

 Return the textures used to render this material.
Public function Virtual Const void

GetUsedTexturesAndIndices ( TArray< UTexture* >& OutTextures,
TArray< TArray< int32 > >& OutIndices,
EMaterialQualityLevel::Type QualityLevel,
ERHIFeatureLevel::Type FeatureLevel
)

 Return the textures used to render this material and the material indices bound to each.
Public function Virtual Const bool Checks to see if this material has all its shaders cached.
Public function Virtual bool

IsDependent ( UMaterialInterface* TestDependency
)

 Test this material for dependency on a given material.
Public function Virtual bool

IsDependent_Concurrent ( UMaterialInterface* TestDependency,
TMicRecursionGuard RecursionGuard
)

 Same as above, but can be called concurrently
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool

IsPropertyActive ( EMaterialProperty InProperty
)

 Checks to see if an input property should be active, based on the state of the material
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const void

LogMaterialsAndTextures ( FOutputDevice& Ar,
int32 Indent
)

 Output to the log which materials and textures are used by this material.
Public function Virtual void

OverrideNumericParameterDefault ( EMaterialParameterType Type,
const FHashedMaterialParameterInfo& ParameterInfo,
const UE::Shader::FValue& Value,
bool bOverride,
ERHIFeatureLevel::Type FeatureLevel
)

 Overrides the default value of the given parameter (transient).
Public function Virtual void

OverrideTexture ( const UTexture* InTextureToOverride,
UTexture* OverrideTexture,
ERHIFeatureLevel::Type InFeatureLevel
)

 Override a specific texture (transient)
Public function Virtual Const 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).
Public function Virtual void  
Public function Virtual Const bool  
Public function Virtual bool Check if the textures have changed since the last time the material was serialized for Lightmass...
Public function Virtual Const bool  

Overridden from UObject

  Type Name Description
Public function Virtual void 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
Public function Virtual void Called before destroying the object.
Public function Virtual void Clear all cached cooked platform data
Public function Virtual void Clears cached cooked platform data for specific platform
Public function Virtual void Called to finish destroying the object.
Public function Virtual void

GetResourceSizeEx ( FResourceSizeEx& CumulativeResourceSize
)

 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).
Public function Virtual bool Have we finished loading all the cooked platform data for the target platforms requested in BeginCacheForCookedPlatformData
Public function Virtual bool Called to check if the object is ready for FinishDestroy.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Called after applying a transaction to the object.
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void

PreSave ( FObjectPreSaveContext SaveContext
)

 Presave function.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Deprecated Variables

  Type Name Description
Public variable bool bOverrideBaseProperties_DEPRECATED  

Deprecated Functions

  Type Name Description
Public function Virtual PRAGMA_DISABLE_DEPRECATION_WARNINGSvoid

PreSave ( const ITargetPlatform* TargetPlatform
)

 Use version that takes FObjectPreSaveContext instead.
Protected function void

UpdatePermutationAllocations ( FMaterialResourceDeferredDeletionArray* ResourcesToFree
)

 Calling UpdatePermutationAllocations is no longer necessary

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page