1. Epic GamesDeveloper
  3. UMaterialInstanceDynamic

UMaterialInstanceDynamic

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

Inheritance Hierarchy

References

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

Syntax

class UMaterialInstanceDynamic : public UMaterialInstance

Variables

  Type Name Description
Public variable TMap< FName, TArray< FName > > RenamedTextures In order to remap to the correct texture streaming data, we must keep track of each texture renamed.

Constructors

  Type Name Description
Public function  

UMaterialInstanceDynamic ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void Remove all parameter values
Public function void 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).
Public function void Copies the uniform parameters (scalar, vector and texture) from a material or instance hierarchy.
Public function void Copy parameter values from another material instance.
Public function void

CopyScalarAndVectorParameters ( const UMaterialInterface& SourceMaterialToCopyFrom,
ERHIFeatureLevel::Type FeatureLevel
)

 Copy all interpolatable (scalar/vector) parameters from *SourceMaterialToCopyFrom to *this, using the current QualityLevel and given FeatureLevel For runtime use.
Public function Static UMaterialInstanceDynamic *

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

 Create a material instance dynamic parented to the specified material with the specified name.
Public function Static UMaterialInstanceDynamic *

Create ( UMaterialInterface* ParentMaterial,
UObject* InOuter
)

 Create a material instance dynamic parented to the specified material.
Public function 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.
Public function 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.
Public function 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.
Public function float

K2_GetScalarParameterValue ( FName ParameterName
)

 Get the current scalar (float) parameter value from an MID
Public function float Get the current scalar (float) parameter value from an MID, using MPI (to allow access to layer parameters)
Public function UTexture * Get the current MID texture parameter value
Public function UTexture * Get the current MID texture parameter value, using MPI (to allow access to layer parameters)
Public function FLinearColor

K2_GetVectorParameterValue ( FName ParameterName
)

 Get the current MID vector parameter value
Public function FLinearColor Get the current MID vector parameter value, using MPI (to allow access to layer parameters)
Public function void 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).
Public function void

SetDoubleVectorParameterValue ( FName ParameterName,
FVector4 Value
)

 Set an MID vector parameter value
Public function void

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

 Set the value of the given font parameter.
Public function void  
Public function void Set an MID texture parameter value
Public function void Set an MID texture parameter value using MPI (to allow access to layer parameters)
Public function 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.
Public function void

SetScalarParameterValue ( FName ParameterName,
float Value
)

 Set a MID scalar (float) parameter value
Public function void

SetScalarParameterValueByInfo ( const FMaterialParameterInfo& ParameterInfo,
float Value
)

 Set a MID scalar (float) parameter value using MPI (to allow access to layer parameters)
Public function void Set an MID texture parameter value
Public function void

SetTextureParameterValue ( FName ParameterName,
UTexture* Value
)

 Set an MID texture parameter value
Public function void Set an MID texture parameter value using MPI (to allow access to layer parameters)
Public function 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.
Public function void

SetVectorParameterValue ( FName ParameterName,
FLinearColor Value
)

 Set an MID vector parameter value
Public function 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).
Public function void

SetVectorParameterValue ( FName ParameterName,
const FVector4& Value
)

  
Public function void

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

  
Public function void Set an MID vector parameter value, using MPI (to allow access to layer parameters)
Public function void

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

  

Overridden from UMaterialInstance

  Type Name Description
Public function Virtual Const bool  
Public function Virtual void  

Overridden from UMaterialInterface

  Type Name Description
Public function Virtual Const EBlendMode  
Public function Virtual Const bool  
Public function Virtual Const FDisplacementScaling  
Public function Virtual Const float  
Public function Virtual Const float Material base property overrides. MIDs cannot override these so they just grab from their parent.
Public function Virtual Const FMaterialShadingModelField  
Public function Virtual Const float

GetTextureDensity ( FName TextureName,
const FMeshUVChannelInfo& UVChannelData
)

 This overrides does the remapping before looking at the parent data.
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 bool  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page