diag captureFrameToFile: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " {2,}\}\}" to " }}")
m (Text replacement - "\|x([0-9])= *<code>([^<]*)<\/code>" to "|x$1= <sqf>$2</sqf>")
 
(20 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:diag_captureFrameToFile}}
{{RV|type=command
{{Command


| arma3
|game1= arma3


|1.16
|branch= diag prof


|gr1= Diagnosis
|version1= 1.16


|gr2= Performance Logging
|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  
|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  
written to a log file in the same directory as the [[Crash_Files|.rpt file]].<br>
written to a log file in the same directory as the [[Crash_Files|.rpt file]].<br>
The full Path to the log file is logged to simultaneously.<br>
The full Path to the log file is logged to simultaneously.<br>
The data in the log file can be copied and pasted into the [[diag_captureFrame]] UI dialog to get a visualisation later on.<br>
The data in the log file can be copied and pasted into the [[diag_captureFrame]] UI dialog to get a visualisation later on.
'''Note''': Only available in specific builds. See [[Performance Profiling]] for details.


| '''diag_captureFrameToFile''' frame
|s1= [[diag_captureFrameToFile]]  frame


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


| [[Nothing]]
|r1= [[Nothing]]
 
|x1= <code>[[diag_captureFrameToFile]] 1; //capture the first frame after command execution</code>
|x2= <code>[[diag_captureFrameToFile]] 24; //capture 24th frame after command execution</code>
 
| [[Performance Profiling]], [[diag_captureSlowFrame]], [[diag_logSlowFrame]], [[diag_captureFrame]], [[logEntities]], [[exportJIPMessages]]
}}


<dl class="command_description">
|x1= <sqf>diag_captureFrameToFile 1; //capture the first frame after command execution</sqf>
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>


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


[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
|seealso= [[Performance Profiling]] [[diag_captureSlowFrame]] [[diag_logSlowFrame]] [[diag_captureFrame]] [[logEntities]] [[exportJIPMessages]]
{{GameCategory|arma2|Scripting Commands}}
}}
{{GameCategory|arma3|Scripting Commands}}

Latest revision as of 10:21, 13 May 2022

Arma 3 logo black.png1.16
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 written to a log file in the same directory as the .rpt file.
The full Path to the log file is logged to simultaneously.
The data in the log file can be copied and pasted into the diag_captureFrame UI dialog to get a visualisation later on.
Groups:
DiagnosticPerformance Profiling

Syntax

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

Examples

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

Additional Information

See also:
Performance Profiling diag_captureSlowFrame diag_logSlowFrame diag_captureFrame logEntities exportJIPMessages

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_captureFrameToFile&oldid=318853"