UnrealC++ on ながむしメモ

UE5.2でC++プロジェクトのビルド時間が増加した問題の対処 [UE][UE5.2]

Sat, 10 Jun 2023 22:17:12 +0900

UE5.1からUE5.2へアップデートしてから, C++プロジェクトのビルド時間が5倍以上に増えて困った.

ソースコードを色々書き換えて調べたところ,

GlobalShader派生クラスへのSRV, UAV設定関数をフラットに記述する数が大きく影響

というところまでわかったのでメモ.

私と同じ沼にハマったひとの役にたてば幸い.

具体的には以下のUtil関数が該当

RenderCore/Public/ShaderParameterUtils.h
SetSRVParameter()
SetUAVParameter()

これらを一つの関数内で直接大量に(フラットに)記述するとビルド時間が大きく増加する模様.
対策としては Shader単位等で関数化してそれを呼び出すような記述 とするとUE5.1以前と同じくらいのビルド時間だった.

// ビルド時間が増えるパターン 100個くらい並んでました.
void MainFunc()
{
 // 全てのShaderに対するSetSRV/SetUAVをフラットに記述.
 SetSRVParameter(ShaderA, SRV);
 SetSRVParameter(ShaderA, SRV);
 SetUAVParameter(ShaderA, UAV);
 SetUAVParameter(ShaderA, UAV);
 ...
 SetSRVParameter(ShaderZ, SRV);
 SetSRVParameter(ShaderZ, SRV);
 SetUAVParameter(ShaderZ, UAV);
 SetUAVParameter(ShaderZ, UAV);
}

エンジン側のソースコードを見るとシェーダ毎等で関数に分けていたため,
そのように書き直したところビルド時間が以前と同じくらいになった.

// ビルド時間が増えないパターン.
void SetParamShaderA()
{
 SetSRVParameter(ShaderA, SRV);
 SetSRVParameter(ShaderA, SRV);
 SetUAVParameter(ShaderA, UAV);
 SetUAVParameter(ShaderA, UAV);
 ...
}
...
void SetParamShaderZ()
{
 SetSRVParameter(ShaderZ, SRV);
 SetSRVParameter(ShaderZ, SRV);
 SetUAVParameter(ShaderZ, UAV);
 SetUAVParameter(ShaderZ, UAV);
 ...
}
void MainFunc()
{
 // Shader毎のSRV/UAV設定メソッドを記述.
 SetParamShaderA(...);
 ...
 SetParamShaderZ(...);
}

私のプロジェクトでは前者の場合 8分前後かかっていたものが, 後者に修正したところ 1分前後に短縮された.

TextureArrayに対して実行可能なDrawMaterialToRenderTargetプラグイン[UE][Plugin]

Mon, 16 Jan 2023 08:00:00 +0900

TextureRenderTarget2DArray のSlice(配列の要素)を指定して DrawMaterialToRenderTarget ができるUEプラグインの公開.

これは何
導入
- リポジトリの NglTextureRt2dArrayUtil をコピー
- プラグインが読み込まれているか確認
サンプル
最後

これは何

テクスチャ配列アセットの要素に対してマテリアル描画を実行できるプラグイン.
UE標準のDrawMaterialToRenderTargetノードとほぼ同じで, TextureRenderTarget2DArrayとその何番目にDrawするかを指定できる.

NglDrawMaterialToRenderTargetArraySliceノード

内部で一時テクスチャの生成やコピーをする必要があったため, ゲーム中にリアルタイム利用するような用途向きではない点に注意.

エンジン改造無しで実装するためにこうなったが今後修正できるかもしれない(未定),

動作確認 UE5.1 Win64

導入

リポジトリの NglTextureRt2dArrayUtil をコピー

ue_plugin/distribution/NglTextureRt2dArrayUtil at main · nagakagachi/ue_plugin · GitHub

自身のプロジェクトに Plugins ディレクトリを作成し, その中に上記Githubの NglTextureRt2dArrayUtil ディレクトリをコピーペーストする.

プラグインが読み込まれているか確認

プロジェクトを開いて編集/プラグインのウィンドウを開き, NglTextureRt2dArrayUtilプラグインが有効になっていればOK.

サンプル

プラグインコンテンツのEditorUtilityWidget EUW_DrawToRenderTargetArraySample を右クリック->エディターユーティリティウィジットを実行で簡易サンプルが起動する

ウィンドウ左側にマテリアルと描画先Array要素番号(Slice Index)を指定.
ウィンドウ右側に書き込み先のTextureRTArrayアセットを指定。
Runボタンを押すとArray指定要素にマテリアル描画が実行される.

下図はWidgetでSlice 0番に対して実行して, エディタでTextureRTArrayの Slice 0 を表示して結果を確認している様子.

出来上がったTextureRtArrayをテクスチャ配列アセットに変換するなどご自由に.

最後

役にたった場合はGithubのStarや使ったよというメッセージを貰えると嬉しいです!

そもそも作った理由はエディタでマテリアルを使って自由に色々なテクスチャ配列を作りたかったため.

面白い使い方やもっと良い機能案があればご連絡ください.

以上…

MainViewのViewportSizeとカメラ位置,カメラ姿勢の取得

Sat, 06 Nov 2021 20:13:54 +0900

UE4.27で確認

// Get Current View Info (EditorMode, PlayMode).
auto GetCurrentViewportInfo = [](const UWorld* world, FVector2D& out_viewport_size, FVector& out_view_location, FQuat& out_view_quat)
{
 if (!world)
 return;

#if WITH_EDITOR
 if (world->WorldType == EWorldType::Editor || world->WorldType == EWorldType::EditorPreview)
 {
 // EditorMode.
 // Use First Editor Viewport.
 for (FLevelEditorViewportClient* level_viewport_clients : GEditor->GetLevelViewportClients())
 {
 if (level_viewport_clients && level_viewport_clients->IsPerspective())
 {
 out_viewport_size = level_viewport_clients->Viewport->GetSizeXY();
 out_view_location = level_viewport_clients->GetViewLocation();
 out_view_quat = level_viewport_clients->GetViewRotation().Quaternion();
 break;
 }
 }
 }
 else
#endif
 {
 // Non EditorMode.
 // Use First PlayerCamera.
 if (auto* camera_manager = UGameplayStatics::GetPlayerCameraManager(world, 0))
 {
 GEngine->GameViewport->GetViewportSize(out_viewport_size);
 out_view_location = camera_manager->GetCameraLocation();
 out_view_quat = camera_manager->GetCameraRotation().Quaternion();
 }
 }

 return;
};

const UWorld* world = [ワールド];
FVector2D out_viewport_size;
FVector out_view_location;
FQuat out_view_quat;
// Get Info.
GetCurrentViewportInfo(world, out_viewport_size, out_view_location, out_view_quat);

元のはてなブログ記事

ProjectRoot直下のShadersディレクトリをShaderIncludePathに追加するだけのPlugin [UE4]

Wed, 18 Aug 2021 08:30:00 +0900

これはなに
置き場所
使い方
エラーメッセージ
参考資料

これはなに

プロジェクトルート/Shaders をUEのShaderIncludePathに自動追加するプラグイン.
UE4.25辺りからマテリアルのCustomノードで Include File Paths を指定して外部シェーダファイルをインクルードして利用できるようになったが,インクルードパスの設定が面倒だったので勉強ついでに自分用自動化プラグインを作成した.

置き場所

github.com

使い方

1. zipを解凍してできたNglShaderIncludePluginを ProjectRoot/Plugins にコピー.
2. ProjectRoot/Shaders ディレクトリにCustomノードで使いたい ush を配置.

// テストで用意した IncludeTest.ush というファイル
#pragma once
float3 Func00()
{
 return float3(1.0, 0.0, 0.0);
}

3. マテリアルのCustomノードの Include File Paths に "/Project/filename.ush" を入力.

Customノード例

4. Customノードでインクルードしたushの関数などが利用できるようになる.

エラーメッセージ

UEプロジェクト起動時に Shaders ディレクトリが存在しないと以下のような警告がログに出力されるのでディレクトリを作成するように.

LogTemp: Warning: [FNglShaderIncludePluginModule] directory [ProjectRoot/Shaders] does not exist.

UE4 ComputeShader Write, Material Read (GPGPU)

Fri, 20 Mar 2020 06:00:00 +0900

エンジンバージョン:4.24 (4.25がリリースされたら対応予定)

はじめに
サンプルコード
説明
サンプルコードの概要

ComputeShaderで計算した結果を、RWテクスチャを利用してダイレクトにマテリアルで利用する。↓はサンプルコードの実行の様子。

ﾜｻﾜｻﾜｻ

記事用のサンプルはもうこれでいいか（妥協#UE4Study pic.twitter.com/qCDI2oPJHr
— なが (@nagakagachi) 2020年3月19日

はじめに

前回の記事ではComputeShaderでメッシュ情報を直接生成する方法を紹介した。前回記事の手法では頂点カラー等を利用することでComputeShaderからマテリアルへ追加情報を渡すことができる。しかし頂点データの一部を間借りすることから渡せる情報に制限がある。
当記事ではComputeShaderが書き込みをしたRWテクスチャをそのままマテリアルで利用することで頂点データ利用に比べてより自由に情報を受け渡す方法を検証してうまくいったので公開。そもそもこんな面倒なことしなくても可能な方法があるかもしれないので注意。
(GlobalShader利用, エンジン改造無し)

サンプルコード

uprojectファイルを右クリック→Generate Visual Studio project files でプロジェクトコード生成.
github.com

説明

RWテクスチャ定義

マテリアルで利用可能且つComputeShaderで書き込みが可能なUAVリソースとしてのテクスチャが必要であるため、UTextureRenderTarget2Dを継承したRWテクスチャを定義する。
bCanCreateUAVにtrueを指定することでリソース自体がUAV利用可能な設定で作成される。ただしこの設定だけではUAVが作成されないため(メンバ変数uav_)、RWテクスチャとして利用するComputeShader処理側で必要なときに生成する(後述)。
また、UAVの破棄はRenderThreadで処理する必要があるのでデストラクタでRenderThreadのコマンドとして発行している。

// UavTextureSampleComponent.h
UCLASS(BlueprintType)
class UNglRWTextureRenderTarget2D : public UTextureRenderTarget2D
{
	GENERATED_UCLASS_BODY()
public:
virtual ~UNglRWTextureRenderTarget2D();
FUnorderedAccessViewRHIRef uav_;

};

// UavTextureSampleComponent.cpp
UNglRWTextureRenderTarget2D::UNglRWTextureRenderTarget2D(const FObjectInitializer& ObjectInitializer)
: Super(ObjectInitializer)
{
bNeedsTwoCopies = false;
// リソース生成時にUAV利用可能な設定で作成することを指示
bCanCreateUAV = true;
}
UNglRWTextureRenderTarget2D::~UNglRWTextureRenderTarget2D()
{
if (uav_.IsValid())
{
// UAVの破棄
// 破棄は描画スレッドで実行する必要があるのでコマンドをキューに積む.
auto rhi_resource = uav_;
ENQUEUE_RENDER_COMMAND(UpdateResourceImmediate)(
[rhi_resource](FRHICommandListImmediate& RHICmdList)
{
rhi_resource->Release();
}
);
}
}

RWテクスチャのUAV生成

本来ならUTextureRenderTarget2Dの初期化フローの中で生成するのが理想だが、今回はUAV利用する側が生成することにした。

// UavTextureSampleComponent.cpp 252行目
if (!rw_tex->uav_.IsValid())
{
	rw_tex->uav_ = RHICreateUnorderedAccessView(rw_tex->Resource->TextureRHI);
}

ComputeShaderによるRWテクスチャへの書き込み

生成したUAVはComputeShaderパラメータに設定することで利用可能。

// UavTextureSampleComponent.cpp 271行目
SetUAVParameter(RHICmdList, rhi_cs, cs->rw_tex, rw_tex->uav_);

RWテクスチャのマテリアルでの利用

UNglRWTextureRenderTarget2Dは通常のUTextureオブジェクトと同様にマテリアルパラメータに設定可能。これでComputeShaderで書き込みをしたRWテクスチャをそのままマテリアルで利用できる。

UE4 ComputeShaderでMeshの頂点バッファをリアルタイム書き換えする (GPGPU)

Sun, 22 Sep 2019 22:26:04 +0900

エンジンバージョン:4.22, 4.23

諸事情によりサンプルプロジェクト無し

UE4のProceduralMeshのようなことをComputeShaderでできたら、大量の頂点をリアルタイムに操作できて面白いのではないかという思い付き。
今回はたくさんの草をリアルタイムに生成する目的で実装してある程度うまくいったのでメモ。
この方法を応用すれば頂点カラーとかにInstanceID的なものやそのほか特殊な情報を埋め込んでおいてマテリアルBPで利用するといったこともできる。

この記事はC++とGlobalShaderを利用したもので、且つエンジン改造はしない。
また、自前で用意した頂点バッファをComputeShaderで書き換えてUE4のメッシュ描画に流す方法がメインであるため、実装したComputeShader自体については深く説明しない。

www.youtube.com
↑プレイヤーからの影響を草一本一本が受ける例。
草の位置や基準方向などを構造化バッファで保持しているのでそれらをComputeShaderで更新すればこのようなことも可能。
www.youtube.com
↑さらにマテリアルBP側で頂点オフセットによる風揺れをつけた例。
描画自体はUE4のメッシュ描画に乗っかっているのでStaticMesh等と同じようにマテリアルが使えるのが強みの一つ。

基本の考え

自分で作成した頂点バッファやインデックスバッファをUE4のメッシュ描画に流し込む方法は意外と簡単で、FPrimitiveSceneProxy派生クラスでGetDynamicMeshElements()関数をoverrideして適切にバッファ情報を渡せば可能になる。
そこでこれらのバッファをUnorderedAccess可能な設定で作成しておき、毎フレームComputeShaderで書き換えるようにすることで、形状をリアルタイムに変更しつつマテリアル等を含めた描画部分はUE4の仕組みをそのまま利用できると考えた。

フローのイメージ

必要な要素の概要

自作ComputeShader用GlobalShader
- 自作MeshProxyが生成した頂点バッファUAVやインデックスバッファUAVへ読み書きして草メッシュを作る
- 草メッシュの位置や向きは別途StructuredBufferで与える
自作MeshComponentクラス
- 対になる自作MeshProxyを生成してシステムに登録し、ゲーム側からの情報を通知する役割
自作MeshProxyクラス
- 自作MeshComponentの描画スレッド側における分身のような存在
- UnorderedAccess可能な各種頂点バッファとインデックスバッファおよびそれらのUAVを作成する
- UE4メッシュ描画システムのメッシュ情報収集に適切に頂点バッファなどを設定する
- ComputeShaderのDispatchコマンド発行もする

自作ComputeShader用GlobalShader

自作MeshProxyの各バッファのUAVを設定して書き換えるComputeShaderのGlobalShader。
GlobalShader自体については公式のドキュメントを参考。
https://docs.unrealengine.com/ja/Programming/Rendering/ShaderInPlugin/QuickStart/index.html
ComputeShaderをGlobalShaderとして作成してUAV他パラメータを設定する流れについては以下のブログが参考になる。
[UE4][ComputeShader][HLSL][C++]Unreal Engine 4で(RW)StructuredBufferを用いたComputeShaderを利用する（その２：C++側シェーダクラス） – サイアメント技術メモ

今回はComputeShaderのスレッド一つが草一本を担当することとし、スレッドIDと草一つに割り当てられた頂点数からスレッドが書き込む頂点バッファ内の位置を決めている。あまり特殊なことはしていないが、接線法線頂点バッファ等がPackedフォーマットになっている場合はUAVから読み取った値をUnpackしたり書き戻す際に再度Packしたりといった処理が必要な点に注意。

ComputeShaderの処理イメージ

自作MeshComponentクラス

UPrimitiveComponentを継承
コンポーネントとしてゲームスレッド側の情報を管理する。UProceduralMeshComponentを参考にした。
コンポーネントの描画スレッド側の情報を管理するカスタムMeshProxyクラスを生成して保持し、適切に情報を渡したりするのが主な役目。
適切なタイミングで自作MeshProxyへComputeShaderのDispatchコマンド生成をリクエストをする。

virtual void UComputeMeshComponent::TickComponent(float DeltaTime, enum ELevelTick TickType, FActorComponentTickFunction *ThisTickFunction) override
{
 // SendRenderDynamicData_Concurrent の呼び出しをリクエスト
 MarkRenderDynamicDataDirty();
}
virtual void UComputeMeshComponent::SendRenderDynamicData_Concurrent() override
{
 // カスタムMeshProxyにComputeShaderのDispatchコマンド生成を要求
 カスタムMeshProxy->EnqueueDispatchComputeShader();
}

UE4 翻訳メモ Mesh Drawing Pipeline Conversion Guide for Unreal Engine 4.22

Thu, 18 Apr 2019 15:05:22 +0900

4.22で大幅に変更されたらしいメッシュ描画パイプラインのドキュメントをGoogle翻訳先生の力を借りて翻訳しつつメモ

docs.unrealengine.com

より詳細は
docs.unrealengine.com
や
www.youtube.com
を参照

Introduction

Unreal Engine（UE4）4.22リリースでは、Mesh Drawing Pipelineは完全に書き直されました。主な変更点は、フレーム毎に描画の準備をするImmediate Mode からすべてのシーン描画が事前に準備される Retained Mode に移行したことです。これは、シーン全体のシェーダバインディングテーブルを必要とするDirectX Raytracing（DXR）や、CPUが可視性の情報無しに描画の準備をする必要がある GPU-Driven-Rendering など、今後のテクノロジをサポートできるようになるための重要な変更です。

UE4 4.22でのMesh Drawing Pipelineの変更についての詳細は、Mesh Drawing PipelineのドキュメントおよびGame Developer's Conference（GDC）のプレゼンテーションUnreal Engine 4.22用Mesh Drawing Pipelineのリファクタリングを参照してください。

UE4 TArrayのSetNumZeroedふるまいメモ

Sun, 26 Aug 2018 16:38:03 +0900

UE4.20.2

UE4のCodePluginでTArrayを多用していていつもSetNumZeroedの挙動を忘れるのでメモ

TArray::SetNumZeroed(NewSize, bAllowShrinking)

SetNumZeroed()によって要素数が増える場合
- ゼロ値要素が末尾に付加される。元の要素は変化しない。

TArray<float> testArray;
testArray.Add(1.0f);
testArray.Add(2.0f);
testArray.Add(3.0f); // { 1.0, 2.0, 3.0 }
testArray.SetNumZeroed(5); // { 1.0, 2.0, 3.0, 0.0, 0.0 }

SetNumZeroed()によって要素数が減る場合
- 単純に切り詰められる。元の要素は変化しない。

TArray<float> testArray;
testArray.Add(1.0f);
testArray.Add(2.0f);
testArray.Add(3.0f); // { 1.0, 2.0, 3.0 }
testArray.SetNumZeroed(1); // { 1.0 }

関係ないけどTArrayの要素を指定した値（ゼロとか）にするメソッドがほしい
（ないよね？）

元のはてなブログ記事