From 357729910acedb995f5df5df91d2817fcd619d4a Mon Sep 17 00:00:00 2001 From: b-luk <97480502+b-luk@users.noreply.github.com> Date: Mon, 10 Nov 2025 12:48:01 -0800 Subject: [PATCH] Update "Frame Capture with RenderDoc" docs with instructions for Android (#178138) Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> --- .../impeller/docs/renderdoc_frame_capture.md | 27 ++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/docs/engine/impeller/docs/renderdoc_frame_capture.md b/docs/engine/impeller/docs/renderdoc_frame_capture.md index 4bce6f3e4e3..0ac10ad32e1 100644 --- a/docs/engine/impeller/docs/renderdoc_frame_capture.md +++ b/docs/engine/impeller/docs/renderdoc_frame_capture.md @@ -47,6 +47,31 @@ ![Renderdoc Capture](https://raw.githubusercontent.com/flutter/assets-for-api-docs//5da33067f5cfc7f177d9c460d618397aad9082ca/assets/engine/impeller/renderdoc_frame_capture/render-doc-capture.avif) -_See also:_ +## RenderDoc on Android + +RenderDoc can be used on a debug-mode Flutter app running on Android. + +1. First use `flutter run` to build and install the debug-mode app apk onto the Android device. + - The app can use the default engine + or it can [use a local engine](https://github.com/flutter/flutter/blob/main/docs/engine/Debugging-the-engine.md#running-a-flutter-app-with-a-local-engine). + - To debug an app with Impeller explicitly enabled or disabled, + specify an `EnableImpeller` value in your `AndroidManifest.xml` as described + [here](https://github.com/flutter/flutter/blob/main/engine/src/flutter/impeller/README.md#android). + - **Note**: Any `--(no-)enable-impeller` flag used with `flutter run` will not be retained when the app is launched from RenderDoc. + +2. Follow the RenderDoc [Android How To](https://renderdoc.org/docs/how/how_android_capture.html) + to connect RenderDoc to your Android device and select your app to debug. + - Click the `...` button at the end of the "Executable Path" input field + to choose from available installed app packages on the device. + +3. Click "Launch". + If everything is working, the app should begin running on your device. + Capturing frames works in exactly the same way as described above for + debugging a Linux executable. + +## See also * [Learning to Read GPU Frame Captures](https://github.com/flutter/flutter/blob/main/docs/engine/impeller/docs/read_frame_captures.md) + * The official [RenderDoc documentation](https://renderdoc.org/docs/index.html) + * Particularly the [Quick Start](https://renderdoc.org/docs/getting_started/quick_start.html) + and [How do I...?](https://renderdoc.org/docs/how/index.html) guides