Difference between revisions of "diag captureFrame"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (command group: Diagnosis)
m (Text replacement - "\|x([0-9])= *<code>([^<]*)<\/code>" to "|x$1= <sqf>$2</sqf>")
 
(21 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:diag_captureFrame}}
+
{{RV|type=command
{{Command|Comments=
 
____________________________________________________________________________________________
 
  
| arma2oa |Game name=
+
|game1= arma2oa
 +
|version1= 1.63
  
|1.63|Game version=
+
|game2= arma3
 +
|version2= 1.00
  
|gr1= Diagnosis |GROUP1=
+
|branch= diagnostic profiling
  
|gr2= Performance Logging|GROUP2=
+
|gr1= Diagnostic
____________________________________________________________________________________________
 
  
| This command starts counting frames from the moment it is executed and when the count reaches the number passed as param, the current frame is captured and captured data UI dialog appears, similar to [[diag_captureSlowFrame]].<br>
+
|gr2= Performance Profiling
This can also be executed on a dedicated Server and because a Server has no UI it will behave like [[diag_captureFrameToFile]].<br>
 
Special: BattlEye's RCON variant of this command is #captureFrame<br>
 
'''Note''': Only available in specific builds. See [[Performance Profiling]] for details. |DESCRIPTION=
 
____________________________________________________________________________________________
 
  
| '''diag_captureFrame''' frame|SYNTAX=
+
|descr= This command starts counting frames from the moment it is executed and when the count reaches the number passed as param, the current frame is captured and captured data UI dialog appears, similar to [[diag_captureSlowFrame]]. This can also be executed on a dedicated Server and because a Server has no UI it will behave like [[diag_captureFrameToFile]].
 +
{{Feature|Important|BattlEye's RCON variant of this command is '''#captureFrame'''}}
  
|p1= frame: [[Number]] - next n-th frame to be captured |PARAMETER1=
+
|s1= [[diag_captureFrame]] frame
  
| [[Nothing]] |RETURNVALUE=
+
|p1= frame: [[Number]] - next n-th frame to be captured
____________________________________________________________________________________________
 
 
 
|x1= <code>[[diag_captureFrame]] 1; //capture the first frame after command execution</code> |EXAMPLE1=
 
|x2= <code>[[diag_captureFrame]] 24; //capture 24th frame after command execution</code> |EXAMPLE2=
 
____________________________________________________________________________________________
 
  
| [[Performance Profiling]], [[diag_captureSlowFrame]], [[diag_logSlowFrame]], [[logEntities]], [[exportJIPMessages]], [[diag_captureFrameToFile]] |SEEALSO=
+
|r1= [[Nothing]]
  
}}
+
|x1= <sqf>diag_captureFrame 1; // capture the first frame after command execution</sqf>
  
<h3 style="display:none">Notes</h3>
+
|x2= <sqf>diag_captureFrame 24; // capture 24th frame after command execution</sqf>
<dl class="command_description">
 
<!-- Note Section BEGIN -->
 
<!-- Note Section END -->
 
</dl>
 
  
<h3 style="display:none">Bottom Section</h3>
+
|seealso= [[Arma 3: Diagnostics Exe]] [[Performance Profiling]] [[diag_captureSlowFrame]] [[diag_logSlowFrame]] [[logEntities]] [[exportJIPMessages]] [[diag_captureFrameToFile]]
 
+
}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 

Latest revision as of 11:22, 13 May 2022

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

Description

Description:
This command starts counting frames from the moment it is executed and when the count reaches the number passed as param, the current frame is captured and captured data UI dialog appears, similar to diag_captureSlowFrame. This can also be executed on a dedicated Server and because a Server has no UI it will behave like diag_captureFrameToFile.
BattlEye's RCON variant of this command is #captureFrame
Groups:
DiagnosticPerformance Profiling

Syntax

Syntax:
diag_captureFrame frame
Parameters:
frame: Number - next n-th frame to be captured
Return Value:
Nothing

Examples

Example 1:
diag_captureFrame 1; // capture the first frame after command execution
Example 2:
diag_captureFrame 24; // capture 24th frame after command execution

Additional Information

See also:
Arma 3: Diagnostics Exe Performance Profiling diag_captureSlowFrame diag_logSlowFrame logEntities exportJIPMessages diag_captureFrameToFile

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