getResolution: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Some wiki formatting)
m (Text replacement - "<tt>([a-zA-Z0-9\. _"']+)<\/tt>" to "{{hl|$1}}")
Line 18: Line 18:
{{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.}}
{{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 | important | The engine default value for {{hl|fovTop}} 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:
{{Feature | Informative | The {{hl|aspectRatio}} 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"
{{{!}} class{{=}}"wikitable"
! 16/9 !! 16/10 !! 5/4 !! 4/3 !! 16/9 triple screen
! 16/9 !! 16/10 !! 5/4 !! 4/3 !! 16/9 triple screen
Line 30: Line 30:


|r1= [[Array]] - <tt>[screenW, screenH, viewPortW, viewPortH, aspectRatio, uiScale, fovTop, fovLeft, tripleHead]</tt><br>
|r1= [[Array]] - <tt>[screenW, screenH, viewPortW, viewPortH, aspectRatio, uiScale, fovTop, fovLeft, tripleHead]</tt><br>
* <tt>screenW</tt>: [[Number]] - width of the screen in pixels
* {{hl|screenW}}: [[Number]] - width of the screen in pixels
* <tt>screenH</tt>: [[Number]] - height of the screen in pixels
* {{hl|screenH}}: [[Number]] - height of the screen in pixels
* <tt>viewPortW</tt>: [[Number]] - width of the '''4:3''' view port in pixels
* {{hl|viewPortW}}: [[Number]] - width of the '''4:3''' view port in pixels
* <tt>viewPortH</tt>: [[Number]] - height of the '''4:3''' view port in pixels  
* {{hl|viewPortH}}: [[Number]] - height of the '''4:3''' view port in pixels  
* <tt>aspectRatio</tt>: [[Number]] - screen aspect ratio
* {{hl|aspectRatio}}: [[Number]] - screen aspect ratio
* <tt>uiScale</tt>: [[Number]] - the scale of the UI, which affects view port size:
* {{hl|uiScale}}: [[Number]] - the scale of the UI, which affects view port size:
: {{{!}} class{{=}}"wikitable" style{{=}}"margin-top: -0.5em"
: {{{!}} class{{=}}"wikitable" style{{=}}"margin-top: -0.5em"
{{!}}+ Arma 3
{{!}}+ Arma 3
Line 42: Line 42:
{{!}} 0.47 {{!}}{{!}} 0.55 {{!}}{{!}} 0.7 {{!}}{{!}} 0.85 {{!}}{{!}} 1
{{!}} 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 {{arma3}} v1.94)
* {{hl|fovTop}}: [[Number]] - vertical FOV in [[rad | radians]], the same as {{hl|fovTop}} value from the user profile (since {{arma3}} v1.94)
* <tt>fovLeft</tt>: [[Number]] - horizontal FOV in [[rad | radians]], the same as<tt>fovLeft</tt> value from the user profile (since {{arma3}} v1.94)
* {{hl|fovLeft}}: [[Number]] - horizontal FOV in [[rad | radians]], the same as{{hl|fovLeft}} value from the user profile (since {{arma3}} v1.94)
* <tt>tripleHead</tt>: [[Boolean]] - [[true]] if user has triple head screen (see also [[safeZoneXAbs]], [[safeZoneWAbs]]) (since {{arma3}} v1.94)
* {{hl|tripleHead}}: [[Boolean]] - [[true]] if user has triple head screen (see also [[safeZoneXAbs]], [[safeZoneWAbs]]) (since {{arma3}} v1.94)


|x1= <code>_res = [[getResolution]]; {{cc|a 16/9 single monitor setup}}</code>
|x1= <code>_res = [[getResolution]]; {{cc|a 16/9 single monitor setup}}</code>

Revision as of 23:45, 15 November 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
  • fovTop: Number - vertical FOV in radians, the same as fovTop value from the user profile (since Arma 3 v1.94)
  • fovLeft: Number - horizontal FOV in radians, the same asfovLeft value from the user profile (since Arma 3 v1.94)
  • tripleHead: Boolean - true if user has triple head screen (see also safeZoneXAbs, safeZoneWAbs) (since Arma 3 v1.94)

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:
_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.