【Unity-Shader】#03 テクスチャを半透明に表示する

前回張ったテクスチャを半透明に表示します。

▼ 前回の記事

www.snoopopo.com

全文

Shader "Custom/Transparent"
{
    Properties
    {
        _MainTex("Texture", 2D) = "white" {}
    }

    SubShader
    {
        //半透明が適応されるために必要
        Tags
        {
            "Queue" = "Transparent"
            "RenderType" = "Transparent"
        }

        Blend SrcAlpha OneMinusSrcAlpha //重なったオブジェクトの画素の色とのブレンド方法の指定

        Pass
        {
            CGPROGRAM

            #pragma vertex vert
            #pragma fragment frag

            #include "UnityCG.cginc"

            struct appdata
            {
                float4 vertex : POSITION;
                float2 uv : TEXCOORD;
            };

            struct v2f
            {
                float4 vertex : SV_POSITION;
                float2 uv : TEXCOORD;
            };

            sampler2D _MainTex;

            v2f vert(appdata v)
            {
                v2f o;
                o.vertex = UnityObjectToClipPos(v.vertex);
                o.uv = v.uv;
                return o;
            }

            fixed4 frag(v2f i) : SV_Target
            {
                fixed4 color = tex2D(_MainTex, i.uv);
                color.a = 0.5; //半透明にする
                return color;
            }

            ENDCG
        }
    }
}

フラグメントシェーダー

           fixed4 frag(v2f i) : SV_Target
            {
                fixed4 color = tex2D(_MainTex, i.uv);
                color.a = 0.5; //半透明にする
                return color;
            }

おさらい：フラグメントシェーダーはその画素の色を決定することが役割。

単純にtex2Dを使ってこの画素に対する画像の位置の色を取得し、そのアルファ値をシェーダーで変えている。

これだけで半透明に表示されそうだと思ったが、半透明にならない。

アルファ値を反映させるには？

       //半透明が適応されるために必要
        Tags
        {
            "Queue" = "Transparent"
            "RenderType" = "Transparent"
        }

        Blend SrcAlpha OneMinusSrcAlpha //重なったオブジェクトの画素の色とのブレンド方法の指定

上記のような記述が必要になる。

Tags

レンダリングパイプラインに、こういう設定で処理を行ってね、というのを設定できる。

unity固有の構文＝ShaderLab で記述方法が決まっている。

docs.unity3d.com

半透明なオブジェクトは不透明なオブジェクトの後に描画しないといけない理由

半透明のオブジェクトを描画したい場合、先に不透明なオブジェクトを描画しておく必要がある。
手前にある半透明のオブジェクトと奥にある不透明のオブジェクトが重なったときに、
先に手前にある半透明のオブジェクトを描画してしまうと問題がおきるためである。

なぜなら、レンダリングパイプラインの手順上、
１：手前にある半透明のオブジェクトを描画　→Zbufferに半透明の色が入る
２：奥にある不透明のオブジェクトを描画する際にZTestで奥にあるので、重なった部分の色は描画しなくなる
⇒重なったときに奥にある不透明なオブジェクトも見えていないとおかしいが、描画されないことになってしまう。

このあたりの話は以下の記事で書いてた： www.snoopopo.com

そのため、Queue を使い、必ず不透明なオブジェクトの後に透明なオブジェクトを描画するようにする。

そうすると・・・
１：奥にある不透明のオブジェクトを描画する　→Zbufferに不透明な色が入る
２：手前にある半透明のオブジェクトを描画する　→Zbufferに既に入っている色と自分の色をブレンドして表示する

という手順にすることができる。

TagsのQueue

というわけでオブジェクトの描画順を意識しないといけないことがわかったわけだが、
その指定をするのが Queue になる。

| 指定できる文字列 | 説明 | 値 | | Geometry | 不透明なオブジェクト用。Queueを設定していないとデフォルトでこの指定になっている| 2000 | | Transparent | 半透明なオブジェクト用。| 3000 |

Queueは文字列で指定しているが、内部的には数値になっており、数値が小さい方から先に描画される。

ブランド方法の指定

       Blend SrcAlpha OneMinusSrcAlpha //重なったオブジェクトの画素の色とのブレンド方法の指定

半透明なオブジェクトの場合は、奥にある重なったオブジェクトの色と合成して表示すると自然な表示になる。

その色の合成方法の指定が上記。

【Unity-Shader】#02 不透明なテクスチャを表示する

不透明な画像＝テクスチャを表示するシェーダーを作成します。

全文

Shader "Custom/Texture"
{
    Properties
    {
        _MainTex("Texture", 2D) = "white" {}
    }

    SubShader
    {
        Pass
        {
            CGPROGRAM

            #pragma vertex vert
            #pragma fragment frag

            #include "UnityCG.cginc"

            struct appdata
            {
                float4 vertex : POSITION;
                float2 uv : TEXCOORD;   //テクスチャ座標
            };

            struct v2f
            {
                float4 vertex : SV_POSITION;
                float2 uv : TEXCOORD;
            };

            sampler2D _MainTex;

            v2f vert(appdata v)
            {
                v2f o;
                o.vertex = UnityObjectToClipPos(v.vertex);
                o.uv = v.uv;
                return o;
            }

            fixed4 frag(v2f i) : SV_Target
            {
                fixed4 color = tex2D(_MainTex, i.uv);
                return color;
            }

            ENDCG
        }
    }
}

Properties

properties に設定するとマテリアルのインスペクタから値を設定することができる。

   Properties
    {
        _MainTex("Texture", 2D) = "white" {}
    }

・_MainTex はシェーダー内の変数 sampler2D _MainTex を表していて、マテリアルで設定した値はこの変数に入ることを表す。

   SubShader
    {
        Pass
        {
            CGPROGRAM

            sampler2D _MainTex;

            ENDCG
        }
    }

・"Textue" →マテリアルのインスペクタ　に表示する名称。
・2D →2D型　であることを表す。テクスチャを設定したい場合には2D型を使う。
・"white" →テクスチャが設定されていないときのデフォルト色。

sampler2D 型

テクスチャの参照そのものが代入される型。　後術するtex2Dメソッドとセットで使われる。

頂点シェーダ

           struct appdata
            {
                float4 vertex : POSITION;
                float2 uv : TEXCOORD;   //テクスチャ座標
            };

            struct v2f
            {
                float4 vertex : SV_POSITION;
                float2 uv : TEXCOORD;
            };

            sampler2D _MainTex;

            v2f vert(appdata v)
            {
                v2f o;
                o.vertex = UnityObjectToClipPos(v.vertex);
                o.uv = v.uv;
                return o;
            }

UV座標

ポリゴンの各頂点にはテクスチャの座標情報が含まれている。
テクスチャの座標情報とは、張り付けられるテクスチャのどの画素がその頂点の位置に対応するかを表す情報。
これをUV座標といい、左下が(０,０）で、右上が（1,1）で表される。真ん中は（0.5,0.5) になるという意味。

この情報は、頂点が持っている情報であるため、 まずはレンダリングパイプラインから頂点シェーダにUV座標をもらい、それをフラグメントシェーダに連携する。 その後、フラグメントシェーダで、UV座標を元に画像からその画素に対する色を取得する。

セマンティクス　TEXCOORD

UV座標を表す。

フラグメントシェーダ

上述した通り、インプットのv2fにはUV座標が定義されており、頂点シェーダで設定したものが入っている。

これを使い、この画素に対するテクスチャを取得する。

           fixed4 frag(v2f i) : SV_Target
            {
                fixed4 color = tex2D(_MainTex, i.uv);
                return color;
            }

tex2D

指定されたUV座標の画素の色を返す関数。

【Unity-Shader】#0? テクスチャ座標をつかって色を算出する

フラグメントシェーダーを使ってオブジェクトの色をテクスチャ座標をつかって算出します。

全文

Shader "Custom/UvColor"
{
    Properties
    {
        _MainTex("Texture", 2D) = "white" {}
    }

    SubShader
    {
        Pass
        {
            CGPROGRAM

            #pragma vertex vert
            #pragma fragment frag

            #include "UnityCG.cginc"

            struct appdata
            {
                float4 vertex : POSITION;
                float2 uv : TEXCOORD;
            };

            struct v2f
            {
                float4 vertex : SV_POSITION;
                float2 uv : TEXCOORD;
            };

            float4 _MainTex_ST;

            v2f vert(appdata v)
            {
                v2f o;
                o.vertex = UnityObjectToClipPos(v.vertex);
                o.uv = TRANSFORM_TEX(v.uv, _MainTex);
                return o;
            }

            fixed4 frag(v2f i) : SV_Target
            {
                return fixed4(i.uv.x, i.uv.y, 0, 1);
            }

            ENDCG
        }
    }
}

フラグメントシェーダ

            fixed4 frag(v2f i) : SV_Target
            {
                return fixed4(i.uv.x, i.uv.y, 0, 1);
            }

頂点シェーダから取得した TEXCOORD はテクスチャ座標を表しているので、その値をそのまま色に当てはめている。

【Unity-Shader】#01 オブジェクトを単色で塗りつぶす

フラグメントシェーダーを使ってオブジェクトを単色で塗りつぶします。

全文

Shader "Custom/Color"
{
    SubShader
    {
        Pass
        {
            CGPROGRAM

            #pragma vertex vert
            #pragma fragment frag

            #include "UnityCG.cginc"

            struct appdata
            {
                float4 vertex : POSITION;
            };

            struct v2f
            {
                float4 vertex : SV_POSITION;
            };

            v2f vert(appdata v)
            {
                v2f o;
                o.vertex = UnityObjectToClipPos(v.vertex);
                return o;
            }

            fixed4 frag(v2f i) : SV_Target
            {
                return fixed4(1, 0, 0, 1);
            }

            ENDCG
        }
    }
}

頂点シェーダ

おさらい：頂点シェーダーは頂点の数分よばれる。

           struct appdata
            {
                float4 vertex : POSITION;
            };

            struct v2f
            {
                float4 vertex : SV_POSITION;
            };

            v2f vert(appdata v)
            {
                v2f o;
                o.vertex = UnityObjectToClipPos(v.vertex);
                return o;
            }

UnityObjectToClipPos

引数で受け取った頂点の座標＝３D座標　をビュー座標（画面に映る座標）に変換してくれる便利関数。

インクロードしている UnityCG.cginc に定義されている。

セマンティクス POSITION、SV_POSITION

セマンティクスとは　この値がどういう意味を表すのかを定義したもの。
この定義をみてレンダリングパイプラインもこの値がなんなのか判断できる。

ここで出てきているPOSITION、SV_POSITIONはどちらも座標位置を表す。
頂点シェーダの出力であるレンダリングパイプラインに渡す座標は、SV_POSITION　として、POSITIONと区別するために利用されているっぽい。

フラグメントシェーダー

おさらい：フラグメントシェーダは画素数分よばれる。

           fixed4 frag(v2f i) : SV_Target
            {
                return fixed4(1, 0, 0, 1);
            }

今回は赤く塗りつぶすだけなので、引数でつかった値を使わず、そのままその画素の色として (1,0,0,1)=赤 を返している。

fixed4 型

4つの固定小数点で構成される型。よく色を表すのに使ったりする。

【Unity-Shader】#00 レンダリングパイプライン

この記事は…

booth.pm

主に上記の電子書籍で学んだことを自分用にまとめたものです。
Shaderを学ぶのに始めに読むのにかなりお勧めの本でした！

UnlitShader

Un Lighting Shader の略。
陰影や輝きを表現する「ライティング」「シャーディング」といった処理を含まないシェーダのこと。
オブジェクトの設定された色やテクスチャがそのまま描画されるもっともシンプルなシェーダのこと。

つまり、学習しやすい。

３Dオブジェクトを描画するには

「レンダリングパイプライン」と呼ばれる工程を行うことで、３Dオブジェクトが画面に出力される。

レンダリングパイプライン

１：頂点の映る位置を算出する ⇒Vertex Shader
２：ポリゴンの表裏を確認する ⇒Culling
３：描画する画素を決定する ⇒Rasterize
４：ZBufferの値を比較する ⇒Z Test
５：画素を描画する ⇒Fragmet Shader(Pixel Shader)
６：描画する色を合成する ⇒Blending
７：ZBufferの値を更新する ⇒Z Write

１と５、つまりVertex ShaderとFragment Shader の処理部分はプログラムを実装して自由に変更することができる。

プログラマブルシェーダー

実装するプログラムによってオブジェクトの描画方法を任意に実装する仕組みのこと。
フラグメントシェーダや、頂点シェーダはまさにこれ。

１：頂点の映る位置を算出する　Vertex Shader

・オブジェクト←複数のメッシュ
・メッシュ←複数のポリゴン
・ポリゴン←３つの頂点

画面上のどの位置に頂点を描画するのか算出する。ポリゴン１つを表示するには３つ頂点があるので３回行う。

２：ポリゴンの表裏を確認する

ポリゴンには表裏が設定されている。
　→unityではその頂点の番号が時計まわりに見える方向を表として定義している

描画負荷を下げるために裏面をむいているポリゴンは描画しないようにしている＝culling (カリング）
shaderにおけるcullingを Backface Culling　という

というのがデフォルトの動作で設定によって、裏面のみ描画、表・裏どっちも描画、という風にもできる

３：描画する画素を決定する

ポリゴンが画面上のどの画素に描画されるかを決定する＝ラスタライズ Rasterize
１で頂点位置が決まり、３でポリゴンがどの画素で描画するかが決まる

４：ZBufferの値を比較する

描画する画素に既に描画されているポリゴンがないか確認する。描画済みのポリゴンが存在するかどうかは「Z Buffer」に書き込まれている
「Z Buffer」は描画する画面と同じ解像度を持った異なる画面
「Z Buffer」＝「Depth Buffer」・深度バッファ
「Z Buffer」にはカメラからポリゴンまでの距離を表す値＝z座標が書き込まれている

描画しようとしているポリゴンのZ値がすでに描画されているポリゴンのZ値よりも小さい場合は、
描画しようとしているポリゴンの方が手前になる

Z値を比較する処理を「Z Test」、またはDepth Testという
「Z Testに成功する」とは、Z値を比較して、新しいポリゴンが描画できる状態のことをいう

５：画素を描画する　Fragmet Shader(Pixel Shader)

画素に描画する色を算出して描画する
色は光源や、他のオブジェクトの影を考慮したり、あるいは、テクスチャを参照するなどして算出する

この処理はラスタライズで決定された画素の数分行われる。

６：描画する色を合成する　Blending

半透明なオブジェクトを描画する場合、重なった奥にあるオブジェクトを描画してから、そのあとに半透明なオブジェクトの描画を行う。
半透明なので、先に描画したオブジェクトの色と合成して描画する。

★不透明なオブジェクト→半透明なオブジェクト　という順番で描画する

７：ZBufferの値を更新する

画素の描画が終わったら、Z Bufferに新しいZ値を書き込んで更新する。＝「Z Write」

特定のコミットのブランチを作成したい

特定のコミットのブランチを作成

git checkout {コミットハッシュ値} -b {ブランチ名}

例)

git checkout 00abe35 -b tmp/20190421

【Ｃ＃】in / out / ref パラメータ修飾子

パラメータとは、引数のことです。

C#の引数には in, out, ref というパラメータ修飾子をつけることができます。

今回の記事は、パラメータ修飾子それぞれの機能ついて

パラメータ修飾子をつけない場合

C#では、値(プリミティブ)型でも参照型でも「値渡し」になります。

詳しくはこちら↓

www.snoopopo.com

ref パラメータ

refをつけると参照渡しになる。

private void Test()
{
    int a = 0;
    Poyo(ref a);
    Debug.Log(a); //出力結果は1になる
}
    
private void Poyo(ref int a){
    a = 1;
}

out パラメータ

outをつけると、呼ばれた側のメソッドで代入しなければいけない＝代入されることが保証される。
もちろん、値渡しにするとそれが実現できないので、参照渡しになる。

private void Test(){
    int a; //初期化する必要なし
    Poyo(out a); //outはつけないとだめ。
}

private void Poyo(out int a){
    a = 1; //代入する必要がある
}

渡すときにoutつけるので、渡す側のメソッドでは変数に値が代入されることが呼ばれる側のメソッドの定義を見なくても一目でわかる。

outパラメータはint.TryParse()のように渡したパラメータに結果を詰める、
みたいなメソッドでよく使われる。

int result; //初期化の必要はない
int.TryParse(input, out result);
Debug.Log(result);

渡したList型に値を詰めるメソッドとかはよくあると思うので、そういう時もoutパラメータが有効。

List result;
Poyo(out result);

---

c# 7.0 からは以下のように省略する書き方もできるようになった。

• c# 7.0以降▼

int.TryParse(input, out int result); //省略した書き方
Debug.Log(result);

in パラメータ

inパラメータはC#7で追加された。

読み取り専用の引数になります。

読み取り専用なので、inパラメータがついたメソッドを呼ぶ前に必ず値を代入しておく必要があります。

• 呼ぶ側

int a;
Val(a);　//aの値が代入されてないのでコンパイルエラー
int b = 1;
Val(b); 　//OK
Val(100); //直に定数渡すのもＯＫ

呼ばれるメソッド側では引数に値を代入することはできなります。
これによって勝手に書き換えられるようなことがなくなることが保証される。

• 値型の場合

private void Val(in int b)
{
    b = b++; //コンパイルエラー
}

• 参照型の場合

private void Ref(in List<Hoge> list)
{
    list = new List<Hoge>();　//コンパイルエラー
    list.Add(new Hoge());　//これは問題なし
}

参照型の場合は、参照型の変数の値＝実体の参照を変えることができない、
つまり新しい参照を代入する＝newすることはできません。
これによって、今までrefで書くことができていた以下のような処理を防ぐことができる。

以下のソースはrefで渡された参照型変数にnewすることが呼び出されたメソッド側でできてしまい、
呼び出し側のメソッドが知らないうちに参照が書き換えることができる状態だった。
inを使えばnewされることがないのでこれを防ぐことができる。

private void Ref(ref List<Hoge> list)
{
    list = new List<Hoge>();
}

inパラメータがもっている参照が示す参照先のオブジェクトを操ることはできるので、

C#7を使うには

unityでC#7を使うには、

Edit > ProjectSettings > Player > Scripting Runtime Version

を.NET 4.x Equivalentにすることで使えるようになる。