WoW:API GetScreenHeight: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
No edit summary
 
m (Move page script moved page API GetScreenHeight to API GetScreenHeight without leaving a redirect)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<center>'''GetScreenHeight''' ''-Documentation by AlexanderYoshi-''</center>
{{wowapi}}
 
Returns the height of the window in pixels.
Returns the height of the window in pixels.


Line 19: Line 18:
----
----
;''Example''
;''Example''
  if( GetScreenHeight() == 600) then ChatFrame:AddMessage("Using 800x600 mode"); end
  if( GetScreenHeight() * UIParent:GetEffectiveScale() == 600) then ChatFrame:AddMessage("Using 800x600 mode"); end


;''Result''
;''Result''
Line 27: Line 26:
;''Description''
;''Description''


: Returns the height of the window in pixels.
: Returns the height of the window in pixels.  This value is affected by the UI's scale.


----
: Also note that the return value will not match the screen resolution chosen from the Video Options menu, but will instead represent a dimension with the same aspect ratio.  For example, the following code...
{{Template:WoW API}}
DEFAULT_CHAT_FRAME:AddMessage( ( GetScreenWidth() * UIParent:GetEffectiveScale() ).."x"..( GetScreenHeight() * UIParent:GetEffectiveScale() ) );
: ...will print "960x768" for the actual screen resolution "1280x1024".  Both of these dimensions share a 5:4 aspect ratio.

Latest revision as of 04:46, 15 August 2023

WoW API < GetScreenHeight

Returns the height of the window in pixels.

GetScreenHeight();

Arguments
none

Returns
Number screenHeight
screenHeight
Height of window in pixels

Example
if( GetScreenHeight() * UIParent:GetEffectiveScale() == 600) then ChatFrame:AddMessage("Using 800x600 mode"); end
Result
Using 800x600 mode

Description
Returns the height of the window in pixels. This value is affected by the UI's scale.
Also note that the return value will not match the screen resolution chosen from the Video Options menu, but will instead represent a dimension with the same aspect ratio. For example, the following code...
DEFAULT_CHAT_FRAME:AddMessage( ( GetScreenWidth() * UIParent:GetEffectiveScale() ).."x"..( GetScreenHeight() * UIParent:GetEffectiveScale() ) );
...will print "960x768" for the actual screen resolution "1280x1024". Both of these dimensions share a 5:4 aspect ratio.