Install UnmaskForUGUI with Unity Package Manager!

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.0",
    ...
  },
}

To update the package, change #1.1.0 to the target version.

It seems that the UnmaskRaycastFilter is no longer working. The Button receives no events even though the IsRaycastLocationValid function behaves correctly.

To Reproduce
Steps to reproduce the behavior:

1. Unity 2022.3.2f1
2. Create a new scene
3. Add the UI > Unmask > Tutorial Button
4. Try to click the button with the default settings => Does not work

Expected behavior
The button should receive the events

Screenshots

It is not possible to provide a screenshot of it not working

Environment (please complete the following information):

1. Unity 2022.3.2f1
2. Unmask 1.4.1
3. URP
4. InputSystem/EventSystem

Not sure what I'm doing wrong. I already checked the IsRaycastLocationValid and this is working correctly. I also tried different camera settings. The "area" is detected correctly, but the ray is not passing through. Any help is welcome.

Hello,

I want to use Unmask with the option "only for children" inside a scrollview (the viewport use the default UI mask).
When I do this, the mask of the viewport do not affect anymore the children that are ordered after the Unmask gameobject.

My hierarchy:

ShadowMask use Unmask with "only for children" option
and Viewport use default UI mask

Am I doing something wrong? or this is a bug?
(in this example I could manage to avoid using "only for children" but in my project I can't)

A feature request from mail.

Image [Mask]
  -- Text [Unmask]
  -- Image
  -- Image (Need to prevent unmask)

In my case ,my canvas was setting to Screen Space -camera,and then,the UnmaskRaycastFilter componet didn't work,The ray can not Passes through the unmasked rectangle.

Environment (please complete the following information):

• Platform: [e.g. Editor(Windows/Mac), Standalone(Windows/Mac), iOS, Android, WebGL]
• Unity: [e.g. 2018.4.0f1]
• UnmaskForUGUI: [e.g. v1.0.0]

The package can't be installed using Unity package manager (UPM)

'5.5' is not valid 'unity' attribute value. Expected '<year>.<version>'

To Reproduce
Steps to reproduce the behavior:

1. Go to Packages/manifest.json
2. Add the following line:
   "com.coffee.unmask": "https://github.com/mob-sakai/UnmaskForUGUI.git#1.1.1",

Environment:

• Platform: Editor Windows
• Unity: 2019.1.4f1
• UnmaskForUGUI: 1.1.1

I also use the "SoftMaskForUGUI" plugin. That's perfect effect except Inverse SoftMaskable must be the child of SoftMask in Hierarchy. I cannot make multiple holes on one background.
Then I found this plugin "UnmaskForUGUI". It allows me to make multiple holes on one background, but without soft mask effect. Is it possible to use soft mask to make multiple holes on one background?
Thanks for sharing your plugins! Both of them are very useful for me.

Describe the bug
When used on the built player (.apk) for Android device, the mask doesn't work at all.

To Reproduce
Steps to reproduce the behavior:

1. Import Unmask
2. Import Demo and build demo scene
3. Deploy to "any" Android device
4. Unmask is not working

Environment (please complete the following information):

• Platform: Android (tested on Nexus 5 with Android 6.0.1 and on Samsung Galaxy S10 with Android 9 I think)
• Unity: 2019.2.18
• UnmaskForUGUI: 1.1.3

Additional context
Add any other context, screenshots or gif animations about the bug here.

UnmaskRaycastFilter is not reliable?

So for our project, since our camera is using perspective projection, the funciton

camera.WorldToScreenPoint() is not reliable when converting from world position to screen point, therefore the UnmaskRaycastFilter's function IsRaycastLocationValid() is always returning false no matter what.

However I have found a solution for this: instead of using camera.WorldToScreenPoint(), unity has a build in function RectTransformUtility.RectangleContainsScreenPoint() to check whether a screen point is inside the rect transform. So maybe this is better? At least it worked for me 😄

Here is the modified version of IsRaycastLocationValid() function:

public bool IsRaycastLocationValid(Vector2 sp, Camera eventCamera)
{
  // Skip if deactived.
  if (!isActiveAndEnabled || !m_TargetUnmask || !m_TargetUnmask.isActiveAndEnabled){
   return true;
  }
    // check inside
  return !RectTransformUtility.RectangleContainsScreenPoint((m_TargetUnmask.transform as RectTransform), sp);
}

Description
Errors in Unity 2021 LTS when trying to instantiate a Tutorial Button through the menu.

To Reproduce
Steps to reproduce the behavior:

1. GameObject > UI > Unmask > Tutorial Button
2. See errors

Environment:

• Unity 2021 LTS

Problem
In 2021 LTS, Unity has changed the path from "GameObject/UI/Button" to "GameObject/UI/Button - TextMeshPro". Changing it manually fixes the problem, however it would be broken on any older version. A Unity version check with scripting symbols should do the trick.

I've been using your library and it's great.
But I notice that the mask's border will be pixelated when using sprite with alpha color. Could it support soft mask like SoftMaskForUGUI?

Hello,

I noticed that Unmask is not working if not child of a Unity Mask.

I made a simple project, you can open the Bug scene to view the issue.
UnmaskForUGUIBugUnmask.zip

The shadow of ElementTemplateOutside is still visible in the center.
I use the v1.3 of UnmaskForUGUI

I cut a hole on a black image,but the hole's edge looks like too sharp,so ,how to blur the edge of the hole?