AMD Capsaicin Framework v1.2

Author: kurbeco

.clang-format

@@ -8,14 +8,17 @@ AlignConsecutiveAssignments: Consecutive
 AlignConsecutiveBitFields: Consecutive
 AlignConsecutiveDeclarations: Consecutive
 AlignConsecutiveMacros: Consecutive
+#AlignConsecutiveShortCaseStatements: true 
 AlignEscapedNewlines: Left
 AlignOperands: AlignAfterOperator
 AlignTrailingComments: true
 AllowAllArgumentsOnNextLine: true
 AllowAllConstructorInitializersOnNextLine: true
 AllowAllParametersOfDeclarationOnNextLine: true
+#AllowBreakBeforeNoexceptSpecifier: Never
 AllowShortBlocksOnASingleLine: Empty
 AllowShortCaseLabelsOnASingleLine: true
+#AllowShortCompoundRequirementOnASingleLine: true
 AllowShortFunctionsOnASingleLine: Inline
 AllowShortIfStatementsOnASingleLine: WithoutElse
 AllowShortLambdasOnASingleLine: Inline
@@ -45,13 +48,17 @@ BraceWrapping:
   SplitEmptyFunction: false
   SplitEmptyRecord: false
   SplitEmptyNamespace: false
+#BreakAdjacentStringLiterals: true
+BreakAfterAttributes: Never
+#BreakAfterReturnType: Automatic
 BreakBeforeBinaryOperators: NonAssignment
 BreakBeforeBraces: Custom
 BreakBeforeConceptDeclarations: true
 BreakBeforeTernaryOperators: true
 BreakConstructorInitializers: BeforeComma
 BreakInheritanceList: BeforeComma
 BreakStringLiterals: false
+#BreakTemplateDeclarations: Yes
 ColumnLimit: 110
 CompactNamespaces: false
 ConstructorInitializerIndentWidth: 4
@@ -77,12 +84,16 @@ IndentCaseLabels: false
 IndentExternBlock: NoIndent
 IndentGotoLabels: false
 IndentPPDirectives: AfterHash
-IndentRequires: false
+IndentRequiresClause: false
 IndentWidth: 4
 IndentWrappedFunctionNames: false
-#InsertTrailingCommas: Wrapped
+InsertBraces: true
+InsertNewlineAtEOF: true
+KeepEmptyLinesAtEOF: true
 KeepEmptyLinesAtTheStartOfBlocks: false
 LambdaBodyIndentation: Signature
+LineEnding: LF
+#MainIncludeChar: Quote
 MaxEmptyLinesToKeep: 1
 NamespaceIndentation: None
 PPIndentWidth: -1
@@ -92,8 +103,13 @@ QualifierAlignment: Custom
 QualifierOrder: ['inline', 'static', 'constexpr', 'volatile', 'type', 'restrict', 'const' ]
 ReferenceAlignment: Pointer
 ReflowComments: true
+RemoveParentheses: Leave
+RemoveSemicolon: true
+RequiresClausePosition: OwnLine
+RequiresExpressionIndentation: OuterScope
 SeparateDefinitionBlocks: Always
 ShortNamespaceLines: 0
+#SkipMacroDefinitionBody: false
 SortIncludes: true
 SortUsingDeclarations: true
 SpaceAfterCStyleCast: false
@@ -118,6 +134,7 @@ SpacesInContainerLiterals: false
 SpacesInLineCommentPrefix:
   Minimum: 1
   Maximum: 1
+SpacesInParens: Never
 SpacesInParentheses: false
 SpacesInSquareBrackets: false
 TabWidth: 4

.clang-tidy

@@ -0,0 +1,4 @@
+Checks: 'bugprone-*,cert-*,clang-analyzer-*,cppcoreguidelines-*,hicpp-*,misc-*,modernize-*,performance-*,readability-*,-modernize-use-trailing-return-type,-portability-simd-intrinsics,-readability-function-size,-llvmlibc-implementation-in-namespace,-fuchsia-default-arguments-declarations,-fuchsia-default-arguments-calls,-llvmlibc-callee-namespace,-llvm-header-guard,-cppcoreguidelines-avoid-magic-numbers,-readability-magic-numbers,-cppcoreguidelines-owning-memory,-bugprone-easily-swappable-parameters,-cppcoreguidelines-avoid-c-arrays,-cppcoreguidelines-non-private-member-variables-in-classes,-cppcoreguidelines-pro-bounds-array-to-pointer-decay,-cppcoreguidelines-pro-bounds-constant-array-index,-cppcoreguidelines-pro-bounds-pointer-arithmetic,-cppcoreguidelines-pro-type-reinterpret-cast,-cppcoreguidelines-pro-type-union-access,-cppcoreguidelines-pro-type-vararg,google-runtime-operator,google-upgrade-googletest-case,-hicpp-signed-bitwise,llvm-include-order,-readability-avoid-nested-conditional-operator,-readability-else-after-return,-readability-function-cognitive-complexity,-readability-identifier-length,-readability-identifier-naming,-hicpp-avoid-c-arrays,-misc-include-cleaner,-readability-convert-member-functions-to-static,-bugprone-branch-clone,-cppcoreguidelines-init-variables,-modernize-avoid-c-arrays,-misc-const-correctness,-cppcoreguidelines-avoid-do-while,-hicpp-vararg,-readability-redundant-string-init,-hicpp-no-array-decay,-bugprone-exception-escape,-readability-identifier-naming,-misc-non-private-member-variables-in-classes,-clang-diagnostic-pragma-once-outside-header,-google-runtime-operator'
+FormatStyle: 'file'
+HeaderFileExtensions: ['h','hpp']
+ImplementationFileExtensions: ['cpp','inl']

.editorconfig

@@ -1,5 +1,5 @@
 
-[*.{c,c++,cc,config,cp,cpp,cu,cxx,h,hh,hpp,hxx,inc,inl]
+[*.{c,c++,cc,config,cp,cpp,cu,cxx,h,hh,hpp,hxx,inc,inl}]
 indent_style=space
 indent_size=4
 tab_width=4

.gitignore

@@ -3,4 +3,6 @@ build
 imgui.ini
 .vscode
 .vs
-out
+out/
+cache/
+shader_cache/

.gitmodules

@@ -1,9 +1,3 @@
 [submodule "third_party/gfx"]
 	path = third_party/gfx
 	url = https://github.com/gboisse/gfx.git
-[submodule "third_party/CLI11"]
-	path = third_party/CLI11
-	url = https://github.com/CLIUtils/CLI11
-[submodule "assets/CapsaicinTestMedia"]
-	path = assets/CapsaicinTestMedia
-	url = https://github.com/GPUOpen-LibrariesAndSDKs/CapsaicinTestMedia.git

CMakeLists.txt

@@ -1,17 +1,14 @@
-cmake_minimum_required(VERSION 3.24.0)
+cmake_minimum_required(VERSION 3.25.0)
+cmake_policy(SET CMP0141 NEW)
 
 project(Capsaicin
-    VERSION 1.1.0
+    LANGUAGES CXX
+    VERSION 1.2.0
     DESCRIPTION "AMD experimental real-time rendering framework designed for graphics research and development"
 )
 
 set_property(GLOBAL PROPERTY USE_FOLDERS ON)
 
-# Set preprocessor definitions
-add_definitions(    
-    /MP
-)
-
 # Disable unused parameters from 3rd party directories
 set(GFX_BUILD_EXAMPLES            OFF CACHE BOOL "")
 set(BUILD_TESTING                 OFF CACHE BOOL "")
@@ -21,28 +18,80 @@ set(GFX_ENABLE_SCENE              ON CACHE BOOL "")
 set(GFX_ENABLE_GUI                ON CACHE BOOL "")
 
 # Gather dependencies
+include(FetchContent)
 add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/third_party/gfx EXCLUDE_FROM_ALL)
-add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/third_party/CLI11 EXCLUDE_FROM_ALL)
+set_target_properties(gfx PROPERTIES FOLDER "third_party")
 set(BUILD_SHARED_LIBS OFF CACHE INTERNAL "" FORCE)
 
-# Organize third party projects
-set_target_properties(uninstall PROPERTIES FOLDER "third_party")
-set_target_properties(gfx PROPERTIES FOLDER "third_party")
-set_target_properties(CLI11 PROPERTIES FOLDER "third_party")
-set_target_properties(tinyobjloader PROPERTIES FOLDER "third_party/gfx_deps")
-set_target_properties(tinyexr PROPERTIES FOLDER "third_party/gfx_deps")
-set_target_properties(ktx PROPERTIES FOLDER "third_party/gfx_deps")
-set_target_properties(astcenc-avx2-static PROPERTIES FOLDER "third_party/gfx_deps/ktx_deps")
-set_target_properties(ktx_read PROPERTIES FOLDER "third_party/gfx_deps/ktx_deps")
-set_target_properties(ktx_version PROPERTIES FOLDER "third_party/gfx_deps/ktx_deps")
-set_target_properties(obj_basisu_cbind PROPERTIES FOLDER "third_party/gfx_deps/ktx_deps")
-set_target_properties(objUtil PROPERTIES FOLDER "third_party/gfx_deps/ktx_deps")
-
-if(TARGET mkvk)
-    set_target_properties(mkvk PROPERTIES FOLDER "third_party/gfx_deps/ktx_deps")
-    set_target_properties(makedfd2vk PROPERTIES FOLDER "third_party/gfx_deps/ktx_deps")
-    set_target_properties(makevk2dfd PROPERTIES FOLDER "third_party/gfx_deps/ktx_deps")
-    set_target_properties(mkvkformatfiles PROPERTIES FOLDER "third_party/gfx_deps/ktx_deps")
+FetchContent_Declare(
+    CLI11
+    GIT_REPOSITORY https://github.com/CLIUtils/CLI11.git
+    GIT_TAG        v2.4.2
+    GIT_SHALLOW    TRUE
+    GIT_PROGRESS   TRUE
+    SOURCE_DIR     "${CMAKE_CURRENT_SOURCE_DIR}/third_party/cli11/"
+    FIND_PACKAGE_ARGS 2.0.0 NAMES CLI11
+)
+FetchContent_MakeAvailable(CLI11)
+if(NOT CLI11_FOUND)
+    set_target_properties(CLI11 PROPERTIES FOLDER "third_party")
+endif()
+
+FetchContent_Declare(
+    yaml-cpp
+    GIT_REPOSITORY https://github.com/jbeder/yaml-cpp.git
+    GIT_TAG        0.8.0
+    GIT_SHALLOW    TRUE
+    GIT_PROGRESS   TRUE
+    SOURCE_DIR     "${CMAKE_CURRENT_SOURCE_DIR}/third_party/yaml-cpp/"
+    FIND_PACKAGE_ARGS 0.7.0 NAMES yaml-cpp
+)
+set(YAML_CPP_BUILD_TOOLS OFF CACHE BOOL "")
+FetchContent_MakeAvailable(yaml-cpp)
+if(NOT yaml-cpp_FOUND)
+    set_target_properties(yaml-cpp PROPERTIES FOLDER "third_party")
+endif()
+
+FetchContent_Declare(
+    nlohmann_json
+    GIT_REPOSITORY https://github.com/nlohmann/json.git
+    GIT_TAG        v3.11.3
+    GIT_SHALLOW    TRUE
+    GIT_PROGRESS   TRUE
+    SOURCE_DIR     "${CMAKE_CURRENT_SOURCE_DIR}/third_party/nlohmann_json/"
+    FIND_PACKAGE_ARGS NAMES nlohmann_json
+)
+FetchContent_MakeAvailable(nlohmann_json)
+if(NOT nlohmann_json_FOUND)
+    set_target_properties(nlohmann_json PROPERTIES FOLDER "third_party")
+endif()
+
+FetchContent_Declare(
+    meshoptimizer
+    GIT_REPOSITORY https://github.com/zeux/meshoptimizer.git
+    GIT_TAG        v0.22
+    GIT_SHALLOW    TRUE
+    GIT_PROGRESS   TRUE
+    SOURCE_DIR     "${CMAKE_CURRENT_SOURCE_DIR}/third_party/meshoptimizer/"
+    FIND_PACKAGE_ARGS NAMES meshoptimizer
+)
+FetchContent_MakeAvailable(meshoptimizer)
+if(NOT meshoptimizer_FOUND)
+    set_target_properties(meshoptimizer PROPERTIES FOLDER "third_party")
+    add_library(meshoptimizer::meshoptimizer ALIAS meshoptimizer)
+endif()
+
+option(CAPSAICIN_DOWNLOAD_TEST_MEDIA "Download test media scenes" ON)
+if(CAPSAICIN_DOWNLOAD_TEST_MEDIA)
+    FetchContent_Declare(
+        CapsaicinTestMedia
+        GIT_REPOSITORY https://github.com/GPUOpen-LibrariesAndSDKs/CapsaicinTestMedia.git
+        GIT_TAG        v1.2
+        GIT_SHALLOW    TRUE
+        GIT_PROGRESS   TRUE
+        SOURCE_DIR     "${CMAKE_CURRENT_SOURCE_DIR}/assets/CapsaicinTestMedia/"
+    )
+    FetchContent_MakeAvailable(CapsaicinTestMedia)
 endif()
 
 # Set project output directory variables.

LICENSE

@@ -0,0 +1,19 @@
+Copyright © 2023 Advanced Micro Devices, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files(the “Software”), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and /or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions :
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -11,7 +11,7 @@ Features:
 - Inbuilt user extensible UI
 - Automated debugging and profiling information
 - Pluggable and swappable common rendering techniques such as ToneMapping, TAA, AO etc.
-- Unbiased reference path tracer
+- Reference path tracer
 
 ![Capsaicin](docs/images/scene_viewer.png)
 
@@ -35,40 +35,46 @@ Furthermore the technique can estimate direct lighting through its probe system
 
 - Direct3D12 capable hardware and OS (Windows 10 20H2 or newer)
 - [Windows 10 SDK](https://developer.microsoft.com/en-us/windows/downloads/windows-10-sdk/) or newer
-- CMake 3.10 or newer (can use Visual Studio, VSCode or any other CMake supported IDE)
+- CMake 3.24 or newer (can use Visual Studio, VSCode or any other CMake supported IDE)
 - DirectX Raytracing capable GPU and compatible drivers
 
 ## Building
 
-Capsaicin uses submodules to include any required dependencies beyond those listed in **Prerequisites**.
+Capsaicin uses submodules to include any essential dependencies.
+
+The following submodules are required:
+- gfx: Contains gfx D3D12 abstraction library (located in "third_party/" subfolder
 
 When acquiring the code make sure to clone the repo with submodules included:
 
-`git clone --recurse-submodules https://github.com/GPUOpen-LibrariesAndSDKs/Capsaicin`
+`git clone --recurse-submodules https://github.com/Radeon-Pro/Capsaicin`
 
 If you have already cloned this repo without submodules, then use:
 
 `git submodule update --init --recursive`
 
 Capsaicin uses the [CMake](https://cmake.org/) build system. See the [Getting Started](./docs/development/getting_started.md) section for more information.
 
+Additional third party resources used by Capsaicin will be acquired using CMakes inbuilt FetchContent functionality during CMake configuration. See the [Getting Started](./docs/development/getting_started.md) section for a list of used dependencies and how they are retrieved.
+
 ## Resources
 
 - [Documentation](./docs/index.md)
     - [Getting Started](./docs/development/getting_started.md)
     - [Architecture](./docs/development/architecture.md)
+    - [Usage](./docs/usage/scene_viewer_usage.md)
 
 ## Citation
 
-If Capsaicin is used in any published work, please ensure to cite it using:
+If Capsaicin is used in any published work, ensure to cite it using:
 
 ```bibtex
 @Misc{Capsaicin23,
    author = {Boissé, Guillaume and Oliver, Matthew and Meunier, Sylvain and Dupont de Dinechin, Héloïse and Eto, Kenta},
    title =  {The {AMD Capsaicin Framework}},
    year =   {2023},
    month =  {8},
-   url =    {https://github.com/GPUOpen-LibrariesAndSDKs/Capsaicin},
+   url =    {https://github.com/Radeon-Pro/Capsaicin_Open},
 }
 ```
 

assets/.gitignore

@@ -0,0 +1 @@
+CapsaicinTestMedia/