diag captureFrameToFile: Difference between revisions
Jump to navigation
Jump to search
m (Text replacement - "|gr2= Performance Logging" to "|gr2= Performance Profiling") |
m (formatting) |
||
| Line 1: | Line 1: | ||
{{RV|type=command | {{RV|type=command | ||
| | |game1= arma3diag | ||
|1.16 | |version1= 1.16 | ||
|gr1= Diagnostic | |gr1= Diagnostic | ||
| Line 9: | Line 9: | ||
|gr2= Performance Profiling | |gr2= Performance Profiling | ||
| 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 | |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. | The data in the log file can be copied and pasted into the [[diag_captureFrame]] UI dialog to get a visualisation later on. | ||
{{Feature|informative|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> | |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> | |x2= <code>[[diag_captureFrameToFile]] 24; //capture 24th frame after command execution</code> | ||
|seealso= [[Performance Profiling]], [[diag_captureSlowFrame]], [[diag_logSlowFrame]], [[diag_captureFrame]], [[logEntities]], [[exportJIPMessages]] | |seealso= [[Performance Profiling]], [[diag_captureSlowFrame]], [[diag_logSlowFrame]], [[diag_captureFrame]], [[logEntities]], [[exportJIPMessages]] | ||
}} | }} | ||
Revision as of 23:53, 28 March 2021
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 Profilingdiag_captureSlowFramediag_logSlowFramediag_captureFramelogEntitiesexportJIPMessages
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:Introduced with arma3diag version 1.16]][[ Category: arma3diag: New Scripting Commands | DIAG CAPTUREFRAMETOFILE]][[ Category: arma3diag: Scripting Commands | DIAG CAPTUREFRAMETOFILE]]