Skip to content

Commit 1d09dec

Browse files
committed
Update documentation for RMV 1.1 release.
Change-Id: I3dd55c8ad6091cb37f086b14db8b1eec59a4b445
1 parent 72d517e commit 1d09dec

File tree

68 files changed

+990
-845
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

68 files changed

+990
-845
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
# Radeon™ Memory Visualizer
22

3-
The Radeon Memory Visualizer (RMV) is a software tool that will allow users to analyze video memory usage on AMD Radeon GPUs. RMV will reveal detailed information regarding an application’s video memory consumption and access patterns. This will allow users to understand how memory is being leveraged and open the door to new optimization opportunities.
3+
The Radeon Memory Visualizer (RMV) is a software tool that will allow users to analyze video memory usage on AMD Radeon GPUs. RMV will reveal detailed information regarding an application’s video memory consumption and access patterns. This will allow users to understand how memory is being leveraged and open the door to new optimization opportunities.
44

55
## Getting Started
66

7-
1. Install the latest AMD Video/display driver with RMV support. Be sure to run DDU before installing the driver to ensure a clean install.
8-
2. Unzip the download file. The directory contains the following:
7+
1. Install the latest AMD Video/display driver. Be sure to run DDU before installing the driver to ensure a clean install.
8+
2. Unzip/Untar the download file. The directory contains the following:
99
* Radeon Developer Service (RDS)
1010
* Radeon Developer Service CLI (RDS headless)
1111
* Radeon Developer Panel (RDP)
1212
* Radeon Memory Visualizer (RMV)
1313
3. To gather a memory trace from a game, run the Radeon Developer Panel.
14-
* After making a connection, go to the 'SYSTEM' tab and add the name of the executable to be traced to the list in "My applications".
14+
* After making a connection, go to the 'SYSTEM' tab (this should be performed automatically for local connections).
1515
* Start your application. The Radeon Developer Panel will switch to the "APPLICATIONS" tab. The overlay window in the top left of the application being traced will show if RMV tracing is enabled. If not, make sure the app is running in Vulkan® or DirectX®12 mode.
16-
* When tracing is complete, click "Dump trace" or close your application (in this case, the trace will be dumped automatically).
16+
* When tracing is complete, click on the 'Memory Trace' tab and click "Dump Trace" or close your application (in this case, the trace will be dumped automatically).
1717
4. For further detailed instructions, please see the documentation provided in the Help. Help can be found in the following locations:
1818
* Help web pages exist in the "docs" sub directory
1919
* Help web pages can be accessed from the **Help** button (?) in the Developer Panel
@@ -24,6 +24,7 @@ The Radeon Memory Visualizer (RMV) is a software tool that will allow users to a
2424

2525
## Supported ASICs
2626

27+
* AMD Radeon RX 6000 series
2728
* AMD Radeon RX 5000 series
2829
* AMD Radeon VII
2930
* AMD RX Vega 64 and RX Vega 56
@@ -34,6 +35,6 @@ The Radeon Memory Visualizer (RMV) is a software tool that will allow users to a
3435

3536
## Supported OS's and API's
3637

37-
### Windows 10 only (Version 1903 or higher recommended)
38+
### Windows® 10 only (version 1903 or higher recommended)
3839
* DirectX12
3940
* Vulkan

Release_Notes.txt

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
Radeon Memory Visualizer V1.1 11-24-2020
2+
----------------------------------------
3+
4+
V1.1 Changes
5+
------------------------------------
6+
7+
1) Add support for showing aliased resources in the allocation overview and allocation explorer panes.
8+
2) Rework the resource "Filter by size" slider throughout so that the resources are more evenly distributed.
9+
3) Empty tables show a graphical indication and description as to why the table is empty.
10+
4) Add "color by commit type" coloring mode.
11+
5) Add search box and filter by allocation size to the allocation table in the allocation explorer pane.
12+
6) Show unmapped resource memory in residency donut in the resource details pane.
13+
7) Bug/stability fixes.
14+
15+
Known Issues
16+
------------------------------------
17+
18+
(1a) More than a single active device at a time within a single application is not supported. In this case, only the first device will be traced.
19+
(1b) More than a single Vulkan/DX12 process at a time is not supported. Only the first started application will be traced.
20+
(2) In the Snapshots|Resource details pane, Physical memory mapped events may be shown before virtual allocate events.
21+
(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.
22+
(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.
23+
(5) Running multiple instances of the Radeon Developer Panel is not supported.
24+
(6) Sparse texture are not fully supported.
25+
(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.
26+
27+
Release Notes History
28+
------------------------------------
29+
30+
V1.0
31+
------------------------------------
32+
This is the first public release of the Radeon Memory Visualizer.

docs/source/allocation_explorer.rst

Lines changed: 0 additions & 15 deletions
This file was deleted.

docs/source/allocation_overview.rst

Lines changed: 0 additions & 32 deletions
This file was deleted.

docs/source/capture.rst

Lines changed: 0 additions & 8 deletions
This file was deleted.
Binary file not shown.
-51.6 KB
Binary file not shown.

docs/source/media/device_config_1.png

-28.7 KB
Binary file not shown.

docs/source/media/recent_traces_1.png

-26.2 KB
Binary file not shown.
Binary file not shown.

0 commit comments

Comments
 (0)