screenshot: Difference between revisions

Latest revision as of 11:26, 11 April 2025

Hover & click on the images for description

Description

Description:

Post-Process Effect	Active in screenshot
ColorInversion
FilmGrain
ColorCorrections
DynamicBlur
WetDistortion
ChromaticAberration
RadialBlur
SSAO
Resolution

Takes a screenshot of the 3D scene and saves it to the provided filename.

Only the 3D scene is captured, no GUI/cursor
Sampling is taken in consideration: a 200% sampling value on a 1920x1080 resolution takes a 3840x2160 screenshot
PNG is the only available format

The file is saved in the Screenshots folder in the Profile directory. The folder is by default limited to 250 MB to prevent abuse.
To increase the limit, add the following line at the end of the profile file:

maxScreenShotFolderSizeMB = 2000; // 2 GB

Groups:

System

Syntax

Syntax:: screenshot filename
Parameters:: filename: String - must have .png extension; desired path and name relative to <PROFILEDIR>\Screenshots\ (see Profile).
If empty string c"" used, the filename will be autogenerated in format: YYYY_MM_DD_hh_mm_ss.png
Return Value:: Boolean - true if success

Examples

Example 1:: Copy
screenshot "";
Example 2:: Copy
screenshot "testFile.png";
Example 3:: The following code will result in the screenshot being placed in \Documents\Arma 3\Screenshots\any\where\you\want.png:
Copy
screenshot "any\where\you\want.png";

Additional Information

See also:: BIS_fnc_exportEditorPreviews Configuring Asset Previews

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

Komachi - c: Posted on Mar 20, 2018 - 15:29 (UTC)
: The command will silently fail if your profiles folder is configured to be somewhere else (-profiles parameter), or if your HDR setting is below 16 (configurable in arma3.cfg or medium and above in in-game settings) For full reference on recommended settings consult Eden Editor: Configuring Asset Previews.

@@ Line 6: / Line 6: @@
 |gr1= System
-|descr= Captures a screenshot and stores it to given filename. <u>PNG is the only available format</u> and the file must have .png extension.<br><br>
+|descr=
-The file is saved into ''Screenshots'' folder in the [[Profile]] directory. The folder is by default limited to 250 MB to prevent abuse.<br>
+{{{!}} class="wikitable align-center-col-2 float-right"
+! [[Post Process Effects|Post-Process Effect]]
+! Active in<br>screenshot
+{{!}}-
+{{!}} ColorInversion
+{{!}} {{Icon|unchecked}}
+{{!}}-
+{{!}} FilmGrain
+{{!}} {{Icon|unchecked}}
+{{!}}-
+{{!}} ColorCorrections
+{{!}} {{Icon|unchecked}}
+{{!}}-
+{{!}} DynamicBlur
+{{!}} {{Icon|checked}}
+{{!}}-
+{{!}} WetDistortion
+{{!}} {{Icon|checked}}
+{{!}}-
+{{!}} ChromaticAberration
+{{!}} {{Icon|checked}}
+{{!}}-
+{{!}} RadialBlur
+{{!}} {{Icon|checked}}
+{{!}}-
+{{!}} SSAO
+{{!}} {{Icon|unknown}}
+{{!}}-
+{{!}} Resolution
+{{!}} {{Icon|checked}}
+{{!}}}
+Takes a screenshot of the 3D scene and saves it to the provided filename.
+* Only the 3D scene is captured, no GUI/cursor
+* Sampling is taken in consideration: a 200% sampling value on a 1920x1080 resolution takes a 3840x2160 screenshot
+* PNG is the only available format
+<br>
+The file is saved in the ''Screenshots'' folder in the [[Profile]] directory. The folder is by default limited to '''250 MB''' to prevent abuse.<br>
 To increase the limit, add the following line at the end of the profile file:
 <syntaxhighlight lang="cpp">maxScreenShotFolderSizeMB = 2000; // 2 GB</syntaxhighlight>
@@ Line 13: / Line 50: @@
 |s1= [[screenshot]] filename
-|p1= filename: [[String]] - desired path and name relative to {{hl|&lt;PROFILEDIR&gt;\Screenshots\}} (see [[Profile]]).<br>
+|p1= filename: [[String]] - '''must''' have {{hl|.png}} extension; desired path and name relative to {{hl|&lt;PROFILEDIR&gt;\Screenshots\}} (see [[Profile]]).<br>
-If empty string "" used, the filename will be autogenerated in format: {{hl|YYYY_MM_DD_hh_mm_ss.png}}
+If empty string <sqf inline>""</sqf> used, the filename will be autogenerated in format: {{hl|YYYY_MM_DD_hh_mm_ss.png}}
 |r1= [[Boolean]] - [[true]] if success
@@ Line 22: / Line 59: @@
 |x2= <sqf>screenshot "testFile.png";</sqf>
-|x3= The following code will result in the screenshot being placed in {{hl|\Documents\Arma 3\Screenshots\'''any\where\you\want.png'''}}
+|x3= The following code will result in the screenshot being placed in {{hl|\Documents\Arma 3\Screenshots\'''any\where\you\want.png'''}}:
 <sqf>screenshot "any\where\you\want.png";</sqf>
 |seealso= [[BIS_fnc_exportEditorPreviews]] [[Eden_Editor:_Configuring_Asset_Previews|Configuring Asset Previews]]
-}}
-{{Note
-|user= Nelis75733126
-|timestamp= 20160718183100
-|text= This command only captures the rendered picture (including ppEffects). GUI nor the mouse are visible on the screenshot. '''(Arma 3 1.62.137494)'''
-}}
-{{Note
-|user= POLPOX
-|timestamp= 20171203084200
-|text= Change Sampling on Video Options to make bigger picture than your screen.<br>
-For example, 200% sampling on 1920x1080 screen and take screenshot via this command, it will generate a 3840x2160 picture.
 }}
@@ Line 44: / Line 68: @@
 |user= Komachi
 |timestamp= 20180320152900
-|text=  The command will silently fail if your profiles folder is configured to be somewhere else (-profiles parameter), or if your HDR setting is below 16 (configurable in arma3.cfg or medium and above in in-game settings)
+|text= The command will silently fail if your profiles folder is configured to be somewhere else ({{hl|-profiles}} parameter), or if your HDR setting is below 16 (configurable in arma3.cfg or medium and above in in-game settings)
-For full reference on recommended settings consult [[Eden Editor: Configuring Asset Previews]]
+For full reference on recommended settings consult [[Eden Editor: Configuring Asset Previews]].
 }}