1. Epic GamesDeveloper
  3. UMaterialInstanceDynamic

UMaterialInstanceDynamic

API > API/Runtime > API/Runtime/Engine

   
Name UMaterialInstanceDynamic
Type class
Header File /Engine/Source/Runtime/Engine/Public/Materials/MaterialInstanceDynamic.h
Include Path #include "Materials/MaterialInstanceDynamic.h"

Syntax

UCLASS (HideCategories=Object, CollapseCategories, BlueprintType, MinimalAPI)  
class UMaterialInstanceDynamic : public UMaterialInstance

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UMaterialInstanceDynamic ( const FObjectInitializer& ObjectInitializer
)

   Materials/MaterialInstanceDynamic.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
RenamedTextures TMap< FName, TArray< FName > > In order to remap to the correct texture streaming data, we must keep track of each texture renamed. Materials/MaterialInstanceDynamic.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ClearParameterValues()

 Remove all parameter values Materials/MaterialInstanceDynamic.h  

void CopyInterpParameters ( UMaterialInstance* Source
)

 Copies over parameters given a material instance (only copy from the instance, not following the hierarchy) much faster than K2_CopyMaterialInstanceParameters(), The output is the object itself (this). Materials/MaterialInstanceDynamic.h
  • Meta=(DisplayName="Copy Interp Parameters")
  • Category="Rendering|Material"
Copies the uniform parameters (scalar, vector and texture) from a material or instance hierarchy. Materials/MaterialInstanceDynamic.h  

void CopyParameterOverrides ( UMaterialInstance* MaterialInstance
)

 Copy parameter values from another material instance. Materials/MaterialInstanceDynamic.h
  • BlueprintCallable
  • Meta=(DisplayName="Copy Parameter Overrides")
  • Category="Rendering|Material"

void CopyScalarAndVectorParameters ( const UMaterialInterface& SourceMaterialToCopyFrom,
EShaderPlatform ShaderPlatform
)

   Materials/MaterialInstanceDynamic.h  

void CopyScalarAndVectorParameters ( const UMaterialInterface& SourceMaterialToCopyFrom,
ERHIFeatureLevel::Type InFeatureLevel
)

 Copy all interpolatable (scalar/vector) parameters from *SourceMaterialToCopyFrom to *this, using the current QualityLevel and given FeatureLevel For runtime use. Materials/MaterialInstanceDynamic.h  

bool InitializeScalarParameterAndGetIndex ( const FName& ParameterName,
float Value,
int32& OutParameterIndex
)

 Use this function to set an initial value and fetch the index for use in SetScalarParameterByIndex. Materials/MaterialInstanceDynamic.h
  • BlueprintCallable
  • Meta=(Keywords="SetFloatParameterValue")
  • Category="Rendering|Material"

bool InitializeVectorParameterAndGetIndex ( const FName& ParameterName,
const FLinearColor& Value,
int32& OutParameterIndex
)

 Use this function to set an initial value and fetch the index for use in the following function. Materials/MaterialInstanceDynamic.h  

void K2_CopyMaterialInstanceParameters ( UMaterialInterface* Source,
bool bQuickParametersOnly
)

 Copies over parameters given a material interface (copy each instance following the hierarchy) Very slow implementation, avoid using at runtime. Materials/MaterialInstanceDynamic.h
  • BlueprintCallable
  • Meta=(DisplayName="Copy Material Instance Parameters", ScriptName="CopyMaterialInstanceParameters")
  • Category="Rendering|Material"

float K2_GetScalarParameterValue ( FName ParameterName
)

 Get the current scalar (float) parameter value from an MID Materials/MaterialInstanceDynamic.h
  • BlueprintCallable
  • Meta=(DisplayName="Get Scalar Parameter Value", ScriptName="GetScalarParameterValue", Keywords="GetFloatParameterValue")
  • Category="Rendering|Material"

float K2_GetScalarParameterValueByInfo ( const FMaterialParameterInfo& ParameterInfo
)

 Get the current scalar (float) parameter value from an MID, using MPI (to allow access to layer parameters) Materials/MaterialInstanceDynamic.h
  • BlueprintCallable
  • Meta=(DisplayName="Get Scalar Parameter Value By Info", ScriptName="GetScalarParameterValueByInfo", Keywords="GetFloatParameterValue")
  • Category="Rendering|Material"

UTextureCollection * K2_GetTextureCollectionParameterValue ( FName ParameterName
)

 Get the current MID texture collection parameter value Materials/MaterialInstanceDynamic.h
  • BlueprintCallable
  • Meta=(DisplayName="Get Texture Collection Parameter Value", ScriptName="GetTextureCollectionParameterValue")
  • Category="Rendering|Material"

UTextureCollection * K2_GetTextureCollectionParameterValueByInfo ( const FMaterialParameterInfo& ParameterInfo
)

 Get the current MID texture collection parameter value, using MPI (to allow access to layer parameters) Materials/MaterialInstanceDynamic.h
  • BlueprintCallable
  • Meta=(DisplayName="Get Texture Collection Parameter Value By Info", ScriptName="GetTextureCollectionParameterValueByInfo")
  • Category="Rendering|Material"

UTexture * K2_GetTextureParameterValue ( FName ParameterName
)

 Get the current MID texture parameter value Materials/MaterialInstanceDynamic.h
  • BlueprintCallable
  • Meta=(DisplayName="Get Texture Parameter Value", ScriptName="GetTextureParameterValue")
  • Category="Rendering|Material"

UTexture * K2_GetTextureParameterValueByInfo ( const FMaterialParameterInfo& ParameterInfo
)

 Get the current MID texture parameter value, using MPI (to allow access to layer parameters) Materials/MaterialInstanceDynamic.h
  • BlueprintCallable
  • Meta=(DisplayName="Get Texture Parameter Value By Info", ScriptName="GetTextureParameterValueByInfo")
  • Category="Rendering|Material"

FLinearColor K2_GetVectorParameterValue ( FName ParameterName
)

 Get the current MID vector parameter value Materials/MaterialInstanceDynamic.h
  • BlueprintCallable
  • Meta=(DisplayName="Get Vector Parameter Value", ScriptName="GetVectorParameterValue", Keywords="GetColorParameterValue")
  • Category="Rendering|Material"

FLinearColor K2_GetVectorParameterValueByInfo ( const FMaterialParameterInfo& ParameterInfo
)

 Get the current MID vector parameter value, using MPI (to allow access to layer parameters) Materials/MaterialInstanceDynamic.h
  • BlueprintCallable
  • Meta=(DisplayName="Get VectorParameter Value By Info", ScriptName="GetVectorParameterValueByInfo", Keywords="GetColorParameterValue")
  • Category="Rendering|Material"
Interpolates the scalar and vector parameters of this material instance based on two other material instances, and an alpha blending factor The output is the object itself (this). Materials/MaterialInstanceDynamic.h
  • BlueprintCallable
  • Meta=(DisplayName="Interpolate Material Instance Parameters", ScriptName="InterpolateMaterialInstanceParameters")
  • Category="Rendering|Material"

void SetDoubleVectorParameterValue ( FName ParameterName,
FVector4 Value
)

 Set an MID vector parameter value Materials/MaterialInstanceDynamic.h
  • BlueprintCallable
  • Meta=(Keywords="SetVectorParameterValue")
  • Category="Rendering|Material"

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

 Set the value of the given font parameter. Materials/MaterialInstanceDynamic.h  

void SetNaniteOverride ( UMaterialInterface* InMaterial
)

   Materials/MaterialInstanceDynamic.h  

void SetRuntimeVirtualTextureParameterValue ( FName ParameterName,
URuntimeVirtualTexture* Value
)

 Set an MID texture parameter value Materials/MaterialInstanceDynamic.h
  • BlueprintCallable
  • Category="Rendering|Material"

void SetRuntimeVirtualTextureParameterValueByInfo ( const FMaterialParameterInfo& ParameterInfo,
URuntimeVirtualTexture* Value
)

 Set an MID texture parameter value using MPI (to allow access to layer parameters) Materials/MaterialInstanceDynamic.h
  • BlueprintCallable
  • Category="Rendering|Material"

bool SetScalarParameterByIndex ( int32 ParameterIndex,
float Value
)

 Use the cached value of OutParameterIndex from InitializeScalarParameterAndGetIndex to set the scalar parameter ONLY on the exact same MID. Materials/MaterialInstanceDynamic.h
  • BlueprintCallable
  • Meta=(Keywords="SetFloatParameterValue")
  • Category="Rendering|Material"

void SetScalarParameterValue ( FName ParameterName,
float Value
)

 Set a MID scalar (float) parameter value Materials/MaterialInstanceDynamic.h
  • BlueprintCallable
  • Meta=(Keywords="SetFloatParameterValue")
  • Category="Rendering|Material"

void SetScalarParameterValueByInfo ( const FMaterialParameterInfo& ParameterInfo,
float Value
)

 Set a MID scalar (float) parameter value using MPI (to allow access to layer parameters) Materials/MaterialInstanceDynamic.h
  • BlueprintCallable
  • Meta=(Keywords="SetFloatParameterValue")
  • Category="Rendering|Material"

void SetSparseVolumeTextureParameterValue ( FName ParameterName,
USparseVolumeTexture* Value
)

 Set an MID texture parameter value Materials/MaterialInstanceDynamic.h
  • BlueprintCallable
  • Category="Rendering|Material"

void SetTextureCollectionParameterValue ( FName ParameterName,
UTextureCollection* Value
)

 Set an MID texture collection parameter value Materials/MaterialInstanceDynamic.h
  • BlueprintCallable
  • Category="Rendering|Material"

void SetTextureCollectionParameterValueByInfo ( const FMaterialParameterInfo& ParameterInfo,
UTextureCollection* Value
)

 Set an MID texture collection parameter value using MPI (to allow access to layer parameters) Materials/MaterialInstanceDynamic.h
  • BlueprintCallable
  • Category="Rendering|Material"

void SetTextureParameterValue ( FName ParameterName,
UTexture* Value
)

 Set an MID texture parameter value Materials/MaterialInstanceDynamic.h
  • BlueprintCallable
  • Category="Rendering|Material"

void SetTextureParameterValueByInfo ( const FMaterialParameterInfo& ParameterInfo,
UTexture* Value
)

 Set an MID texture parameter value using MPI (to allow access to layer parameters) Materials/MaterialInstanceDynamic.h
  • BlueprintCallable
  • Category="Rendering|Material"

bool SetVectorParameterByIndex ( int32 ParameterIndex,
const FLinearColor& Value
)

 Use the cached value of OutParameterIndex above to set the vector parameter ONLY on the exact same MID. Materials/MaterialInstanceDynamic.h  

void SetVectorParameterValue ( FName ParameterName,
FLinearColor Value
)

 Set an MID vector parameter value Materials/MaterialInstanceDynamic.h
  • BlueprintCallable
  • Meta=(Keywords="SetColorParameterValue")
  • Category="Rendering|Material"

void SetVectorParameterValue ( FName ParameterName,
const FVector& Value
)

 Conveniences to keep general FLinearColor constructors explicit without adding extra burden to existing users of this function (where the conversion is straightforward). Materials/MaterialInstanceDynamic.h  

void SetVectorParameterValue ( FName ParameterName,
const FVector4& Value
)

   Materials/MaterialInstanceDynamic.h  

void SetVectorParameterValueByInfo ( const FMaterialParameterInfo& ParameterInfo,
const FVector& Value
)

   Materials/MaterialInstanceDynamic.h  
Set an MID vector parameter value, using MPI (to allow access to layer parameters) Materials/MaterialInstanceDynamic.h
  • BlueprintCallable
  • Meta=(Keywords="SetColorParameterValue")
  • Category="Rendering|Material"

void SetVectorParameterValueByInfo ( const FMaterialParameterInfo& ParameterInfo,
const FVector4& Value
)

   Materials/MaterialInstanceDynamic.h  

Overridden from UMaterialInstance

Name Remarks Include Path Unreal Specifiers

virtual bool HasOverridenBaseProperties()

   Materials/MaterialInstanceDynamic.h  

virtual void UpdateCachedData()

   Materials/MaterialInstanceDynamic.h  

Overridden from UMaterialInterface

Name Remarks Include Path Unreal Specifiers

virtual EBlendMode GetBlendMode()

   Materials/MaterialInstanceDynamic.h  

virtual bool GetCastDynamicShadowAsMasked()

   Materials/MaterialInstanceDynamic.h  

virtual FDisplacementFadeRange GetDisplacementFadeRange()

   Materials/MaterialInstanceDynamic.h  

virtual FDisplacementScaling GetDisplacementScaling()

   Materials/MaterialInstanceDynamic.h  

virtual float GetMaxWorldPositionOffsetDisplacement()

   Materials/MaterialInstanceDynamic.h  

virtual float GetOpacityMaskClipValue()

 Material base property overrides. MIDs cannot override these so they just grab from their parent. Materials/MaterialInstanceDynamic.h  

virtual FMaterialShadingModelField GetShadingModels()

   Materials/MaterialInstanceDynamic.h  

virtual float GetTextureDensity ( FName TextureName,
const FMeshUVChannelInfo& UVChannelData
) const

 This overrides does the remapping before looking at the parent data. Materials/MaterialInstanceDynamic.h  

virtual bool HasPixelAnimation()

   Materials/MaterialInstanceDynamic.h  

virtual bool IsDisplacementFadeEnabled()

   Materials/MaterialInstanceDynamic.h  

virtual bool IsDitheredLODTransition()

   Materials/MaterialInstanceDynamic.h  

virtual bool IsMasked()

   Materials/MaterialInstanceDynamic.h  

virtual bool IsShadingModelFromMaterialExpression()

   Materials/MaterialInstanceDynamic.h  

virtual bool IsThinSurface()

   Materials/MaterialInstanceDynamic.h  

virtual bool IsTranslucencyWritingVelocity()

   Materials/MaterialInstanceDynamic.h  

virtual bool IsTwoSided()

   Materials/MaterialInstanceDynamic.h  

Protected

Name Remarks Include Path Unreal Specifiers

void InitializeMID ( UMaterialInterface* ParentMaterial
)

   Materials/MaterialInstanceDynamic.h  

Static

Name Remarks Include Path Unreal Specifiers

static UMaterialInstanceDynamic * Create ( UMaterialInterface* ParentMaterial,
UObject* InOuter,
FName Name
)

 Create a material instance dynamic parented to the specified material. [Optional] Specify name. Materials/MaterialInstanceDynamic.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page