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

Light Theme

Dark Theme

UMaterialInstanceConstant

Material Instances may be used to change the appearance of a material without incurring an expensive recompilation of the material.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UMaterialInterface

UMaterialInstance

UMaterialInstanceConstant

ULandscapeMaterialInstanceConstant

References

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

Syntax

class UMaterialInstanceConstant : public UMaterialInstance

Remarks

Material Instances may be used to change the appearance of a material without incurring an expensive recompilation of the material. General modification of the material cannot be supported without recompilation, so the instances are limited to changing the values of predefined material parameters. The parameters are statically defined in the compiled material by a unique name, type and default value.

Variables

		Name	Description
	FGuid	ParameterStateId	Unique ID for this material instance's parameter set Updated on changes in the editor to allow those changes to be detected
	UPhysicalMateri...	PhysMaterialMask	Physical material mask to use for this graphics material. Used for sounds, effects etc.

Constructors

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

Functions

	Name	Description
void	ClearParameterValuesEditorOnly()	Clear all parameter overrides on this material instance.
void	CopyMaterialUniformParametersEditorOnly ( UMaterialInterface* Source, bool bIncludeStaticParams )	Copies the uniform parameters (scalar, vector and texture) from a material or instance hierarchy.
float	K2_GetScalarParameterValue ( FName ParameterName )	Get the scalar (float) parameter value from an MIC
UTexture ...	K2_GetTextureParameterValue ( FName ParameterName )	Get the MIC texture parameter value
FLinearColor	K2_GetVectorParameterValue ( FName ParameterName )	Get the MIC vector parameter value
void	SetFontParameterValueEditorOnly ( const FMaterialParameterInfo& Para..., UFont* FontValue, int32 FontPage )
void	SetParentEditorOnly ( UMaterialInterface* NewParent, bool RecacheShader )	Set the parent of this material instance.
void	SetRuntimeVirtualTextureParameterValueEditorOnly ( const FMaterialParameterInfo& Para..., URuntimeVirtualTexture* Value )
void	SetScalarParameterAtlasEditorOnly ( const FMaterialParameterInfo& Para..., FScalarParameterAtlasInstanceData A... )
void	SetScalarParameterValueEditorOnly ( const FMaterialParameterInfo& Para..., float Value )
void	SetTextureParameterValueEditorOnly ( const FMaterialParameterInfo& Para..., UTexture* Value )
void	SetVectorParameterValueEditorOnly ( const FMaterialParameterInfo& Para..., FLinearColor Value )	Set the value parameters.

Overridden from UMaterialInterface

		Name	Description
	UPhysicalMat...	GetPhysicalMaterialMask()	Return a pointer to the physical material mask used by this material instance.

Overridden from UObject

		Name	Description
	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.

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

Take our survey

Dismiss