Initial package

Author: vanifatovvlad

.editorconfig

@@ -0,0 +1,12 @@
+[Dd]ebug/
+[Rr]elease/
+x64/
+[Bb]in/
+[Oo]bj/
+
+*.*~
+.vs
+.vscode
+.idea
+.gradle
+*.DotSettings.user

.gitignore

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 CodeWriter Packages
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

LICENSE.md

@@ -1,2 +1,15 @@
-# TutorialMaskForUGUI
+# TutorialMaskForUGUI [![Github license](https://img.shields.io/github/license/codewriter-packages/TutorialMaskForUGUI.svg?style=flat-square)](#) [![Unity 2021.3](https://img.shields.io/badge/Unity-2021.3+-2296F3.svg?style=flat-square)](#) ![GitHub package.json version](https://img.shields.io/github/package-json/v/codewriter-packages/TutorialMaskForUGUI?style=flat-square)
+
 UI Tutorial Mask is a component for highlighting specific objects over darkened background for Unity UI (uGUI)
+
+![Demo](https://github.com/codewriter-packages/TutorialMaskForUGUI/assets/26966368/4b31beed-3324-42d8-ad7c-62edcafb1bdc)
+
+## :open_book: How to Install
+Minimal Unity Version is 2021.3.
+
+Library distributed as git package ([How to install package from git URL](https://docs.unity3d.com/Manual/upm-ui-giturl.html))
+<br>Git URL: `https://github.com/codewriter-packages/TutorialMaskForUGUI.git`
+
+## :green_book: License
+
+TutorialMaskForUGUI is [MIT licensed](./LICENSE.md).

LICENSE.md.meta

@@ -0,0 +1,3 @@
+{
+	"name": "CodeWriter.TutorialMaskForUGUI.Runtime"
+}

README.md

@@ -0,0 +1,81 @@
+using System;
+using UnityEngine;
+using UnityEngine.EventSystems;
+using UnityEngine.Rendering;
+using UnityEngine.UI;
+
+namespace CodeWriter.UIExtensions
+{
+    [RequireComponent(typeof(Mask))]
+    public class MaskFixForTutorial : UIBehaviour, IMaterialModifier
+    {
+        [NonSerialized]
+        private Graphic _graphic;
+
+        [NonSerialized]
+        private Mask _mask;
+
+        [NonSerialized]
+        private Material _maskMaterial;
+
+        [NonSerialized]
+        private Material _unmaskMaterial;
+
+        public Graphic Graphic => _graphic ?? (_graphic = GetComponent<Graphic>());
+        public Mask Mask => _mask ?? (_mask = GetComponent<Mask>());
+
+        public Material GetModifiedMaterial(Material baseMaterial)
+        {
+            if (!Mask.MaskEnabled())
+            {
+                return baseMaterial;
+            }
+
+            var rootSortCanvas = MaskUtilities.FindRootSortOverrideCanvas(transform);
+            var stencilDepth = MaskUtilities.GetStencilDepth(transform, rootSortCanvas);
+            if (stencilDepth >= 7)
+            {
+                Debug.LogWarning("Attempting to use a stencil mask with depth > 8", gameObject);
+                return baseMaterial;
+            }
+
+            int desiredStencilBit = 1 << stencilDepth;
+
+            // if we are at the first level...
+            // we want to destroy what is there
+            if (desiredStencilBit == 1)
+            {
+                var maskMaterial = StencilMaterial.Add(baseMaterial, 1, StencilOp.Replace, CompareFunction.Always,
+                    Mask.showMaskGraphic ? ColorWriteMask.All : 0, 255, desiredStencilBit);
+                StencilMaterial.Remove(_maskMaterial);
+                _maskMaterial = maskMaterial;
+
+                var unmaskMaterial = StencilMaterial.Add(baseMaterial, 1, StencilOp.Zero, CompareFunction.Always, 0,
+                    255, desiredStencilBit);
+                StencilMaterial.Remove(_unmaskMaterial);
+                _unmaskMaterial = unmaskMaterial;
+                Graphic.canvasRenderer.popMaterialCount = 1;
+                Graphic.canvasRenderer.SetPopMaterial(_unmaskMaterial, 0);
+
+                return _maskMaterial;
+            }
+
+            //otherwise we need to be a bit smarter and set some read / write masks
+            var maskMaterial2 = StencilMaterial.Add(baseMaterial, desiredStencilBit | (desiredStencilBit - 1),
+                StencilOp.Replace, CompareFunction.Equal, Mask.showMaskGraphic ? ColorWriteMask.All : 0,
+                desiredStencilBit - 1, desiredStencilBit | (desiredStencilBit - 1));
+            StencilMaterial.Remove(_maskMaterial);
+            _maskMaterial = maskMaterial2;
+
+            Graphic.canvasRenderer.hasPopInstruction = true;
+            var unmaskMaterial2 = StencilMaterial.Add(baseMaterial, desiredStencilBit - 1, StencilOp.Replace,
+                CompareFunction.Equal, 0, desiredStencilBit - 1, desiredStencilBit | (desiredStencilBit - 1));
+            StencilMaterial.Remove(_unmaskMaterial);
+            _unmaskMaterial = unmaskMaterial2;
+            Graphic.canvasRenderer.popMaterialCount = 1;
+            Graphic.canvasRenderer.SetPopMaterial(_unmaskMaterial, 0);
+
+            return _maskMaterial;
+        }
+    }
+}