Work Graph Playground v1.1.0

- Add support for the experimental Mesh Node preview feature
- Add HelloMeshNodes tutorial
- Extend command line argument parsing
- Add support for opening external .hlsl files

Author: maxoberberger

CMakeLists.txt

@@ -1,6 +1,6 @@
 # This file is part of the AMD & HSC Work Graph Playground.
 #
-# Copyright (C) 2024 Advanced Micro Devices, Inc. and Coburg University of Applied Sciences and Arts.
+# Copyright (C) 2025 Advanced Micro Devices, Inc. and Coburg University of Applied Sciences and Arts.
 # All rights reserved.
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -22,7 +22,7 @@
 # THE SOFTWARE.
 
 cmake_minimum_required(VERSION 3.17)
-project(WorkGraphPlayground VERSION 0.1)
+project(WorkGraphPlayground VERSION 1.1)
 
 set(CMAKE_CXX_STANDARD 20)
 set(CMAKE_CXX_STANDARD_REQUIRED True)
@@ -35,23 +35,28 @@ add_compile_definitions(UNICODE _UNICODE)
 
 set_property(GLOBAL PROPERTY USE_FOLDERS ON)
 
+option(PLAYGROUND_ENABLE_MESH_NODES "Enable experimental mesh node support" OFF)
+set(PLAYGROUND_COPY_TUTORIAL_MODE "none" CACHE STRING "Mode for copying tutorial files to output bin folder.\n none: do not copy tutorial files.\n copy: copy tutorial files after build step.\n symlink: create symlinks for tutorial folder to bin folder.")
+set_property(CACHE PLAYGROUND_COPY_TUTORIAL_MODE PROPERTY STRINGS none copy symlink)
+
 add_subdirectory(imported)
 
+add_executable(${PROJECT_NAME})
+
+if (PLAYGROUND_ENABLE_MESH_NODES)
+    target_compile_definitions(${PROJECT_NAME} PRIVATE ENABLE_MESH_NODES)
+endif()
 
+# collect & add C++ source files
 file(GLOB PROJECT_SOURCE_FILES
     ${CMAKE_CURRENT_SOURCE_DIR}/include/*.h
     ${CMAKE_CURRENT_SOURCE_DIR}/src/*.cpp)
-file(GLOB_RECURSE PROJECT_SHADER_FILES
-    ${CMAKE_CURRENT_SOURCE_DIR}/tutorials/*.md
-    ${CMAKE_CURRENT_SOURCE_DIR}/tutorials/*.png
-    ${CMAKE_CURRENT_SOURCE_DIR}/tutorials/*.h
-    ${CMAKE_CURRENT_SOURCE_DIR}/tutorials/*.hlsl)
-set_source_files_properties(${PROJECT_SHADER_FILES} PROPERTIES VS_TOOL_OVERRIDE "Text")
-
-add_executable(${PROJECT_NAME} ${PROJECT_SOURCE_FILES} ${PROJECT_SHADER_FILES})
+target_sources(${PROJECT_NAME} PRIVATE ${PROJECT_SOURCE_FILES})
+
 target_include_directories(${PROJECT_NAME} PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/include)
+# link NuGet packages and ImGui
 target_link_libraries(${PROJECT_NAME} PRIVATE
-    Microsoft.Direct3D.D3D12    
+    Microsoft.Direct3D.D3D12
     Microsoft.Direct3D.DXC
     Microsoft.Direct3D.WARP
     d3d12
@@ -60,36 +65,92 @@ target_link_libraries(${PROJECT_NAME} PRIVATE
     dxguid
     imgui)
 
-set_target_properties(${PROJECT_NAME} PROPERTIES 
+set_target_properties(${PROJECT_NAME} PROPERTIES
+    # set playground app to be DPI aware, i.e. disable scaling in Windows compositor
     VS_DPI_AWARE "PerMonitor"
-    VS_DEBUGGER_WORKING_DIRECTORY "${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/$<CONFIG>")
+    # set working directory to current directory
+    VS_DEBUGGER_WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR})
+
+# set playground as startup project
 set_property(DIRECTORY "." PROPERTY VS_STARTUP_PROJECT ${PROJECT_NAME})
 
-# set source group for shader files & link to bin folder
-set(SHADER_BASE_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/tutorials)
-foreach(SHADER ${PROJECT_SHADER_FILES})
-    get_filename_component(SHADER_FILE_DIRECTORY ${SHADER} DIRECTORY)
-    get_filename_component(SHADER_FILE_NAME ${SHADER} NAME)
-    file(RELATIVE_PATH SHADER_FILE_DIRECTORY_RELATIVE_PATH ${SHADER_BASE_DIRECTORY} ${SHADER_FILE_DIRECTORY})
-            
-    if ("${SHADER_FILE_DIRECTORY_RELATIVE_PATH}" STREQUAL "")
-        source_group("Shader Source Files" FILES ${SHADER})
-    else()
-        source_group("Shader Source Files/${SHADER_FILE_DIRECTORY_RELATIVE_PATH}" FILES ${SHADER})
+set(TUTORIAL_FOLDER_LIST "")
+function(add_tutorial_folder TUTORIAL_FOLDER PREFIX SOURCE_GROUP)
+    if (NOT EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/${TUTORIAL_FOLDER})
+        message(FATAL "Tutorial folder ${TUTORIAL_FOLDER} not found in current source directory!")
     endif()
 
-    # to enable shader hot-reloading, instead of copying the shaders to the bin output folder at the end of the build,
-    # we create hardlinks between a file in the bin folder and the shader source file.
-    # This way, updates to the shader source file are automatically propagated to the bin folder,
-    # and - unlike symlinks - the hardlinks allow copying/moving/compressing the bin folder without having broken links.
-
-    # create parent folder
-    add_custom_command(TARGET ${PROJECT_NAME} POST_BUILD
-        COMMAND ${CMAKE_COMMAND} -E make_directory  
-        ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/$<CONFIG>/tutorials/${SHADER_FILE_DIRECTORY_RELATIVE_PATH})
-    # create hardlink
-    add_custom_command(TARGET ${PROJECT_NAME} POST_BUILD
-        COMMAND ${CMAKE_COMMAND} -E create_hardlink  
-        ${SHADER}
-        ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/$<CONFIG>/tutorials/${SHADER_FILE_DIRECTORY_RELATIVE_PATH}/${SHADER_FILE_NAME})
-endforeach()
+    # collect tutorial source files
+    file(GLOB_RECURSE TUTORIAL_FILES
+        ${CMAKE_CURRENT_SOURCE_DIR}/${TUTORIAL_FOLDER}/*.md
+        ${CMAKE_CURRENT_SOURCE_DIR}/${TUTORIAL_FOLDER}/*.png
+        ${CMAKE_CURRENT_SOURCE_DIR}/${TUTORIAL_FOLDER}/*.h
+        ${CMAKE_CURRENT_SOURCE_DIR}/${TUTORIAL_FOLDER}/*.hlsl)
+
+    # add tutorial source files and disable compilation of HLSL files
+    target_sources(${PROJECT_NAME} PRIVATE ${TUTORIAL_FILES})
+    set_source_files_properties(${TUTORIAL_FILES} PROPERTIES VS_TOOL_OVERRIDE "Text")
+
+    if ("${PLAYGROUND_COPY_TUTORIAL_MODE}" STREQUAL "copy")
+        add_custom_command(TARGET ${PROJECT_NAME} POST_BUILD
+            COMMAND ${CMAKE_COMMAND} -E copy_directory
+            ${CMAKE_CURRENT_SOURCE_DIR}/${TUTORIAL_FOLDER}
+            ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/$<CONFIG>/${TUTORIAL_FOLDER})
+    elseif("${PLAYGROUND_COPY_TUTORIAL_MODE}" STREQUAL "symlink")
+        # To allow for easy copying of the playground and all tutorials, we support creating symlinks for all
+        # tutorial folders to the bin output folder. As shader source files are not part of the build process
+        # changes to these files are not tracked by the build system.
+        # To still keep all the shader source files in the bin folder up-to-date, we create a symlink for each folder.
+        # This way, updates to the shader source file are automatically propagated to the bin folder,
+        # allowing you to copy/move/compress the bin folder with the latest version of your shader file.
+
+        add_custom_command(TARGET ${PROJECT_NAME} POST_BUILD
+            COMMAND ${CMAKE_COMMAND} -E create_symlink
+            ${CMAKE_CURRENT_SOURCE_DIR}/${TUTORIAL_FOLDER}
+            ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/$<CONFIG>/${TUTORIAL_FOLDER})
+    endif()
+
+    # set source group for shader files & link to bin folder
+    foreach(TUTORIAL_FILE ${TUTORIAL_FILES})
+        get_filename_component(TUTORIAL_FILE_DIRECTORY ${TUTORIAL_FILE} DIRECTORY)
+        get_filename_component(TUTORIAL_FILE_NAME ${TUTORIAL_FILE} NAME)
+        file(RELATIVE_PATH TUTORIAL_FILE_DIRECTORY_RELATIVE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/${TUTORIAL_FOLDER} ${TUTORIAL_FILE_DIRECTORY})
+
+        if ("${TUTORIAL_FILE_DIRECTORY_RELATIVE_PATH}" STREQUAL "")
+            source_group("${SOURCE_GROUP}" FILES ${TUTORIAL_FILE})
+        else()
+            source_group("${SOURCE_GROUP}/${TUTORIAL_FILE_DIRECTORY_RELATIVE_PATH}" FILES ${TUTORIAL_FILE})
+        endif()
+    endforeach()
+
+    set(TUTORIAL_FOLDER_LIST "${TUTORIAL_FOLDER_LIST}std::make_pair(\"${TUTORIAL_FOLDER}\", \"${PREFIX}\")," PARENT_SCOPE)
+endfunction(add_tutorial_folder)
+
+add_tutorial_folder(tutorials "Tutorial" "Shader Source Files")
+
+if (PLAYGROUND_ENABLE_MESH_NODES)
+    # Add mesh node tutorials. These are only included if mesh nodes are enabled.
+    add_tutorial_folder(mesh-node-tutorials "Mesh Node Tutorial" "Shader Source Files/Mesh Nodes")
+endif()
+
+########################################################################################################
+# Add new tutorial folders here
+# 
+# Example: 
+# add_tutorial_folder(./path/to/your/folder "My Tutorial Prefix" "Shader Source Files/My New Tutorials")
+#
+# Tutorials in this folder will show up in the UI as "My Tutorial Prefix #: Tutorial Name" and
+# show up in the solution under "Shader Source Files/My New Tutorials"
+#
+
+
+
+########################################################################################################
+
+# Once all tutorials are added, set define for app to scan all tutorial folders at runtime
+target_compile_definitions(${PROJECT_NAME} PRIVATE TUTORIAL_FOLDER_LIST=${TUTORIAL_FOLDER_LIST})
+
+
+
+
+

imported/CMakeLists.txt

@@ -1,6 +1,6 @@
 # This file is part of the AMD & HSC Work Graph Playground.
 #
-# Copyright (C) 2024 Advanced Micro Devices, Inc. and Coburg University of Applied Sciences and Arts.
+# Copyright (C) 2025 Advanced Micro Devices, Inc. and Coburg University of Applied Sciences and Arts.
 # All rights reserved.
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -23,17 +23,27 @@
 
 include(nuget.cmake)
 
+if (PLAYGROUND_ENABLE_MESH_NODES)
+    set(NUGET_D3D12_VERSION 1.715.1-preview)
+    set(NUGET_DXC_VERSION 1.8.2404.55-mesh-nodes-preview)
+    set(NUGET_WARP_VERSION 1.0.14.1-preview)
+else()
+    set(NUGET_D3D12_VERSION 1.613.3)
+    set(NUGET_DXC_VERSION 1.8.2403.18)
+    set(NUGET_WARP_VERSION 1.0.14.2)
+endif()
+
 fetch_nuget_package(
     PACKAGE Microsoft.Direct3D.D3D12
-    VERSION 1.613.3
+    VERSION ${NUGET_D3D12_VERSION}
 )
 fetch_nuget_package(
     PACKAGE Microsoft.Direct3D.DXC
-    VERSION 1.8.2403.18
+    VERSION ${NUGET_DXC_VERSION}
 )
 fetch_nuget_package(
     PACKAGE Microsoft.Direct3D.WARP
-    VERSION 1.0.13
+    VERSION ${NUGET_WARP_VERSION}
 )
 
 file(GLOB IMGUI_SOURCES

imported/nuget.cmake

@@ -1,6 +1,6 @@
 # This file is part of the AMD & HSC Work Graph Playground.
 #
-# Copyright (C) 2024 Advanced Micro Devices, Inc. and Coburg University of Applied Sciences and Arts.
+# Copyright (C) 2025 Advanced Micro Devices, Inc. and Coburg University of Applied Sciences and Arts.
 # All rights reserved.
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -35,8 +35,8 @@ function(fetch_nuget_package)
     endif()
 
     set(DOWNLOAD_URL "https://www.nuget.org/api/v2/package/${FETCH_NUGET_PACKAGE_PACKAGE}/${FETCH_NUGET_PACKAGE_VERSION}")
-    set(DOWNLOAD_FILE ${CMAKE_CURRENT_BINARY_DIR}/nuget/${FETCH_NUGET_PACKAGE_PACKAGE}.zip)
-    set(PACKAGE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/nuget/${FETCH_NUGET_PACKAGE_PACKAGE})
+    set(DOWNLOAD_FILE ${CMAKE_CURRENT_BINARY_DIR}/nuget/${FETCH_NUGET_PACKAGE_PACKAGE}-${FETCH_NUGET_PACKAGE_VERSION}.zip)
+    set(PACKAGE_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/nuget/${FETCH_NUGET_PACKAGE_PACKAGE}-${FETCH_NUGET_PACKAGE_VERSION})
 
     if (NOT EXISTS ${DOWNLOAD_FILE})
         message(STATUS "Downloading NuGet package \"${FETCH_NUGET_PACKAGE_PACKAGE}\" from \"${DOWNLOAD_URL}\".")
@@ -68,7 +68,6 @@ function(fetch_nuget_package)
         message("Generating custom command for ${PACKAGE_BIN_FILE_NAME}")
         add_custom_command(
             OUTPUT   ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/$<CONFIG>/${PACKAGE_BIN_FILE_NAME}
-            PRE_BUILD
             COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/$<CONFIG>
             COMMAND ${CMAKE_COMMAND} -E copy_if_different ${PACKAGE_BIN_FILE} ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/$<CONFIG>
             MAIN_DEPENDENCY  ${PACKAGE_BIN_FILE}

include/Application.h

@@ -1,6 +1,6 @@
 // This file is part of the AMD & HSC Work Graph Playground.
 //
-// Copyright (C) 2024 Advanced Micro Devices, Inc. and Coburg University of Applied Sciences and Arts.
+// Copyright (C) 2025 Advanced Micro Devices, Inc. and Coburg University of Applied Sciences and Arts.
 // All rights reserved.
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -24,6 +24,7 @@
 #pragma once
 
 #include <chrono>
+#include <vector>
 
 #include "Device.h"
 #include "ShaderCompiler.h"
@@ -38,6 +39,15 @@ class Application {
         std::uint32_t windowWidth  = 1280;
         std::uint32_t windowHeight = 720;
 
+        std::vector<WorkGraph::WorkGraphTutorial> tutorials;
+
+        std::optional<WorkGraph::WorkGraphTutorial> tutorial;
+
+#ifdef ENABLE_MESH_NODES
+        // MSAA sample count for render target
+        std::uint32_t renderTargetSampleCount = 1;
+#endif
+
         bool forceWarpAdapter         = false;
         bool enableDebugLayer         = false;
         bool enableGpuValidationLayer = false;
@@ -48,8 +58,6 @@ class Application {
 
     void Run();
 
-    static std::span<const WorkGraph::WorkGraphTutorial> GetTutorials();
-
 private:
     void OnRender(ID3D12GraphicsCommandList10* commandList, const Swapchain::RenderTarget& renderTarget);
     void OnRenderUserInterface(ID3D12GraphicsCommandList10* commandList, const Swapchain::RenderTarget& renderTarget);
@@ -69,6 +77,15 @@ class Application {
     void CreatePersistentScratchBuffer();
     void ClearShaderResources(ID3D12GraphicsCommandList10* commandList);
 
+    // Util methods for MSAA
+    void CreateMsaaResources(std::uint32_t width,
+                             std::uint32_t height,
+                             std::uint32_t sampleCount,
+                             std::uint32_t sampleQuality);
+    void ResolveMsaaRenderTarget(ID3D12GraphicsCommandList*     commandList,
+                                 const Swapchain::RenderTarget& swapchainRenderTarget,
+                                 const Swapchain::RenderTarget& msaaRenderTarget);
+
     void CreateFontBuffer();
 
     std::unique_ptr<Window>    window_;
@@ -84,6 +101,12 @@ class Application {
     ComPtr<ID3D12DescriptorHeap> clearDescriptorHeap_;
     ComPtr<ID3D12DescriptorHeap> resourceDescriptorHeap_;
 
+    // Multi-sample resources
+    ComPtr<ID3D12Resource>       msaaColorResource_;
+    ComPtr<ID3D12DescriptorHeap> msaaColorDescriptorHeap_;
+    ComPtr<ID3D12Resource>       msaaDepthResource_;
+    ComPtr<ID3D12DescriptorHeap> msaaDepthDescriptorHeap_;
+
     // Shader resources
     ComPtr<ID3D12Resource> writableBackbuffer_;
     ComPtr<ID3D12Resource> scratchBuffer_;
@@ -100,10 +123,12 @@ class Application {
     // Start time of current tutorial. Delta to current time is available in the shader as "Time"
     std::chrono::high_resolution_clock::time_point startTime_           = std::chrono::high_resolution_clock::now();
 
+    std::vector<WorkGraph::WorkGraphTutorial> workGraphTutorials_;
+
     // Work Graph resources
-    ShaderCompiler              shaderCompiler_;
-    ComPtr<ID3D12RootSignature> workGraphRootSignature_;
-    std::uint32_t               workGraphTutorialIndex_     = 0;
-    bool                        workGraphUseSampleSolution_ = false;
-    std::unique_ptr<WorkGraph>  workGraph_;
+    std::unique_ptr<ShaderCompiler> shaderCompiler_;
+    ComPtr<ID3D12RootSignature>     workGraphRootSignature_;
+    WorkGraph::WorkGraphTutorial    workGraphTutorial_;
+    bool                            workGraphUseSampleSolution_ = false;
+    std::unique_ptr<WorkGraph>      workGraph_;
 };

include/Device.h

@@ -1,6 +1,6 @@
 // This file is part of the AMD & HSC Work Graph Playground.
 //
-// Copyright (C) 2024 Advanced Micro Devices, Inc. and Coburg University of Applied Sciences and Arts.
+// Copyright (C) 2025 Advanced Micro Devices, Inc. and Coburg University of Applied Sciences and Arts.
 // All rights reserved.
 //
 // Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -62,18 +62,22 @@ class Device {
     ID3D12Device9*      GetDevice() const;
     ID3D12CommandQueue* GetCommandQueue() const;
 
+    bool               IsSoftwareAdapter() const;
     const std::string& GetAdapterDescription() const;
 
+    D3D12_WORK_GRAPHS_TIER GetSupportedWorkGraphsTier() const;
+
 private:
-    void                  CreateDXGIFactory(bool enableDebugLayer, bool enableGpuValidationLayer);
-    ComPtr<ID3D12Device9> CreateDevice(IDXGIAdapter1* adapter) const;
-    bool                  CheckDeviceFeatures(ID3D12Device9* device) const;
-    void                  CreateDeviceResources();
+    void                   CreateDXGIFactory(bool enableDebugLayer, bool enableGpuValidationLayer);
+    ComPtr<ID3D12Device9>  CreateDevice(IDXGIAdapter1* adapter) const;
+    D3D12_WORK_GRAPHS_TIER GetSupportedWorkGraphsTier(ID3D12Device9* device) const;
+    void                   CreateDeviceResources();
 
     void RegisterDebugMessageCallback();
 
-    ComPtr<IDXGIFactory4> dxgiFactory_;
+    ComPtr<IDXGIFactory6> dxgiFactory_;
 
+    bool        softwareAdapter_    = false;
     std::string adapterDescription_ = "Unknown Adapter";
 
     ComPtr<ID3D12Device9>      device_;