Navigation
API > API/Plugins > API/Plugins/AvalancheMask
Represents a material and its mask state
| Name | FAvaMask2DMaterialMaskState |
| Type | struct |
| Header File | /Engine/Plugins/VirtualProduction/Avalanche/Source/AvalancheMask/Public/Mask2D/AvaMask2DMaskState.h |
| Include Path | #include "Mask2D/AvaMask2DMaskState.h" |
Syntax
USTRUCT ()
struct FAvaMask2DMaterialMaskState
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Mask2D/AvaMask2DMaskState.h | |||
FAvaMask2DMaterialMaskState
(
const FAvaMask2DMaterialSlotId& InSlotId |
Mask2D/AvaMask2DMaskState.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| MaskState | FAvaMask2DMaskState | The mask state of the material | Mask2D/AvaMask2DMaskState.h | |
| MaterialWeak | TWeakObjectPtr< UMaterialInstanceDynamic > | Material instance dynamic assigned for this state | Mask2D/AvaMask2DMaskState.h | |
| SlotMaterialId | FAvaMask2DMaterialSlotId | The slot id to save / restore the material parameters for | Mask2D/AvaMask2DMaskState.h | |
| TopmostMaterialContainer | TWeakObjectPtr< UObject > | The topmost material containers that this state belongs to | Mask2D/AvaMask2DMaskState.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Apply() |
Applies the mask state to the material | Mask2D/AvaMask2DMaskState.h | |
bool IsDependentOf
(
UMaterialInterface* InMaterial |
Determines whether this material is dependent of the given material interface | Mask2D/AvaMask2DMaskState.h | |
void Store() |
Stores the material's mask state | Mask2D/AvaMask2DMaskState.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator==
(
const FAvaMask2DMaterialSlotId& InSlotId |
Mask2D/AvaMask2DMaskState.h |