Reverse mask for uGUI element in Unity.
<< Description | WebGL Demo | Download | Install | Usage >>
What's new? See changelog
Do you want to receive notifications for new releases? Watch this repo
Unmask provides the following features:
- Reverse mask
- Ray through the unmasked rectangle
- Following another object
- Support nesting
Find the manifest.json file in the Packages folder of your project and edit it to look like this:
{
"dependencies": {
"com.coffee.unmask": "https://github.com/mob-sakai/UnmaskForUGUI.git#1.1.3",
...
},
}
To update the package, change #{version}
to the target version.
Or, use UpmGitExtension.
Download *.unitypackage
from Releases and import the package into your Unity project.
Select Assets > Import Package > Custom Package
from the menu.
- Add Unmask component to the UI element (Image, RawImage, Text, etc...) under Mask, from
Add Component
in inspector orComponent > UI > Unmask > Unmask
menu. - If you want to unmask the area of the button, follow the steps below:
- Set the button to
Fit Target
in Unmask component. - If the button moves with animation etc., enable
Fit On LateUpdate
in Unmask component. - Add a UnmaskRaycastFilter component to UI element blocking ray.
- Set the Unmask to
Unmask
in UnmaskRaycastFilter component. - Disable
RaycastTarget
of the UI elements, as necessary.
- Set the button to
- Enjoy!
- Unity 5.5+ (included Unity 2018.x)
- No other SDK are required
- MIT
- © UTJ/UCL
- GitHub page : https://github.com/mob-sakai/UnmaskForUGUI
- Releases : https://github.com/mob-sakai/UnmaskForUGUI/releases
- Issue tracker : https://github.com/mob-sakai/UnmaskForUGUI/issues
- Current project : https://github.com/mob-sakai/UnmaskForUGUI/projects/1
- Change log : https://github.com/mob-sakai/UnmaskForUGUI/blob/upm/CHANGELOG.md