ComputeShader on ながむしメモ

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();
}