Window

Conformances

• protocol CustomStringConvertible

  A type with a customized textual representation.

• protocol Equatable

  A type that can be compared for value equality.

• protocol Hashable

  A type that can be hashed into a Hasher to produce an integer hash value.

• protocol Identifiable<ID>

  A class of types whose instances hold the value of an entity with stable identity.

• protocol VariantRepresentable

  Types that conform to VariantRepresentable can be stored directly in Variant with no conversion. These include all of the Variant types from Godot (for example GString, Rect, Plane), Godot objects (those that subclass SwiftGodot.Object) as well as the built-in Swift types UInt8, Int64 and Double.

• protocol VariantStorable

  Types that conform to VariantStorable can be stored in a Variant and can be extracted back out of a Variant.

Types

• enum ContentScaleAspect
• enum ContentScaleMode
• enum ContentScaleStretch
• enum Flags
• enum LayoutDirection
• enum Mode
• class Signal1

  Signal support.

• class Signal2

  Signal support.

• enum WindowInitialPosition

Type members

• static let notificationThemeChanged: Int

  Sent when the node needs to refresh its theme items. This happens in one of the following cases:

• static let notificationVisibilityChanged: Int

  Emitted when Window’s visibility changes, right before [signal visibility_changed].

• class var godotClassName: StringName

Instance members

• var aboutToPopup: SimpleSignal

  Emitted right after popup(rect:) call, before the Window appears or does anything.

• var alwaysOnTop: Bool

  If true, the window will be on top of all other windows. Does not work if transient is enabled.

• var autoTranslate: Bool

  Toggles if any text should automatically change to its translated version depending on the current locale.

• var borderless: Bool

  If true, the window will have no borders.

• var closeRequested: SimpleSignal

  Emitted when the Window’s close button is pressed or when popupWindow is enabled and user clicks outside the window.

• var contentScaleAspect: Window.ContentScaleAspect

  Specifies how the content’s aspect behaves when the Window is resized. The base aspect is determined by contentScaleSize.

• var contentScaleFactor: Double

  Specifies the base scale of Window’s content when its size is equal to contentScaleSize.

• var contentScaleMode: Window.ContentScaleMode

  Specifies how the content is scaled when the Window is resized.

• var contentScaleSize: Vector2i

  Base size of the content (i.e. nodes that are drawn inside the window). If non-zero, Window’s content will be scaled when the window is resized to a different size.

• var contentScaleStretch: Window.ContentScaleStretch

  The policy to use to determine the final scale factor for 2D elements. This affects how contentScaleFactor is applied, in addition to the automatic scale factor determined by contentScaleSize.

• var currentScreen: Int32

  The screen the window is currently on.

• var dpiChanged: SimpleSignal

  Emitted when the Window’s DPI changes as a result of OS-level changes (e.g. moving the window from a Retina display to a lower resolution one).

• var exclusive: Bool

  If true, the Window will be in exclusive mode. Exclusive windows are always on top of their parent and will block all input going to the parent Window.

• var extendToTitle: Bool

  If true, the Window contents is expanded to the full size of the window, window title bar is transparent.

• var filesDropped: Signal2

  Emitted when files are dragged from the OS file manager and dropped in the game window. The argument is a list of file paths.

• var focusEntered: SimpleSignal

  Emitted when the Window gains focus.

• var focusExited: SimpleSignal

  Emitted when the Window loses its focus.

• var goBackRequested: SimpleSignal

  Emitted when a go back request is sent (e.g. pressing the “Back” button on Android), right after NodenotificationWmGoBackRequest````.

• var initialPosition: Window.WindowInitialPosition

  Specifies the initial type of position for the Window. See WindowInitialPosition constants.

• var keepTitleVisible: Bool

  If true, the Window width is expanded to keep the title bar text fully visible.

• var maxSize: Vector2i

  If non-zero, the Window can’t be resized to be bigger than this size.

• var minSize: Vector2i

  If non-zero, the Window can’t be resized to be smaller than this size.

• var mode: Window.Mode

  Set’s the window’s current mode.

• var mouseEntered: SimpleSignal

  Emitted when the mouse cursor enters the Window‘s visible area, that is not occluded behind other Controls or windows, provided its guiDisableInput is false and regardless if it’s currently focused or not.

• var mouseExited: SimpleSignal

  Emitted when the mouse cursor leaves the Window‘s visible area, that is not occluded behind other Controls or windows, provided its guiDisableInput is false and regardless if it’s currently focused or not.

• var mousePassthrough: Bool

  If true, all mouse events will be passed to the underlying window of the same application. See also mousePassthroughPolygon.

• var mousePassthroughPolygon: PackedVector2Array

  Sets a polygonal region of the window which accepts mouse events. Mouse events outside the region will be passed through.

• var popupWindow: Bool

  If true, the Window will be considered a popup. Popups are sub-windows that don’t show as separate windows in system’s window manager’s window list and will send close request when anything is clicked outside of them (unless exclusive is enabled).

• var position: Vector2i

  The window’s position in pixels.

• var size: Vector2i

  The window’s size in pixels.

• var theme: Theme?

  The Theme resource this node and all its Control and Window children use. If a child node has its own Theme resource set, theme items are merged with child’s definitions having higher priority.

• var themeChanged: SimpleSignal

  Emitted when the notificationThemeChanged notification is sent.

• var themeTypeVariation: StringName

  The name of a theme type variation used by this Window to look up its own theme items. See themeTypeVariation for more details.

• var title: String

  The window’s title. If the Window is native, title styles set in Theme will have no effect.

• var titlebarChanged: SimpleSignal

  Emitted when window title bar decorations are changed, e.g. macOS window enter/exit full screen mode, or extend-to-title flag is changed.

• var transient: Bool

  If true, the Window is transient, i.e. it’s considered a child of another Window. The transient window will be destroyed with its transient parent and will return focus to their parent when closed. The transient window is displayed on top of a non-exclusive full-screen parent window. Transient windows can’t enter full-screen mode.

• var transparent: Bool

  If true, the Window’s background can be transparent. This is best used with embedded windows.

• var unfocusable: Bool

  If true, the Window can’t be focused nor interacted with. It can still be visible.

• var unresizable: Bool

  If true, the window can’t be resized. Minimize and maximize buttons are disabled.

• var visibilityChanged: SimpleSignal

  Emitted when Window is made visible or disappears.

• var visible: Bool

  If true, the window is visible.

• var windowInput: Signal1

  Emitted when the Window is currently focused and receives any input, passing the received event as an argument. The event’s position, if present, is in the embedder’s coordinate system.

• var wrapControls: Bool

  If true, the window’s size will automatically update when a child node is added or removed, ignoring minSize if the new size is bigger.

• func addThemeColorOverride(name: StringName, color: Color)

  Creates a local override for a theme Color with the specified name. Local overrides always take precedence when fetching theme items for the control. An override can be removed with removeThemeColorOverride(name:).

• func addThemeConstantOverride(name: StringName, constant: Int32)

  Creates a local override for a theme constant with the specified name. Local overrides always take precedence when fetching theme items for the control. An override can be removed with removeThemeConstantOverride(name:).

• func addThemeFontOverride(name: StringName, font: Font?)

  Creates a local override for a theme Font with the specified name. Local overrides always take precedence when fetching theme items for the control. An override can be removed with removeThemeFontOverride(name:).

• func addThemeFontSizeOverride(name: StringName, fontSize: Int32)

  Creates a local override for a theme font size with the specified name. Local overrides always take precedence when fetching theme items for the control. An override can be removed with removeThemeFontSizeOverride(name:).

• func addThemeIconOverride(name: StringName, texture: Texture2D?)

  Creates a local override for a theme icon with the specified name. Local overrides always take precedence when fetching theme items for the control. An override can be removed with removeThemeIconOverride(name:).

• func addThemeStyleboxOverride(name: StringName, stylebox: StyleBox?)

  Creates a local override for a theme StyleBox with the specified name. Local overrides always take precedence when fetching theme items for the control. An override can be removed with removeThemeStyleboxOverride(name:).

• func beginBulkThemeOverride()

  Prevents *_theme_*_override methods from emitting notificationThemeChanged until endBulkThemeOverride is called.

• func canDraw() -> Bool

  Returns whether the window is being drawn to the screen.

• func childControlsChanged()

  Requests an update of the Window size to fit underlying Control nodes.

• func endBulkThemeOverride()

  Ends a bulk theme override update. See beginBulkThemeOverride.

• func getContentsMinimumSize() -> Vector2

  Returns the combined minimum size from the child Control nodes of the window. Use childControlsChanged to update it when children nodes have changed.

• func getLayoutDirection() -> Window.LayoutDirection

  Returns layout direction and text writing direction.

• func getPositionWithDecorations() -> Vector2i

  Returns the window’s position including its border.

• func getSizeWithDecorations() -> Vector2i

  Returns the window’s size including its border.

• func getThemeColor(name: StringName, themeType: StringName) -> Color

  Returns a Color from the first matching Theme in the tree if that Theme has a color item with the specified name and themeType.

• func getThemeConstant(name: StringName, themeType: StringName) -> Int32

  Returns a constant from the first matching Theme in the tree if that Theme has a constant item with the specified name and themeType.

• func getThemeDefaultBaseScale() -> Double

  Returns the default base scale value from the first matching Theme in the tree if that Theme has a valid defaultBaseScale value.

• func getThemeDefaultFont() -> Font?

  Returns the default font from the first matching Theme in the tree if that Theme has a valid defaultFont value.

• func getThemeDefaultFontSize() -> Int32

  Returns the default font size value from the first matching Theme in the tree if that Theme has a valid defaultFontSize value.

• func getThemeFont(name: StringName, themeType: StringName) -> Font?

  Returns a Font from the first matching Theme in the tree if that Theme has a font item with the specified name and themeType.

• func getThemeFontSize(name: StringName, themeType: StringName) -> Int32

  Returns a font size from the first matching Theme in the tree if that Theme has a font size item with the specified name and themeType.

• func getThemeIcon(name: StringName, themeType: StringName) -> Texture2D?

  Returns an icon from the first matching Theme in the tree if that Theme has an icon item with the specified name and themeType.

• func getThemeStylebox(name: StringName, themeType: StringName) -> StyleBox?

  Returns a StyleBox from the first matching Theme in the tree if that Theme has a stylebox item with the specified name and themeType.

• func getWindowId() -> Int32

  Returns the ID of the window.

• func grabFocus()

  Causes the window to grab focus, allowing it to receive user input.

• func hasFocus() -> Bool

  Returns true if the window is focused.

• func hasThemeColor(name: StringName, themeType: StringName) -> Bool

  Returns true if there is a matching Theme in the tree that has a color item with the specified name and themeType.

• func hasThemeColorOverride(name: StringName) -> Bool

  Returns true if there is a local override for a theme Color with the specified name in this Control node.

• func hasThemeConstant(name: StringName, themeType: StringName) -> Bool

  Returns true if there is a matching Theme in the tree that has a constant item with the specified name and themeType.

• func hasThemeConstantOverride(name: StringName) -> Bool

  Returns true if there is a local override for a theme constant with the specified name in this Control node.

• func hasThemeFont(name: StringName, themeType: StringName) -> Bool

  Returns true if there is a matching Theme in the tree that has a font item with the specified name and themeType.

• func hasThemeFontOverride(name: StringName) -> Bool

  Returns true if there is a local override for a theme Font with the specified name in this Control node.

• func hasThemeFontSize(name: StringName, themeType: StringName) -> Bool

  Returns true if there is a matching Theme in the tree that has a font size item with the specified name and themeType.

• func hasThemeFontSizeOverride(name: StringName) -> Bool

  Returns true if there is a local override for a theme font size with the specified name in this Control node.

• func hasThemeIcon(name: StringName, themeType: StringName) -> Bool

  Returns true if there is a matching Theme in the tree that has an icon item with the specified name and themeType.

• func hasThemeIconOverride(name: StringName) -> Bool

  Returns true if there is a local override for a theme icon with the specified name in this Control node.

• func hasThemeStylebox(name: StringName, themeType: StringName) -> Bool

  Returns true if there is a matching Theme in the tree that has a stylebox item with the specified name and themeType.

• func hasThemeStyleboxOverride(name: StringName) -> Bool

  Returns true if there is a local override for a theme StyleBox with the specified name in this Control node.

• func hide()

  Hides the window. This is not the same as minimized state. Hidden window can’t be interacted with and needs to be made visible with show.

• func isEmbedded() -> Bool

  Returns true if the window is currently embedded in another window.

• func isLayoutRtl() -> Bool

  Returns true if layout is right-to-left.

• func isMaximizeAllowed() -> Bool

  Returns true if the window can be maximized (the maximize button is enabled).

• func isUsingFontOversampling() -> Bool

  Returns true if font oversampling is enabled. See setUseFontOversampling(enable:).

• func moveToCenter()

  Centers a native window on the current screen and an embedded window on its embedder Viewport.

• func moveToForeground()

  Moves the Window on top of other windows and focuses it.

• func popup(rect: Rect2i)

  Shows the Window and makes it transient (see transient). If rect is provided, it will be set as the Window’s size. Fails if called on the main window.

• func popupCentered(minsize: Vector2i)

  Popups the Window at the center of the current screen, with optionally given minimum size. If the Window is embedded, it will be centered in the parent Viewport instead.

• func popupCenteredClamped(minsize: Vector2i, fallbackRatio: Double)

  Popups the Window centered inside its parent Window. fallbackRatio determines the maximum size of the Window, in relation to its parent.

• func popupCenteredRatio(Double)

  If Window is embedded, popups the Window centered inside its embedder and sets its size as a ratio of embedder’s size.

• func popupExclusive(fromNode: Node?, rect: Rect2i)

  Attempts to parent this dialog to the last exclusive window relative to fromNode, and then calls popup(rect:) on it. The dialog must have no current parent, otherwise the method fails.

• func popupExclusiveCentered(fromNode: Node?, minsize: Vector2i)

  Attempts to parent this dialog to the last exclusive window relative to fromNode, and then calls popupCentered(minsize:) on it. The dialog must have no current parent, otherwise the method fails.

• func popupExclusiveCenteredClamped(fromNode: Node?, minsize: Vector2i, fallbackRatio: Double)

  Attempts to parent this dialog to the last exclusive window relative to fromNode, and then calls popupCenteredClamped(minsize:fallbackRatio:) on it. The dialog must have no current parent, otherwise the method fails.

• func popupExclusiveCenteredRatio(fromNode: Node?, ratio: Double)

  Attempts to parent this dialog to the last exclusive window relative to fromNode, and then calls popupCenteredRatio(_:) on it. The dialog must have no current parent, otherwise the method fails.

• func popupExclusiveOnParent(fromNode: Node?, parentRect: Rect2i)

  Attempts to parent this dialog to the last exclusive window relative to fromNode, and then calls popupOnParent(parentRect:) on it. The dialog must have no current parent, otherwise the method fails.

• func popupOnParent(parentRect: Rect2i)

  Popups the Window with a position shifted by parent Window’s position. If the Window is embedded, has the same effect as popup(rect:).

• func removeThemeColorOverride(name: StringName)

  Removes a local override for a theme Color with the specified name previously added by addThemeColorOverride(name:color:) or via the Inspector dock.

• func removeThemeConstantOverride(name: StringName)

  Removes a local override for a theme constant with the specified name previously added by addThemeConstantOverride(name:constant:) or via the Inspector dock.

• func removeThemeFontOverride(name: StringName)

  Removes a local override for a theme Font with the specified name previously added by addThemeFontOverride(name:font:) or via the Inspector dock.

• func removeThemeFontSizeOverride(name: StringName)

  Removes a local override for a theme font size with the specified name previously added by addThemeFontSizeOverride(name:fontSize:) or via the Inspector dock.

• func removeThemeIconOverride(name: StringName)

  Removes a local override for a theme icon with the specified name previously added by addThemeIconOverride(name:texture:) or via the Inspector dock.

• func removeThemeStyleboxOverride(name: StringName)

  Removes a local override for a theme StyleBox with the specified name previously added by addThemeStyleboxOverride(name:stylebox:) or via the Inspector dock.

• func requestAttention()

  Tells the OS that the Window needs an attention. This makes the window stand out in some way depending on the system, e.g. it might blink on the task bar.

• func resetSize()

  Resets the size to the minimum size, which is the max of minSize and (if wrapControls is enabled) getContentsMinimumSize. This is equivalent to calling set_size(Vector2i()) (or any size below the minimum).

• func setImeActive(Bool)

  If active is true, enables system’s native IME (Input Method Editor).

• func setImePosition(Vector2i)

  Moves IME to the given position.

• func setLayoutDirection(Window.LayoutDirection)

  Sets layout direction and text writing direction. Right-to-left layouts are necessary for certain languages (e.g. Arabic and Hebrew).

• func setUnparentWhenInvisible(unparent: Bool)

  If unparent is true, the window is automatically unparented when going invisible.

• func setUseFontOversampling(enable: Bool)

  Enables font oversampling. This makes fonts look better when they are scaled up.

• func show()

  Makes the Window appear. This enables interactions with the Window and doesn’t change any of its property other than visibility (unlike e.g. popup(rect:)).

Subclasses

• class AcceptDialog

  A base dialog used for user notification.

• class Popup

  Base class for contextual windows and panels with fixed position.