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

Light Theme

Dark Theme

UMaterialParameterCollection

Asset class that contains a list of parameter names and their default values.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UMaterialParameterCollection

References

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

Syntax

class UMaterialParameterCollection : public UObject

Remarks

Asset class that contains a list of parameter names and their default values. Any number of materials can reference these parameters and get new values when the parameter values are changed.

Variables

	Name	Description
TArray< FCollec...	ScalarParameters
FGuid	StateId	Used by materials using this collection to know when to recompile.
TArray< FCollec...	VectorParameters

Constructors

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

Functions

	Name	Description
FGuid	GetParameterId ( FName ParameterName )	Finds a parameter id given a name, returns the default guid if the parameter was not found.
void	GetParameterIndex ( const FGuid& Id, int32& OutIndex, int32& OutComponentIndex )	Gets a vector and component index for the given parameter, used when compiling materials, to know where to access a certain parameter.
FName	GetParameterName ( const FGuid& Id )	Finds a parameter name given an Id, returns NAME_None if the parameter was not found.
void	GetParameterNames ( TArray< FName >& OutParameterNames, bool bVectorParameters )	Populates an array with either scalar or vector parameter names.
const FColle...	GetScalarParameterByName ( FName ParameterName )	Utility to find a scalar parameter struct given a parameter name. Returns NULL if not found.
const FShade...	GetUniformBufferStruct()	Accessor for the uniform buffer layout description.
const FColle...	GetVectorParameterByName ( FName ParameterName )	Utility to find a vector parameter struct given a parameter name. Returns NULL if not found.

Overridden from UObject

	Name	Description
void	BeginDestroy()	Called before destroying the object.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	PreEditChange ( FProperty* PropertyAboutToChan... )	This is called when a property is about to be modified externally

Overridden from UObjectBaseUtility

		Name	Description
	bool	CanBeInCluster()	Called during cluster construction if the object can be added to a cluster

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

Take our survey

Dismiss