Namespace: window
Language: Lua
Type: Defold Lua
File: script_window.cpp
Source: engine/gamesys/src/gamesys/scripts/script_window.cpp
Functions and constants to access the window, window event listeners and screen dimming.
Type: ENUM Screen-dimming modes
Members
window.DIMMING_OFF - dimming mode off Dimming mode is used to control whether or not a mobile device should dim the screen after a period without user interaction.window.DIMMING_ON - dimming mode on Dimming mode is used to control whether or not a mobile device should dim the screen after a period without user interaction.window.DIMMING_UNKNOWN - dimming mode unknown Dimming mode is used to control whether or not a mobile device should dim the screen after a period without user interaction. This mode indicates that the dim mode can’t be determined, or that the platform doesn’t support dimming.Type: STRUCT Width and height are present for window.WINDOW_EVENT_RESIZED and absent for other window events.
Members
width? (integer) - Window width after a resize.height? (integer) - Window height after a resize.Type: FUNCTION Returns the current dimming mode set on a mobile device. The dimming mode specifies whether or not a mobile device should dim the screen after a period without user interaction. On platforms that does not support dimming, window.DIMMING_UNKNOWN is always returned.
Returns
mode (window.DIMMING) - The mode for screen dimmingType: FUNCTION This returns the content scale of the current display. On HTML5, the scale respects display.high_dpi, html5.min_pixel_ratio and html5.max_pixel_ratio. When High DPI is disabled, the scale is 1.
Returns
scale (number) - The display scaleType: FUNCTION This returns the current lock state of the mouse cursor
Returns
state (boolean) - The lock stateType: FUNCTION Returns an array of active occlusion rectangles intersecting the game window, such as camera cutouts and the Dynamic Island. Each rectangle is clipped to the window and uses a bottom-left origin and pixel units matching window.get_size. These coordinates are independent of GUI adjustment and the project’s logical resolution. Supported on iOS 27.1+ and Android 9 (API level 28)+. On iOS, rectangles include the interaction margins supplied by UIKit. On Android, rectangles describe display cutouts. Folds, system bars, keyboards, and gesture areas are not reported by this API. Unsupported platforms and windows with no reported occlusions return an empty table. An empty result does not guarantee that the whole window is safe; use window.get_safe_area when a safe layout rectangle is needed. Query once during initialization and again following window.WINDOW_EVENT_RESIZED. On supported platforms this event also refreshes reserved areas when their geometry changes without a size change. The returned table is a snapshot and is not modified by subsequent events.
Returns
areas (window.reserved_area[]) - array of window.reserved_area rectanglesExamples
local function update_reserved_areas(self)
self.reserved_areas = window.get_reserved_areas()
end
function init(self)
update_reserved_areas(self)
window.set_listener(function(self, event, data)
if event == window.WINDOW_EVENT_RESIZED then
update_reserved_areas(self)
end
end)
end
Type: FUNCTION This returns the safe area rectangle (x, y, width, height) and the inset values relative to the window edges. On platforms without a safe area, this returns the full window size and zero insets.
Returns
safe_area (window.safe_area) - safe area dataType: FUNCTION This returns the current window size (width and height).
Returns
width (integer) - The window widthheight (integer) - The window heightType: STRUCT Window reserved-area data
Members
x (integer) - Left edge in window pixels.y (integer) - Bottom edge in window pixels.width (integer) - Rectangle width in window pixels.height (integer) - Rectangle height in window pixels.Type: STRUCT Window safe-area data
Members
x (integer) - Safe-area x-coordinate.y (integer) - Safe-area y-coordinate.width (integer) - Safe-area width.height (integer) - Safe-area height.inset_left (integer) - Inset from the left window edge.inset_top (integer) - Inset from the top window edge.inset_right (integer) - Inset from the right window edge.inset_bottom (integer) - Inset from the bottom window edge.Type: FUNCTION Sets the dimming mode on a mobile device. The dimming mode specifies whether or not a mobile device should dim the screen after a period without user interaction. The dimming mode will only affect the mobile device while the game is in focus on the device, but not when the game is running in the background. This function has no effect on platforms that does not support dimming.
Parameters
mode (window.DIMMING) - The mode for screen dimmingType: FUNCTION Sets a window event listener. Only one window event listener can be set at a time.
Parameters
callback (fun(self:script_instance, event:window.WINDOW_EVENT, data:window.event_data) |
nil) - A callback which receives info about window events. Pass an empty function or nil if you no longer wish to receive callbacks. |
Examples
function window_callback(self, event, data)
if event == window.WINDOW_EVENT_FOCUS_LOST then
print("window.WINDOW_EVENT_FOCUS_LOST")
elseif event == window.WINDOW_EVENT_FOCUS_GAINED then
print("window.WINDOW_EVENT_FOCUS_GAINED")
elseif event == window.WINDOW_EVENT_ICONIFIED then
print("window.WINDOW_EVENT_ICONIFIED")
elseif event == window.WINDOW_EVENT_DEICONIFIED then
print("window.WINDOW_EVENT_DEICONIFIED")
elseif event == window.WINDOW_EVENT_RESIZED then
print("Window resized: ", data.width, data.height)
end
end
function init(self)
window.set_listener(window_callback)
end
Type: FUNCTION Set the locking state for current mouse cursor on a PC platform. This function locks or unlocks the mouse cursor to the center point of the window. While the cursor is locked, mouse position updates will still be sent to the scripts as usual.
Parameters
flag (boolean) - The lock state for the mouse cursorType: FUNCTION Sets the window position.
Parameters
x (integer) - Horizontal position of windowy (integer) - Vertical position of windowType: FUNCTION Sets the window size. Works on desktop platforms only.
Parameters
width (integer) - Width of windowheight (integer) - Height of windowType: FUNCTION Sets the window title. Works on desktop platforms.
Parameters
title (string) - The title, encoded as UTF-8Type: ENUM Window events
Members
window.WINDOW_EVENT_DEICONIFIED - deiconified window event This event is sent to a window event listener when the game window or app screen is restored after being iconified.window.WINDOW_EVENT_FOCUS_GAINED - focus gained window event This event is sent to a window event listener when the game window or app screen has gained focus. This event is also sent at game startup and the engine gives focus to the game.window.WINDOW_EVENT_FOCUS_LOST - focus lost window event This event is sent to a window event listener when the game window or app screen has lost focus.window.WINDOW_EVENT_ICONIFIED - iconify window event This event is sent to a window event listener when the game window or app screen is iconified (reduced to an application icon in a toolbar, application tray or similar).window.WINDOW_EVENT_RESIZED - resized window event This event is sent to a window event listener when the game window or app screen is resized. On iOS, it is also sent after orientation transitions and safe-area inset changes, even when the size is unchanged. After window.get_reserved_areas has been queried, changes to reserved areas also trigger this event on supported platforms. The current size is passed along in the data field to the event listener.