Legacy Documentation: Version 5.6 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

MaskUtilities

class in UnityEngine.UI

Description

Mask related utility class.

This class provides masking-specific utility functions.

Static Functions

FindRootSortOverrideCanvasFind a root Canvas.
GetRectMaskForClippableFind the correct RectMask2D for a given IClippable.
GetRectMasksForClipSearch for all RectMask2D that apply to the given RectMask2D (includes self).
GetStencilDepthFind the stencil depth for a given element.
IsDescendantOrSelfHelper function to determine if the child is a descendant of father or is father.
Notify2DMaskStateChangedNotify all IClippables under the given component that they need to recalculate clipping.
NotifyStencilStateChangedNotify all IMaskable under the given component that they need to recalculate masking.