getResolution: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Add "sampling")
(fov top, fov left, triple head, description, example)
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Returns an array containing all information about resolution.
| Returns an array containing all information about current client screen resolution in format:<br>
<tt>[screenW, screenH, viewPortW, viewPortH, aspectRatio, uiScale, fovTop, fovLeft, trippleHead]</tt>
<br>Where:
* <tt>screenW</tt> [[Number]]: width of the screen in pixels
* <tt>screenH</tt> [[Number]]: height of the screen in pixels
* <tt>viewPortW</tt> [[Number]]: width of the 4:3 view port in pixels
* <tt>viewPortH</tt> [[Number]]: height of the 4:3 view port in pixels
* <tt>aspectRatio</tt> [[Number]]: screen aspect ratio
* <tt>uiScale</tt> [[Number]]: the scale of the UI, which affects view port size, is currently (Arma 3):<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<tt>0.47 - Very Small</tt><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<tt>0.55 - Small</tt><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<tt>0.7 - Normal</tt><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<tt>0.85 - Large</tt><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<tt>1 - Very Large</tt><br>
* <tt>fovTop</tt> [[Number]]: vertical FOV in [[rad | radians]], the same as <tt>fovTop</tt> value from the user profile (''Since Arma 3 v1.94.145947'')
* <tt>fovLeft</tt> [[Number]]: horizontal FOV in [[rad | radians]], the same as<tt>fovLeft</tt> value from the user profile (''Since Arma 3 v1.94.145947'')
* <tt>trippleHead</tt> [[Boolean]]: [[true]] if user has triple head screen (see also [[safeZoneXAbs]], [[safeZoneWAbs]]) (''Since Arma 3 v1.94.145947'')<br><br>
{{Feature Arma3|'''Render resolution''' is not returned by this command.<br>
{{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.}}
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.}}
{{Important | The engine default value for <tt>fovTop</tt> is <b>0.75</b> in case it is needed to calculate difference with custom FOV}}
{{Informative| The <tt>aspectRatio</tt> is calculated as <tt>fovLeft / fovTop</tt> and should be the same as <tt>screenW / screenH</tt> for undistorted image if the FOV is custom. Some of the common values:
* 16/9 {{=}} 1.777777(…)
* 16/10 {{=}} 1.6
* 5/4 {{=}} 1.25
* 4/3 {{=}} 1.333333(…)
* triple screen 16/9 {{=}} 5.333333(…)}}
|Description=
|Description=
____________________________________________________________________________________________
____________________________________________________________________________________________
Line 15: Line 38:
| [[getResolution]] |Syntax=
| [[getResolution]] |Syntax=


| [[Array]] - to format [width, height, uiViewPortWidth, uiViewPortHeight, aspectRatio, uiScale]
| [[Array]] - see the description|Return value=
{{Informative|aspect ratio is returned as a coefficient:
* 16/9 {{=}} 1.777777(…)
* 16/10 {{=}} 1.6
* 5/4 {{=}} 1.25
* 4/3 {{=}} 1.333333(…)
* triple screen 16/9 {{=}} 5.333333(…)}}
|Return value=
____________________________________________________________________________________________
____________________________________________________________________________________________


Line 52: Line 68:
0.55 {{codecomment|// UI scale}}
0.55 {{codecomment|// UI scale}}
]</code> |Example 3=
]</code> |Example 3=
|x4= Since Arma 3 v1.94.145947:<code>_res = [[getResolution]]; {{codecomment|// 16/9 monitor setup}}</code>
<code>[
1920, {{codecomment|// width}}
1080, {{codecomment|// height}}
792, {{codecomment|// 2D viewport width}}
594, {{codecomment|// 2D viewport height}}
1.77778, {{codecomment|// aspect ratio}}
0.55, {{codecomment|// UI scale}}
0.75, {{codecomment|// fovTop}}
1.33333, {{codecomment|// fovLeft}}
false {{codecomment|// trippleHead}}
]</code> |Example 4=
____________________________________________________________________________________________
____________________________________________________________________________________________


Revision as of 15:47, 31 July 2019

A2 OA Logo.png1.55
Hover & click on the images for description

Description

Description:
Returns an array containing all information about current client screen resolution in format:
[screenW, screenH, viewPortW, viewPortH, aspectRatio, uiScale, fovTop, fovLeft, trippleHead]
Where:
  • 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, is currently (Arma 3):
       0.47 - Very Small
       0.55 - Small
       0.7 - Normal
       0.85 - Large
       1 - Very Large
  • fovTop Number: vertical FOV in radians, the same as fovTop value from the user profile (Since Arma 3 v1.94.145947)
  • fovLeft Number: horizontal FOV in radians, the same asfovLeft value from the user profile (Since Arma 3 v1.94.145947)
  • trippleHead Boolean: true if user has triple head screen (see also safeZoneXAbs, safeZoneWAbs) (Since Arma 3 v1.94.145947)

Template:Feature Arma3
⚠
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 = 1.777777(…)
  • 16/10 = 1.6
  • 5/4 = 1.25
  • 4/3 = 1.333333(…)
  • triple screen 16/9 = 5.333333(…)
Groups:
Uncategorised

Syntax

Syntax:
getResolution
Return Value:
Array - see the description

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:
Since Arma 3 v1.94.145947:_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 // trippleHead ]

Additional Information

See also:
worldToScreenscreenToWorldsafeZoneXsafeZoneYsafeZoneWsafeZoneH

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

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.

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=getResolution&oldid=125204"