Class StencilMaterial

Dynamic material class makes it possible to create custom materials on the fly on a per-Graphic basis, and still have them get cleaned up correctly.

Inheritance

Object

StencilMaterial

Namespace: UnityEngine.UI

Syntax

public static class StencilMaterial

Methods

Add(Material, Int32, StencilOp, CompareFunction, ColorWriteMask)

Add a new material using the specified base and stencil ID.

Declaration

public static Material Add(Material baseMat, int stencilID, StencilOp operation, CompareFunction compareFunction, ColorWriteMask colorWriteMask)

Parameters

Type	Name	Description
Material	baseMat
Int32	stencilID
StencilOp	operation
CompareFunction	compareFunction
ColorWriteMask	colorWriteMask

Returns

Type	Description
Material

Add(Material, Int32, StencilOp, CompareFunction, ColorWriteMask, Int32, Int32)

Add a new material using the specified base and stencil ID.

Declaration

public static Material Add(Material baseMat, int stencilID, StencilOp operation, CompareFunction compareFunction, ColorWriteMask colorWriteMask, int readMask, int writeMask)

Parameters

Type	Name	Description
Material	baseMat
Int32	stencilID
StencilOp	operation
CompareFunction	compareFunction
ColorWriteMask	colorWriteMask
Int32	readMask
Int32	writeMask

Returns

Type	Description
Material

ClearAll()

Declaration

public static void ClearAll()

Remove(Material)

Remove an existing material, automatically cleaning it up if it's no longer in use.

Declaration

public static void Remove(Material customMat)

Parameters

Type	Name	Description
Material	customMat