diag captureSlowFrame: Difference between revisions

Latest revision as of 16:29, 5 September 2024

1.63

1.00

Hover & click on the images for description

⚠

Only available in Diagnostic/Profiling branch(es).

Description

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

Render	Main Thread	Visualize	Mjob
bgD3D	total memAl	visul	Mjob

Groups:

Diagnostic Performance Profiling

Syntax

Syntax:: diag_captureSlowFrame [section, threshold, frameSkip]
Parameters:: section: String - case-sensitive
: threshold: Number - section duration in seconds
since 1.18: frameSkip: Number - number of frames to ignorebefore measuring
Return Value:: Nothing

Examples

Example 1:: diag_captureSlowFrame ["total", 0.003];
Example 2:: diag_captureSlowFrame ["memAl", 0.0001, 30];

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

@@ Line 1: / Line 1: @@
-{{DISPLAYTITLE:diag_captureSlowFrame}}
+{{RV|type=command
-{{Command|= Comments
-____________________________________________________________________________________________
-| arma2oa |= Game name
+|game1= arma2oa
+|version1= 1.63
-|1.63|= Game version
+|game2= tkoh
-____________________________________________________________________________________________
+|version2= 1.00
-| [[File:CaptureSlowFrame.jpg|right|200x120px]] 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:
+|game3= arma3
-''Render''
+|version3= 1.00
-<br/> - '''bgD3D'''
-<br/>''Main Thread''
-<br/> - '''total'''
-<br/> - '''memAl'''
-<br/>''Visualize''
-<br/> - '''visul'''
-<br/>''Mjob''
-<br/> - '''Mjob'''
-'''Note''': Only available in specific builds. See [[Performance Profiling]] for details. |= Description
+|branch= diag prof
-____________________________________________________________________________________________
-| '''diag_captureSlowFrame''' [section, threshold] |= Syntax
+|gr1= Diagnostic
-|p1= section: [[String]] - (case sensitive) |= Parameter 1
+|gr2= Performance Profiling
-|p2= threshold: [[Number]] - Duration of the section in seconds |= Parameter 2
+|descr= [[File:CaptureSlowFrame.jpg|right|200x120px]]
+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:
-| [[Nothing]] |= Return value
+{{{!}} class="wikitable valign-top-row-2" style="margin: 1em auto"
-____________________________________________________________________________________________
+! Render
+! Main Thread
-|x1= <code>[[diag_captureSlowFrame]] ['total',0.003];</code> |= Example 1
+! Visualize
-|x2= <code>[[diag_captureSlowFrame]] ['memAl', 0.0001];</code> |= Example 2
+! Mjob
-____________________________________________________________________________________________
+{{!}}-
+{{!}}
+* bgD3D
+{{!}}
+* total
+* memAl
+{{!}}
+* visul
+{{!}}
+* Mjob
+{{!}}}
-| [[Performance Profiling]], [[diag_captureFrame]], [[diag_logSlowFrame]] |= See also
+|s1= [[diag_captureSlowFrame]] [section, threshold, frameSkip]
-}}
+|p1= section: [[String]] - case-sensitive
-<h3 style="display:none">Notes</h3>
+|p2= threshold: [[Number]] - section duration in seconds
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<dd class="notedate">Posted on December 5, 2013
-<dt class="note">'''[[User:Killzone_Kid|Killzone_Kid]]'''
-<dd class="note">
-Available in Arma 3 [DEV] branch since version 1.09.113238. For Dedicated Servers, the results are in the RPT.
+|p3= frameSkip: [[Number]] - number of frames to ignorebefore measuring
+|p3since= arma3 1.18 <!-- estimate, was committed at 2014-03-31 -->
+|r1= [[Nothing]]
+|x1= <sqf>diag_captureSlowFrame ["total", 0.003];</sqf>
-<!-- Note Section END -->
+|x2= <sqf>diag_captureSlowFrame ["memAl", 0.0001, 30];</sqf>
-</dl>
-<h3 style="display:none">Bottom Section</h3>
+|seealso= [[Performance Profiling]] [[diag_captureFrame]] [[diag_logSlowFrame]]
+}}
-[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
-[[Category:Command_Group:_Performance_Logging|{{uc:{{PAGENAME}}}}]]