Unity杂文——UGUI基于图集的shader遮罩

原文地址

前言

在Unity开发过程中,为了节省图,经常会做一些图形的遮罩,笔者开发UI使用的是UGUI遮罩,用过UGUI的Mask做遮罩的应该都知道,UGUI的mask做遮罩有很明显的锯齿,于是笔者就从网上学习一套shader做的遮罩,但是仅仅是shader做的遮罩虽然效果很好,但是在正式开发中,为了优化性能,大部分图片都是会打成图集的,这时候shader中的UV就不是我们想要的UV了,这时候就需要做一些修改了。所以本文是基于图集的shader遮罩。

普通的shader遮罩

image.png

上图左边是普通的UGUI的正常mask,右边是shader写的遮罩,边缘锯齿比较很明显。

shader代码

Shader "ImageMask01"
{
    Properties
    {
        [PerRendererData] _MainTex ("Sprite Texture", 2D) = "white" {}
        _Mask ("Base (RGB)", 2D) = "white" {} 
        _Color ("Tint", Color) = (1,1,1,1)

        _StencilComp("Stencil Comparison", Float) = 8
        _Stencil("Stencil ID", Float) = 0
        _StencilOp("Stencil Operation", Float) = 0
        _StencilWriteMask("Stencil Write Mask", Float) = 255
        _StencilReadMask("Stencil Read Mask", Float) = 255

        _ColorMask("Color Mask", Float) = 15
    }

    SubShader
    {
        Tags
        {
            "Queue"="Transparent"
            "IgnoreProjector"="True"
            "RenderType"="Transparent"
            "PreviewType"="Plane"
            "CanUseSpriteAtlas"="True"
        }

        Stencil
        {
            Ref [_Stencil]
            Comp [_StencilComp]
            Pass [_StencilOp]
            ReadMask [_StencilReadMask]
            WriteMask [_StencilWriteMask]
        }

        Cull Off
        Lighting Off
        ZWrite Off
        ZTest [unity_GUIZTestMode]
        Blend SrcAlpha OneMinusSrcAlpha
        ColorMask [_ColorMask]

        Pass
        {
            CGPROGRAM
            #pragma vertex vert
            #pragma fragment frag
            #pragma target 2.0

            #include "UnityCG.cginc"
            #include "UnityUI.cginc"

            #pragma multi_compile_local _ UNITY_UI_CLIP_RECT
            #pragma multi_compile_local _ UNITY_UI_ALPHACLIP

            struct appdata_t
            {
                fixed2 uv : TEXCOORD0;
                float4 vertex   : POSITION;
                float4 color    : COLOR;
            };

            struct v2f
            {
                fixed2 uv : TEXCOORD0;
                float4 vertex   : SV_POSITION;
                fixed4 color    : COLOR;
            };

            sampler2D _MainTex;
            fixed4 _Color;
            sampler2D _Mask;

            v2f vert(appdata_t IN)
            {
                v2f OUT;
                OUT.vertex = UnityObjectToClipPos(IN.vertex);
                OUT.uv = IN.uv;
                OUT.color = IN.color * _Color;
#ifdef PIXELSNAP_ON
                OUT.vertex = UnityPixelSnap(OUT.vertex);
#endif

                return OUT;
            }

            fixed4 frag(v2f IN) : SV_Target
            {
                fixed4 color = tex2D(_MainTex, IN.uv) * IN.color;
                fixed4 mask = tex2D(_Mask, IN.uv);
                color.a *= mask.a;
                return color;
            }
        ENDCG
        }
    }
}

代码分析

上述代码虽然多,但是大部分都是通用的固定写法,包含一些shader支持UGUI的mask的写法,这里就不要进行讲解了,我们来看看我们shader做mask的关键代码。

Properties
{
    ...
    _Mask ("Base (RGB)", 2D) = "white" {} 
    ...
}

在Properties主要是把我们需要遮罩的形状放进去,这里需要注意的是需要遮罩的部分图片必须不透明,因为在做遮罩的时候是读取这个图片的透明度来判断是否需要进行遮罩的。也就是下面的代码:

fixed4 frag(v2f IN) : SV_Target
{
    fixed4 color = tex2D(_MainTex, IN.uv) * IN.color;
    fixed4 mask = tex2D(_Mask, IN.uv);
    color.a *= mask.a;
    return color;
}

逐片源操作的时候来进行读取来遮罩显示。

基于图集的遮罩

虽然上述已经实现了遮罩,但是在假如我们需要遮罩的图片是在图集上,会发现我们的遮罩会出现错误,不遮罩或者遮罩的不对,这是因为shader在读取图片的UV坐标的时候读取的并不是0~1而是图片在图集中的坐标,所以根据坐标进行遮罩是不行的。
解决方案就是需要把遮罩的坐标转成0~1的坐标,这样就可以判断是否需要遮罩了。
虽然我们有了解决方案,但是我们如何在shader中获取图片在图集的坐标呢,笔者的解决方案是利用一个C#的脚本,把图片坐标传递给shader。

Shader新的代码

Properties
{
    ...
    _Mask ("Base (RGB)", 2D) = "white" {} 
    _UvRect ("UvRect", Vector) = (0, 0, 1, 1)
    ...
}

上述是Properties中的代码,可以看出和普通的相比多了一个_UvRect参数,是用来保存图片在图集中的坐标的。

fixed4 frag(v2f IN) : SV_Target
{
    fixed4 color = tex2D(_MainTex, IN.uv) * IN.color;   
    float2 temuv = float2((IN.uv.x - _UvRect.x)/(_UvRect.z - _UvRect.x),(IN.uv.y - _UvRect.y)/(_UvRect.w - _UvRect.y));
    fixed4 mask = tex2D(_Mask, temuv);
    color.a *= mask.a;
    return color;
}

在判断是否遮罩的时候,可以看到笔者关键性的代码,就是teamuv的赋值,算法很简单,知道图片四个角在图集的UV坐标,就是_UvRect参数,然后(IN.uv.x - _UvRect.x)(IN.uv.y - _UvRect.y)就为了计算图片距离图片原点坐标的差值,也就是坐标系的坐标,他们在分别除以他们坐在的长度就转换成新的UV坐标了,其实就是图片本身的UV坐标了,然后就可以和普通的shader一样计算了。

C#代码

public class RefreshUVRect : MonoBehaviour
{
    private Material material;

    private Image img;
    // Start is called before the first frame update
    void Start()
    {
        img = GetComponent<Image>();
        material = img.material;
        Refresh();
    }

    public void Refresh()
    {
        if (img)
        {
            Vector4 uvRect = UnityEngine.Sprites.DataUtility.GetOuterUV(img.overrideSprite);
            material.SetVector("_UvRect", uvRect);
        }
    }

}

C#的代码比较简单,就是获取一下材质,然后把图片四个角的UV坐标传递给材质,UnityEngine.Sprites.DataUtility.GetOuterUV这个方法就是获取UV的边界坐标。
<font color=red size=4>特别提醒一下,遮罩后编辑器模式下是错误的,因为获取的还是图片坐标,运行状态下观看就是正确的了</font>

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,284评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,115评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,614评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,671评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,699评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,562评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,309评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,223评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,668评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,859评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,981评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,705评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,310评论 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,904评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,023评论 1 270
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,146评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,933评论 2 355

推荐阅读更多精彩内容