Difference between revisions of "love.window.getMode"

m
m (Returns: Added new refreshrate field.)
Line 25: Line 25:
 
{{subparam|boolean|highdpi|True if [[love.window.getPixelScale|high-dpi mode]] is allowed on Retina displays in OS X. Does nothing on non-Retina displays. Added in [[0.9.1]].}}
 
{{subparam|boolean|highdpi|True if [[love.window.getPixelScale|high-dpi mode]] is allowed on Retina displays in OS X. Does nothing on non-Retina displays. Added in [[0.9.1]].}}
 
{{subparam|boolean|srgb|True if sRGB gamma correction is applied when drawing to the screen. Added in [[0.9.1]].}}
 
{{subparam|boolean|srgb|True if sRGB gamma correction is applied when drawing to the screen. Added in [[0.9.1]].}}
 +
{{subparam|number|refreshrate|The refresh rate of the screen's current display mode, in Hz. May be 0 if the value can't be determined. Added in [[0.9.2]].}}
 +
 
== See Also ==
 
== See Also ==
 
* [[parent::love.window]]
 
* [[parent::love.window]]

Revision as of 22:20, 28 August 2014

Available since LÖVE 0.9.0
Moved from love.graphics.getMode.

Gets the display mode and properties of the window.

Function

Synopsis

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

Arguments

None.

Returns

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.
boolean vsync
True if the graphics framerate is synchronized with the monitor's refresh rate, false otherwise.
number fsaa
The number of antialiasing samples used (0 if FSAA 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.
number minwidth
The minimum width of the window, if it's resizable.
number minheight
The minimum height of the window, if it's resizable.
boolean highdpi
True if high-dpi mode is allowed on Retina displays in OS X. Does nothing on non-Retina displays. Added in 0.9.1.
boolean srgb
True if sRGB gamma correction is applied when drawing to the screen. Added in 0.9.1.
number refreshrate
The refresh rate of the screen's current display mode, in Hz. May be 0 if the value can't be determined. Added in 0.9.2.

See Also

Other Languages