getResolution: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\| *((\[\[[a-zA-Z0-9_ |()]+\]\],? ?)+) * \}\}" to "|seealso= $1 }}")
(formatting and new command group)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| arma2oa
|game1= arma2oa


|1.55
|version1= 1.55
 
|game2= tkoh
 
|version2= 1.00
 
|game3= arma3
 
|version3= 0.50


|gr1= System
|gr1= System


|gr2= GUI Control
|gr2= GUI Control - Positioning
 
|descr= Returns an array containing all information about current client screen resolution.
 
{{Feature|arma3 | '''Render resolution''' is not returned by this command.<br>
A sampling setting of '''50%''' means half of native width ''and'' half of native height, resulting in a render resolution of '''''25%''''' the original resolution.}}
{{Feature | important | The engine default value for <tt>fovTop</tt> is '''0.75''' in case it is needed to calculate difference with custom FOV.}}
{{Feature | Informative | The <tt>aspectRatio</tt> is calculated as <tt>fovLeft&nbsp;/&nbsp;fovTop</tt> and should be the same as <tt>screenW&nbsp;/&nbsp;screenH</tt> for undistorted image if the FOV is custom. Some of the common values:
{{{!}} class{{=}}"wikitable"
! 16/9 !! 16/10 !! 5/4 !! 4/3 !! 16/9 triple screen
{{!}}-
{{!}} 1.777777(…) {{!}}{{!}} 1.6 {{!}}{{!}} 1.25 {{!}}{{!}} 1.333333(…) {{!}}{{!}} 5.333333(…)
{{!}}}
}}
 
|s1= [[getResolution]]


| Returns an array containing all information about current client screen resolution in format:<br>
|r1= [[Array]] - <tt>[screenW, screenH, viewPortW, viewPortH, aspectRatio, uiScale, fovTop, fovLeft, tripleHead]</tt><br>
<tt>[screenW, screenH, viewPortW, viewPortH, aspectRatio, uiScale, fovTop, fovLeft, tripleHead]</tt><br>
Where:
* <tt>screenW</tt>: [[Number]] - width of the screen in pixels
* <tt>screenW</tt>: [[Number]] - width of the screen in pixels
* <tt>screenH</tt>: [[Number]] - height of the screen in pixels
* <tt>screenH</tt>: [[Number]] - height of the screen in pixels
Line 27: Line 48:
* <tt>fovLeft</tt>: [[Number]] - horizontal FOV in [[rad | radians]], the same as<tt>fovLeft</tt> value from the user profile ({{Since|arma3|1.94.145947}})
* <tt>fovLeft</tt>: [[Number]] - horizontal FOV in [[rad | radians]], the same as<tt>fovLeft</tt> value from the user profile ({{Since|arma3|1.94.145947}})
* <tt>tripleHead</tt>: [[Boolean]] - [[true]] if user has triple head screen (see also [[safeZoneXAbs]], [[safeZoneWAbs]]) ({{Since|arma3|1.94.145947}})
* <tt>tripleHead</tt>: [[Boolean]] - [[true]] if user has triple head screen (see also [[safeZoneXAbs]], [[safeZoneWAbs]]) ({{Since|arma3|1.94.145947}})
{{Feature|arma3 | '''Render resolution''' is not returned by this command.<br>
A sampling setting of '''50%''' means half of native width ''and'' half of native height, resulting in a render resolution of '''''25%''''' the original resolution.}}
{{Feature | important | The engine default value for <tt>fovTop</tt> is '''0.75''' in case it is needed to calculate difference with custom FOV.}}
{{Feature | Informative | The <tt>aspectRatio</tt> is calculated as <tt>fovLeft&nbsp;/&nbsp;fovTop</tt> and should be the same as <tt>screenW&nbsp;/&nbsp;screenH</tt> for undistorted image if the FOV is custom. Some of the common values:
{{{!}} class{{=}}"wikitable"
! 16/9 !! 16/10 !! 5/4 !! 4/3 !! 16/9 triple screen
{{!}}-
{{!}} 1.777777(…) {{!}}{{!}} 1.6 {{!}}{{!}} 1.25 {{!}}{{!}} 1.333333(…) {{!}}{{!}} 5.333333(…)
{{!}}}
}}
| [[getResolution]]
| [[Array]] - see the description


|x1= <code>_res = [[getResolution]]; {{cc|a 16/9 single monitor setup}}</code>
|x1= <code>_res = [[getResolution]]; {{cc|a 16/9 single monitor setup}}</code>
Line 94: Line 100:
<!-- Note Section END -->
<!-- Note Section END -->
</dl>
</dl>
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Revision as of 10:49, 5 March 2021

Hover & click on the images for description

Description

Description:
Returns an array containing all information about current client screen resolution.
Arma 3
Render resolution is not returned by this command.
A sampling setting of 50% means half of native width and half of native height, resulting in a render resolution of 25% the original resolution.
The engine default value for fovTop is 0.75 in case it is needed to calculate difference with custom FOV.
The aspectRatio is calculated as fovLeft / fovTop and should be the same as screenW / screenH for undistorted image if the FOV is custom. Some of the common values:
16/9 16/10 5/4 4/3 16/9 triple screen
1.777777(…) 1.6 1.25 1.333333(…) 5.333333(…)
Groups:
SystemGUI Control - Positioning

Syntax

Syntax:
getResolution
Return Value:
Array - [screenW, screenH, viewPortW, viewPortH, aspectRatio, uiScale, fovTop, fovLeft, tripleHead]
  • screenW: Number - width of the screen in pixels
  • screenH: Number - height of the screen in pixels
  • viewPortW: Number - width of the 4:3 view port in pixels
  • viewPortH: Number - height of the 4:3 view port in pixels
  • aspectRatio: Number - screen aspect ratio
  • uiScale: Number - the scale of the UI, which affects view port size:
Arma 3
Very Small Small Normal Large Very Large
0.47 0.55 0.7 0.85 1

Examples

Example 1:
_res = getResolution; // a 16/9 single monitor setup [ 1360, // width 768, // height 867, // 2D viewport width 653, // 2D viewport height 1.77778, // aspect ratio 0.85 // UI scale ]
Example 2:
_res = getResolution; // dedicated server [ 160, // width 120, // height 136, // 2D viewport width 102, // 2D viewport height 1.33333, // aspect ratio 0.85 // UI scale ]
Example 3:
_res = getResolution; // a triple 16/9 monitor setup [ 5760, // width 1080, // height 792, // 2D viewport width 594, // 2D viewport height 5.33333, // aspect ratio 0.55 // UI scale ]
Example 4:
Template:Since:_res = getResolution; // 16/9 monitor setup [ 1920, // width 1080, // height 792, // 2D viewport width 594, // 2D viewport height 1.77778, // aspect ratio 0.55, // UI scale 0.75, // fovTop 1.33333, // fovLeft false // tripleHead ]

Additional Information

See also:
getObjectFOVworldToScreenscreenToWorldsafeZoneXsafeZoneYsafeZoneWsafeZoneH

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
Posted on 05:38, 20 December 2010
tom_48_97
This command can be useful to play a video (see this function BIS_fnc_playVideo) in the given format if you have compiled it for different UI scale.