Visual StudioでCMakeを使うなら知っておきたい: VS_SHADER_OBJECT_FILE_NAMEを使いこなしてシェーダー開発を効率化

VS_SHADER_OBJECT_FILE_NAME は、CMake の "Properties: Source Files" プロパティにおいて、HLSL シェーダーソースファイル (.hlsl) のコンパイル時に生成されるオブジェクトファイルの名前を指定するために使用されるプロパティです。これは、Visual Studio IDE を用いたビルド時に特に役立ちます。

機能

このプロパティを使用することで、オブジェクトファイル名をプロジェクトの構成や要件に合わせて柔軟に設定できます。
デフォルトのオブジェクトファイル名は、ソースファイル名に .obj 拡張子を付加したものになります。
HLSL シェーダーソースファイル (.hlsl) をコンパイルする際に、生成されるオブジェクトファイルの名前を指定できます。

設定方法

VS_SHADER_OBJECT_FILE_NAME プロパティは、CMake の target_sources() コマンドまたは add_executable() コマンド内で設定できます。以下はその例です。

target_sources(my_shader_target my_shader.hlsl)
set_property(SOURCE my_shader.hlsl PROPERTY VS_SHADER_OBJECT_FILE_NAME my_shader.obj)

add_executable(my_app my_app.cpp)
target_sources(my_app my_shader.hlsl)
set_property(SOURCE my_shader.hlsl PROPERTY VS_SHADER_OBJECT_FILE_NAME my_app_shader.obj)

利点

Visual Studio IDE におけるデバッグや分析を容易化します。
異なるシェーダーバリアント (頂点シェーダー、ピクセルシェーダーなど) 用のオブジェクトファイル名を区別することができます。
オブジェクトファイル名を明確に制御することで、プロジェクトのビルド構成をより整理しやすくなります。

このプロパティは、Visual Studio IDE を用いたビルド時にのみ有効です。他のビルドシステムでは、異なる方法でオブジェクトファイル名を制御する必要があります。
VS_SHADER_OBJECT_FILE_NAME プロパティは、CMake 3.12 以降でのみ使用可能です。

VS_SHADER_OBJECT_FILE_NAME プロパティは、HLSL シェーダーソースファイル (.hlsl) のコンパイル時に生成されるオブジェクトファイルの名前を制御するための便利なツールです。Visual Studio IDE を用いたビルドにおいて、プロジェクトの構成を整理し、デバッグや分析を容易化するために役立ちます。

この説明は、プログラミング初心者にも理解しやすいように、専門用語を極力避け、平易な言葉で記述しています。

target_sources(my_shader_target my_shader.hlsl)
set_property(SOURCE my_shader.hlsl PROPERTY VS_SHADER_OBJECT_FILE_NAME my_shader.obj)

例2: 複数のシェーダーソースファイル

この例では、vertex_shader.hlsl と fragment_shader.hlsl という名前の 2 つの HLSL シェーダーソースファイルがあり、それぞれのオブジェクトファイル名を vertex_shader.obj と fragment_shader.obj に設定します。

target_sources(my_shader_program vertex_shader.hlsl fragment_shader.hlsl)
set_property(SOURCE vertex_shader.hlsl PROPERTY VS_SHADER_OBJECT_FILE_NAME vertex_shader.obj)
set_property(SOURCE fragment_shader.hlsl PROPERTY VS_SHADER_OBJECT_FILE_NAME fragment_shader.obj)

例3: ターゲットディレクトリを指定

この例では、my_shader.hlsl という名前の HLSL シェーダーソースファイルがあり、そのオブジェクトファイルを build/shaders ディレクトリに生成するように設定します。

target_sources(my_shader_target my_shader.hlsl)
set_property(SOURCE my_shader.hlsl PROPERTY VS_SHADER_OBJECT_FILE_NAME "${CMAKE_BINARY_DIR}/build/shaders/my_shader.obj")

これらの例は、Visual Studio IDE を用いたビルドを想定しています。他のビルドシステムでは、異なる設定が必要になる場合があります。

代替方法

CMake の "SET_TARGET_PROPERTIES" コマンドを使用する

この方法は、ターゲット全体のオブジェクトファイル出力設定を制御する際に役立ちます。

target_sources(my_shader_program vertex_shader.hlsl fragment_shader.hlsl)
set_target_properties(my_shader_program PROPERTIES
  VS_SHADER_OBJECT_FILE_NAME "${CMAKE_BINARY_DIR}/build/shaders/vertex_shader.obj"
  VS_SHADER_OBJECT_FILE_NAME "${CMAKE_BINARY_DIR}/build/shaders/fragment_shader.obj")

カスタム CMake ターゲットを作成する

この方法は、より複雑な制御が必要な場合や、VS_SHADER_OBJECT_FILE_NAME プロパティでサポートされていない機能を使用したい場合に役立ちます。

add_custom_target(my_shader_objects
  SOURCES vertex_shader.hlsl fragment_shader.hlsl
  COMMAND ${CMAKE_HLSL_COMPILER} -o "${CMAKE_BINARY_DIR}/build/shaders/vertex_shader.obj" vertex_shader.hlsl
         ${CMAKE_HLSL_COMPILER} -o "${CMAKE_BINARY_DIR}/build/shaders/fragment_shader.obj" fragment_shader.hlsl)

target_link_libraries(my_app my_shader_objects)

ビルドシステムに固有の設定を使用する

CMake 以外のビルドシステムを使用している場合は、そのシステムに固有の設定を使用してオブジェクトファイル名を制御できる場合があります。

代替方法を使用する場合は、CMake のドキュメントやビルドシステムのドキュメントを参照してください。
代替方法は、プロジェクトの構成や要件によって異なる場合があります。
代替方法を使用する前に、VS_SHADER_OBJECT_FILE_NAME プロパティの制限事項を理解していることを確認してください。