Update documentation and source code for RRA v1.9

Author: ahosier

.clang-format

@@ -2,11 +2,11 @@ BasedOnStyle: Google
 IndentWidth: 4
 UseTab: Never
 ColumnLimit: 160
+
 Language: Cpp
 AccessModifierOffset: -4
 BreakBeforeBraces: Custom
 BraceWrapping:
-
   AfterCaseLabel: true
   AfterClass: true
   AfterControlStatement: true
@@ -23,7 +23,7 @@ BraceWrapping:
   SplitEmptyFunction: true
   SplitEmptyRecord: true
   SplitEmptyNamespace: true
-ConstructorInitializerAllOnOneLineOrOnePerLine : false
+ConstructorInitializerAllOnOneLineOrOnePerLine: false
 BreakConstructorInitializers: BeforeComma
 DerivePointerAlignment: false
 IndentCaseLabels: false
@@ -33,12 +33,13 @@ AlignConsecutiveDeclarations: true
 AlignEscapedNewlines: Left
 AlignTrailingComments: true
 AlignOperands: true
-AllowShortFunctionsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: None
 AllowShortIfStatementsOnASingleLine: false
 AllowShortLoopsOnASingleLine: false
-AllowShortBlocksOnASingleLine: false
+AllowShortBlocksOnASingleLine: Never
 ReflowComments: false
-SortIncludes: false
+SortIncludes: CaseSensitive
+IncludeBlocks: Preserve
 SortUsingDeclarations: false
 BinPackArguments: false
 BinPackParameters: false

CMakeLists.txt

@@ -7,15 +7,16 @@ cmake_minimum_required(VERSION 3.11)
 
 set(SYSTEM_INFO_BUILD_RDF_INTERFACES ON)
 
-set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake")
+
+set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
 include(dev_tools)
 
 ## Specify the top level name of the project - this will define the solution name for Visual Studio
 project(RRA)
 
 # Define version information
 set(RRA_MAJOR_VERSION 1)
-set(RRA_MINOR_VERSION 8)
+set(RRA_MINOR_VERSION 9)
 if (NOT RRA_BUGFIX_NUMBER)
     set(RRA_BUGFIX_NUMBER 0)
 endif ()
@@ -26,8 +27,8 @@ string(TIMESTAMP DATE "\"%m/%d/%Y\"")
 string(TIMESTAMP YEAR "%Y")
 string(TIMESTAMP YEAR_STRING "\"%Y\"")
 
-configure_file("${CMAKE_SOURCE_DIR}/Buildinfo.properties.in" "${CMAKE_SOURCE_DIR}/Buildinfo.properties")
-configure_file("${CMAKE_SOURCE_DIR}/source/frontend/version.h.in" "${CMAKE_SOURCE_DIR}/source/frontend/version.h")
+configure_file("${CMAKE_CURRENT_SOURCE_DIR}/Buildinfo.properties.in" "${CMAKE_CURRENT_SOURCE_DIR}/Buildinfo.properties")
+configure_file("${CMAKE_CURRENT_SOURCE_DIR}/source/frontend/version.h.in" "${CMAKE_CURRENT_SOURCE_DIR}/source/frontend/version.h")
 
 # Add cmake utilities
 list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
@@ -49,19 +50,23 @@ ENDIF()
 
 # As default for RRA, include the debug status in filename - but not the platform bitness
 set (CMAKE_DEBUG_POSTFIX -d)
-set (CMAKE_RELEASE_POSTFIX)
+set (CMAKE_RELEASE_POSTFIX )
+
 
 # Add definitions for supported hardware
 add_definitions(-DGPURT_BUILD_RTIP3)
 add_definitions(-DGPURT_BUILD_RTIP3_1)
 
+# Add definitions needed by GLM
+add_definitions(-DGLM_ENABLE_EXPERIMENTAL)
+
 # Add for CentOS compiler warning
 add_definitions(-DJSON_SKIP_UNSUPPORTED_COMPILER_CHECK)
 
-include_directories("${PROJECT_SOURCE_DIR}/external/")
-include_directories("${PROJECT_SOURCE_DIR}/external/qt_common/")
-include_directories("${PROJECT_SOURCE_DIR}/external/third_party/")
-include_directories("${PROJECT_SOURCE_DIR}/external/third_party/vulkan/include/")
+include_directories("${CMAKE_CURRENT_SOURCE_DIR}/external/")
+include_directories("${CMAKE_CURRENT_SOURCE_DIR}/external/qt_common/")
+include_directories("${CMAKE_CURRENT_SOURCE_DIR}/external/third_party/")
+include_directories("${CMAKE_CURRENT_SOURCE_DIR}/external/third_party/vulkan/include/")
 
 # Global compiler options
 IF(WIN32)
@@ -102,10 +107,19 @@ MACRO(SOURCE_GROUP_BY_FOLDER target)
     ENDIF (files)
 ENDMACRO(SOURCE_GROUP_BY_FOLDER)
 
-add_subdirectory(external/qt_common qt_common)
-add_subdirectory(external/rdf/imported/zstd)
-add_subdirectory(external/rdf/rdf)
-add_subdirectory(external/system_info_utils)
+if (NOT TARGET QtUtils)
+    add_subdirectory(external/qt_common qt_common)
+endif()
+
+if (NOT TARGET amdrdf)
+    add_subdirectory(external/rdf/imported/zstd)
+    add_subdirectory(external/rdf/rdf)
+endif()
+
+if (NOT TARGET system_info)
+    add_subdirectory(external/system_info_utils)
+endif()
+
 add_subdirectory(source/backend backend)
 add_subdirectory(source/frontend frontend)
 add_subdirectory(source/renderer renderer)
@@ -126,25 +140,20 @@ ENDIF(WIN32)
 
 ## Copy Documentation and Samples to output directory. Note - this target is intentionally not included in
 ## the default project build. It needs to be explicitly built as a separate project
-
-# Determine where the build process will be placing the binary files
-# This is evaluated at project build time - not at CMake generation time
-set(BUILD_ROOT $<$<CONFIG:debug>:${CMAKE_RUNTIME_OUTPUT_DIRECTORY_DEBUG}>$<$<CONFIG:release>:${CMAKE_RUNTIME_OUTPUT_DIRECTORY_RELEASE}>)
-
-set(DOCS_OUTPUT_DIR ${BUILD_ROOT})
+set(DOCS_OUTPUT_DIR ${CMAKE_BINARY_DIR})
 
 # group sphinx source files into a sphinx folder
-file(GLOB SPHINX_DOC_FILES ${SPHINX_DOC_FILES} ${CMAKE_SOURCE_DIR}/documentation/source/*.rst)
-set (SPHINX_DOC_MAIN ${CMAKE_SOURCE_DIR}/documentation/source/conf.py)
+file(GLOB SPHINX_DOC_FILES ${SPHINX_DOC_FILES} ${CMAKE_CURRENT_SOURCE_DIR}/documentation/source/*.rst)
+set (SPHINX_DOC_MAIN ${CMAKE_CURRENT_SOURCE_DIR}/documentation/source/conf.py)
 set (ALL_SPHINX_FILES ${SPHINX_DOC_FILES} ${SPHINX_DOC_MAIN})
 source_group("sphinx" FILES ${ALL_SPHINX_FILES})
 
 # group release documents into a release_docs folder
 set (RELEASE_DOCS_IN_ROOT
-     ${CMAKE_SOURCE_DIR}/README.md
-     ${CMAKE_SOURCE_DIR}/RELEASE_NOTES.txt
-     ${CMAKE_SOURCE_DIR}/NOTICES.txt
-     ${CMAKE_SOURCE_DIR}/LICENSE.txt
+     ${CMAKE_CURRENT_SOURCE_DIR}/README.md
+     ${CMAKE_CURRENT_SOURCE_DIR}/RELEASE_NOTES.txt
+     ${CMAKE_CURRENT_SOURCE_DIR}/NOTICES.txt
+     ${CMAKE_CURRENT_SOURCE_DIR}/LICENSE.txt
 )
 set (RELEASE_DOCS ${RELEASE_DOCS_IN_ROOT})
 source_group("release_docs" FILES ${RELEASE_DOCS})
@@ -160,25 +169,25 @@ if(SPHINX_EXECUTABLE)
     # this ensures the sphinx docs are built everytime you ask to build the Documentation target
     # Sphinx has proper dependency checking, so this works as expected.
     # Once built, clean up any unneeded files.
-    add_custom_target(Documentation ALL SOURCES ${ALL_SPHINX_FILES} ${RELEASE_DOCS} DEPENDS sphinx_output)
+    add_custom_target(RRADocumentation ALL SOURCES ${ALL_SPHINX_FILES} ${RELEASE_DOCS} DEPENDS sphinx_output)
     add_custom_command(MAIN_DEPENDENCY ${SPHINX_DOC_MAIN} OUTPUT sphinx_output
         COMMAND ${CMAKE_COMMAND} -E echo "building Sphinx documentation"
-        COMMAND ${SPHINX_EXECUTABLE} ${CMAKE_SOURCE_DIR}/documentation/source ${DOCS_OUTPUT_DIR}/help/rra/. -t ${SPHINX_OPTION}
+        COMMAND ${SPHINX_EXECUTABLE} ${CMAKE_CURRENT_SOURCE_DIR}/documentation/source ${DOCS_OUTPUT_DIR}/help/rra/. -t ${SPHINX_OPTION}
         COMMAND ${CMAKE_COMMAND} -E remove_directory ${DOCS_OUTPUT_DIR}/help/rra/.doctrees
     )
     install(DIRECTORY ${DOCS_OUTPUT_DIR}/help DESTINATION . COMPONENT apps)
 else()
     message(WARNING "SPHINX_EXECUTABLE (sphinx-build) is not found! Documentation will not be built!")
     # If the sphinx binary isn't found, then just create the Documentation project with only the release docs in it.
-    add_custom_target(Documentation ALL SOURCES ${ALL_SPHINX_FILES} ${RELEASE_DOCS})
+    add_custom_target(RRADocumentation ALL SOURCES ${ALL_SPHINX_FILES} ${RELEASE_DOCS})
 endif()
 
-add_custom_command(TARGET Documentation POST_BUILD
+add_custom_command(TARGET RRADocumentation POST_BUILD
     COMMAND ${CMAKE_COMMAND} -E echo "copying Documentation to output directory"
     COMMAND ${CMAKE_COMMAND} -E copy_if_different ${RELEASE_DOCS_IN_ROOT}           ${DOCS_OUTPUT_DIR}/.
     COMMAND ${CMAKE_COMMAND} -E echo "copying Samples to output directory"
     COMMAND ${CMAKE_COMMAND} -E make_directory ${DOCS_OUTPUT_DIR}/samples
-    COMMAND ${CMAKE_COMMAND} -E copy_if_different ${CMAKE_SOURCE_DIR}/samples/landscape.rra  ${DOCS_OUTPUT_DIR}/samples/sample_trace.rra
+    COMMAND ${CMAKE_COMMAND} -E copy_if_different ${CMAKE_CURRENT_SOURCE_DIR}/samples/landscape.rra  ${DOCS_OUTPUT_DIR}/samples/sample_trace.rra
 )
 
 install(FILES
@@ -213,5 +222,3 @@ cpack_add_component(debug
         DISPLAY_NAME "Debug Symbols"
         DESCRIPTION "Debug Symbols")
 
-
-

RELEASE_NOTES.txt

@@ -1,11 +1,12 @@
-Radeon Raytracing Analyzer V1.8 03/11/2025
+Radeon Raytracing Analyzer V1.9 06/17/2025
 ------------------------------------------
 
-V1.8 Changes
+V1.9 Changes
 ------------------------------------
-1) Support for AMD Radeon RX 9000 series GPUs
-2) Support for the Wayland display manager on Ubuntu.
-3) Bug/stability fixes.
+1) Addition of an index column to the BLAS/TLAS tables.
+2) Change the heatmap grayscaling on the Ray Dispatches pane so it doesn't clash with the grayed out image when selecting a region.
+3) Allow selecting the previous and next rays from the Dispatch coordinates table directly from the Ray Inspector pane.
+4) Bug/stability fixes.
 
 Known Issues
 ------------------------------------
@@ -25,6 +26,12 @@ Known Issues
 Release Notes History
 ------------------------------------
 
+V1.8 Changes
+------------------------------------
+1) Support for AMD Radeon RX 9000 series GPUs.
+2) Support for the Wayland display manager on Ubuntu.
+3) Bug/stability fixes.
+
 V1.7 Changes
 ------------------------------------
 1) Dark mode user interface support, allowing the user to choose between a light and dark theme (or have RRA follow the OS theme setting).

build/dependency_map.py

@@ -25,7 +25,7 @@
     github_tools + "qt_common"                                      : ["../external/qt_common",          "v4.2.0",                                   True],
     github_tools + "update_check_api"                               : ["../external/update_check_api",   "v2.1.1",                                   True],
     github_tools + "system_info_utils"                              : ["../external/system_info_utils",  "v2.1",                                     True],
-    github_root  + "g-truc/glm"                                     : ["../external/third_party/glm",    "0.9.9.8",                                  True],
+    github_root  + "g-truc/glm"                                     : ["../external/third_party/glm",    "1.0.0",                                    True],
     github_root  + "KhronosGroup/Vulkan-Headers"                    : ["../external/third_party/vulkan", "sdk-1.3.211",                              True],
     github_root  + "zeux/volk"                                      : ["../external/third_party/volk",   "1.2.190",                                  True],
     github_root  + "GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator" : ["../external/vma",                "d2f0313d20c803f83cc3637ac1facf8e4d6899e4", False],

build/pre_build.py

@@ -272,6 +272,7 @@ def generate_config(config):
                 elif args.toolchain == "2017":
                     cmake_args.extend(["-Tv141"])
 
+
     if sys.platform.startswith('linux'):
         if args.qt_system:
             cmake_args.extend(["-DQT_SYSTEM:BOOL=TRUE"])
@@ -375,7 +376,7 @@ def generate_config(config):
 
             cmake_args = ["cmake", "--build", build_dir, "--parallel", args.build_jobs]
 
-            cmake_args_docs = ["cmake", "--build", build_dir, "--target", "Documentation", "--parallel", args.build_jobs]
+            cmake_args_docs = ["cmake", "--build", build_dir, "--target", "RRADocumentation", "--parallel", args.build_jobs]
         elif sys.platform == "win32":
             build_dir = cmake_output_dir
 
@@ -385,7 +386,7 @@ def generate_config(config):
                 cmake_args.append("/p:CodeAnalysisRuleSet=NativeMinimumRules.ruleset")
                 cmake_args.append("/p:RunCodeAnalysis=true")
 
-            cmake_args_docs = ["cmake", "--build", build_dir, "--config", config, "--target", "Documentation", "--", "/m:" + args.build_jobs]
+            cmake_args_docs = ["cmake", "--build", build_dir, "--config", config, "--target", "RRADocumentation", "--", "/m:" + args.build_jobs]
 
         p = subprocess.Popen(cmake_args, cwd=cmake_output_dir, stderr=subprocess.STDOUT)
         p.wait()

documentation/requirements.txt

@@ -1,4 +1,4 @@
 # Defining requirements for docs
 sphinx==5.3.0
 sphinx_rtd_theme==1.1.1
-readthedocs-sphinx-search==0.1.1
+readthedocs-sphinx-search==0.3.2

documentation/source/blas_windows.rst

@@ -103,6 +103,8 @@ Above the table is the base address of the BLAS used by all the instances.
 
 The following fields are displayed:
 
+* Row Id - The row index. This is an incrementing value starting at 0.
+
 * Instance index - The API index for the instance.
 
 * Instance address – The virtual GPU address for the instance node within the TLAS.
@@ -130,7 +132,7 @@ The following fields are displayed:
 * Transform[x][y] - The instance transform, comprising of the rotation and scaling components.
 
 The columns can be sorted by clicking on them. The arrow in the heading shows if
-sorting is in ascending or descending order.
+sorting is in ascending or descending order. The Row Id cannot be sorted.
 
 Typically, instances are created with their own local co-ordinate system. When
 placed in the scene, each instance requires a transformation from its local
@@ -150,6 +152,8 @@ address of the TLAS containing the BLAS.
 
 The following fields are displayed:
 
+* Row Id - The row index. This is an incrementing value starting at 0.
+
 * Geometry index - The index of the geometry that the triangle belongs to.
 
 * Opaque - Presence of the opaque geometry flag.
@@ -176,7 +180,7 @@ The following fields are displayed:
 
 The columns can be sorted by clicking on the column header, apart from the vertex
 columns; sorting is disabled for these columns. The arrow in the heading shows if
-sorting is in ascending or descending order.
+sorting is in ascending or descending order. The Row Id cannot be sorted.
 
 The Geometries Tab
 ------------------
@@ -191,6 +195,8 @@ address of the TLAS containing the BLAS.
 
 The following fields are displayed:
 
+* Row Id - The row index. This is an incrementing value starting at 0.
+
 * Geometry index - The index of the geometry in the BLAS. This refers to the first column in the triangles table.
 
 * Opaque - Presence of the opaque geometry flag.
@@ -200,7 +206,7 @@ The following fields are displayed:
 * Primitive count - The number of primitives contained in the geometry.
 
 The columns can be sorted by clicking on the column header. The arrow in the heading shows if
-sorting is in ascending or descending order.
+sorting is in ascending or descending order. The Row Id cannot be sorted.
 
 The BLAS Properties Tab
 -----------------------

documentation/source/conf.py

@@ -54,9 +54,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = u'1.8.0'
+version = u'1.9.0'
 # The full version, including alpha/beta/rc tags.
-release = u'1.8.0'
+release = u'1.9.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.