diag_captureSlowFrame

Description

Opens "capture frame" dialog if current frame exceeds set threshold in seconds. One can indicate to either capture duration of a specific profiling selection or the total duration of the frame. The selection names can be obtained by expanding the profiling tree. Clicking on a tree item will highlight the item on the graph and vice versa. The GUI also provides method of copying of the displayed data to clipboard.

Note

Chrome export format: Capturing to file also creates a .trace file, which can be imported into chrome://tracing (in chromium based webbrowsers), or https://ui.perfetto.dev/

The same format can be exported by pressing the "COPY ALL" button, in the capture frame UI, with Ctrl key being held down.

Syntax

diag_captureSlowFrame [section, threshold, frameSkip, toFile, continuousCounter]

Parameters:

• section: String - case-sensitive; some of the selections:

  Render	Main Thread	Visualize	Mjob
  - bgD3D	- total - sLoop (for dedicated server) - cLoop (for headless client) - memAl	- visul	- Mjob

• threshold: Number or Arma 3 v2.20 String

  • Number: section duration in seconds. 0 captures always IF the section you gave as section filter appears inside the given frame. "total" always appears, while "callExt" might not always appear for example.
  • String: number with unit (s / ms / us / ns / fps, e.g "30fps" - see SI prefixes for more unit information)

  Important

  The capture happens "when the section/scope duration is larger/longer than this", except with "fps" where it is "when smaller/lower".

• frameSkip: Number - (Optional, default 0) number of frames to ignore before measuring (since arma3 1.18)

• toFile: Boolean - (Optional, default false) if true, doesn't open UI and writes straight to file. If logging to file, it automatically also outputs a .trace file. Note: even if false it might still force to file if it doesn't have a UI, like a server or HC (since arma3 2.20)

• continuousCounter: Number - (Optional, default 0) captures N slow frames. 0 or 1 will only capture one frame - do not set it to negative! Can be aborted by running diag_captureFrame or another diag_captureSlowFrame usage (since arma3 2.20)

Returns: Nothing

Examples

Example 1

diag_captureSlowFrame ["total", 0.003];

Example 2

diag_captureSlowFrame ["total", "0.003s"];

Example 3

diag_captureSlowFrame ["total", "3ms"];

Example 4

diag_captureSlowFrame ["total", "333fps"];

Example 5

diag_captureSlowFrame ["memAl", 0.0001, 30];

Example 6

diag_captureSlowFrame ["total", 0, 0, false, 3]; // opens the capture UI three times

See also

Arma 3: Diagnostics Exe · Performance Profiling · Arma 3: Cheats · Multiplayer Server Commands · diag_captureFrameToFile · diag_captureFrame · diag logSlowFrame · logEntities · exportJIPMessages