2019-10-09

【Unity】LWRPでポストプロセスを使用しつつUIの手前にパーティクルを表示する

2D UI LWRP Unity2019.2 パーティクル

f:id:tsubaki_t1:20191009221926g:plain

LWRPはカメラのスタックができない
PostProcessingの後にUIとパーティクルを描画する
UIの間にパーティクルを挟む
注意点

PCを新しくしてからの初更新です。

環境：Unity 2019.2f8、LightWeight RP 6.9.1

LWRPはカメラのスタックができない

　いろいろと便利なLWRPですが、一つだけよく言われる致命的な問題があります。 カメラを複数使用して描画する事ができない という点です。　RenderTexture に描画結果を出力して後でまとめるといった事は可能なのですが、今まで使ってきた 複数のカメラを使って描画する事が出来ないのは、非常にもどかしいです。

　特に問題になりやすいのはUIとパーティクルの描画です。　よくある演出として UIの手前にエフェクトを表示する があります。これは大抵の場合「ゲームを描画するカメラ」「UIだけを表示するカメラ」の二つに分けて描画し、「UIだけを表示するカメラ」にパーティクルを描画させることで実現していました。　ただしLWRPになりカメラのスタックが出来なくなったので、専用カメラが使用できません。よって異なる方法を考える必要があります。

　難しいのが、まず ScreenSpaceOverlay は使えません。UIの手前にパーティクルを描画出来ない為です。　　また ScreenSpace-Camera でも単純には上手くいきません。単純に処理すればUIがポストプロセスの影響を受けるので、特にカラーコレクションを使用すると盛大に色合いが変わってしまいます。またBloomやDOFの影響を受けるのはひどいです。同様にPlaneDistanceの設置でUIがステージにめり込む事もあり得ます。この設定をいくら小さくしても、手前で爆発するなど何らかの理由でUIよりステージオブジェクトが手前に描画される事があるのは問題でしょう。

f:id:tsubaki_t1:20191009223546p:plain — UIがポストプロセスの影響を受けてしまっているケース

f:id:tsubaki_t1:20191009223652p:plain — UIがステージにめり込んでしまっているケース。ScreenSpace-CameraだとPlaneDistance設定で起こりえる

PostProcessingの後にUIとパーティクルを描画する

　一番手っ取り早いアプローチは Custom Forward Render を使用して、UIとパーティクルを描画する事です。　このアプローチではUIをポストプロセスの影響を受けないようにしつつパーティクルをUIの手前に描画出来ます。また Screen Space Camera を使いつつもステージやキャラクターの後ろにUIが表示されるといった事も回避できます。
　この手順のアイディアは非常に単純で 任意のレイヤーに所属するオブジェクトを、ポストプロセスの後に描画しよう というものです。

　実際の手順はこんな感じです。

　まず最初にUIは ScreenSpace-Camera を使用する必要があります。 CanvasのRender ModeをScreen space-Cameraに設定します。またCanvas GameObjectのレイヤーはUIに設定します。パーティクルのGameObjectもUIに設定します。
　パーティクルをUIの手前に描画したいので、Order in Layerを使用してUIの手前にパーティクルを描画するように設定します。 UIの場合はCanvasに、パーティクルの場合はRendererにあります。

f:id:tsubaki_t1:20191009225200j:plain — Canvasの設定

f:id:tsubaki_t1:20191009225813p:plain — ParticleのOrder In layerを設定する場所

　レンダラー側の設定を行います。まずは Create > Rendering > ***Pipeline > Forward Renderer でCustom Forward Rendererアセットを作ります。その後、Lightweight Renderer Pipeline AssetのRender TypeをCustomに設定し、Custom Forward Rendererアセットを登録します。

f:id:tsubaki_t1:20191009230101p:plain — Custom Forward Rendererを作る

f:id:tsubaki_t1:20191009230506j:plain — Custom Forward Rendererを使用する設定

　次にCustom Forward Rendererの設定を行います。ここは少し手順が多いので、箇条書きします。

Default Layer Mask から UI を外す。
Render Features の + を押す。追加するパスは Rendere Object を選択
NameをUIに変更（任意）
EventをAfter Rendering に変更
Filters > Queue を Transparent に変更
Filters > Layer Mask で UI を選択
Override > Depth にチェックを入れ、Depth Test を Disabledに変更

f:id:tsubaki_t1:20191009231723g:plain — 手順

これでUIの手前にパーティクルを描画出来ました。

UIの間にパーティクルを挟む

　今回の手順では描画順は完全にOrder In Layer順になっています。なのでパーティクルの所属するOrder In LayerをCanvasの間に挟んでやれば、UIとUIの間にパーティクルを挟む事も可能です。

f:id:tsubaki_t1:20191009232807j:plain — UIとUIの間にパーティクルを挟む

注意点

　これはあくまでもパーティクルがTransparentを使用している前提の使い方なので成立しています（つまりDepth Testを使用していない事が重要）。もしUIの手前に複数のSubMeshを持つオブジェクトを描画するといった場合はRenderTextureをオフスクリーンで描画する方が理にかなっていると言えるかもしれません。

　今回の手順はURPでも使用できました。HDRPは不明です。

　ScreenSpace-Cameraを使用する関係上、編集する場合にはPrefabモードが便利です。ただし、その場合ScreenSpace-Overlayになるので（PrefabからScene上のカメラを参照出来ない為）描画順回りは少し混乱するかもしれません。

　カメラのスタックはロードマップには載っているみたいです。現状は未実装なので、このトリックが必要という感じで。

2019-07-16

【Unity】2019.2で追加されたTryGetComponentについて

Unity2019.2 何の役に立つのかよく分からんシリーズ Unity C#

f:id:tsubaki_t1:20190716231235j:plain

Unity 2019.2から、TryGetComponentというAPIが追加されました。何時も通りGetComponentで取得する際、なんか見覚えがないAPIがあってビビったのはここだけの話。

TryGetComponent
パフォーマンスは？

TryGetComponent

今まで「コンポーネントが割り当てられていない状態」を取得する場合、とりあえず GetComponent で取得して中身がNullかどうかを確認するというのが常套手段でした。

            var component = array[i].GetComponent<SampleComponent>();
            if (component != null)
                component.Value++;

TryGetComponentは、戻り値にコンポーネントを取得できたかを確認してくれます。例えば上と同じ動作は、下のように記述出来ます。

            if( TryGetComponent(out SampleComponent comp))
                comp.Value++;

パフォーマンスは？

パフォーマンスですが、GetComponentで取得後にNullチェックするのと大して変わりません。これは「ビルド前後」「取得するコンポーネントの有無」に関わらずです。

試しに下のようなコードで毎フレーム1000個ほどGameObjectを複製してGetComponentした所、こんな結果になりました。エディターでTryGetComponent時に妙に遅いのを除けば、大体想定した感じの動きです。

        SampleComponent comp;

        Profiler.BeginSample("test_TryGetComponent");

        for (int i = 0; i < data.capacity; i++)
        {
            if( TryGetComponent(out  comp))
                comp.Value++;
        }

        Profiler.EndSample();

        Profiler.BeginSample("test_GetComponent");

        for(int i=0; i<data.capacity; i++)
        {
            var component = array[i].GetComponent<SampleComponent>();
            if (component != null)
                component.Value++;
        }

        Profiler.EndSample();