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

Light Theme

Dark Theme

UMaterialParameterCollectionInstance

Class that stores per-world instance parameter data for a given [UMaterialParameterCollection](API\Runtime\Engine\Materials\UMaterialParameterCollection) resource.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UMaterialParameterCollectionInstance

References

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

Syntax

class UMaterialParameterCollectionInstance : public UObject

Remarks

Class that stores per-world instance parameter data for a given UMaterialParameterCollection resource. Instances of this class are always transient.

Variables

	Name	Description
bool	bLoggedMissingParameterWarning	Tracks whether this instance has ever issued a missing parameter warning, to reduce log spam.
bool	bNeedsRenderStateUpdate	Tracks whether this instance needs to update the render state from the game thread
UMaterialParame...	Collection	Collection resource this instance is based off of.
FMaterialParame...	Resource	Instance resource which stores the rendering thread representation of this instance.
TMap< FName, fl...	ScalarParameterValues	Overrides for scalar parameter values.
TMap< FName, FL...	VectorParameterValues	Overrides for vector parameter values.
TWeakObjectPtr<...	World	World that owns this instance.

Constructors

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

Functions

	Name	Description
void	DeferredUpdateRenderState ( bool bRecreateUniformBuffer )
const UMater...	GetCollection()
void	GetParameterData ( TArray< FVector4 >& ParameterData )	Boils down the instance overrides and default values into data to be set on the uniform buffer.
FMaterialPar...	GetResource()
bool	GetScalarParameterValue ( FName ParameterName, float& OutParameterValue )	Gets parameter values, returns false if the parameter was not found.
bool	GetVectorParameterValue ( FName ParameterName, FLinearColor& OutParameterValue )
void	SetCollection ( UMaterialParameterCollection* ..., UWorld* InWorld )	Initializes the instance with the collection it is based off of and the world it is owned by.
bool	SetScalarParameterValue ( FName ParameterName, float ParameterValue )	Sets parameter value overrides, returns false if the parameter was not found.
bool	SetVectorParameterValue ( FName ParameterName, const FLinearColor& ParameterValue )
void	UpdateRenderState ( bool bRecreateUniformBuffer )

Overridden from UObject

		Name	Description
	void	FinishDestroy()	Called to finish destroying the object.
	void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

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

Take our survey

Dismiss