love.window.updateMode

Available since LÖVE 11.0

This function is not supported in earlier versions.

Sets the display mode and properties of the window, without modifying unspecified properties.

If width or height is 0, updateMode will use the width and height of the desktop.

Changing the display mode may have side effects: for example, canvases will be cleared. Make sure to save the contents of canvases beforehand or re-draw to them afterward if you need to.

Function

Synopsis

success = love.window.updateMode( width, height, settings )

Arguments

number width

Window width.

number height

Window height.

table settings

The settings table with the following optional fields. Any field not filled in will use the current value that would be returned by love.window.getMode.

boolean fullscreen

Fullscreen (true), or windowed (false).

FullscreenType fullscreentype

The type of fullscreen to use.

boolean vsync

True if LÖVE should wait for vsync, false otherwise.

number msaa

The number of antialiasing samples.

boolean resizable

True if the window should be resizable in windowed mode, false otherwise.

boolean borderless

True if the window should be borderless in windowed mode, false otherwise.

boolean centered

True if the window should be centered in windowed mode, false otherwise.

number display

The index of the display to show the window in, if multiple monitors are available.

number minwidth

The minimum width of the window, if it's resizable. Cannot be less than 1.

number minheight

The minimum height of the window, if it's resizable. Cannot be less than 1.

boolean highdpi

True if high-dpi mode should be used on Retina displays in macOS and iOS. Does nothing on non-Retina displays.

number x

The x-coordinate of the window's position in the specified display.

number y

The y-coordinate of the window's position in the specified display.

Returns

boolean success

True if successful, false otherwise.

Notes

• If fullscreen is enabled and the width or height is not supported (see love.window.getFullscreenModes), the window may be resized to the closest available resolution and a resize event will be triggered.

• If the fullscreen type is "desktop", then the window will be automatically resized to the desktop resolution.

• In Android, the aspect ratio deducted from the width and the height is used to determine whetever the game run in landscape or portrait.

• Transparent backgrounds are currently not supported.

See Also

• love.window
• love.window.setMode
• love.window.getMode
• love.window.getFullscreenModes
• love.resize

Other Languages

Dansk – Deutsch – English – Español – Français – Indonesia – Italiano – Lietuviškai – Magyar – Nederlands – Polski – Português – Română – Slovenský – Suomi – Svenska – Türkçe – Česky – Ελληνικά – Български – Русский – Српски – Українська – עברית – ไทย – 日本語 – 正體中文 – 简体中文 – Tiếng Việt – 한국어
More info