Update documentation for V1.13.1

README.md

@@ -43,6 +43,7 @@ In order to use the latest features of RGP, it is strongly recommended that user
 * Windows® 11
 * Ubuntu 18.04 LTS (Vulkan only)
 * Ubuntu 20.04 LTS (Vulkan only)
+* Ubuntu 22.04 LTS (Vulkan only)
 
 
 ## Compute APIs, RDNA and GCN hardware, and operating systems

Release_Notes.txt

@@ -1,27 +1,18 @@
-Radeon™ GPU Profiler V1.13 04-21-2022
+Radeon™ GPU Profiler V1.13.1 07-27-2022
 -------------------------------------
 
-V1.13 Changes
+V1.13.1 Changes
 -------------------------------------
 
 * Radeon GPU Profiler
 
-1) Support for additional AMD RDNA™ 2 hardware
-2) Ray tracing counter visualization in the Wavefront Occupancy pane
-3) Support for DirectX® Raytracing (DXR) Tier 1.1 style inline raytracing
-  - Shaders that perform inline raytracing will be marked as such in various parts of RGP
-  - New "Color by ray tracing" mode in the Wavefront timeline portion of the Wavefront Occupancy pane will highlight waves from traditional ray tracing events as well as waves from shaders that contain inline ray tracing
-4) The ISA view in the Pipeline state pane now supports searching
-5) The shader table in the Pipeline state pane for ray tracing events now shows how many shaders are part of the pipeline
-6) Bug/stability fixes
-
-* Radeon Developer Panel
-
-1) RDP will now collect ray tracing counters when profiling an application running on a GPU that supports ray tracing
-2) As part of the support for ray tracing counters, RDP will now post-process counter data after capture. This allows for faster loading of profile data files in RGP
-3) The size of the SQTT memory buffer can now be configured to allow for a larger or smaller buffer
-4) Reduced profiling overhead when using a Workflow that includes both Profiling and Memory Tracing
-5) Fixed capture issue which caused each command buffer to be submitted individually when using a Workflow that includes both Profiling and Memory Tracing
+1) The seed used to generate random colors (for the "Color by event", "Color by API PSO" and "Color by user events" modes) can be altered by the user (https://github.com/GPUOpen-Tools/radeon_gpu_profiler/issues/64)
+2) Fixed issue with disassembly of SMEM instructions with offsets (https://github.com/GPUOpen-Tools/radeon_gpu_profiler/issues/65)
+3) Fixed sorting by Duration and Drain time columns in the Barriers pane (https://github.com/GPUOpen-Tools/radeon_gpu_profiler/issues/67)
+4) Fixed incorrect front-face stencil func value for DirectX® 12 profiles (https://github.com/GPUOpen-Tools/radeon_gpu_profiler/issues/68)
+5) Context rolls pane now includes the Vulkan® front and back stencil reference (https://github.com/GPUOpen-Tools/radeon_gpu_profiler/issues/69)
+6) Pipeline state pane will now report when thread group dimensions are the limiting factor for theoretical wavefront occupancy
+7) RGP can now open profile files saved in paths containing non-ASCII characters
 
 Known Issues
 -------------------------------------
@@ -44,7 +35,7 @@ Known Issues
 14) It is recommended to use at least 1080p display resolution (1920 x 1080) with the RGP user interface. Some minor user interface issues may appear when using a lower resolution.
 15) Cache and ray tracing counter data collection is not currently supported on RDNA 2 based APUs.
 
-* Windows®
+* Windows
 
 1)  Queue synchronization data will be missing from DirectX 12 apps running on Windows Home editions.
 2)  D3D12 command list calls of ExecuteIndirect() may show in RGP as multiple compute events.
@@ -54,7 +45,7 @@ Known Issues
 
 * Linux®
 
-1)  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
+1)  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
 2)  After launching RGP from the Developer Panel to view a captured profile, the panel may fail to connect the next time it is launched. The workaround is to close RGP before relaunching the panel.
 3)  If the Developer Panel or the Developer Service crash while running with the root account, it may be necessary to restart/exit them again with the root account in order to cleanup shared memory.
 4)  When running with the root account, the Developer Panel may output error or warning messages to the terminal. These should not prevent the panel from functioning properly.
@@ -71,6 +62,28 @@ Known Issues
 Release Notes History
 -------------------------------------
 
+V1.13 Changes
+-------------------------------------
+
+* Radeon GPU Profiler
+
+1) Support for additional AMD RDNA 2 hardware
+2) Ray tracing counter visualization in the Wavefront Occupancy pane
+3) Support for DirectX Raytracing (DXR) Tier 1.1 style inline raytracing
+  - Shaders that perform inline raytracing will be marked as such in various parts of RGP
+  - New "Color by ray tracing" mode in the Wavefront timeline portion of the Wavefront Occupancy pane will highlight waves from traditional ray tracing events as well as waves from shaders that contain inline ray tracing
+4) The ISA view in the Pipeline state pane now supports searching
+5) The shader table in the Pipeline state pane for ray tracing events now shows how many shaders are part of the pipeline
+6) Bug/stability fixes
+
+* Radeon Developer Panel
+
+1) RDP will now collect ray tracing counters when profiling an application running on a GPU that supports ray tracing
+2) As part of the support for ray tracing counters, RDP will now post-process counter data after capture. This allows for faster loading of profile data files in RGP
+3) The size of the SQTT memory buffer can now be configured to allow for a larger or smaller buffer
+4) Reduced profiling overhead when using a Workflow that includes both Profiling and Memory Tracing
+5) Fixed capture issue which caused each command buffer to be submitted individually when using a Workflow that includes both Profiling and Memory Tracing
+
 V1.12 Changes
 -------------------------------------
 
@@ -169,7 +182,7 @@ V1.8 Changes
 6) Navigation is now supported from Overlays in the Event timeline in the Wavefront Occupancy pane
 7) Improved performance in the Pipeline State view when loading ISA for large shaders
 8) Improved column sorting support in Pipelines Overview pane
-9) Support for viewing the location (for example in Windows® Explorer) of an .rgp file (both the currently-loaded or a recently-loaded file)
+9) Support for viewing the location (for example in Windows Explorer) of an .rgp file (both the currently-loaded or a recently-loaded file)
 10) Support running on Ubuntu 20.04
 11) Bug/stability fixes
 
@@ -268,7 +281,7 @@ V1.4 Changes
 AMD RX Vega 64, AMD RX Vega 56, AMD Ryzen™ 5 2400G and Ryzen 3 2200G Processors with Radeon Vega Graphics
 2) Improved ability to capture profiles from applications with multiple devices and APIs
 3) Coloring of alert messages changed so that warnings are colored with a yellow background
-4) Alert the user if peak clocks isn't enabled (Linux® only)
+4) Alert the user if peak clocks isn't enabled (Linux only)
 5) Display 'localhost' if connected via a pipe locally, rather than the pipename
 6) Bug/stability fixes & UI clean ups
 

docs/source/conf.py

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

docs/source/index.rst

@@ -74,6 +74,8 @@ Graphics APIs, RDNA and GCN hardware, and operating systems
 
 -  Ubuntu 20.04 LTS (Vulkan only)
 
+-  Ubuntu 22.04 LTS (Vulkan only)
+
 Compute APIs, RDNA and GCN hardware, and operating systems
 ----------------------------------------------------------
 
@@ -128,17 +130,17 @@ How to load a profile
 
 There are a few ways to load a profile into RGP.
 
-1) Use the “File/Open profile” pull down menu item, or the
-   “File/Recent profiles” pull down menu item.
+1) Use the "File/Open profile" pull down menu item, or the
+   "File/Recent profiles" pull down menu item.
 
 .. image:: media_rgp/rgp_file_load.png
 
 .. image:: media_rgp/rgp_file_recent.png
 
-2) Go to the “Welcome” view and click on the “Open a Radeon GPU
-   Profile…” link.
+2) Go to the "Welcome" view and click on the "Open a Radeon GPU
+   Profile…" link.
 
-3) Go to the “Welcome” view and click on a profile that you have
+3) Go to the "Welcome" view and click on a profile that you have
    previously loaded in the Recent list.
 
 .. image:: media_rgp/rgp_welcome.png
@@ -154,7 +156,7 @@ There are a few ways to load a profile into RGP.
 
 5) Load a profile into a new instance of the **Radeon GPU Profiler**
    from the **Radeon Developer Panel**. Select a profile in the list and
-   click on “Open profile”.
+   click on "Open profile".
 
 .. image:: media_rgp/rdp_open_profile.png
 
@@ -885,14 +887,14 @@ The main functions provided by AGS for marking applications are:
   agsDriverExtensionsDX12_PopMarker;
   agsDriverExtensionsDX12_SetMarker;
 
-The below example shows how a draw call can be enclosed within a “Draw
-Particles” user marker, followed by inserting a marker.
+The below example shows how a draw call can be enclosed within a "Draw
+Particles" user marker, followed by inserting a marker.
 ::
 
   // Push a marker
   agsDriverExtensionsDX12_PushMarker(m_AGSContext, pCommandList, "DrawParticles");
 
-  // This draw call will be in the “Draw Particles” User Marker
+  // This draw call will be in the "Draw Particles" User Marker
   pCommandList->DrawInstanced(ParticleCount, 1, 0, 0);
 
   // Pop a marker
@@ -929,8 +931,8 @@ Viewing User Markers
 --------------------
 
 The RGP file captured for a frame of the above application contains many
-user markers. The user markers can be seen in the “Event timing” and
-“Pipeline state” views when you choose the “Group by User Marker” option
+user markers. The user markers can be seen in the "Event timing" and
+"Pipeline state" views when you choose the "Group by User Marker" option
 as shown below.
 
 .. image:: media_rgp/rgp_user_markers_1.png

docs/source/settings.rst

@@ -29,6 +29,13 @@ This pane allows users to thoroughly customize those colors.
 
 .. image:: media_rgp/rgp_themes_and_colors_settings.png
 
+**NOTE**: There are some coloring modes in RGP that use randomly-generated colors. These
+are the **Color by event**, **Color by API PSO** and **Color by user events** modes. In
+some situations, the randomly-generated colors can cause two very similar colors to be
+displayed near each other in the user interface, making it hard to distinguish between
+the similar colors. In order to alleviate this issue, the **Random color seed** setting
+allows the random seed to be altered, generating a different set of random colors.
+
 Keyboard shortcuts
 ------------------
 

docs/source/wavefront_occupancy.rst

@@ -27,7 +27,7 @@ desired region as shown below.
 .. image:: media_rgp/rgp_wavefront_occupancy_3.png
 
 You can zoom into the region by selecting Ctrl + Z, or by clicking on
-“Zoom to selection” (result shown below).
+"Zoom to selection" (result shown below).
 
 .. image:: media_rgp/rgp_wavefront_occupancy_4.png
 
@@ -378,8 +378,8 @@ timeline view and navigate to the Event timing, Pipeline state,
 or Instruction timing pane, or to one of the panes in the Overview tab.
 The selected event or overlay will be shown in the chosen view.
 
-In addition, the user can zoom into an event using the “Zoom to
-selection” option from this context menu.
+In addition, the user can zoom into an event using the "Zoom to
+selection" option from this context menu.
 
 Below is a screenshot of what the right-click context menu looks like.