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 > Editor > MaterialEditor > UMaterialEditingLibrary

Light Theme

Dark Theme

UMaterialEditingLibrary

Blueprint library for creating/editing Materials

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UBlueprintFunctionLibrary

UMaterialEditingLibrary

References

Module	MaterialEditor
Header	/Engine/Source/Editor/MaterialEditor/Public/MaterialEditingLibrary.h
Include	#include "MaterialEditingLibrary.h"

Syntax

class UMaterialEditingLibrary : public UBlueprintFunctionLibrary

Remarks

Blueprint library for creating/editing Materials

Functions

	Name	Description
void	ClearAllMaterialInstanceParameters ( UMaterialInstanceConstant* Ins... )	Clears all material parameters set by this Material Instance
bool	ConnectMaterialExpressions ( UMaterialExpression* FromExpre..., FString FromOutputName, UMaterialExpression* ToExpress..., FString ToInputName )	Create connection between two material expressions
bool	ConnectMaterialProperty ( UMaterialExpression* FromExpre..., FString FromOutputName, EMaterialProperty Property )	Connect a material expression output to one of the material property inputs (e.g. diffuse color, opacity etc)
UMaterialExp...	CreateMaterialExpression ( UMaterial* Material, TSubclassOf< UMaterialExpression > ..., int32 NodePosX, int32 NodePosY )	Create a new material expression node within the supplied material
UMaterialExp...	CreateMaterialExpressionEx ( UMaterial* Material, UMaterialFunction* MaterialFun..., TSubclassOf< UMaterialExpression > ..., UObject* SelectedAsset, int32 NodePosX, int32 NodePosY )	Create a new material expression node within the supplied material, optionally specifying asset to use
UMaterialExp...	CreateMaterialExpressionInFunction ( UMaterialFunction* MaterialFun..., TSubclassOf< UMaterialExpression > ..., int32 NodePosX, int32 NodePosY )	Create a new material expression node within the supplied material function
void	DeleteAllMaterialExpressions ( UMaterial* Material )	Delete all material expressions in the supplied material
void	DeleteAllMaterialExpressionsInFunction ( UMaterialFunction* MaterialFun... )	Delete all material expressions in the supplied material function
void	DeleteMaterialExpression ( UMaterial* Material, UMaterialExpression* Expressio... )	Delete a specific expression from a material. Will disconnect from other expressions.
void	DeleteMaterialExpressionInFunction ( UMaterialFunction* MaterialFun..., UMaterialExpression* Expressio... )	Delete a specific expression from a material function. Will disconnect from other expressions.
void	GetChildInstances ( UMaterialInterface* Parent, TArray< FAssetData >& ChildInstanc... )	Gets all direct child mat instances
float	GetMaterialDefaultScalarParameterValue ( UMaterial* Material, FName ParameterName )	Get the default scalar (float) parameter value from a Material
bool	GetMaterialDefaultStaticSwitchParameterValue ( UMaterial* Material, FName ParameterName )	Get the default static switch parameter value from a Material
UTexture ...	GetMaterialDefaultTextureParameterValue ( UMaterial* Material, FName ParameterName )	Get the default texture parameter value from a Material
FLinearColor	GetMaterialDefaultVectorParameterValue ( UMaterial* Material, FName ParameterName )	Get the default vector parameter value from a Material
float	GetMaterialInstanceScalarParameterValue ( UMaterialInstanceConstant* Ins..., FName ParameterName )	Get the current scalar (float) parameter value from a Material Instance
bool	GetMaterialInstanceStaticSwitchParameterValue ( UMaterialInstanceConstant* Ins..., FName ParameterName )	Get the current static switch parameter value from a Material Instance
UTexture ...	GetMaterialInstanceTextureParameterValue ( UMaterialInstanceConstant* Ins..., FName ParameterName )	Get the current texture parameter value from a Material Instance
FLinearColor	GetMaterialInstanceVectorParameterValue ( UMaterialInstanceConstant* Ins..., FName ParameterName )	Get the current vector parameter value from a Material Instance
TSet< UObjec...	GetMaterialSelectedNodes ( UMaterial* Material )	Get the set of selected nodes from an active material editor
int32	GetNumMaterialExpressions ( const UMaterial* Material )	Returns number of material expressions in the supplied material
int32	GetNumMaterialExpressionsInFunction ( const UMaterialFunction* Mater... )	Returns number of material expressions in the supplied material
void	GetScalarParameterNames ( UMaterialInterface* Material, TArray< FName >& ParameterNames )	Gets all scalar parameter names
bool	GetScalarParameterSource ( UMaterialInterface* Material, const FName ParameterName, FSoftObjectPath& ParameterSource )	Returns the path of the asset where the parameter originated, as well as true/false if it was found
void	GetStaticSwitchParameterNames ( UMaterialInterface* Material, TArray< FName >& ParameterNames )	Gets all static switch parameter names
bool	GetStaticSwitchParameterSource ( UMaterialInterface* Material, const FName ParameterName, FSoftObjectPath& ParameterSource )	Returns the path of the asset where the parameter originated, as well as true/false if it was found
void	GetTextureParameterNames ( UMaterialInterface* Material, TArray< FName >& ParameterNames )	Gets all texture parameter names
bool	GetTextureParameterSource ( UMaterialInterface* Material, const FName ParameterName, FSoftObjectPath& ParameterSource )	Returns the path of the asset where the parameter originated, as well as true/false if it was found
void	GetVectorParameterNames ( UMaterialInterface* Material, TArray< FName >& ParameterNames )	Gets all vector parameter names
bool	GetVectorParameterSource ( UMaterialInterface* Material, const FName ParameterName, FSoftObjectPath& ParameterSource )	Returns the path of the asset where the parameter originated, as well as true/false if it was found
bool	HasMaterialUsage ( UMaterial* Material, EMaterialUsage Usage )	Check if a particular usage is enabled for the supplied material (e.g. SkeletalMesh, ParticleSprite etc)
void	LayoutMaterialExpressions ( UMaterial* Material )	Layouts the expressions in a grid pattern
void	LayoutMaterialFunctionExpressions ( UMaterialFunction* MaterialFun... )	Layouts the expressions in a grid pattern
void	RebuildMaterialInstanceEditors ( UMaterial* BaseMaterial )	Rebuilds dependent Material Instance Editors
void	RebuildMaterialInstanceEditors ( UMaterialFunction* BaseFunctio... )	Rebuilds dependent Material Instance Editors
void	RecompileMaterial ( UMaterial* Material )	Trigger a recompile of a material.
void	SetMaterialInstanceParent ( UMaterialInstanceConstant* Ins..., UMaterialInterface* NewParent )	Set the parent Material or Material Instance to use for this Material Instance
bool	SetMaterialInstanceScalarParameterValue ( UMaterialInstanceConstant* Ins..., FName ParameterName, float Value )	Set the scalar (float) parameter value for a Material Instance
bool	SetMaterialInstanceTextureParameterValue ( UMaterialInstanceConstant* Ins..., FName ParameterName, UTexture* Value )	Set the texture parameter value for a Material Instance
bool	SetMaterialInstanceVectorParameterValue ( UMaterialInstanceConstant* Ins..., FName ParameterName, FLinearColor Value )	Set the vector parameter value for a Material Instance
bool	SetMaterialUsage ( UMaterial* Material, EMaterialUsage Usage, bool& bNeedsRecompile )	Enable a particular usage for the supplied material (e.g. SkeletalMesh, ParticleSprite etc)
void	UpdateMaterialFunction ( UMaterialFunctionInterface* Ma..., UMaterial* PreviewMaterial )	Update a Material Function after edits have been made.
void	UpdateMaterialInstance ( UMaterialInstanceConstant* Ins... )	Called after making modifications to a Material Instance to recompile shaders etc.

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

Take our survey

Dismiss