Navigation
API > API/Runtime > API/Runtime/Engine
Class that stores per-world instance parameter data for a given UMaterialParameterCollection resource. Instances of this class are always transient.
| Name | UMaterialParameterCollectionInstance |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Public/Materials/MaterialParameterCollectionInstance.h |
| Include Path | #include "Materials/MaterialParameterCollectionInstance.h" |
Syntax
UCLASS (HideCategories=object, MinimalAPI)
class UMaterialParameterCollectionInstance : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UMaterialParameterCollectionInstance
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UMaterialParameterCollectionInstance
(
const FObjectInitializer& ObjectInitializer |
Materials/MaterialParameterCollectionInstance.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnScalarParameterUpdated | TMulticastDelegate_OneParam< void, ScalarParameterUpdate > | Materials/MaterialParameterCollectionInstance.h | |
| FOnVectorParameterUpdated | TMulticastDelegate_OneParam< void, VectorParameterUpdate > | Materials/MaterialParameterCollectionInstance.h | |
| ScalarParameterUpdate | TPair< FName, float > | Materials/MaterialParameterCollectionInstance.h | |
| VectorParameterUpdate | TPair< FName, FLinearColor > | Materials/MaterialParameterCollectionInstance.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bLoggedMissingParameterWarning | bool | Tracks whether this instance has ever issued a missing parameter warning, to reduce log spam. | Materials/MaterialParameterCollectionInstance.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void DeferredUpdateRenderState
(
bool bRecreateUniformBuffer |
Materials/MaterialParameterCollectionInstance.h | ||
void ForceReturnToDefaultValues() |
Materials/MaterialParameterCollectionInstance.h | ||
const UMaterialParameterCollection * GetCollection() |
Materials/MaterialParameterCollectionInstance.h | ||
FMaterialParameterCollectionInstanceResource * GetResource() |
Materials/MaterialParameterCollectionInstance.h | ||
bool GetScalarParameterValue
(
const FCollectionScalarParameter& Parameter, |
Alternate Get method for parameter values where the Collection parameter is provided | Materials/MaterialParameterCollectionInstance.h | |
bool GetScalarParameterValue
(
FName ParameterName, |
Gets parameter values, returns false if the parameter was not found. | Materials/MaterialParameterCollectionInstance.h | |
bool GetVectorParameterValue
(
const FCollectionVectorParameter& Parameter, |
Materials/MaterialParameterCollectionInstance.h | ||
bool GetVectorParameterValue
(
FName ParameterName, |
Materials/MaterialParameterCollectionInstance.h | ||
bool IsCollectionValid() |
Materials/MaterialParameterCollectionInstance.h | ||
FOnScalarParameterUpdated & OnScalarParameterUpdated() |
Materials/MaterialParameterCollectionInstance.h | ||
FOnVectorParameterUpdated & OnVectorParameterUpdated() |
Materials/MaterialParameterCollectionInstance.h | ||
void SetCollection
(
UMaterialParameterCollection* InCollection, |
Initializes the instance with the collection it is based off of and the world it is owned by. | Materials/MaterialParameterCollectionInstance.h | |
bool SetScalarParameterValue
(
FName ParameterName, |
Sets parameter value overrides, returns false if the parameter was not found. | Materials/MaterialParameterCollectionInstance.h | |
bool SetVectorParameterValue
(
FName ParameterName, |
Materials/MaterialParameterCollectionInstance.h | ||
bool SetVectorParameterValue
(
FName ParameterName, |
Materials/MaterialParameterCollectionInstance.h | ||
bool SetVectorParameterValue
(
FName ParameterName, |
Materials/MaterialParameterCollectionInstance.h | ||
void UpdateRenderState
(
bool bRecreateUniformBuffer |
Materials/MaterialParameterCollectionInstance.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void FinishDestroy() |
Materials/MaterialParameterCollectionInstance.h | ||
virtual void PostInitProperties() |
Materials/MaterialParameterCollectionInstance.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void GetParameterData
(
TArray< FVector4f >& ParameterData |
Boils down the instance overrides and default values into data to be set on the uniform buffer. | Materials/MaterialParameterCollectionInstance.h |