1. Epic GamesDeveloper
  3. UMaterialParameterCollectionInstance

UMaterialParameterCollectionInstance

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

Unreal Engine C++ API Reference > Runtime > Engine > Materials

Inheritance Hierarchy

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

  Type Name Description
Public variable bool bLoggedMissingParameterWarning Tracks whether this instance has ever issued a missing parameter warning, to reduce log spam.
Protected variable bool bNeedsRenderStateUpdate Tracks whether this instance needs to update the render state from the game thread
Protected variable TWeakObjectPtr< UMaterialParameterCollection > Collection Collection resource this instance is based off of.
Protected variable FMaterialParameterCollectionInstanceResource * Resource Instance resource which stores the rendering thread representation of this instance.
Protected variable FOnScalarParameterUpdated ScalarParameterUpdatedDelegate Delegate for when a scalar parameter value is updated
Protected variable TMap< FName, float > ScalarParameterValues Overrides for scalar parameter values.
Protected variable FOnVectorParameterUpdated VectorParameterUpdatedDelegate Delegate for when a vector parameter value is updated
Protected variable TMap< FName, FLinearColor > VectorParameterValues Overrides for vector parameter values.
Protected variable TWeakObjectPtr< UWorld > World World that owns this instance.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

DeferredUpdateRenderState ( bool bRecreateUniformBuffer
)

  
Public function Const const UMaterialParameterCollection *  
Protected function Const void

GetParameterData ( TArray< FVector4f >& ParameterData
)

 Boils down the instance overrides and default values into data to be set on the uniform buffer.
Public function FMaterialParameterCollectionInstanceResource *  
Public function Const bool

GetScalarParameterValue ( const FCollectionScalarParameter& Parameter,
float& OutParameterValue
)

 Alternate Get method for parameter values where the Collection parameter is provided
Public function Const bool

GetScalarParameterValue ( FName ParameterName,
float& OutParameterValue
)

 Gets parameter values, returns false if the parameter was not found.
Public function Const bool

GetVectorParameterValue ( const FCollectionVectorParameter& Parameter,
FLinearColor& OutParameterValue
)

  
Public function Const bool

GetVectorParameterValue ( FName ParameterName,
FLinearColor& OutParameterValue
)

  
Public function Const bool  
Public function FOnScalarParameterUpdated &  
Public function FOnVectorParameterUpdated &  
Public function void

SetCollection ( UMaterialParameterCollection* InCollection,
UWorld* InWorld
)

 Initializes the instance with the collection it is based off of and the world it is owned by.
Public function bool

SetScalarParameterValue ( FName ParameterName,
float ParameterValue
)

 Sets parameter value overrides, returns false if the parameter was not found.
Public function bool

SetVectorParameterValue ( FName ParameterName,
const FVector& ParameterValue
)

  
Public function bool

SetVectorParameterValue ( FName ParameterName,
const FLinearColor& ParameterValue
)

  
Public function bool

SetVectorParameterValue ( FName ParameterName,
const FVector4& ParameterValue
)

  
Public function void

UpdateRenderState ( bool bRecreateUniformBuffer
)

  

Overridden from UObject

  Type Name Description
Public function Virtual void Called to finish destroying the object.
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Typedefs

Name Description
FOnScalarParameterUpdated  
FOnVectorParameterUpdated  
ScalarParameterUpdate  
VectorParameterUpdate  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page