深夜開発

一度書いたコードを忘れないように保存しておく場所です

UE内で管理されているアセット情報をC++で取得する

UnrealEngine

UE内で管理されているアセットへのC++を使ったアクセス

UE内で管理されているアセットへの基本的なアクセスにはIAssetRegistryクラスを使用するのがとても簡単 UEditorAssetLibraryクラスやUEditorLoadingAndSavingUtilsクラスを併用する事でほぼすべての操作がC++上から実行できる。 ただし、これらの機能はエディタ有効時（#if WITH_EDITOR ～ #endifブロック内）にしか使用することはできない。

github.com

依存モジュールの追加

UEditorAssetLibraryクラスやUEditorLoadingAndSavingUtilsクラスを使用する場合、EditorScriptingUtilitiesやUnrealEdといった依存モジュールをプロジェクトに追加する必要がある。

プロジェクトのビルド設定スクリプト（???.Build.cs)に以下のようにして依存モジュールを追加する

using UnrealBuildTool;
using UnrealBuildTool.Rules;

public class UEAssetUtility : ModuleRules
{
    public UEAssetUtility(ReadOnlyTargetRules Target) : base(Target)
    {
        PCHUsage = PCHUsageMode.UseExplicitOrSharedPCHs;
    
        PublicDependencyModuleNames.AddRange(new string[]
        {
            "Core",
            "CoreUObject",
            "Engine",
            "InputCore"
        });

        PrivateDependencyModuleNames.AddRange(new string[]
        {
            "EditorScriptingUtilities", // 追加
            "UnrealEd" // 追加
        });
    }
}

アセットの検索

AFRFilterを使って、

  • 検索するパス
  • 検索するクラス型
  • 再帰的に検索するのか？

などの条件を細かく指定する事が可能。 GetAssets関数は検索条件に引っかかったアセットをTArrayコンテナで一挙に受け取ることができる。

FARFilter Filter;

// 指定したパス以下のアセットを取得
Filter.PackagePaths.Add(FName(TEXT("/Game/Common")));
Filter.PackagePaths.Add(FName(TEXT("/Game/Levels")));

// 指定したクラス型名のアセットを取得
Filter.ClassPaths.Add(USkeletalMesh::StaticClass()->GetClassPathName());
Filter.ClassPaths.Add(UStaticMesh::StaticClass()->GetClassPathName());

Filter.bRecursivePaths = true;   // Trueなら、PackagePathsで指定したパス以下を再帰的に検索する
Filter.bRecursiveClasses = true; // Trueなら、ClassPathsで指定したクラスの派生クラスも検索する

TArray<FAssetData> OutAssetData;
if (IAssetRegistry::Get()->GetAssets(Filter, OutAssetData))
{
    int32 Index = 0;
    for (auto& AssetData : OutAssetData)
    {
        const FString AssetName = AssetData.AssetClassPath.GetAssetName().ToString();
        const FString PackageName = AssetData.PackageName.ToString();

        UE_LOG(LogTemp, Log, TEXT("Found asset[%d]: '%s' %s"), Index++, *AssetName, *PackageName);
    }
}

アセットを一挙に受け取るのではなく、見つかったアセットを個別評価するEnemerateAssets関数も存在する

FARFilter Filter;

// 指定したパス以下のアセットを取得
Filter.PackagePaths.Add(FName(TEXT("/Game/Common")));
Filter.PackagePaths.Add(FName(TEXT("/Game/Levels")));

// 指定したクラス型名のアセットを取得
Filter.ClassPaths.Add(USkeletalMesh::StaticClass()->GetClassPathName());
Filter.ClassPaths.Add(UStaticMesh::StaticClass()->GetClassPathName());

Filter.bRecursivePaths = true;   // Trueなら、PackagePathsで指定したパス以下を再帰的に検索する
Filter.bRecursiveClasses = true; // Trueなら、ClassPathsで指定したクラスの派生クラスも検索する

int32 Index = 0;
IAssetRegistry::Get()->EnumerateAssets(Filter, [&Index](const FAssetData& AssetData)
{
    const FString AssetName = AssetData.AssetClassPath.GetAssetName().ToString();
    const FString PackageName = AssetData.PackageName.ToString();

    UE_LOG(LogTemp, Log, TEXT("Found asset[%d]: '%s' %s"), Index++, *AssetName, *PackageName);
});

パッケージが存在しているか調べる

指定したパッケージが、UE管理内アセット中に存在するかを判定する。 FPackageName::DoesPackageExist関数では、未だディスクに保存されていないOnMemoryなパッケージは判定されないようなので、その際はIAssetRegistry::TryGetAssetByObjectPathなどと使い分けるとよい

const FString PackageName(TEXT("/Game/Common/Materials/MI_BaseColorAndNormal"));

if (FPackageName::DoesPackageExist(PackageName))
{
    // PackageNameで指定されたパッケージが見つかった
    UE_LOG(LogTemp, Log, TEXT("Package %s already exists"), *PackageName);
}
else
{
    // PackageNameで指定されたパッケージが見つからなかなった
    UE_LOG(LogTemp, Log, TEXT("Package %s was not found"), *PackageName);
}

パッケージが依存しているアセットを全て取得

指定したパッケージが依存しているアセット（例えばマテリアルインスタンスアセットならば親マテリアルアセットなど）を全て取得する。 IAssetRegistry::GetDependenciesで取得できるのは依存先アセットのパッケージ名なので、FAssetDataが必要ならばパッケージ名を使ってIAssetRegistry::GetAssetsなどで取得する。

const FName PackageName(TEXT("/Game/Common/Materials/MI_BaseColorAndNormal"));

TArray<FAssetIdentifier> OutDependencies;
if (IAssetRegistry::Get()->GetDependencies(FAssetIdentifier(PackageName), OutDependencies))
{
    int32 Index = 0;
    
    // 見つかった依存先アセットを全て列挙
    for (const auto& DependencyAsset : OutDependencies)
    {
        if (DependencyAsset.PackageName != NAME_None)
        {
            UE_LOG(LogTemp, Log, TEXT("Found dependency asset[%d]: %s"), Index++, *(DependencyAsset.PackageName));
        }
    }
}

パッケージが参照しているアセットを全て取得

指定したパッケージが参照しているアセット（例えばマテリアルアセットならば子マテリアルインスタンスアセットやテクスチャアセットなど）を全て取得する。

const FName PackageName(TEXT("/Game/Common/Materials/MI_BaseColorAndNormal"));

TArray<FAssetIdentifier> OutReferencers;
if (IAssetRegistry::Get()->GetReferencers(FAssetIdentifier(PackageName), OutReferencers))
{
    int32 Index = 0;

    // 見つかった参照先アセットを全て列挙
    for (const auto& ReferenceAsset : OutReferencers)
    {
        if (ReferenceAsset.PackageName != NAME_None)
        {
            UE_LOG(LogTemp, Log, TEXT("Found reference asset[%d]: %s"), Index++, *(ReferenceAsset.PackageName));
        }
    }
}

アセットの複製

指定したアセットを複製する。 参照しているアセットなどは複製元と同じものとなるため、参照アセットごと複製する場合には全ての参照アセットに対して、

  1. 参照アセットの複製
  2. 複製した参照アセットへの差し替え

を行っていく必要がある。

const FString SrcPackageName(TEXT("/Game/Common/Materials/MI_BaseColorAndNormal"));
const FString DstPackageName(TEXT("/Game/Level/Materials/MI_BaseColorAndNormal"));

// SrcPackageNameで指定されたパッケージを、DstPackageNameで指定された場所へ複製する
UObject* DstObject = UEditorAssetLibrary::DuplicateAsset(SrcPackageName, DstPackageName);
if (IsValid(DstObject))
{
    UE_LOG(LogTemp, Log, TEXT("Duplicate asset: %s -> %s"), *SrcPackageName, *DstPackageName);
}
else
{
    UE_LOG(LogTemp, Warning, TEXT("Failed to duplicate asset: %s -> %s"), *SrcPackageName, *DstPackageName);
}

RenderDocを使ったUnrealEngineプロジェクトのGPUデバッグ

UnrealEngine

RenderDocのインストール

  1. RenderDocインストーラを公式からダウンロード
  2. ダウンロードしたインストーラを実行
    • ※UnrealEngineを終了してからインストールを行う事
  3. セットアップウィザードが起動するのでNextをクリック
  4. I accept the terms in the License AgreementをチェックしてNextをクリック
  5. 個別設定をしないのならばTypicalまたはCompleteを選択後、Nextをクリック
  6. インストール設定に問題が無ければInstallをクリック
  7. インストールが完了したらFinishをクリック

UnrealEditor上からRenderDocを使う

  1. プラグイン設定を開く
  2. RenderDocプラグインを有効化
    1. RenderDocで検索
    2. プラグインにチェック
    3. 今すぐ再起動でエディタを再起動する
      RenderDocプラグインを有効化
  3. RenderDocプラグインの初期設定を行う
    1. プロジェクト設定を開く
      • メニュー『編集』→『プロジェクト設定』
      • ツールバー『設定』→『プロジェクト設定』
    2. 『プラグイン』→『RenderDoc』→『詳細設定』を開く
    3. スタートアップ時に自動アタッチにチェック
      • UnrealEditorの起動引数に-AttachRenderDocを追加することでも有効化可能
    4. RenderDoc実行ファイルパスにRenderDocをインストールしたパスを設定
      • RenderDocインストール時、特に変更していなければ C:\Program Files\RenderDoc となっているはず
    5. エディタを再起動する
      RenderDocの詳細設定
  4. 有効化されたRenderDocを使ってシーンキャプチャを行う
    • 右上のRenderDocアイコンをクリックしてキャプチャ
    • コンソールコマンドrenderdoc.CaptureFrameを実行してキャプチャ
      キャプチャフレーム
  5. キャプチャに成功すれば自動的にRenderDocが起動する

パッケージ上からRenderDocを使う

  1. RenderDocを起動し、Launch Applicationタブを開く
    LaunchApplicationタブを開く
  2. Executable Pathにプロファイルを行うアプリケーションの実行ファイルを指定し、Launchをクリックして起動
    • 作業ディレクトリを実行ファイルと別の場所を指定する場合のみ、Working Directoryを設定
    • 必要があれば起動引数をCommand-line Argumentsへ指定
      • 複数のRHIを含んだパッケージ作成していれば、起動引数から使用するRHIを指定可能
        • DirectX11: -d3d11
        • DirectX12: -d3d12
        • Vulkan: -vulkan
    • 通常UnrealEngineで作成したパッケージの場合、『Capture Option』→『Capture Child Processes』にチェックを入れる
      起動する
  3. 起動すると親プロセスタブが開くので、『Child Process』→『[ProjectName].exe [PID ???]』をダブルクリックして子プロセスのタブ開く
    子プロセスを開く
  4. 任意のタイミングで『Tools』→『Capture Frame(s) Immediately』をクリックするか、ゲーム画面上からF12を押すと、Captures collectedにキャプチャした内容が列挙される。
  5. 『Captures collected』に列挙されたキャプチャをダブルクリックで開くことで、詳細を確認することが出来る

RenderDoc以外のGPUプロファイラ

RenderDocは大抵のGPUでデバッグできる反面、プロファイル用途として使用するには取得できる内部カウンタが不正確などといった欠点がある。 正確な内部カウンタを取得したい場合には、プロファイルを行いたい環境に合ったプロファイラを使ってください

  1. NVIDIA製品専用
  2. AMD製品専用
  3. Intel製品専用
  4. Windows専用
  5. Qualcomm Snapdragon(Adreno)専用
  6. Arm Mali専用

Win32 threadを使ったスレッド生成

並行・並列処理

Win32API

Microsoft Windows上で用いられるAPIで、スレッドに限らずあらゆる機能を提供する。 通常スレッドを生成するにはCreateThread関数を使用するが、諸事情で同じ機能を提供する_beginThread関数、AfxBeginThread関数なども存在する

Sample code

#include <stdio.h>
#include <windows.h>

#define STACK_SIZE (512 * 1024)

struct thread_args
{
    int r;
    int a;
    int b;
    int c;
}

// 生成したスレッドで実行する関数
UINT thread_entry(void *args) {
    auto targs = reinterpret_cast<thread_args*>(args);
    targs->r = targs->a * targs->b + targs->c;

    return 0;
}

int main()
{
    thread_arg args;
    args.r = 0;
    args.a = 10;
    args.b = 20;
    args.c = 30;

    UINT thread_id = 0;
    auto thread_handle = reinterpret_cast<HANDLE>(_beginthreadex(
        nullptr,                               // セキュリティ属性
        static_cast<unsigned int>(STACK_SIZE), // スタックサイズ
        thread_entry,                          // スレッドの実行を開始する関数
        &args,                                 // スレッド関数に渡される引数
        CREATE_SUSPENDED,                      // 初期化フラグ。『CREATE_SUSPENDED』を指定すると一時停止状態で生成される
        &thread_id                             // スレッド識別子
    ));

    // スレッド優先度を設定
    // 『THREAD_PRIORITY_ABOVE_NORMAL』は通常より1ポイント上の優先順位
    SetThreadPriority(thread_handle, THREAD_PRIORITY_ABOVE_NORMAL);

    // スレッドの実行を開始する
    ResumeThread(thread_handle);

    // スレッドの終了を待つ
    WaitForSingleObject(thread_handle, INFINITE);

    // スレッドハンドルを閉じる
    CloseHandle(thread_handle);

    // 結果を出力
    printf("value = %d\n", args.r);

    return 0;
}

出力

value = 230

std::threadを使ったスレッド生成

並行・並列処理

std::thread

C++11より導入された、新しい実行スレッドを生成、待機、その他の操作を行う仕組みを提供するテンプレートクラス。 std::threadのコンストラクタに与えられた関数オブジェクトと、このコンストラクタを呼び出したスレッドとの間で並行に処理が実行される。

コンストラクタの定義は、

template <class F, class ...Args>
explicit thread(F&& f, Args&&... args);

このような可変引数の形になっていて、ラムダ式と共に用いられる場合が多い。

機能は最小限のものしか提供されない為、実装環境に依存したスレッドハンドルを取得するメソッドが提供されており、

native_handle_type native_handle();

このハンドルを使う事で高度なスレッド操作を行うことが出来る。 通常このハンドルは、

  • Unix系環境（libstdc++、libc++）では『pthread_t』
  • MS Windows環境（Visual C++）では『HANDLE』

を表している。 各実装環境でのスレッド生成は以下を参照

kamai-tech-lab.hatenablog.com kamai-tech-lab.hatenablog.com

Sample code

#include <stdio.h>
#include <thread>

int main()
{
    int value = 0;

    // スレッドを作成、発行
    // ここで生成したスレッドの返り値は無視されるため、結果を受け取る変数の参照も渡しておく
    auto mad = std::thread([](int &r, int a, int b, int c)
    {
        r = a * b + c;
    }, std::ref(value), 10, 20, 30);


#ifdef WIN32
    // スレッド優先度を設定
    // 『THREAD_PRIORITY_BELOW_NORMAL』は通常より1ポイント下の優先順位
    SetThreadPriority(mad.native_handle(), THREAD_PRIORITY_BELOW_NORMAL);
#elif defined(__linux__)
    sched_param param;
    param.sched_priority = 10;

    // スケジューリングポリシー、優先度を設定
    pthread_setschedparam(mad.native_handle(), SCHED_RR, &param);
#endif

    // スレッドが完了するまで待つ
    mad.join();

    // 結果を出力
    printf("value = %d\n", value);
    
    return 0;
}
出力
value = 230

pthreadを使ったスレッド生成

並行・並列処理

pthread

一般的にPOSIXスレッドの標準実装ライブラリの事を指し、スレッドの生成や基本的な操作を行うことが出来る。 POSIXをサポートしている多くの環境（主にUnix系）で利用できる反面、標準では基本的な機能のみが提供されるため、環境に依存した高度な処理を行う場合には拡張命令を使用する必要がある。

Sample code

#include <stdio.h>
#include <pthread.h>

#define STACK_SIZE (512 * 1024)
#define SCHED_POLICY SCHED_OTHER
#define SCHED_PRIORITY 10

#define CLAMP(x, min_value, max_value) (x < min_value ? min_value : (max_value < x ? max_value : x))

struct thread_arg
{
    int r;
    int a;
    int b;
    int c;
};

// 生成したスレッドで実行する関数
void* thread_entry(void *args)
{
    auto targs = reinterpret_cast<thread_arg*>(args);
    targs->r = targs->a * targs->b + targs->c;

    return nullptr;
}

int main()
{
    pthread_attr_t attr;
    pthread_attr_init(&attr);

    // 生成するスレッドのスタックサイズを設定
    if (pthread_attr_setstacksize(&attr, STACK_SIZE) != 0) {
        pthread_attr_destroy(&attr);
        return 1;
    }

    // 呼び出しスレッドのスケジューリング属性を継承しないよう設定
    if (pthread_attr_setinheritsched(&attr, PTHREAD_EXPLICIT_SCHED) != 0) {
        pthread_attr_destroy(&attr);
        return 2;
    }

    // スケジューリングポリシーを設定
    if (pthread_attr_setschedpolicy(&attr, SCHED_POLICY) != 0) {
        pthread_attr_destroy(&attr);
        return 3;
    }

    sched_param param;

    const int min_priority = sched_get_priority_min(SCHED_POLICY);
    const int max_priority = sched_get_priority_max(SCHED_POLICY);
    param.sched_priority = CLAMP(SCHED_PRIORITY, min_priority, max_priority);

    // スケジューリング優先度を設定
    if (pthread_attr_setschedparam(&attr, &param) != 0) {
        pthread_attr_destroy(&attr);
        return 4;
    }
    
    thread_arg args;
    args.r = 0;
    args.a = 10;
    args.b = 20;
    args.c = 30;

    // スレッドのハンドル
    pthread_t thread;

    // スレッドを生成、発行
    if (pthread_create(&thread, &attr, thread_entry, &args) != 0) {
        pthread_attr_destroy(&attr);
        return 5;
    }

    // スレッド属性を破棄
    pthread_attr_destroy(&attr);

    // スレッドの終了を待つ
    // スレッドの内部メモリを解放する為、pthread_join または pthread_detach を必ず呼ばなければならない
    pthread_join(thread, nullptr);

    // 結果を出力
    printf("value = %d\n", args.r);

    return 0;
}
出力
value = 230