自定义Unity材质Inspector之关键字枚举(KeywordEnum)

<转>我也忘了转自哪里,抱歉,感谢原作者

在这一篇文章中,我们要介绍关键字的枚举类型。

在平时我们书写Shader的过程中都会定义很多的关键字来区分shader的不同用途和功能,当然Unity内置的关键字宏也很多,比如如下代码摘自Lighting.cginc

inline fixed4 LightingLambert (SurfaceOutput s, UnityGI gi)
{
fixed4 c;
c = UnityLambertLight (s, gi.light);
 
#if defined(DIRLIGHTMAP_SEPARATE)
#ifdef LIGHTMAP_ON
c += UnityLambertLight (s, gi.light2);
#endif
#ifdef DYNAMICLIGHTMAP_ON
c += UnityLambertLight (s, gi.light3);
#endif
#endif
 
#ifdef UNITY_LIGHT_FUNCTION_APPLY_INDIRECT
c.rgb += s.Albedo * gi.indirect.diffuse;
#endif
 
return c;
}

但这简单的几句代码里就定义了 DIRLIGHTMAP_SEPARATE,LIGHTMAP_ON,DYNAMICLIGHTMAP_ON,UNITY_LIGHT_FUNCTION_APPLY_INDIRECT 这4个关键字宏。

通常定义这些编译宏的好处就是在最少的代码完成最多的功能,而这些宏是给编译器看的。

对于这些宏的开启与关闭,我们最常见的就是直接在代码里面对齐进行关闭,但这样的操作往往是依赖图形工程师或技术美术的支持,普通的美工和其他人是不敢随便动的。那有没有一种方式,提供一个简单的选择界面,让普通美工或策划来控制这些宏的开启和关闭呢?

答案当然是有,这就是今天的介绍内容。内容依然来自Unity的官方文档(MaterialPropertyDrawer),pass:官方文档中有不少错误的地方,希望博友注意哦!


1、最简单的一种:Toggle 无参

//当勾选上时,定义_FANCY_ON这个宏
[Toggle]_Fancy("Fancy?",Int)=0

也就是当勾选这个参数时,就表示定义了_FANCY_ON这个宏,在代码中使用时#if _FANCY_ON 或 #if defined(_FANCY_ON)  或 #ifdef _FANCY_ON 结果为真,完整源码如下:

Shader "MaterialPropertyDrawer/MaterialPropertyDrawerKeywordEnumToggleNull" {
    Properties
    {
        //当勾选上时,定义_FANCY_ON这个宏
        [Toggle] _Fancy ("Fancy?", Int) = 0
    }
    SubShader
    {
        pass
        {
            Tags{ "LightMode"="ForwardBase"}
            CGPROGRAM
            #pragma shader_feature _FANCY_ON
            #pragma vertex vert
            #pragma fragment frag
            #include "UnityCG.cginc"
 
            struct vertOut{
                float4 pos:SV_POSITION;
                float4 color:COLOR;
            };
            vertOut vert(appdata_base v)
            {
                vertOut o = (vertOut)0;
                o.pos=mul(UNITY_MATRIX_MVP,v.vertex);
                
                o.color=float4(1,0,0,1);//红
                
                #if _FANCY_ON
                    o.color=float4(0,1,0,1);//绿
                #endif
                
                return o;
            }
            float4 frag(vertOut i):COLOR
            {
                return i.color;
            }
            ENDCG
}//end pass
}
}

2、看上去更易理解的Toggle:有参

其实这种跟上面的那种是一样的,只是Toggle里面带有宏参数,在Toggle里面定义宏的名字,可以跟外面的不一样

// Will set "ENABLE_FANCY" shader keyword when set
[Toggle(ENABLE_FANCY)]_Fancy("Fancy?",Float)=0

还是上面类似的例子,源码如下:

Shader "MaterialPropertyDrawer/MaterialPropertyDrawerKeywordEnumToggleNull" {
Properties {
        [Toggle(FANCY_ON)] _Fancy ("Fancy?", Int) = 0
}
SubShader {
pass{
            Tags{ "LightMode"="ForwardBase"}
            CGPROGRAM
            #pragma shader_feature FANCY_ON
            #pragma vertex vert
            #pragma fragment frag
            #include "UnityCG.cginc"
            #include "Lighting.cginc"
 
            struct vertOut{
                float4 color:COLOR;
            };
            vertOut vert(appdata_base v)
            {
                vertOut o = (vertOut)0;
                
                o.color=float4(1,0,0,1);//红
                
                #if FANCY_ON
                    o.color=float4(0,1,0,1);//绿
                #endif
                
                return o;
            }
            float4 frag(vertOut i):COLOR
            {
                return i.color;
            }
            ENDCG
}//end pass
}
}

3、更多状态的关键字定义

在上面的示例中都只定义了一个关键字的开和关,那要定义更多状态的关键字要怎么处理呢?使用KeywordEnum

// Display a popup with None,Add,Multiply choices.
// Each option will set _OVERLAY_NONE, _OVERLAY_ADD, _OVERLAY_MULTIPLY shader keywords.

[KeywordEnum(None,Add,Multiply)]_Overlay("Overlay mode",Float)=0

使用_Overlay一个变量来定义_OVERLAY_NONE,_OVERLAY_ADD, _OVERLAY_MULTIPLY三个关键字的互斥使用。

我们的示例如下:


Shader"MaterialPropertyDrawer/MaterialPropertyDrawerKeywordEnum"{    Properties{        [KeywordEnum(Red,Green,Blue)]_ColorMode("Color Mode",Float)=0    }    SubShader{        pass{            Tags{"LightMode"="ForwardBase"}            CGPROGRAM            #pragma shader_feature _COLORMODE_RED _COLORMODE_GREEN _COLORMODE_BLUE            #pragma vertex vert            #pragma fragment frag            #include "UnityCG.cginc"             structvertOut{                float4pos:SV_POSITION;                float4color:COLOR;            };            vertOutvert(appdata_basev)            {                vertOuto=(vertOut)0;                o.pos=mul(UNITY_MATRIX_MVP,v.vertex);                o.color=float4(0,0,0,1);                                #if _COLORMODE_RED                    o.color=float4(1,0,0,1);                                #elif _COLORMODE_GREEN                    o.color=float4(0,1,0,1);                                #elif _COLORMODE_BLUE                    o.color=float4(0,0,1,1);                #endif                                returno;            }            float4frag(vertOuti):COLOR            {                returni.color;            }            ENDCG}//end pass}}


这样的使用,就给用户提供了一个下拉框来选择要激活哪一个关键字,如下所示:

这就可以任意切换了,O(∩_∩)O哈哈~

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

推荐阅读更多精彩内容