Version: 2019.1 (switch to 2018.3 or 2017.4)
LanguageEnglish
  • C#
Experimental: this API is experimental and might be changed or removed in the future.

SpriteShapeRenderer.maskInteraction

Other Versions
Leave feedback
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

Submission failed

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

Close

Cancel

public SpriteMaskInteraction maskInteraction;

Description

Specifies how the SpriteShape interacts with the masks.

SpriteShapes by default do not interact with Sprite Masks, and remain at their original visibility even when overlapping masks. Set this value to either VisibleInsideMask or VisibleOutsideMask to have the SpriteShape interact with Sprite Masks. Set this value to VisibleInsideMask to have the SpriteShape visible within a mask, and set to VisibleOutsideMask to achieve the inverse effect.

Did you find this page useful? Please give it a rating:

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright © 2019 Unity Technologies. Publication: 2019.1-002V. Built: 2019-04-15.
TutorialsCommunity AnswersKnowledge BaseForumsAsset Store