Update documentation for RMV 1.3 release.

Author: ahosier

License.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017-2021 Advanced Micro Devices, Inc.
+Copyright (c) 2017-2022 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

README.md

@@ -35,7 +35,7 @@ The Radeon Memory Visualizer (RMV) is a software tool that will allow users to a
 
 ## Supported OS's and API's
 
-### Windows® 10 only (version 1903 or higher recommended)
+### Windows® 10/11
 * DirectX12
 * Vulkan
 
@@ -111,4 +111,4 @@ CMake is a registered trademark of Kitware, Inc.
 Qt and the Qt logo are registered trademarks of the Qt Company Ltd and/or its subsidiaries worldwide.
 
 
-© 2020-2021 Advanced Micro Devices, Inc. All rights reserved.
+© 2020-2022 Advanced Micro Devices, Inc. All rights reserved.

Release_Notes.txt

@@ -1,12 +1,10 @@
-Radeon Memory Visualizer V1.2 07-20-2021
-----------------------------------------
+Radeon™ Memory Visualizer V1.3 01-20-2022
+-----------------------------------------
 
-V1.2 Changes
+V1.3 Changes
 ------------------------------------
-
-1) Add tooltips showing resource details on the Resource overview pane.
-2) Add range-based address searching for resource tables.
-3) Bugs/stability fixes.
+1) DX12 Resource naming.
+2) Bugs/stability fixes.
 
 Known Issues
 ------------------------------------
@@ -16,13 +14,21 @@ Known Issues
 (2) In the Snapshots|Resource details pane, Physical memory mapped events may be shown before virtual allocate events.
 (3) Some of the Pane navigation shortcuts may conflict with the keyboard shortcuts used by the Radeon Settings (such as ALT-R). It is recommended to remap the Radeon settings so they don't conflict.
 (4) Some UI elements do not rescale properly when the OS's DPI scale settings are dynamically changed, or when dragging RMV between two monitors with different DPI scales. Close and re-open RMV to view at proper sizes.
-(5) Running multiple instances of the Radeon Developer Panel is not supported. This is also true when running the Radeon Developer Panel supplied with RMV at the same time as the Radeon Developer Panel supplied with the Radeon GPU Profiler.
+(5) Running multiple instances of the Radeon Developer Panel is not supported.
 (6) Sparse texture are not fully supported.
 (7) When tracing an application that uses a launcher, or an application that creates multiple devices, it is possible that more than one trace file will be written to disk. In the case of the launcher, adding the launcher's executable name to the Blocked applications list in the Radeon Developer Panel should prevent multiple trace files. Restarting the Radeon Developer Panel may be required before attempting to trace again.
+(8) If a memory dump is created by shutting down the application being traced and there are a large number of resource names, some names may not be included in the RMV file.  The work-around is to use the Dump trace button in the Radeon Developer Panel and wait for the button to be disabled before shutting down the application.  This gives the buffered names a chance to be processed.
 
 Release Notes History
 ------------------------------------
 
+V1.2 Changes
+------------------------------------
+
+1) Add tooltips showing resource details on the Resource overview pane.
+2) Add range-based address searching for resource tables.
+3) Bugs/stability fixes.
+
 V1.1 Changes
 ------------------------------------
 

documentation/source/conf.py

@@ -46,17 +46,17 @@
 
 # General information about the project.
 project = u'Radeon Memory Visualizer'
-copyright = u'2018-2021, Advanced Micro Devices, Inc. All rights reserved.'
+copyright = u'2018-2022, Advanced Micro Devices, Inc. All rights reserved.'
 author = u'AMD Developer Tools'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # 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.

documentation/source/heap_overview.rst

@@ -23,9 +23,21 @@ the memory type is oversubscibed or is close to being oversubscribed.
 
 The 'total size' bar shows the total amount of physical memory in the heap.
 
-The 'used' bar shows how much memory the application is using in dark gray.
-The lighter gray to the right indicates the total amount of memory used by all
-processes in the system.
+The "Requested" bar shows how much memory the application has requested. This
+should give an indication of the memory footprint of the application.
+Memory requests typically request virtual memory under the hood and it is up
+to the driver to make sure that virtual memory is mapped to physical memory
+when and where appropriate.
+
+The "Bound" bar shows how much memory has been bound to resources. If there is
+substantially more requested memory than bound memory, it may indicate that
+memory has been requested but is not actually being used by the application.
+
+The "Committed" bar shows how much memory has been mapped to physical memory.
+If the amount of committed memory is substantially less than the amount of
+memory requested, it may indicate that there are other tasks running on the
+system that are consuming memory or the application itself is using more
+memory than is physically available.
 
 The middle column shows a series of statistics for the heap memory type, such
 as where the memory resides (in system or video memory), whether it is mapped

documentation/source/index.rst

@@ -37,7 +37,7 @@ Supported graphics APIs, RDNA and GCN hardware, and operating systems
 
 \ **Supported Operating Systems**
 
--  Windows® 10 only (version 1903 or higher recommended)
+-  Windows® 10/11
 
 Radeon Memory Visualizer - Quick Start
 ======================================
@@ -204,6 +204,17 @@ https://www.lunarg.com/wp-content/uploads/2018/05/Vulkan-Debug-Utils_05_18_v1.pd
 
 specifically the section "Naming Objects"
 
+DirectX 12 resource naming
+--------------------------
+Memory traces for DirectX applications captured with the Radeon Developer Panel
+can include unique names for image-based resources.  Names can be assigned to
+DirectX resources using the ID3D12Object::SetName() method.  Calling the SetName()
+method results in ETW (Event Tracing for Windows) events being emitted and picked
+up by the Panel.  This resource naming information is then included in the RMV trace
+file.
+
+For more information, please review the Microsoft DirectX 12 documentation.
+
 Viewing resource names
 ----------------------
 The resource names will show up in the RMV UI in the resource list pane, for example:
@@ -237,4 +248,4 @@ Microsoft is a registered trademark of Microsoft Corporation in the US and other
 Windows is a registered trademark of Microsoft Corporation in the US and other jurisdictions.
 
 
-© 2018-2021 Advanced Micro Devices, Inc. All rights reserved.
+© 2018-2022 Advanced Micro Devices, Inc. All rights reserved.