capture_renderdoc_frame
Trigger a RenderDoc frame capture in the O3DE editor and report the result; if the API cannot trigger it, provide manual capture alternatives such as F12 or the GPU capture menu.
Instructions
Trigger a RenderDoc frame capture in the O3DE editor.
Attempts to trigger a RenderDoc capture via GraphicsProfilerBus. That
bus is not exposed to editor Python on O3DE 26.10.0, so there the tool
returns manual_required with the manual alternatives (F12 in
RenderDoc, or the editor's GPU capture menu).
Returns:
JSON with status ok if the capture was triggered, error
on failure, or manual_required if the Python API cannot
trigger the capture and manual action is needed.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "capture_renderdoc_frame"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |