1. Epic GamesDeveloper
  3. UMaterialEditingLibrary

UMaterialEditingLibrary

Blueprint library for creating/editing Materials

API > API/Editor > API/Editor/MaterialEditor

Blueprint library for creating/editing Materials

   
Name UMaterialEditingLibrary
Type class
Header File /Engine/Source/Editor/MaterialEditor/Public/MaterialEditingLibrary.h
Include Path #include "MaterialEditingLibrary.h"

Syntax

UCLASS ()  
class UMaterialEditingLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Typedefs

Name Type Remarks Include Path
FOnItemComplete TBaseDelegate_NoParams< void > Item complete callback for use when processing arrays of items. Allows higher level to tick UI etc. MaterialEditingLibrary.h

Functions

Static

Name Remarks Include Path Unreal Specifiers

static void ClearAllMaterialInstanceParameters ( UMaterialInstanceConstant* Instance
)

 Clears all material parameters set by this Material Instance MaterialEditingLibrary.h
  • BlueprintCallable
  • Category="MaterialEditing"

static bool ConnectMaterialExpressions ( UMaterialExpression* FromExpression,
FString FromOutputName,
UMaterialExpression* ToExpression,
FString ToInputName
)

 Create connection between two material expressions MaterialEditingLibrary.h
  • BlueprintCallable
  • Category="MaterialEditing"

static bool ConnectMaterialProperty ( UMaterialExpression* FromExpression,
FString FromOutputName,
EMaterialProperty Property
)

 Connect a material expression output to one of the material property inputs (e.g. diffuse color, opacity etc) MaterialEditingLibrary.h
  • BlueprintCallable
  • Category="MaterialEditing"

static UMaterialExpression * CreateMaterialExpression ( UMaterial* Material,
TSubclassOf< UMaterialExpression > ExpressionClass,
int32 NodePosX,
int32 NodePosY
)

 Create a new material expression node within the supplied material MaterialEditingLibrary.h
  • BlueprintCallable
  • Category="MaterialEditing"

static UMaterialExpression * CreateMaterialExpressionEx ( UMaterial* Material,
UMaterialFunction* MaterialFunction,
TSubclassOf< UMaterialExpression > ExpressionClass,
UObject* SelectedAsset,
int32 NodePosX,
int32 NodePosY,
bool bAllowMarkingPackageDirty
)

 Create a new material expression node within the supplied material, optionally specifying asset to use MaterialEditingLibrary.h  

static UMaterialExpression * CreateMaterialExpressionInFunction ( UMaterialFunction* MaterialFunction,
TSubclassOf< UMaterialExpression > ExpressionClass,
int32 NodePosX,
int32 NodePosY
)

 Create a new material expression node within the supplied material function MaterialEditingLibrary.h
  • BlueprintCallable
  • Category="MaterialEditing"

static void DeleteAllMaterialExpressions ( UMaterial* Material
)

 Delete all material expressions in the supplied material MaterialEditingLibrary.h
  • BlueprintCallable
  • Category="MaterialEditing"

static void DeleteAllMaterialExpressionsInFunction ( UMaterialFunction* MaterialFunction
)

 Delete all material expressions in the supplied material function MaterialEditingLibrary.h
  • BlueprintCallable
  • Category="MaterialEditing"

static void DeleteMaterialExpression ( UMaterial* Material,
UMaterialExpression* Expression
)

 Delete a specific expression from a material. Will disconnect from other expressions. MaterialEditingLibrary.h
  • BlueprintCallable
  • Category="MaterialEditing"

static void DeleteMaterialExpressionInFunction ( UMaterialFunction* MaterialFunction,
UMaterialExpression* Expression
)

 Delete a specific expression from a material function. Will disconnect from other expressions. MaterialEditingLibrary.h
  • BlueprintCallable
  • Category="MaterialEditing"

static UMaterialExpression * DuplicateMaterialExpression ( UMaterial* Material,
UMaterialFunction* MaterialFunction,
UMaterialExpression* Expression
)

 Duplicates the provided material expression adding it to the same material / material function, and copying parameters. MaterialEditingLibrary.h
  • BlueprintCallable
  • Category="MaterialEditing"

static void GetChildInstances ( UMaterialInterface* Parent,
TArray< FAssetData >& ChildInstances
)

 Gets all direct child mat instances MaterialEditingLibrary.h
  • BlueprintCallable
  • Category="MaterialEditing"

static bool GetInputNodeOutputNameForMaterialExpression ( UMaterialExpression* MaterialExpression,
UMaterialExpression* InputNode,
FString& OutputName
)

 Get the output name of input node connected to MaterialExpression from an active material editor MaterialEditingLibrary.h
  • BlueprintPure
  • Category="MaterialEditing"

static TArray< UMaterialExpression * > GetInputsForMaterialExpression ( UMaterial* Material,
UMaterialExpression* MaterialExpression
)

 Get the set of nodes acting as inputs to a node from an active material editor MaterialEditingLibrary.h
  • BlueprintPure
  • Category="MaterialEditing"

static float GetMaterialDefaultScalarParameterValue ( UMaterial* Material,
FName ParameterName
)

 Get the default scalar (float) parameter value from a Material MaterialEditingLibrary.h
  • BlueprintPure
  • Category="MaterialEditing"

static bool GetMaterialDefaultStaticSwitchParameterValue ( UMaterial* Material,
FName ParameterName
)

 Get the default static switch parameter value from a Material MaterialEditingLibrary.h
  • BlueprintPure
  • Category="MaterialEditing"

static UTexture * GetMaterialDefaultTextureParameterValue ( UMaterial* Material,
FName ParameterName
)

 Get the default texture parameter value from a Material MaterialEditingLibrary.h
  • BlueprintPure
  • Category="MaterialEditing"

static FLinearColor GetMaterialDefaultVectorParameterValue ( UMaterial* Material,
FName ParameterName
)

 Get the default vector parameter value from a Material MaterialEditingLibrary.h
  • BlueprintPure
  • Category="MaterialEditing"

static TArray< FString > GetMaterialExpressionInputNames ( UMaterialExpression* MaterialExpression
)

 Get the array of input pin names for a material expression MaterialEditingLibrary.h
  • BlueprintPure
  • Category="MaterialEditing"

static TArray< int32 > GetMaterialExpressionInputTypes ( UMaterialExpression* MaterialExpression
)

 Get the array of input pin types for a material expression MaterialEditingLibrary.h
  • BlueprintPure
  • Category="MaterialEditing"

static void GetMaterialExpressionNodePosition ( UMaterialExpression* MaterialExpression,
int32& NodePosX,
int32& NodePosY
)

 Get the position of the MaterialExpression node. MaterialEditingLibrary.h
  • BlueprintPure
  • Category="MaterialEditing"

static URuntimeVirtualTexture * GetMaterialInstanceRuntimeVirtualTextureParameterValue ( UMaterialInstanceConstant* Instance,
FName ParameterName,
EMaterialParameterAssociation Association
)

 Get the current texture parameter value from a Material Instance MaterialEditingLibrary.h
  • BlueprintPure
  • Category="MaterialEditing"

static float GetMaterialInstanceScalarParameterValue ( UMaterialInstanceConstant* Instance,
FName ParameterName,
EMaterialParameterAssociation Association
)

 Get the current scalar (float) parameter value from a Material Instance MaterialEditingLibrary.h
  • BlueprintPure
  • Category="MaterialEditing"

static USparseVolumeTexture * GetMaterialInstanceSparseVolumeTextureParameterValue ( UMaterialInstanceConstant* Instance,
FName ParameterName,
EMaterialParameterAssociation Association
)

 Get the current texture parameter value from a Material Instance MaterialEditingLibrary.h
  • BlueprintPure
  • Category="MaterialEditing"

static bool GetMaterialInstanceStaticSwitchParameterValue ( UMaterialInstanceConstant* Instance,
FName ParameterName,
EMaterialParameterAssociation Association
)

 Get the current static switch parameter value from a Material Instance MaterialEditingLibrary.h
  • BlueprintPure
  • Category="MaterialEditing"

static UTexture * GetMaterialInstanceTextureParameterValue ( UMaterialInstanceConstant* Instance,
FName ParameterName,
EMaterialParameterAssociation Association
)

 Get the current texture parameter value from a Material Instance MaterialEditingLibrary.h
  • BlueprintPure
  • Category="MaterialEditing"

static FLinearColor GetMaterialInstanceVectorParameterValue ( UMaterialInstanceConstant* Instance,
FName ParameterName,
EMaterialParameterAssociation Association
)

 Get the current vector parameter value from a Material Instance MaterialEditingLibrary.h
  • BlueprintPure
  • Category="MaterialEditing"

static UMaterialExpression * GetMaterialPropertyInputNode ( UMaterial* Material,
EMaterialProperty Property
)

 Get the node providing the output for a given material property from an active material editor MaterialEditingLibrary.h
  • BlueprintPure
  • Category="MaterialEditing"

static FString GetMaterialPropertyInputNodeOutputName ( UMaterial* Material,
EMaterialProperty Property
)

 Get the node output name providing the output for a given material property from an active material editor MaterialEditingLibrary.h
  • BlueprintPure
  • Category="MaterialEditing"

static TSet< UObject * > GetMaterialSelectedNodes ( UMaterial* Material
)

 Get the set of selected nodes from an active material editor MaterialEditingLibrary.h
  • BlueprintPure
  • Category="MaterialEditing"

static UMaterialInterface * GetNaniteOverrideMaterial ( UMaterialInterface* Material
)

 Returns any nanite override material for the given material MaterialEditingLibrary.h
  • BlueprintCallable
  • Category="MaterialEditing"

static int32 GetNumMaterialExpressions ( const UMaterial* Material
)

 Returns number of material expressions in the supplied material MaterialEditingLibrary.h
  • BlueprintPure
  • Category="MaterialEditing"

static int32 GetNumMaterialExpressionsInFunction ( const UMaterialFunction* MaterialFunction
)

 Returns number of material expressions in the supplied material MaterialEditingLibrary.h
  • BlueprintPure
  • Category="MaterialEditing"

static void GetScalarParameterNames ( UMaterialInterface* Material,
TArray< FName >& ParameterNames
)

 Gets all scalar parameter names MaterialEditingLibrary.h
  • BlueprintCallable
  • Category="MaterialEditing"

static 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 MaterialEditingLibrary.h
  • BlueprintCallable
  • Category="MaterialEditing"

static void GetStaticSwitchParameterNames ( UMaterialInterface* Material,
TArray< FName >& ParameterNames
)

 Gets all static switch parameter names MaterialEditingLibrary.h
  • BlueprintCallable
  • Category="MaterialEditing"

static 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 MaterialEditingLibrary.h
  • BlueprintCallable
  • Category="MaterialEditing"

static FMaterialStatistics GetStatistics ( UMaterialInterface* Material
)

 Returns statistics about the given material MaterialEditingLibrary.h
  • BlueprintCallable
  • Category="MaterialEditing"

static void GetTextureParameterNames ( UMaterialInterface* Material,
TArray< FName >& ParameterNames
)

 Gets all texture parameter names MaterialEditingLibrary.h
  • BlueprintCallable
  • Category="MaterialEditing"

static 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 MaterialEditingLibrary.h
  • BlueprintCallable
  • Category="MaterialEditing"

static TArray< UTexture * > GetUsedTextures ( UMaterial* Material
)

 Get the list of textures used by a material MaterialEditingLibrary.h
  • BlueprintPure
  • Category="MaterialEditing"

static void GetVectorParameterNames ( UMaterialInterface* Material,
TArray< FName >& ParameterNames
)

 Gets all vector parameter names MaterialEditingLibrary.h
  • BlueprintCallable
  • Category="MaterialEditing"

static 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 MaterialEditingLibrary.h
  • BlueprintCallable
  • Category="MaterialEditing"

static bool HasMaterialUsage ( UMaterial* Material,
EMaterialUsage Usage
)

 Check if a particular usage is enabled for the supplied material (e.g. SkeletalMesh, ParticleSprite etc) MaterialEditingLibrary.h
  • BlueprintPure
  • Category="MaterialEditing"

static void LayoutMaterialExpressions ( UMaterial* Material
)

 Layouts the expressions in a grid pattern MaterialEditingLibrary.h
  • BlueprintCallable
  • Category="MaterialEditing"

static void LayoutMaterialFunctionExpressions ( UMaterialFunction* MaterialFunction
)

 Layouts the expressions in a grid pattern MaterialEditingLibrary.h
  • BlueprintCallable
  • Category="MaterialEditing"

static void RebuildMaterialInstanceEditors ( UMaterial* BaseMaterial
)

 Rebuilds dependent Material Instance Editors MaterialEditingLibrary.h  

static void RebuildMaterialInstanceEditors ( UMaterialFunction* BaseFunction
)

 Rebuilds dependent Material Instance Editors MaterialEditingLibrary.h  

static void RecompileMaterial ( UMaterial* Material
)

 Trigger a recompile of a material. MaterialEditingLibrary.h
  • BlueprintCallable
  • Category="MaterialEditing"

static void RecompileMaterialInternal ( FMaterialUpdateContext& UpdateContext,
UMaterial* Material
)

   MaterialEditingLibrary.h  

static void RecompileMaterials ( TArray< UMaterial* >& Materials,
FOnItemComplete const& OnItemComplete
)

 Trigger a recompile of an array of materials. MaterialEditingLibrary.h  

static void SetMaterialInstanceParent ( UMaterialInstanceConstant* Instance,
UMaterialInterface* NewParent
)

 Set the parent Material or Material Instance to use for this Material Instance MaterialEditingLibrary.h
  • BlueprintCallable
  • Category="MaterialEditing"

static bool SetMaterialInstanceRuntimeVirtualTextureParameterValue ( UMaterialInstanceConstant* Instance,
FName ParameterName,
URuntimeVirtualTexture* Value,
EMaterialParameterAssociation Association
)

 Set the texture parameter value for a Material Instance MaterialEditingLibrary.h
  • BlueprintCallable
  • Category="MaterialEditing"

static bool SetMaterialInstanceScalarParameterValue ( UMaterialInstanceConstant* Instance,
FName ParameterName,
float Value,
EMaterialParameterAssociation Association
)

 Set the scalar (float) parameter value for a Material Instance MaterialEditingLibrary.h
  • BlueprintCallable
  • Category="MaterialEditing"

static bool SetMaterialInstanceSparseVolumeTextureParameterValue ( UMaterialInstanceConstant* Instance,
FName ParameterName,
USparseVolumeTexture* Value,
EMaterialParameterAssociation Association
)

 Set the texture parameter value for a Material Instance MaterialEditingLibrary.h
  • BlueprintCallable
  • Category="MaterialEditing"

static bool SetMaterialInstanceStaticSwitchParameterValue ( UMaterialInstanceConstant* Instance,
FName ParameterName,
bool Value,
EMaterialParameterAssociation Association,
bool bUpdateMaterialInstance
)

 Set the static switch parameter value for a Material Instance MaterialEditingLibrary.h
  • BlueprintCallable
  • Category="MaterialEditing"

static bool SetMaterialInstanceTextureParameterValue ( UMaterialInstanceConstant* Instance,
FName ParameterName,
UTexture* Value,
EMaterialParameterAssociation Association
)

 Set the texture parameter value for a Material Instance MaterialEditingLibrary.h
  • BlueprintCallable
  • Category="MaterialEditing"

static bool SetMaterialInstanceVectorParameterValue ( UMaterialInstanceConstant* Instance,
FName ParameterName,
FLinearColor Value,
EMaterialParameterAssociation Association
)

 Set the vector parameter value for a Material Instance MaterialEditingLibrary.h
  • BlueprintCallable
  • Category="MaterialEditing"

static bool SetMaterialUsage ( UMaterial* Material,
EMaterialUsage Usage,
bool& bNeedsRecompile
)

 Enable a particular usage for the supplied material (e.g. SkeletalMesh, ParticleSprite etc) MaterialEditingLibrary.h
  • BlueprintCallable
  • Category="MaterialEditing"

static void UpdateMaterialFunction ( UMaterialFunctionInterface* MaterialFunction,
UMaterial* PreviewMaterial
)

 Update a Material Function after edits have been made. MaterialEditingLibrary.h
  • BlueprintCallable
  • Category="MaterialEditing"
  • Meta=(HidePin="PreviewMaterial")

static void UpdateMaterialFunctionInternal ( FMaterialUpdateContext& UpdateContext,
UMaterialFunctionInterface* MaterialFunction,
UMaterial* PreviewMaterial
)

   MaterialEditingLibrary.h  

static void UpdateMaterialFunctions ( TArray< UMaterialFunctionInterface* >& MaterialFunctions,
FOnItemComplete const& OnItemComplete
)

 Update an array of Material Functions after edits have been made. MaterialEditingLibrary.h  

static void UpdateMaterialInstance ( UMaterialInstanceConstant* Instance
)

 Called after making modifications to a Material Instance to recompile shaders etc. MaterialEditingLibrary.h
  • BlueprintCallable
  • Category="MaterialEditing"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page