Update documentation for RRA v1.3 release

Author: ahosier

BUILD.md

@@ -84,5 +84,25 @@ Alternatively, building can be done directly from the prebuild script with the -
 python3 pre_build.py --build
 ```
 
+It is possible to use the system-installed version of Qt rather than using a Qt installer described above. At the time of this writing, Ubuntu 22.04 LTS
+comes with Qt 5.15.3. To use the system Qt, a fake Qt package is needed. For Qt 5.15.3, this can be made by creating the required directory structure
+and setting up symbolic links to point to the system Qt lib and include directories:
+```bash
+mkdir -p ~/Qt/Qt5.15.3/5.15.3/gcc_64
+sudo ln -s /usr/lib/x86_64-linux-gnu ~/Qt/Qt5.15.3/5.15.3/gcc_64/lib
+sudo ln -s /usr/include/x86_64-linux-gnu/qt5 ~/Qt/Qt5.15.3/5.15.3/gcc_64/include
+```
+python3 pre_build.py --qt 5.15.3 --qt-system --disable-extra-qt-lib-deploy --build
+
+Some additional Qt components may be required, so install those:
+
+```
+sudo apt-get install qtbase5-dev
+sudo apt-get install qtbase5-dev-tools
+sudo apt-get install libqt5svg5-dev
+sudo apt-get install libqt5x11extras5
+sudo apt-get install qtbase5-private-dev
+```
+
 [qt-online]: https://www.qt.io/blog/qt-5.15.2-released
 [qt-offline]: https://download.qt.io/archive/qt/5.12/5.12.6/

README.md

@@ -19,13 +19,18 @@ to reduce performance bottlenecks.
    * Radeon Developer Panel (RDP)
    * Radeon Raytracing Analyzer (RRA)
 3. To capture a trace from a game, run the Radeon Developer Panel and follow the instructions in the Help. Help can be found in the following locations:
-   * Help web pages exist in the "docs" sub directory
+   * Help web pages exist in the "help" sub directory
    * Help web pages can be accessed from the **Help** button in the Developer Panel
    * Help web pages can be accessed from the Welcome screen in the Radeon Raytracing Analyzer, or from the **Help** menu
    * The documentation is hosted publicly at:
      * https://radeon-developer-panel.readthedocs.io/en/latest/
      * https://radeon-raytracing-analyzer.readthedocs.io/en/latest/
 
+## Important notes
+1. In order to capture BVH data, please ensure that acceleration structures are rebuilt each frame.
+2. In order to capture ray history information, please ensure that all command buffer are rebuilt each frame.
+3. RayQuery is currently only supported from compute shaders. Calling RayQuery from the graphics pipeline is not supported.
+
 ## Supported APIs
  * DirectX12
  * Vulkan
@@ -43,7 +48,7 @@ to reduce performance bottlenecks.
 See [BUILD.md](BUILD.md) for more details.
 
 ## License ##
-Radeon Raytracing Analyzer is licensed under the MIT license. See the [License.txt](License.txt) file for complete license information.
+Radeon Raytracing Analyzer is licensed under the MIT license. See the [LICENSE.txt](LICENSE.txt) file for complete license information.
 
 ## Copyright information ##
 Please see [NOTICES.txt](NOTICES.txt) for third party license information.

Release_Notes.txt RELEASE_NOTES.txtRelease_Notes.txt renamed to RELEASE_NOTES.txt

@@ -1,13 +1,14 @@
-Radeon Raytracing Analyzer V1.2 04/26/2023
+Radeon Raytracing Analyzer V1.3 09/21/2023
 ------------------------------------------
 
-V1.2 Changes
+V1.3 Changes
 ------------------------------------
-1) Ray face culling flags added to traversal viewer pane.
-2) Geometry list sub-tab added to BLAS tab.
-3) Addition of an instance mask to the TLAS viewer pane.
-4) Addition of a histogram to the traversal mode viewer side pane.
-5) Bugs/stability fixes.
+1) Addition of a RAY tab, to enable the ability to visualize dispatches and individual rays.
+2) Ray Dispatches pane added to visualize ray dispatches and allow selection of pixels within those dispatches.
+3) Ray Inspector pane added to visualize individual rays and their collisions with scene objects.
+4) Reset button added to TLAS/BLAS viewer panes and Inspector pane to reset the UI to its default settings.
+5) Allow viewer UI state to be persistent between RRA sessions via a checkbox in the general settings.
+6) Bugs/stability fixes.
 
 Known Issues
 ------------------------------------
@@ -18,10 +19,22 @@ Known Issues
 (5) Radeon Developer Panel cannot capture RRA traces from non-AMD GPUs.
 (6) Unicode folders and filenames are currently not supported.
 (7) There is currently no default "Application 'up' axis" in the viewer panes. When loading or reloading RRA traces, orient your scene and press the "U" key to automatically set the up axis.
+(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.
 
 Release Notes History
 ------------------------------------
 
+V1.2 Changes
+------------------------------------
+1) Ray face culling flags added to traversal viewer pane.
+2) Geometry list sub-tab added to BLAS tab.
+3) Addition of an instance mask to the TLAS viewer pane.
+4) Addition of a histogram to the traversal mode viewer side pane.
+5) Bugs/stability fixes.
+
 V1.1.1 Changes
 ------------------------------------
 1) Add support for fused instances.

documentation/source/_static/style.css

@@ -0,0 +1,3 @@
+.wy-nav-content {
+    max-width: none;
+}

documentation/source/_templates/layout.html

@@ -0,0 +1,4 @@
+{% extends "!layout.html" %}
+{% block extrahead %}
+    <link href="{{ pathto("_static/style.css", True) }}" rel="stylesheet" type="text/css">
+{% endblock %}

documentation/source/conf.py

@@ -54,16 +54,16 @@
 # built documents.
 #
 # The short X.Y version.
-version = u'1.2.0'
+version = u'1.3.0'
 # The full version, including alpha/beta/rc tags.
-release = u'1.2.0'
+release = u'1.3.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -110,7 +110,7 @@
 # file works better with read the docs (more so than specifying it via the
 # html_context tag)
 def setup(app):
-    app.add_stylesheet('theme_overrides.css')
+    app.add_css_file('theme_overrides.css')
 
 html_show_sourcelink = False
 html_show_sphinx = False

documentation/source/index.rst

@@ -40,7 +40,7 @@ Radeon Raytracing Analyzer - Quick Start
 Starting the Radeon Raytracing Analyzer
 ---------------------------------------
 
-Start **RadeonRaytracingAnalyzer.exe** (this is the tool used to view BVH trace data).
+Start **RadeonRaytracingAnalyzer.exe** (this is the tool used to view RRA trace data).
 
 How to load a trace
 -------------------
@@ -68,7 +68,7 @@ There are a few ways to load a trace into RRA.
 
 .. image:: media/recent_traces_1.png
 
-5) Drag and drop a BVH trace file onto the **Radeon Raytracing Analyzer**
+5) Drag and drop an RRA trace file onto the **Radeon Raytracing Analyzer**
    executable, or onto an already open RRA instance.
 
 The Radeon Raytracing Analyzer user interface
@@ -124,6 +124,13 @@ number of sub-windows..
    e. **Properties** - Lists statistics and properties for the currently
       selected bottom-level acceleration structure.
 
+5. **RAY**
+
+   a. **Dispatches** - The main viewer for visualizing various types of dispatches that shot rays.
+
+   b. **Inspector** - A viewer for inspecting rays and how they interact with
+      the scene.
+
 Settings
 ========
 
@@ -182,6 +189,15 @@ These panes show information about a bottom-level acceleration structure.
 
 .. include:: blas_properties.rst
 
+The RAY windows
+===============
+
+These panes allow dispatches and rays to be visualized.
+
+.. include:: ray_dispatches.rst
+
+.. include:: ray_inspector.rst
+
 DISCLAIMER
 ==========
 The information contained herein is for informational purposes only, and is subject to change without notice. While every