Unity HDRP Hole.ioのようなゲームを作りたい

Question

Unity HDRP2020.3.19f1にて、Hole.ioのようなゲームを作りたいです。

現状、下記動画（URP）を参考にしていますが、
https://www.youtube.com/watch?v=5qGE2PL9wwU
動画内16:52頃か説明されているRenderer Featuresの設定（HoleやHolemaskの描画順序を入れ替えて穴を表現する）
がHDRPでできません。

いろいろググった結果、HDRPの場合、CustomPass（GameObject > Volume > Custom Pass）で実装できるかと思いましたが、HoleMaskの部分だけHoleを前面に表示することができていない状態で行き詰りました。

解決手段もしくは解決糸口を探しております。
よろしくお願いします。

Answer 1

HDRPに疎いものでご参考程度ということでお願いしたいのですが、ご質問を拝見して調べてみたところ確かにCustom Pass機能を使うのが適切そうですね。

あらかじめ用意されているDraw renderers Custom Passとかいうものが、URPで言うところのRender Objectsに相当するもののように思われました。
ですが、どうやらRender Objectsと違ってステンシル設定をオーバーライドする機能はないようです。UserStencilUsageの説明を見ますに、どうやらUnityユーザーが自由に使えるステンシルビットは2つしかないんでしょうかね。
想像しますに、他のビットは複雑な描画を実現するためにHDRPの内部で使われていて、URPのように自由にオーバーライドすることを許してしまうとトラブルの原因になりやすい...みたいな事情があるのかもしれません。

代用品として下記HoleCustomPassスクリプトを用意し...

using UnityEngine;
using UnityEngine.Rendering;
using UnityEngine.Rendering.HighDefinition;
using UnityEngine.Rendering.RendererUtils;

public class HoleCustomPass : CustomPass
{
    private static ShaderTagId[] forwardShaderTags;

    // 描画対象とするオブジェクトのレンダーキュー
    public RenderQueueType queue = RenderQueueType.All;

    // マスク用パスの場合ShaderHoleMaskレイヤーを、穴用パスの場合ShaderHoleレイヤーを選択
    public LayerMask layerMask = 1;

    // オブジェクトの奥行き方向のレンダリング順序の設定
    public SortingCriteria sorting = SortingCriteria.CommonOpaque;

    // マスク用パスの場合、ここにチェックを入れておきます
    public bool mask = false;

    // マスクを書き込むビットを選択
    // たぶんUserBit0でいいかと思うのですが、もし他のシェーダーがUserBit0を
    // 使用している場合は、競合して描画不具合を起こすかもしれません
    // その場合はUserBit1を試してみてください
    public UserStencilUsage stencilBit = UserStencilUsage.UserBit0;

    protected override void Setup(ScriptableRenderContext renderContext, CommandBuffer cmd)
    {
        forwardShaderTags = new[]
        {
            HDShaderPassNames.s_ForwardName,
            HDShaderPassNames.s_ForwardOnlyName,
            HDShaderPassNames.s_SRPDefaultUnlitName
        };
    }

    // 地面の端より外から地面の下を見ると、地面の下に穴の内壁が伸びているのが
    // 見えてしまう現象を回避するため、URocks!さんのチュートリアルでは
    // パイプライン設定のFiltering→Opaque Layer Maskからレイヤーを除外して
    // いるようですが、HDRPだとどの設定があれに該当するのか分かりませんでした...
    // そこで、代わりにメインカメラのCulling Maskからマスク用・穴用レイヤーを
    // 除外しておき、ここでレイヤーマスクを追加してやることにしました
    // シーンビューだと相変わらず穴が地下に伸びてしまうでしょうが、メインカメラの
    // 映像ではマスク外に穴の内壁は描かれなくなるだろうと思います
    protected override void AggregateCullingParameters(ref ScriptableCullingParameters cullingParameters, HDCamera hdCamera)
    {
        cullingParameters.cullingMask |= (uint)(int)this.layerMask;
    }

    protected override void Execute(CustomPassContext ctx)
    {
        // ステンシル設定をオーバーライド、さらに穴用パスならデプス設定もオーバーライド
        var stateBlock = new RenderStateBlock(RenderStateMask.Stencil | (this.mask ? 0 : RenderStateMask.Depth))
        {
            // URocks!さんのチュートリアルではリファレンス値を1にしていますが、
            // 代わりに全ビット1として...
            stencilReference = ~0
        };

        // ステンシル値を読み取る・書き込むビットをstencilBitだけに制限しました
        var stencilState = new StencilState(readMask: (byte)this.stencilBit, writeMask: (byte)this.stencilBit);

        // マスク用・穴用についてそれぞれステンシル設定・デプス設定を編集し...
        if (this.mask)
        {
            stencilState.SetPassOperation(StencilOp.Replace);
        }
        else
        {
            stencilState.SetCompareFunction(CompareFunction.Equal);
            stateBlock.depthState = new DepthState(compareFunction: CompareFunction.Always);
        }
        stateBlock.stencilState = stencilState;

        // レンダリングを実行
        var renderConfig = ctx.hdCamera.frameSettings.IsEnabled(FrameSettingsField.Shadowmask)
            ? HDUtils.GetBakedLightingWithShadowMaskRenderConfig()
            : HDUtils.GetBakedLightingRenderConfig();
        var result = new RendererListDesc(forwardShaderTags, ctx.cullingResults, ctx.hdCamera.camera)
        {
            rendererConfiguration = renderConfig,
            renderQueueRange = this.GetRenderQueueRange(this.queue),
            sortingCriteria = this.sorting,
            excludeObjectMotionVectors = false,
            stateBlock = stateBlock,
            layerMask = this.layerMask
        };
        var renderCtx = ctx.renderContext;
        CoreUtils.DrawRendererList(ctx.renderContext, ctx.cmd, renderCtx.CreateRendererList(result));
    }
}

それをグローバルなCustom Pass Volumeにセットして穴マスクおよび穴の描画を担当させました。また、Obstaclesの追加描画にはDraw renderers Custom Passを使用しました。

すみませんが、コード中のコメントでも申し上げたようにURPのFiltering→Opaque Layer Maskに相当するものを見つけられず、代わりにメインカメラのCulling Maskから穴レイヤーを除外しています。
ついでに穴マスクもメインのレンダリングパスで描画する必要はなさそうに思いまして、併せて除外しました。

これらの処置を加えたところ、穴の見た目は下図のようになりました。

引き続きチュートリアルを続行し、最終的に下図のような穴になりました。

Comments

[john9999]

丁寧なご回答ありがとうございます。
早速試してみましたが、いくつか分からなかったのでご教授ください。

①HoleCustomPassのコードをそのまま流用しましたが、4行目の
　using UnityEngine.Rendering.RendererUtils;
　にて、「型または名前空間の名前 'RendererUtils' が名前空間 'UnityEngine.Rendering' に存在しません」のエラーになってしまいました。
　名前空間についてあまり理解できておらず…、どのようにすれば解決できそうでしょうか？

②HoleCustomPass作成後の、「それをグローバルなCustom Pass Volumeにセット」が具体的にどのような操作でしょうか？

[Bongo]

①について

すみませんでした。ご指摘を受けて確認してみましたら、ご質問者さんがお使いの2020.3.19f1の時点ではまだ正式導入されていない機能を使ってしまっていたようです。
まずコード冒頭の

using UnityEngine.Rendering.RendererUtils;

を

using UnityEngine.Experimental.Rendering;

に変更し、さらにExecuteメソッド末尾の

var renderCtx = ctx.renderContext;
CoreUtils.DrawRendererList(ctx.renderContext, ctx.cmd, renderCtx.CreateRendererList(result));

を

CoreUtils.DrawRendererList(ctx.renderContext, ctx.cmd, RendererList.Create(result));

に変更してもう一度お試しいただけますでしょうか。

②について

あれは、まずご質問者さんがおっしゃった通りにメニューの「GameObject」→「Volume」→「Custom Pass」でカスタムパスボリュームをつくったのち、そのCustomPassVolumeコンポーネントの「Mode」を「Global」に設定することを意図しておりました。
「Local」の場合ですと、さらにオブジェクトにコライダーを付けることでコライダー内にカメラが侵入した場合だけカスタムパスが効果を発揮するように作ることもできるみたいですね。ですが、今回のケースは常時カスタムパスを実行してほしいので「Global」を選びました。