love.window

Available since LÖVE 0.9.0
This module is not supported in earlier versions.


Provides an interface for modifying and retrieving information about the program's window.

Functions

love.window.close Closes the window. 0.10.0
love.window.fromPixels Converts a number from pixels to density-independent units. 0.9.2
love.window.getDPIScale Gets the DPI scale factor associated with the window. 11.0
love.window.getDesktopDimensions Gets the width and height of the desktop. 0.9.0
love.window.getDimensions Gets the width and height of the window. 0.9.0 0.10.0
love.window.getDisplayCount Gets the number of connected monitors. 0.9.0
love.window.getDisplayName Gets the name of a display. 0.9.2
love.window.getDisplayOrientation Gets current device display orientation. 11.3
love.window.getFullscreen Gets whether the window is fullscreen. 0.9.0
love.window.getFullscreenModes Gets a list of supported fullscreen modes. 0.9.0
love.window.getHeight Gets the height of the window. 0.9.0 0.10.0
love.window.getIcon Gets the window icon. 0.9.0
love.window.getMode Gets the display mode and properties of the window. 0.9.0
love.window.getPixelScale Gets the DPI scale factor associated with the window. 0.9.1 11.0
love.window.getPosition Gets the position of the window on the screen. 0.9.2
love.window.getSafeArea Gets unobstructed area inside the window. 11.3
love.window.getTitle Gets the window title. 0.9.0
love.window.getVSync Gets current vsync value. 11.3
love.window.getWidth Gets the width of the window. 0.9.0 0.10.0
love.window.hasFocus Checks if the game window has keyboard focus. 0.9.0
love.window.hasMouseFocus Checks if the game window has mouse focus. 0.9.0
love.window.isCreated Checks if the window has been created. 0.9.0 0.10.0
love.window.isDisplaySleepEnabled Gets whether the display is allowed to sleep while the program is running. 0.10.0
love.window.isMaximized Gets whether the Window is currently maximized. 0.10.2
love.window.isMinimized Gets whether the Window is currently minimized. 11.0
love.window.isOpen Checks if the window is open. 0.10.0
love.window.isVisible Checks if the game window is visible. 0.9.0
love.window.maximize Makes the window as large as possible. 0.10.0
love.window.minimize Minimizes the window to the system's task bar / dock. 0.9.2
love.window.requestAttention Causes the window to request the attention of the user if it is not in the foreground. 0.10.0
love.window.restore Restores the size and position of the window if it was minimized or maximized. 11.0
love.window.setDisplaySleepEnabled Sets whether the display is allowed to sleep while the program is running. 0.10.0
love.window.setFullscreen Enters or exits fullscreen. 0.9.0
love.window.setIcon Sets the window icon. 0.9.0
love.window.setMode Sets the display mode and properties of the window. 0.9.0
love.window.setPosition Sets the position of the window on the screen. 0.9.2
love.window.setTitle Sets the window title. 0.9.0
love.window.setVSync Sets vertical synchronization mode. 11.3
love.window.showMessageBox Displays a message box above the love window. 0.9.2
love.window.toPixels Converts a number from density-independent units to pixels. 0.9.2
love.window.updateMode Sets the display mode and properties of the window, without modifying unspecified properties. 11.0

Enums

DisplayOrientation Types of device display orientation. 11.3
FullscreenType Types of fullscreen modes. 0.9.0
MessageBoxType Types of message box dialogs. 0.9.2

See Also

© 2006–2020 LÖVE Development Team
Licensed under the GNU Free Documentation License, Version 1.3.
https://love2d.org/wiki/love.window