diag captureSlowFrame: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Add offset parameter)
(updated with 2.20 updates provided by Dedmen)
Line 44: Line 44:
|p2= threshold: [[Number]] - section duration in seconds
|p2= threshold: [[Number]] - section duration in seconds


|p3= frameSkip: [[Number]] - number of frames to ignorebefore measuring
|p3= frameSkip: [[Number]] - number of frames to ignore before measuring
|p3since= arma3 1.18 <!-- estimate, was committed at 2014-03-31 -->
|p3since= arma3 1.18 <!-- estimate, was committed at 2014-03-31 -->
|p4= toFile: [[Boolean]] - if true, doesn't open UI and writes straight to file, note that even if false it might still force to file if it doesn't have a UI, like a server or HC
|p4since= arma3 2.20
|p5= continuousCounter: [[Number]] - captures N slow frames. Can be aborted by running diag_captureFrame or another captureSlowFrame
|p5since= arma3 2.20


|r1= [[Nothing]]
|r1= [[Nothing]]
Line 52: Line 58:


|x2= <sqf>diag_captureSlowFrame ["memAl", 0.0001, 30];</sqf>
|x2= <sqf>diag_captureSlowFrame ["memAl", 0.0001, 30];</sqf>
|x3= <sqf>diag_captureSlowFrame ["total", 0, 0, false, 3];</sqf> Will open the capture ui 3 times


|seealso= [[Performance Profiling]] [[diag_captureFrame]] [[diag_logSlowFrame]]
|seealso= [[Performance Profiling]] [[diag_captureFrame]] [[diag_logSlowFrame]]
}}
}}

Revision as of 11:07, 28 October 2024

Hover & click on the images for description
Only available in Diagnostic/Profiling branch(es).

Description

Description:
CaptureSlowFrame.jpg

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. Some of the selections:

Render Main Thread Visualize Mjob
  • bgD3D
  • total
  • memAl
  • visul
  • Mjob
Groups:
DiagnosticPerformance Profiling

Syntax

Syntax:
diag_captureSlowFrame [section, threshold, frameSkip]
Parameters:
section: String - case-sensitive
threshold: Number - section duration in seconds
since Arma 3 logo black.png1.18
frameSkip: Number - number of frames to ignore before measuring
since Arma 3 logo black.png2.20
toFile: Boolean - if true, doesn't open UI and writes straight to file, note that even if false it might still force to file if it doesn't have a UI, like a server or HC
since Arma 3 logo black.png2.20
continuousCounter: Number - captures N slow frames. Can be aborted by running diag_captureFrame or another captureSlowFrame
Return Value:
Nothing

Examples

Example 1:
diag_captureSlowFrame ["total", 0.003];
Example 2:
diag_captureSlowFrame ["memAl", 0.0001, 30];
Example 3:
diag_captureSlowFrame ["total", 0, 0, false, 3];
Will open the capture ui 3 times

Additional Information

See also:
Performance Profiling diag_captureFrame diag_logSlowFrame

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note