【UE5】Visualizerを追加してみた

水ノ茉の宣伝
作業環境
始まり
リポジトリ
エンジン改造のルールと前提の改造
実装
動作確認
見て見て

水ノ茉の宣伝

叡智でえっちな同人作品を予定中…

Ci-en R18

作業環境

Windows 10
Visual Studio 2022
Visual Studio Code
Unreal Engine 5.3

始まり

筆者さんは多少なりともエンジン改造慣れしているので、RenderDocで見ればいいじゃん、としか思わないのですが、5.3からなーんかSky系のLUTまわりがnullでRenderDocキャプチャするとクラッシュすることがあります。（2024/01/02時点。）

Epicさん描画まわりは結構やらかしているので今更気にならないですが。（ムカつきはする。）

開発機材がつよつよなのでクラッシュしても爆速再起動すりゃいいんですが、この機会にVisualizerを実装してみます。

リポジトリ

Unreal Engine 5.3
- https://github.com/kafues511/UnrealEngine/tree/ppi-shadow-map-visualizer/5.3/Engine
- https://github.com/kafues511/UnrealEngine/releases/tag/ppi-shadow-map-visualizer-5.3

エンジン改造のルールと前提の改造

Visualizerで可視化するリソースはシャドウマップをポストプロセスで扱えるようにしてみたで追加したリソースです。そのため、前提としてその改造が必要です。改造のルールもそこに記載してあるため併せて確認してください。

実装

適当に実装していきます。

Engine/Source/Runtime/Engine/Public/ShowFlagsValues.inl

シャドウマップの可視化変数VisualizeShadowProjectionを定義します。

githubで実装を見る（L445-L448）

Engine/Source/Runtime/Engine/Public/ShowFlags.h

FEngineShowFlagsの初期化関数の対応をします。その他の有効、無効化関数も対応するべきですが、面倒なので省きます。

githubで実装を見る（L493-L495）

Engine/Source/Runtime/Renderer/Private/PostProcess/PostProcessing.cpp

PostProcessパス群にシャドウマップのVisualizerパスを追加します。

githubで実装を見る（L73-L75）
githubで実装を見る（L394-L396）
githubで実装を見る（L448-L455）
githubで実装を見る（L504-L506）
githubで実装を見る（L1643-L1655）

Engine/Source/Runtime/Renderer/Private/PostProcess/VisualizeShadowProjection.h

Visualizerパスを生成するために必要な情報を格納するFVisualizeShadowProjectionInputsを定義しています。

githubで実装を見る（L1-L28）

Engine/Source/Runtime/Renderer/Private/PostProcess/VisualizeShadowProjection.cpp

Visualizerパスやシェーダーまわりです。後述しますが初めて作成したVisualizer機能、あんまり面白くなかったので、シェーダーの読込やパス生成についての詳細は割愛します。そのうち少し昔のモンハンのポストプロセスなファーシェーダーとかも作る予定なので、その時に気分が乗ったら紹介しますね。気分屋さんの唯一の欠点、情緒というか火力というか興味がとても不安定。

githubで実装を見る（L1-L76）

Engine/Shaders/Private/VisualizeShadowProjection.usf

シャドウマップのVisualizerシェーダーです。VertexShaderの実装がないですが、AddDrawScreenPass関数を使用する場合はデフォルトの頂点シェーダーが使用されるためです。UVAndScreenPosには、動的解像度やシーケンサ―でビューをした際の左右や上下の余白（黒い帯とか）を考慮したUVが格納されています。これ便利なんですよね。5.2とかだとモバイルレンダラーは呼び出せないとか制限があったような気がしますが、過去の話なのでうろ覚えです。（しかもクラッシュするのは実機だけね、Editorのモバイルプレビューだと表示できちゃうの。内部的にはDirectXで描画してるから。）

githubで実装を見る（L1-L19）