diag captureFrame: Difference between revisions

Revision as of 11:29, 27 February 2021

1.63-wrong parameter ("arma3diag") defined!-[[:Category:Introduced with arma3diag version 1.00|1.00]]

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:: Diagnostic Performance 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

[[ Category: arma3diag: Scripting Commands | DIAG CAPTUREFRAME]]

@@ Line 1: / Line 1: @@
-{{Command|= Comments
+{{RV|type=command
-____________________________________________________________________________________________
-| arma2oa |= Game name
+|game1= arma2oa
-|1.63|= Game version
+|version1= 1.63
-____________________________________________________________________________________________
-| Capture the single frame, following after the number of frames given as parameter. <br>
+|game2= arma3diag
-'''Note''': Only available in specific builds. See [[Performance Profiling]] for details. |= Description
-____________________________________________________________________________________________
-| '''diag_captureFrame''' frame|= Syntax
+|version2= 1.00
-|p1= frame: [[Number]] - next n-th frame to be captured |= Parameter 1
+|branch= diagnostic profiling
-| [[Nothing]] |= Return value
+|gr1= Diagnostic
-____________________________________________________________________________________________
-|x1= <pre>diag_captureFrame 4711</pre> |= Example 1
-____________________________________________________________________________________________
-| [[Performance Profiling]], [[diag_captureSlowFrame]], [[diag_logsLowFrame]] |= See also
+|gr2= Performance Profiling
-}}
+|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'''}}
-<h3 style="display:none">Notes</h3>
+|s1= '''diag_captureFrame''' frame
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
+|p1= frame: [[Number]] - next n-th frame to be captured
-</dl>
-<h3 style="display:none">Bottom Section</h3>
+|r1= [[Nothing]]
+|x1= <code>[[diag_captureFrame]] 1; {{cc|capture the first frame after command execution}}</code>
-[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
+|x2= <code>[[diag_captureFrame]] 24; {{cc|capture 24th frame after command execution}}</code>
-[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
-[[Category:Command_Group:_Performance_Logging|{{uc:{{PAGENAME}}}}]]
+|seealso= [[Arma 3: Diagnostics Exe]] [[Performance Profiling]] [[diag_captureSlowFrame]] [[diag_logSlowFrame]] [[logEntities]] [[exportJIPMessages]] [[diag_captureFrameToFile]]
+}}