Difference between revisions of "love.window.getMode"

Latest revision as of 17:50, 25 April 2023

Available since LÖVE 0.9.0

Gets the display mode and properties of the window.

width, height, flags = love.window.getMode( )

None.

number width

Window width.

number height

Window height.

table flags

Table with the window properties:

boolean fullscreen: Fullscreen (true), or windowed (false).
FullscreenType fullscreentype: The type of fullscreen mode used.
number vsync: 1 if the graphics framerate is synchronized with the monitor's refresh rate, 0 otherwise.
number msaa: The number of antialiasing samples used (0 if MSAA is disabled).
boolean resizable: True if the window is resizable in windowed mode, false otherwise.
boolean borderless: True if the window is borderless in windowed mode, false otherwise.
boolean centered: True if the window is centered in windowed mode, false otherwise.
number display: The index of the display the window is currently in, if multiple monitors are available. First is 1.
number minwidth: The minimum width of the window, if it's resizable.
number minheight: The minimum height of the window, if it's resizable.

Available since LÖVE 0.9.1

boolean highdpi: True if high-dpi mode is allowed on Retina displays in OS X. Does nothing on non-Retina displays.

Available since LÖVE 0.9.2

number refreshrate: The refresh rate of the screen's current display mode, in Hz. May be 0 if the value can't be determined.
number x: The x-coordinate of the window's position in its current display.
number y: The y-coordinate of the window's position in its current display.

Available since LÖVE 0.9.1 and removed in LÖVE 0.10.0

boolean srgb: Removed in 0.10.0 (use love.graphics.isGammaCorrect instead). True if sRGB gamma correction is applied when drawing to the screen.

@@ Line 20: / Line 20: @@
 {{subparam|boolean|borderless|True if the window is borderless in windowed mode, false otherwise.}}
 {{subparam|boolean|centered|True if the window is centered in windowed mode, false otherwise.}}
-{{subparam|number|display|The index of the display the window is currently in, if multiple monitors are available.}}
+{{subparam|number|display|The index of the display the window is currently in, if multiple monitors are available. First is 1.}}
 {{subparam|number|minwidth|The minimum width of the window, if it's resizable.}}
 {{subparam|number|minheight|The minimum height of the window, if it's resizable.}}