A reverse masking solution for uGUI element in Unity.
Reverse mask for uGUI element in Unity.
<< Description | WebGL Demo | Installation | Usage | Contributing >>
Unmask provides the following features:
Component | Features | Screenshot |
---|---|---|
Unmask | Reverse masking for parent Mask component. Fit Target / Fit On Late Update: Fit graphic's transform to target transform on LateUpdate. Only For Children: Unmask affects only for children. Show Unmask Graphic: Show the graphic that is associated with the unmask render area. |
|
UnmaskRaycastFilter | The ray Passes through the unmasked rectangle. You can click on the unmasked button on the back side. |
This package is available on OpenUPM.
You can install it via openupm-cli.
openupm add com.coffee.unmask
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",
...
},
}
To update the package, change suffix #{version}
to the target version.
"com.coffee.unmask": "https://github.com/mob-sakai/UnmaskForUGUI.git#2.0.0",
Or, use UpmGitExtension to install and update the package.
Packages
(It works as an embedded package. For Unity 2018.1 or later)Assets
(Legacy way. For Unity 2017.1 or later)Package Manager
window and select UI Unmask
package in package list and click Demo > Import in project
buttonAssets/Samples/UI Unmask/Import Demo
from menuThe assets will be imported into Assets/Samples/UI Unmask/{version}/Demo
.
Open UIUnmask_Demo
scene and play it.
Create Object From Menu (GameObject > UI > Unmask > ***
)
Menu | Screenshot |
---|---|
Tutorial Button | |
Iris Shot |
Case | Description | Screenshot |
---|---|---|
Unmasked text | Black screen is cut out with unmasked text. | |
Hole | Black screen is cut out with unmasked Image. | |
Tutorial button | In tutorial, only specific button can be pressed. | |
Iris in/out | Transition effect with iris in/out. |
Issues are very valuable to this project.
Pull requests are, a great way to get your ideas into this repository.
See CONTRIBUTING.md and develop branch..
This is an open source project that I am developing in my spare time.
If you like it, please support me.
With your support, I can spend more time on development. :)