diag captureSlowFrame: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Some wiki formatting)
 
(29 intermediate revisions by 2 users not shown)
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) |PARAMETER1=
|gr2= Performance Profiling


|p2= threshold: [[Number]] - Duration of the section in seconds |PARAMETER2=
|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:
{{{!}} class="wikitable valign-top-row-2" style="margin: 1em auto"
! Render
! Main Thread
! Visualize
! Mjob
{{!}}-
{{!}}
* bgD3D
{{!}}
* total
* memAl
{{!}}
* visul
{{!}}
* Mjob
{{!}}}


| [[Nothing]] |RETURNVALUE=
|s1= [[diag_captureSlowFrame]] [section, threshold]
____________________________________________________________________________________________
 
|x1= <code>[[diag_captureSlowFrame]] ['total',0.003];</code> |EXAMPLE1=
|x2= <code>[[diag_captureSlowFrame]] ['memAl', 0.0001];</code> |EXAMPLE2=
____________________________________________________________________________________________


| [[Performance Profiling]], [[diag_captureFrame]], [[diag_logSlowFrame]] |SEEALSO=
|p1= section: [[String]] - case sensitive


}}
|p2= threshold: [[Number]] - section duration in seconds
 
|r1= [[Nothing]]


<h3 style="display:none">Notes</h3>
|x1= <sqf>diag_captureSlowFrame ["total", 0.003];</sqf>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>


<h3 style="display:none">Bottom Section</h3>
|x2= <sqf>diag_captureSlowFrame ["memAl", 0.0001];</sqf>


[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
|seealso= [[Performance Profiling]] [[diag_captureFrame]] [[diag_logSlowFrame]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
}}
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Performance_Logging|{{uc:{{PAGENAME}}}}]]

Latest revision as of 17:30, 16 December 2022

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]
Parameters:
section: String - case sensitive
threshold: Number - section duration in seconds
Return Value:
Nothing

Examples

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

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