You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 2e1721e
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: documentation/source/radeon_developer_panel_cli.rst
+49-5Lines changed: 49 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -48,21 +48,21 @@ Profiling (RGP) options
48
48
* - Option
49
49
- Description
50
50
* - ``-a, --rgp-auto-capture <spec>``
51
-
- Auto-capture mode. Formats: ``frame[:N]`` captures at frame N (default 0); ``dispatch[:start[:count]]`` captures a range of dispatches.
51
+
- Auto-capture mode. Formats: ``frame[:N]`` captures at frame N (``N`` must be at least 5; default 5, as the trace controller reserves the first few frames for capture preparation); ``dispatch[:start[:count]]`` captures a range of dispatches (``start`` must be at least 1, default 1; ``count`` default 1).
52
52
* - ``--rgp-auto-capture-delay <ms>``
53
53
- Delay in milliseconds before dispatch auto-capture starts. Default: 0.
54
54
* - ``--rgp-capture-mode <mode>``
55
-
- RGP capture mode: ``default``, ``frame``, ``draw``, ``dispatch``. ``default`` lets the driver choose based on the API. Default: ``default``.
55
+
- RGP capture mode: ``default``, ``frame``, ``draw``, ``dispatch``. ``default`` lets the driver choose based on the API. Any other value is rejected. Default: ``default``.
56
56
* - ``--rgp-render-op-count <count>``
57
-
- Number of render operations to capture in ``draw`` or ``dispatch`` mode (ignored in ``frame`` mode). Default: 1.
57
+
- Number of render operations to capture in ``draw`` or ``dispatch`` mode (ignored in ``frame`` mode). Must be at least 1 when the capture mode is ``draw`` or ``dispatch``. Default: 1.
58
58
* - ``--rgp-instruction-tracing``
59
59
- Enable instruction-level tracing for detailed shader analysis.
- SQTT buffer size: ``minimum``, ``low``, ``default``, ``high``, ``maximum``. An unrecognized value is not an error; it falls back to ``default``. Default: ``default``.
66
66
67
67
Raytracing (RRA) options
68
68
------------------------
@@ -74,11 +74,55 @@ Raytracing (RRA) options
74
74
* - Option
75
75
- Description
76
76
* - ``--rra-ray-history-buffer-size <size>``
77
-
- Ray history buffer size: ``disabled``, ``minimum``, ``low``, ``default``, ``high``, ``maximum``. Default: ``default``. This option requires ray dispatch data collection to be enabled; explicit arguments are rejected when ``--rra-collect-ray-dispatch-data=false``.
77
+
- Ray history buffer size: ``disabled``, ``minimum``, ``low``, ``default``, ``high``, ``maximum``. An unrecognized value is not an error; it falls back to ``default``. This option requires ray dispatch data collection to be enabled; explicit arguments are rejected when ``--rra-collect-ray-dispatch-data=false``. Default: ``default``.
- Collect ray dispatch data (ray history). Pass ``--rra-collect-ray-dispatch-data=false`` to disable ray history collection. When disabled, explicit ``--rra-ray-history-buffer-size`` arguments are rejected by the CLI. Default: ``true``.
80
80
* - ``--rra-delay-ms <ms>``
81
81
- Delay in milliseconds before triggering each raytracing capture (0 = no delay). Default: 0.
82
+
* - ``--rra-auto-capture``
83
+
- Request the capture automatically when the application creates its graphics device, then exit, instead of waiting for the ``c`` (capture) interactive command. Combine with ``--rra-marker-capture`` to capture the region between the markers without any interaction.
84
+
* - ``--rra-auto-capture-delay <ms>``
85
+
- Delay in milliseconds between the application creating its graphics device and the automatic capture request. Requires ``--rra-auto-capture``; the CLI exits with an error otherwise. Default: 0.
86
+
* - ``--rra-marker-capture``
87
+
- Capture the region between user markers embedded in the application instead of a frame. The capture is still requested with the ``c`` interactive command, or automatically with ``--rra-auto-capture``; it then begins at the next begin marker. Requires **both** ``--rra-marker-begin`` and ``--rra-marker-end``; the CLI exits with an error if either is missing. Requires AMD driver version 26.20 or newer.
88
+
* - ``--rra-marker-begin <string>``
89
+
- Marker string that starts the capture. Only meaningful together with ``--rra-marker-capture``.
90
+
* - ``--rra-marker-end <string>``
91
+
- Marker string that ends the capture. Only meaningful together with ``--rra-marker-capture``.
92
+
93
+
.. NOTE::
94
+
Marker-based capture requires AMD driver version 26.20 or newer. Unlike the
95
+
panel UI, the CLI does not supply default marker strings — ``--rra-marker-begin``
96
+
and ``--rra-marker-end`` must both be given explicitly whenever
97
+
``--rra-marker-capture`` is used.
98
+
99
+
The markers only take effect once a capture has been requested, either
100
+
manually with the ``c`` interactive command or automatically with
101
+
``--rra-auto-capture``. With ``--rra-auto-capture``, use an
102
+
``--rra-auto-capture-delay`` of around 500 ms: a capture requested
103
+
immediately after the graphics device is created can be empty, because the
104
+
driver has not finished setting up raytracing yet. Markers emitted before the
105
+
delay elapses are missed.
106
+
107
+
Example — capture the region between two markers, requesting the capture with the ``c`` interactive command:
108
+
109
+
.. code-block:: bash
110
+
111
+
RadeonDeveloperPanelCLI --mode raytracing \
112
+
--rra-marker-capture \
113
+
--rra-marker-begin RRABeginMarker \
114
+
--rra-marker-end RRAEndMarker
115
+
116
+
Example — capture the region between two markers automatically, without any interaction:
0 commit comments