getResolution: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "[[Category:ArmA 2 OA: New Scripting Commands List" to "[[Category:Arma 2: Operation Arrowhead: New Scripting Commands List")
m (Fix description)
Line 8: Line 8:


| Returns an array containing all information about current client screen resolution in format:<br>
| Returns an array containing all information about current client screen resolution in format:<br>
<tt>[screenW, screenH, viewPortW, viewPortH, aspectRatio, uiScale, fovTop, fovLeft, tripleHead]</tt>
<tt>[screenW, screenH, viewPortW, viewPortH, aspectRatio, uiScale, fovTop, fovLeft, tripleHead]</tt><br>
<br>Where:
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
* <tt>viewPortW</tt> [[Number]]: width of the 4:3 view port 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>viewPortH</tt>: [[Number]] - height of the '''4:3''' view port in pixels  
* <tt>aspectRatio</tt> [[Number]]: screen aspect ratio
* <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>
* <tt>uiScale</tt>: [[Number]] - the scale of the UI, which affects view port size:
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<tt>0.47 - Very Small</tt><br>
: {{{!}} class{{=}}"bikitable" style{{=}}"margin-top: -0.5em"
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<tt>0.55 - Small</tt><br>
{{!}}+ Arma 3
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<tt>0.7 - Normal</tt><br>
! Very Small !! Small !! Normal !! Large !! Very Large
&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>
{{!}} 0.47 {{!}}{{!}} 0.55 {{!}}{{!}} 0.7 {{!}}{{!}} 0.85 {{!}}{{!}} 1
* <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>fovTop</tt>: [[Number]] - vertical FOV in [[rad | radians]], the same as <tt>fovTop</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 Arma 3 v1.94.145947'')<br><br>
* <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}})
{{Feature Arma3|'''Render resolution''' is not returned by this command.<br>
* <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.}}
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}}
{{Important | The engine default value for <tt>fovTop</tt> is '''0.75''' 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:
{{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:
* 16/9 {{=}} 1.777777(…)
{{{!}} class{{=}}"bikitable"
* 16/10 {{=}} 1.6
! 16/9 !! 16/10 !! 5/4 !! 4/3 !! 16/9 triple screen
* 5/4 {{=}} 1.25
{{!}}-
* 4/3 {{=}} 1.333333(…)
{{!}} 1.777777(…) {{!}}{{!}} 1.6 {{!}}{{!}} 1.25 {{!}}{{!}} 1.333333(…) {{!}}{{!}} 5.333333(…)
* triple screen 16/9 {{=}} 5.333333(…)}}
{{!}}}
|Description=
}} |Description=
____________________________________________________________________________________________
____________________________________________________________________________________________


Line 41: Line 43:
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code>_res = [[getResolution]]; {{codecomment|// a 16/9 single monitor setup}}</code>
|x1= <code>_res = [[getResolution]]; {{cc|a 16/9 single monitor setup}}</code>
<code>[
<code>[
1360, {{codecomment|// width}}
1360, {{cc|width}}
768, {{codecomment|// height}}
768, {{cc|height}}
867, {{codecomment|// 2D viewport width}}
867, {{cc|2D viewport width}}
653, {{codecomment|// 2D viewport height}}
653, {{cc|2D viewport height}}
1.77778, {{codecomment|// aspect ratio}}
1.77778, {{cc|aspect ratio}}
0.85 {{codecomment|// UI scale}}
0.85 {{cc|UI scale}}
]</code> |Example 1=
]</code> |Example 1=
|x2= <code>_res = [[getResolution]];  {{codecomment|// dedicated server}}</code>
|x2= <code>_res = [[getResolution]];  {{cc|dedicated server}}</code>
<code>[
<code>[
160, {{codecomment|// width}}
160, {{cc|width}}
120, {{codecomment|// height}}
120, {{cc|height}}
136, {{codecomment|// 2D viewport width}}
136, {{cc|2D viewport width}}
102, {{codecomment|// 2D viewport height}}
102, {{cc|2D viewport height}}
1.33333, {{codecomment|// aspect ratio}}
1.33333, {{cc|aspect ratio}}
0.85 {{codecomment|// UI scale}}
0.85 {{cc|UI scale}}
]</code> |Example 2=
]</code> |Example 2=
|x3= <code>_res = [[getResolution]]; {{codecomment|// a triple 16/9 monitor setup}}</code>
|x3= <code>_res = [[getResolution]]; {{cc|a triple 16/9 monitor setup}}</code>
<code>[
<code>[
5760, {{codecomment|// width}}
5760, {{cc|width}}
1080, {{codecomment|// height}}
1080, {{cc|height}}
792, {{codecomment|// 2D viewport width}}
792, {{cc|2D viewport width}}
594, {{codecomment|// 2D viewport height}}
594, {{cc|2D viewport height}}
5.33333, {{codecomment|// aspect ratio}}
5.33333, {{cc|aspect ratio}}
0.55 {{codecomment|// UI scale}}
0.55 {{cc|UI scale}}
]</code> |Example 3=
]</code> |Example 3=


|x4= Since Arma 3 v1.94.145947:<code>_res = [[getResolution]]; {{codecomment|// 16/9 monitor setup}}</code>
|x4= {{since|arma3|1.94.145947}}:<code>_res = [[getResolution]]; {{cc|16/9 monitor setup}}</code>
<code>[
<code>[
1920, {{codecomment|// width}}
1920, {{cc|width}}
1080, {{codecomment|// height}}
1080, {{cc|height}}
792, {{codecomment|// 2D viewport width}}
792, {{cc|2D viewport width}}
594, {{codecomment|// 2D viewport height}}
594, {{cc|2D viewport height}}
1.77778, {{codecomment|// aspect ratio}}
1.77778, {{cc|aspect ratio}}
0.55, {{codecomment|// UI scale}}
0.55, {{cc|UI scale}}
0.75, {{codecomment|// fovTop}}
0.75, {{cc|fovTop}}
1.33333, {{codecomment|// fovLeft}}
1.33333, {{cc|fovLeft}}
false {{codecomment|// tripleHead}}
false {{cc|tripleHead}}
]</code> |Example 4=
]</code> |Example 4=
____________________________________________________________________________________________
____________________________________________________________________________________________
Line 99: Line 101:
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Arma 2: Operation Arrowhead: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]

Revision as of 00:55, 2 November 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, tripleHead]
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:
Arma 3
Very Small Small Normal Large Very Large
0.47 0.55 0.7 0.85 1

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 16/10 5/4 4/3 16/9 triple screen
1.777777(…) 1.6 1.25 1.333333(…) 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:
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

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=138348"