Work in progress
Godot documentation is being updated to reflect the latest changes in version
4.0. Some documentation pages may
still state outdated information. This banner will tell you if you're reading one of such pages.
The contents of this page are up to date. If you can still find outdated information, please open an issue.
Singleton for window management functions.
DisplayServer handles everything related to window management. This is separated from OS as a single operating system may support multiple display servers.
Headless mode: Starting the engine with the
--headless command line argument disables all rendering and window management functions. Most functions from DisplayServer will return dummy values in this case.
Display server supports global menu. This allows the application to display its menu items in the operating system's top bar. macOS
Feature FEATURE_SUBWINDOWS =
Display server supports multiple windows that can be moved outside of the main window. Windows, macOS, Linux (X11)
Feature FEATURE_TOUCHSCREEN =
Display server supports touchscreen input. Windows, Linux (X11), Android, iOS, Web
Feature FEATURE_MOUSE =
Display server supports mouse input. Windows, macOS, Linux (X11), Android, Web
Feature FEATURE_MOUSE_WARP =
Display server supports warping mouse coordinates to keep the mouse cursor constrained within an area, but looping when one of the edges is reached. Windows, macOS, Linux (X11)
Feature FEATURE_CLIPBOARD =
Display server supports setting and getting clipboard data. See also FEATURE_CLIPBOARD_PRIMARY. Windows, macOS, Linux (X11), Android, iOS, Web
Feature FEATURE_VIRTUAL_KEYBOARD =
Display server supports popping up a virtual keyboard when requested to input text without a physical keyboard. Android, iOS, Web
Feature FEATURE_CURSOR_SHAPE =
Display server supports setting the mouse cursor shape to be different from the default. Windows, macOS, Linux (X11), Android, Web
Feature FEATURE_CUSTOM_CURSOR_SHAPE =
Display server supports setting the mouse cursor shape to a custom image. Windows, macOS, Linux (X11), Web
Feature FEATURE_NATIVE_DIALOG =
Display server supports spawning dialogs using the operating system's native look-and-feel. macOS
Feature FEATURE_IME =
Display server supports Input Method Editor, which is commonly used for inputting Chinese/Japanese/Korean text. This is handled by the operating system, rather than by Godot. Windows, macOS, Linux (X11)
Feature FEATURE_WINDOW_TRANSPARENCY =
Display server supports windows can use per-pixel transparency to make windows behind them partially or fully visible. Windows, macOS, Linux (X11)
Feature FEATURE_HIDPI =
Display server supports querying the operating system's display scale factor. This allows for reliable automatic hiDPI display detection, as opposed to guessing based on the screen resolution and reported display DPI (which can be unreliable due to broken monitor EDID). Windows, macOS
Feature FEATURE_ICON =
Display server supports changing the window icon (usually displayed in the top-left corner). Windows, macOS, Linux (X11)
Feature FEATURE_NATIVE_ICON =
Display server supports changing the window icon (usually displayed in the top-left corner). Windows, macOS
Feature FEATURE_ORIENTATION =
Display server supports changing the screen orientation. Android, iOS