Update documentation and source code for RRA v1.10

Author: ahosier

BUILD.md

@@ -33,8 +33,15 @@ This can be installed once Python is installed, as follows:
 * pip install -U sphinx
 * pip install sphinx_rtd_theme
 
-Run the python pre_build.py script in the build folder from a command prompt. If no command line options are provided, the defaults will be used (Qt 6.7.0 and Visual Studio 2022)
-
+Run the python pre_build.py script from a command prompt. If no command line options are provided, the defaults will be used (Qt 6.7.0 and Visual Studio 2022)
+```bash
+python3 build\pre_build.py
+```
+or
+```bash
+cd build
+python3 pre_build.py
+```
 Some useful options of the pre_build.py script:
 * --vs <Visual Studio version>: generate the solution files for a specific Visual Studio version. For example, to target Visual Studio 2017, add --vs 2017 to the command.
 * --qt <path>: full path to the folder from where you would like the Qt binaries to be retrieved. By default, CMake would try to auto-detect Qt on the system.
@@ -73,8 +80,9 @@ XCB libraries are required for Qt v5 and above. These can be installed by using:
 sudo apt-get install libxcb-cursor-dev
 ```
 
-Run the python pre_build.py in the build folder.
+Run the python pre_build.py script.
 ```bash
+cd build
 python3 pre_build.py
 ```
 Or run the pre_build.py script with the -qt option to specify another version of Qt. For example:

CMakeLists.txt

@@ -16,7 +16,7 @@ project(RRA)
 
 # Define version information
 set(RRA_MAJOR_VERSION 1)
-set(RRA_MINOR_VERSION 9)
+set(RRA_MINOR_VERSION 10)
 if (NOT RRA_BUGFIX_NUMBER)
     set(RRA_BUGFIX_NUMBER 0)
 endif ()
@@ -123,6 +123,7 @@ endif()
 add_subdirectory(source/backend backend)
 add_subdirectory(source/frontend frontend)
 add_subdirectory(source/renderer renderer)
+add_subdirectory(test/source/backend_test backend_test)
 
 # Group external dependency targets into folder
 IF(WIN32)
@@ -140,6 +141,7 @@ 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
+
 set(DOCS_OUTPUT_DIR ${CMAKE_BINARY_DIR})
 
 # group sphinx source files into a sphinx folder
@@ -205,6 +207,7 @@ if (WIN32)
     install(PROGRAMS ${CMAKE_INSTALL_SYSTEM_RUNTIME_LIBS} DESTINATION . COMPONENT apps)
 endif (WIN32)
 
+
 # CPack packaging
 
 set(CPACK_ARCHIVE_COMPONENT_INSTALL ON)
@@ -213,6 +216,7 @@ set(CPACK_COMPONENTS_GROUPING IGNORE)
 set(CPACK_ARCHIVE_APPS_FILE_NAME "RadeonRaytracingAnalyzer_${RRA_MAJOR_VERSION}.${RRA_MINOR_VERSION}.${RRA_BUGFIX_NUMBER}.${RRA_BUILD_NUMBER}")
 set(CPACK_ARCHIVE_DEBUG_FILE_NAME "RadeonRaytracingAnalyzer-PDB_${RRA_MAJOR_VERSION}.${RRA_MINOR_VERSION}.${RRA_BUGFIX_NUMBER}.${RRA_BUILD_NUMBER}")
 
+
 include(CPack)
 
 cpack_add_component(apps
@@ -222,3 +226,5 @@ cpack_add_component(debug
         DISPLAY_NAME "Debug Symbols"
         DESCRIPTION "Debug Symbols")
 
+
+

README.md

@@ -43,8 +43,8 @@ to reduce performance bottlenecks.
 ## Supported Operating Systems
 * Windows® 10
 * Windows® 11
-* Ubuntu 22.04 LTS (Vulkan only)
-* Ubuntu 24.04 LTS (Vulkan only)
+* Ubuntu® 24.04 LTS (Vulkan only)
+  * With the introduction of 25.20-based Linux drivers, the AMDVLK driver is no longer included in the amdgpu-pro driver package. This is a result of the AMDVLK open-source project being discontinued as mentioned [here](https://github.com/GPUOpen-Drivers/AMDVLK/discussions/416). Instead, the RADV open-source Vulkan® driver is installed by default. Consequently, the Radeon Developer Panel does not support capturing data from Vulkan applications when using these newer driver releases. To analyze Linux Vulkan workloads with Radeon GPU Profiler (RGP), Radeon Raytracing Analyzer (RRA), or Radeon Memory Visualizer (RMV), users can opt for a 25.10-based driver. Alternatively, analysis can be performed using the data capture mechanism integrated within the RADV driver, although this method is not supported by the Radeon Developer Panel. For more information on configuring RADV, refer to the environment variable documentation, specifically the [MESA_VK_TRACE_* environment variables](https://docs.mesa3d.org/envvars.html#envvar-MESA_VK_TRACE) which can be utilized for enabling and configuring tracing.
 
 ## Build instructions
 See [BUILD.md](BUILD.md) for more details.

RELEASE_NOTES.txt

@@ -1,12 +1,11 @@
-Radeon Raytracing Analyzer V1.9 06/17/2025
-------------------------------------------
+Radeon Raytracing Analyzer V1.10
+--------------------------------
 
-V1.9 Changes
+V1.10 Changes
 ------------------------------------
-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.
+1) Uncheck checkboxes for disabled nodes in the BLAS/TLAS viewer treeviews.
+2) Fix the triangle area calculation for very small triangles.
+3) Bug/stability fixes.
 
 Known Issues
 ------------------------------------
@@ -20,12 +19,22 @@ Known Issues
 (8) The axis free camera does not properly "Jump to ray" when the view is reset with 'F' key press.
 (9) Only the X dimension is captured for the applications that use indirect dispatches.
 (10) The FOV and camera speed does not get properly transmitted when jumping from ray inspector to TLAS viewer via the links on the left panel.
-(11) The ray dispatches feature is currently experimental on Linux and requires at least 16GB of system memory to work reliably in most cases.
-(12) Please ensure to load RRA scenes on a machine with a similar GPU to the GPU that was used to capture the trace. Large scenes (those taken at 4K) typically require a large amount of video memory so may not load on lower end GPUs.
+(11) Please ensure to load RRA scenes on a machine with a similar GPU to the GPU that was used to capture the trace. Large scenes (those taken at 4K) typically require a large amount of video memory so may not load on lower end GPUs.
+(12) If any dispatches in the Dispatch list show as having malformed data in RRA, try increasing the Ray dispatch buffer size in the Radeon Developer Panel.
+(13) The ray dispatches feature is currently experimental on Linux and requires at least 16GB of system memory to work reliably in most cases.
+(14) With the introduction of 25.20-based Linux drivers, the AMDVLK driver is no longer included in the amdgpu-pro driver package. This is a result of the AMDVLK open-source project being discontinued as mentioned here (https://github.com/GPUOpen-Drivers/AMDVLK/discussions/416). Instead, the RADV open-source Vulkan® driver is installed by default. Consequently, the Radeon Developer Panel does not support capturing data from Vulkan applications when using these newer driver releases. To analyze Linux Vulkan workloads with Radeon GPU Profiler (RGP), Radeon Raytracing Analyzer (RRA), or Radeon Memory Visualizer (RMV), users can opt for a 25.10-based driver. Alternatively, analysis can be performed using the data capture mechanism integrated within the RADV driver, although this method is not supported by the Radeon Developer Panel. For more information on configuring RADV, refer to the environment variable documentation, specifically the MESA_VK_TRACE_* environment variables (https://docs.mesa3d.org/envvars.html#envvar-MESA_VK_TRACE) which can be utilized for enabling and configuring tracing.
+(15) When using a 25.10-based driver or older: Installations of Ubuntu 20.04 or newer may have the RADV open source Vulkan driver installed by default on the system. As a result, after an amdgpu-pro driver install, the default Vulkan ICD may be the RADV ICD. In order to capture a profile, Vulkan applications must be using the amdgpu-pro Vulkan ICD. The default Vulkan ICD can be overridden by setting the following environment variable before launching a Vulkan application: VK_ICD_FILENAMES=/etc/vulkan/icd.d/amd_icd64.json.
 
 Release Notes History
 ------------------------------------
 
+V1.9 Changes
+------------------------------------
+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.
+
 V1.8 Changes
 ------------------------------------
 1) Support for AMD Radeon RX 9000 series GPUs.

build/dependency_map.py

@@ -22,14 +22,16 @@
 # each git dependency has a desired directory where it will be cloned - along with a commit to checkout
 # The third parameter in the value field is whether to do a shallow clone. Usually, this will be True but if a commit hash is used as a branch, a full clone is needed.
 git_mapping = {
-    github_tools + "qt_common"                                      : ["../external/qt_common",          "v4.2.0",                                   True],
+    github_tools + "qt_common"                                      : ["../external/qt_common",          "v4.3.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",    "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],
-    github_root  + "GPUOpen-Drivers/libamdrdf"                      : ["../external/rdf",                "v1.4.0",                                   True],
+    github_root  + "GPUOpen-Drivers/libamdrdf"                      : ["../external/rdf",                "v1.4.2",                                   True],
+
+    github_root + "catchorg/Catch2"                                 : ["../external/third_party/catch2", "v2.13.6",                                  True],
 }
 
 # Downloads required for Windows builds.

build/pre_build.py

@@ -179,6 +179,7 @@ def check_qt_path(qt_root, qt_root_arg, qt_arg):
     if args.platform == "x86":
         cmake_output_dir += args.platform
 
+
 # Clean all files generated by this script or the build process
 if (args.clean):
     log_print ("Cleaning build ...\n")
@@ -212,6 +213,7 @@ def check_qt_path(qt_root, qt_root_arg, qt_arg):
     qt_expanded_root = os.path.expanduser(args.qt_root)
     qt_found,qt_path = check_qt_path(qt_expanded_root, args.qt_root, args.qt)
 
+
     if qt_found == False:
         log_error_and_exit(qt_path)
 

documentation/source/conf.py

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

documentation/source/index.rst

@@ -43,10 +43,10 @@ Supported graphics APIs, RDNA hardware, and operating systems
 
 -  Windows® 11
 
--  Ubuntu® 22.04 LTS (Vulkan only)
-
 -  Ubuntu® 24.04 LTS (Vulkan only)
 
+ -  With the introduction of 25.20-based Linux drivers, the AMDVLK driver is no longer included in the amdgpu-pro driver package. This is a result of the AMDVLK open-source project being discontinued as mentioned `here <https://github.com/GPUOpen-Drivers/AMDVLK/discussions/416>`_. Instead, the RADV open-source Vulkan® driver is installed by default. Consequently, the Radeon Developer Panel does not support capturing data from Vulkan applications when using these newer driver releases. To analyze Linux Vulkan workloads with Radeon GPU Profiler (RGP), Radeon Raytracing Analyzer (RRA), or Radeon Memory Visualizer (RMV), users can opt for a 25.10-based driver. Alternatively, analysis can be performed using the data capture mechanism integrated within the RADV driver, although this method is not supported by the Radeon Developer Panel. For more information on configuring RADV, refer to the environment variable documentation, specifically the `MESA_VK_TRACE_* environment variables <https://docs.mesa3d.org/envvars.html#envvar-MESA_VK_TRACE>`_ which can be utilized for enabling and configuring tracing.
+
 DISCLAIMER
 ----------
 The information contained herein is for informational purposes only, and is subject to change without notice. While every

source/backend/CMakeLists.txt

@@ -20,6 +20,7 @@ set( SOURCES
     "public/rra_assert.h"
     "public/rra_async_ray_history_loader.h"
     "public/rra_blas.h"
+    "public/rra_blas_header.h"
     "public/rra_bvh.h"
     "public/rra_error.h"
     "public/rra_macro.h"
@@ -28,6 +29,7 @@ set( SOURCES
     "public/rra_rtip_info.h"
     "public/rra_system_info.h"
     "public/rra_tlas.h"
+    "public/rra_tlas_header.h"
     "public/rra_trace_loader.h"
 
     # private backend files
@@ -42,6 +44,7 @@ set( SOURCES
     "rra_assert.cpp"
     "rra_async_ray_history_loader.cpp"
     "rra_blas.cpp"
+    "rra_blas_header.cpp"
     "rra_blas_impl.h"
     "rra_bvh.cpp"
     "rra_bvh_impl.h"
@@ -53,6 +56,7 @@ set( SOURCES
     "rra_rtip_info.cpp"
     "rra_system_info.cpp"
     "rra_tlas.cpp"
+    "rra_tlas_header.cpp"
     "rra_tlas_impl.h"
     "rra_trace_loader.cpp"
     "string_table.cpp"

source/backend/api_info.cpp

@@ -125,4 +125,3 @@ namespace rra
     }
 
 }  // namespace rra
-