Class MaterialLayer

Single material layer

MaterialLayer
Assembly: FlaxEngine.dll
File: Engine/Tools/MaterialGenerator/MaterialLayer.h
Syntax
public class MaterialLayer

Constructors

MaterialLayer(const Guid& id)

Initializes a new instance of the MaterialLayer class.

Declaration
public MaterialLayer(const Guid& id)
Parameters
Guid id

The layer asset identifier.

Fields

BlendMode

Blending mode

Declaration
public MaterialBlendMode BlendMode
Field Value
MaterialBlendMode

Domain

Domain

Declaration
public MaterialDomain Domain
Field Value
MaterialDomain

FeaturesFlags

Layer features flags

Declaration
public MaterialFeaturesFlags FeaturesFlags
Field Value
MaterialFeaturesFlags

Graph

Graph data

Declaration
public MaterialGraph Graph
Field Value
MaterialGraph

ID

Layer ID

Declaration
public Guid ID
Field Value
Guid

MaskThreshold

The opacity threshold value (masked materials pixels clipping).

Declaration
public float MaskThreshold
Field Value
float

OpacityThreshold

The opacity threshold value (transparent materials shadow pass though clipping).

Declaration
public float OpacityThreshold
Field Value
float

ParamIdsMappings

Helper array with original layer parameters Ids mappings into new Ids Note: during sampling different materials layers we have to change their parameters Ids due to possible Ids collisions Collisions may occur in duplicated materials so we want to resolve them.

Declaration
public Array<LayerParamMapping> ParamIdsMappings
Field Value
Array<LayerParamMapping>

Root

Root node

Declaration
public MaterialGraph::Node* Root
Field Value
MaterialGraph::Node

ShadingModel

The shading model.

Declaration
public MaterialShadingModel ShadingModel
Field Value
MaterialShadingModel

Usage

Material structure variable name (different for every layer sampling with different UVs, default UVs are a first index)

Declaration
public LayerUsage Usage[4]
Field Value
LayerUsage

UsageFlags

Layer usage flags

Declaration
public MaterialUsageFlags UsageFlags
Field Value
MaterialUsageFlags

Methods

ClearCache()

Clear all cached values

Declaration
public void ClearCache()

CreateDefault(const Guid& id)

Create default empty layer

Declaration
public static MaterialLayer* CreateDefault(const Guid& id)
Parameters
Guid id

Layer id
Returns
MaterialLayer

Layer

GetMappedParamId(const Guid& id)

Declaration
public Guid GetMappedParamId(const Guid& id)
Parameters
Guid id

Returns
Guid

GetVariableName(void* hint)

Declaration
public String GetVariableName(void* hint)
Parameters
void hint

Returns
String

HasAnyVariableName()

Declaration
public bool HasAnyVariableName()
Returns
bool

Load(const Guid& id, ReadStream* graphData, const MaterialInfo& info, const String& caller)

Load layer data

Declaration
public static MaterialLayer* Load(const Guid& id, ReadStream* graphData, const MaterialInfo& info, const String& caller)
Parameters
Guid id

Layer id
ReadStream graphData

Stream with saved graph object
MaterialInfo info

Material info structure
String caller

Calling object name
Returns
MaterialLayer

Layer

Prepare()

Prepare layer for the material compilation process

Declaration
public void Prepare()

UpdateFeaturesFlags()

Declaration
public void UpdateFeaturesFlags()