diag captureFrame: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "{{Feature|Important|" to "{{Feature|important|")
 
(36 intermediate revisions by 6 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


| 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>
|branch= diagnostic profiling
'''Note''': Only available in specific builds. See [[Performance Profiling]] for details. |= Description
____________________________________________________________________________________________


| '''diag_captureFrame''' frame|= Syntax
|gr1= Diagnostic


|p1= frame: [[Number]] - next n-th frame to be captured |= Parameter 1
|gr2= Performance Profiling


| [[Nothing]] |= Return value
|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'''}}
 
|x1= <code>[[diag_captureFrame]] 1; //capture the first frame after command execution</code> |= Example 1
|x2= <code>[[diag_captureFrame]] 24; //capture 24th frame after command execution</code> |= Example 2
____________________________________________________________________________________________


| [[Performance Profiling]], [[diag_captureSlowFrame]], [[diag_logSlowFrame]] |= See also
|s1= [[diag_captureFrame]] frame


}}
|p1= frame: [[Number]] - next n-th frame to be captured


<h3 style="display:none">Notes</h3>
|r1= [[Nothing]]
<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.


|x1= <sqf>diag_captureFrame 1; // capture the first frame after command execution</sqf>


|x2= <sqf>diag_captureFrame 24; // capture 24th frame after command execution</sqf>


 
|seealso= [[Arma 3: Diagnostics Exe]] [[Performance Profiling]] [[diag_captureSlowFrame]] [[diag_logSlowFrame]] [[logEntities]] [[exportJIPMessages]] [[diag_captureFrameToFile]]
 
}}
<!-- Note Section END -->
</dl>
 
<h3 style="display:none">Bottom Section</h3>
 
[[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}}}}]]

Latest revision as of 00:24, 2 February 2024

A2 OA Logo.png1.63Arma 3 logo black.png1.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:
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
Retrieved from "https://community.bistudio.com/wiki?title=diag_captureFrame&oldid=352010"