diag captureFrameToFile: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "_{10,} " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...)
Line 1: Line 1:
{{DISPLAYTITLE:diag_captureFrameToFile}}
{{DISPLAYTITLE:diag_captureFrameToFile}}
{{Command|Comments=
{{Command


| arma3 |Game name=
| arma3


|1.16|Game version=
|1.16


|gr1= Diagnosis |GROUP1=
|gr1= Diagnosis


|gr2= Performance Logging|GROUP2=
|gr2= Performance Logging


| 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  
| 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  
Line 14: Line 14:
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.<br>
'''Note''': Only available in specific builds. See [[Performance Profiling]] for details. |DESCRIPTION=
'''Note''': Only available in specific builds. See [[Performance Profiling]] for details.


| '''diag_captureFrameToFile''' frame|SYNTAX=
| '''diag_captureFrameToFile''' frame


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


| [[Nothing]] |RETURNVALUE=
| [[Nothing]]
   
   
|x1= <code>[[diag_captureFrameToFile]] 1; //capture the first frame after command execution</code> |EXAMPLE1=
|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> |EXAMPLE2=
|x2= <code>[[diag_captureFrameToFile]] 24; //capture 24th frame after command execution</code>


| [[Performance Profiling]], [[diag_captureSlowFrame]], [[diag_logSlowFrame]], [[diag_captureFrame]], [[logEntities]], [[exportJIPMessages]] |SEEALSO=
| [[Performance Profiling]], [[diag_captureSlowFrame]], [[diag_logSlowFrame]], [[diag_captureFrame]], [[logEntities]], [[exportJIPMessages]]


}}
}}

Revision as of 01:30, 18 January 2021


Hover & click on the images for description

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.
Note: Only available in specific builds. See Performance Profiling for details.
Groups:
DiagnosisPerformance Logging

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

Notes

Bottom Section