Legacy Documentation: Version 5.2
LanguageEnglish
  • C#
  • JS

Script language

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

MaskUtilities

class in UnityEngine.UI

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual

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.
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.