Depiction Engine For Unity 2023.0 (Alpha)
All Classes Namespaces Functions Variables Enumerations Properties Pages
DepictionEngine.LayerUtility Class Reference

Utility methods to help manage layers. More...

Static Public Member Functions

static void CreateLayer (string name)
 Create a new layer with the given name if it does not exists (Editor Only).
 
static int GetLayer (string name)
 Returns a layer or create a new one if it does not already exist (The layer will only be created in the Editor).
 
static int GetLayerMaskFromLayerIndex (int index)
 Convert a layer index value to layer mask.
 
static int GetDefaultLayer (Type type)
 
static string GetDefaultLayerName (Type type)
 

Detailed Description

Utility methods to help manage layers.

Member Function Documentation

◆ CreateLayer()

static void DepictionEngine.LayerUtility.CreateLayer ( string  name)
static

Create a new layer with the given name if it does not exists (Editor Only).

Parameters
nameThe name of the new layer.
Exceptions
System.ArgumentNullException

◆ GetLayer()

static int DepictionEngine.LayerUtility.GetLayer ( string  name)
static

Returns a layer or create a new one if it does not already exist (The layer will only be created in the Editor).

Parameters
nameThe name of the layer.
Returns
The layer int value.

◆ GetLayerMaskFromLayerIndex()

static int DepictionEngine.LayerUtility.GetLayerMaskFromLayerIndex ( int  index)
static

Convert a layer index value to layer mask.

Parameters
indexA layer index from 0-31.
Returns
A layer mask value.

The documentation for this class was generated from the following file: