1. Epic GamesDeveloper
  3. UMaterialEditingLibrary

UMaterialEditingLibrary

Blueprint library for creating/editing Materials

API > API/Editor > API/Editor/MaterialEditor

Inheritance Hierarchy

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

  Type Name Description
Public function Static void Clears all material parameters set by this Material Instance
Public function Static bool

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

 Create connection between two material expressions
Public function 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)
Public function Static UMaterialExpression *

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

 Create a new material expression node within the supplied material
Public function 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
Public function Static UMaterialExpression *

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

 Create a new material expression node within the supplied material function
Public function Static void Delete all material expressions in the supplied material
Public function Static void Delete all material expressions in the supplied material function
Public function Static void Delete a specific expression from a material. Will disconnect from other expressions.
Public function Static void Delete a specific expression from a material function. Will disconnect from other expressions.
Public function 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.
Public function Static void

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

 Gets all direct child mat instances
Public function Static bool Get the output name of input node connected to MaterialExpression from an active material editor
Public function Static TArray< UMaterialExpression * >

GetInputsForMaterialExpression ( UMaterial* Material,
UMaterialExpression* MaterialExpression
)

 Get the set of nodes acting as inputs to a node from an active material editor
Public function Static float Get the default scalar (float) parameter value from a Material
Public function Static bool Get the default static switch parameter value from a Material
Public function Static UTexture * Get the default texture parameter value from a Material
Public function Static FLinearColor Get the default vector parameter value from a Material
Public function Static TArray< FString > Get the array of input pin names for a material expression
Public function Static TArray< int32 > Get the array of input pin types for a material expression
Public function Static void

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

 Get the position of the MaterialExpression node.
Public function Static URuntimeVirtualTexture *

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

 Get the current texture parameter value from a Material Instance
Public function Static float

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

 Get the current scalar (float) parameter value from a Material Instance
Public function Static USparseVolumeTexture *

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

 Get the current texture parameter value from a Material Instance
Public function Static bool

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

 Get the current static switch parameter value from a Material Instance
Public function Static UTexture *

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

 Get the current texture parameter value from a Material Instance
Public function Static FLinearColor

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

 Get the current vector parameter value from a Material Instance
Public function Static UMaterialExpression *

GetMaterialPropertyInputNode ( UMaterial* Material,
EMaterialProperty Property
)

 Get the node providing the output for a given material property from an active material editor
Public function 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
Public function Static TSet< UObject * > Get the set of selected nodes from an active material editor
Public function Static UMaterialInterface * Returns any nanite override material for the given material
Public function Static int32

GetNumMaterialExpressions ( const UMaterial* Material
)

 Returns number of material expressions in the supplied material
Public function Static int32 Returns number of material expressions in the supplied material
Public function Static void

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

 Gets all scalar parameter names
Public function 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
Public function Static void

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

 Gets all static switch parameter names
Public function 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
Public function Static FMaterialStatistics Returns statistics about the given material
Public function Static void

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

 Gets all texture parameter names
Public function 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
Public function Static TArray< UTexture * >

GetUsedTextures ( UMaterial* Material
)

 Get the list of textures used by a material
Public function Static void

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

 Gets all vector parameter names
Public function 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
Public function Static bool

HasMaterialUsage ( UMaterial* Material,
EMaterialUsage Usage
)

 Check if a particular usage is enabled for the supplied material (e.g. SkeletalMesh, ParticleSprite etc)
Public function Static void Layouts the expressions in a grid pattern
Public function Static void Layouts the expressions in a grid pattern
Public function Static void Rebuilds dependent Material Instance Editors
Public function Static void Rebuilds dependent Material Instance Editors
Public function Static void Trigger a recompile of a material.
Public function Static void Set the parent Material or Material Instance to use for this Material Instance
Public function Static bool

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

 Set the texture parameter value for a Material Instance
Public function Static bool

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

 Set the scalar (float) parameter value for a Material Instance
Public function Static bool

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

 Set the texture parameter value for a Material Instance
Public function Static bool

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

 Set the static switch parameter value for a Material Instance
Public function Static bool

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

 Set the texture parameter value for a Material Instance
Public function Static bool

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

 Set the vector parameter value for a Material Instance
Public function Static bool

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

 Enable a particular usage for the supplied material (e.g. SkeletalMesh, ParticleSprite etc)
Public function Static void

UpdateMaterialFunction ( UMaterialFunctionInterface* MaterialFunction,
UMaterial* PreviewMaterial
)

 Update a Material Function after edits have been made.
Public function Static void Called after making modifications to a Material Instance to recompile shaders etc.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page