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

Script language

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

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

Switch to Manual
public var maskInteraction: SpriteMaskInteraction;
public SpriteMaskInteraction maskInteraction;

Description

Specifies how the sprite interacts with the masks.

Sprites by default do not interact with Masks and will be visible irrespective of any mask being present or not. Sprites can also be setup to be visible inside a mask by setting this value to VisibleInsideMask. The inverse can be achieved by seting the maskInteraction to VisibleOutsideMask.

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 © 2017 Unity Technologies. Publication: 2017.1-001R. Built: 2017-10-06.
Tutorials Community Answers Knowledge Base Forums Asset Store LegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information