Window

package
v0.0.0-...-c858641 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 14, 2025 License: MIT Imports: 34 Imported by: 0

Documentation

Overview

A node that creates a window. The window can either be a native system window or embedded inside another graphics.gd/classdb/Window (see graphics.gd/classdb/Viewport.Instance.GuiEmbedSubwindows).

At runtime, [graphics.gd/classdb/Window]s will not close automatically when requested. You need to handle it manually using the Instance.OnCloseRequested signal (this applies both to pressing the close button and clicking outside of a popup).

Index

Constants

View Source 
const NotificationThemeChanged Object.Notification = 32 //gd:Window.NOTIFICATION_THEME_CHANGED
View Source 
const NotificationVisibilityChanged Object.Notification = 30 //gd:Window.NOTIFICATION_VISIBILITY_CHANGED

Variables

This section is empty.

Functions

This section is empty.

Types

type Advanced 

type Advanced = class

Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.

type Any 

type Any interface {
	gd.IsClass
	AsWindow() Instance
}

type ContentScaleAspect 

type ContentScaleAspect int //gd:Window.ContentScaleAspect

const (
	// The aspect will be ignored. Scaling will simply stretch the content to fit the target size.
	ContentScaleAspectIgnore ContentScaleAspect = 0
	// The content's aspect will be preserved. If the target size has different aspect from the base one, the image will be centered and black bars will appear on left and right sides.
	ContentScaleAspectKeep ContentScaleAspect = 1
	// The content can be expanded vertically. Scaling horizontally will result in keeping the width ratio and then black bars on left and right sides.
	ContentScaleAspectKeepWidth ContentScaleAspect = 2
	// The content can be expanded horizontally. Scaling vertically will result in keeping the height ratio and then black bars on top and bottom sides.
	ContentScaleAspectKeepHeight ContentScaleAspect = 3
	// The content's aspect will be preserved. If the target size has different aspect from the base one, the content will stay in the top-left corner and add an extra visible area in the stretched space.
	ContentScaleAspectExpand ContentScaleAspect = 4
)

type ContentScaleMode 

type ContentScaleMode int //gd:Window.ContentScaleMode

const (
	// The content will not be scaled to match the [graphics.gd/classdb/Window]'s size.
	ContentScaleModeDisabled ContentScaleMode = 0
	// The content will be rendered at the target size. This is more performance-expensive than [ContentScaleModeViewport], but provides better results.
	ContentScaleModeCanvasItems ContentScaleMode = 1
	// The content will be rendered at the base size and then scaled to the target size. More performant than [ContentScaleModeCanvasItems], but results in pixelated image.
	ContentScaleModeViewport ContentScaleMode = 2
)

type ContentScaleStretch 

type ContentScaleStretch int //gd:Window.ContentScaleStretch

const (
	// The content will be stretched according to a fractional factor. This fills all the space available in the window, but allows "pixel wobble" to occur due to uneven pixel scaling.
	ContentScaleStretchFractional ContentScaleStretch = 0
	// The content will be stretched only according to an integer factor, preserving sharp pixels. This may leave a black background visible on the window's edges depending on the window size.
	ContentScaleStretchInteger ContentScaleStretch = 1
)

type Expanded 

type Expanded [1]gdclass.Window

func (Expanded) GetThemeColor 

func (self Expanded) GetThemeColor(name string, theme_type string) Color.RGBA

Returns a [Color.RGBA] from the first matching graphics.gd/classdb/Theme in the tree if that graphics.gd/classdb/Theme has a color item with the specified 'name' and 'theme_type'.

See graphics.gd/classdb/Control.Instance.GetThemeColor for more details.

func (Expanded) GetThemeConstant 

func (self Expanded) GetThemeConstant(name string, theme_type string) int

Returns a constant from the first matching graphics.gd/classdb/Theme in the tree if that graphics.gd/classdb/Theme has a constant item with the specified 'name' and 'theme_type'.

See graphics.gd/classdb/Control.Instance.GetThemeColor for more details.

func (Expanded) GetThemeFont 

func (self Expanded) GetThemeFont(name string, theme_type string) Font.Instance

Returns a graphics.gd/classdb/Font from the first matching graphics.gd/classdb/Theme in the tree if that graphics.gd/classdb/Theme has a font item with the specified 'name' and 'theme_type'.

See graphics.gd/classdb/Control.Instance.GetThemeColor for details.

func (Expanded) GetThemeFontSize 

func (self Expanded) GetThemeFontSize(name string, theme_type string) int

Returns a font size from the first matching graphics.gd/classdb/Theme in the tree if that graphics.gd/classdb/Theme has a font size item with the specified 'name' and 'theme_type'.

See graphics.gd/classdb/Control.Instance.GetThemeColor for details.

func (Expanded) GetThemeIcon 

func (self Expanded) GetThemeIcon(name string, theme_type string) Texture2D.Instance

Returns an icon from the first matching graphics.gd/classdb/Theme in the tree if that graphics.gd/classdb/Theme has an icon item with the specified 'name' and 'theme_type'.

See graphics.gd/classdb/Control.Instance.GetThemeColor for details.

func (Expanded) GetThemeStylebox 

func (self Expanded) GetThemeStylebox(name string, theme_type string) StyleBox.Instance

Returns a graphics.gd/classdb/StyleBox from the first matching graphics.gd/classdb/Theme in the tree if that graphics.gd/classdb/Theme has a stylebox item with the specified 'name' and 'theme_type'.

See graphics.gd/classdb/Control.Instance.GetThemeColor for details.

func (Expanded) HasThemeColor 

func (self Expanded) HasThemeColor(name string, theme_type string) bool

Returns true if there is a matching graphics.gd/classdb/Theme in the tree that has a color item with the specified 'name' and 'theme_type'.

See graphics.gd/classdb/Control.Instance.GetThemeColor for details.

func (Expanded) HasThemeConstant 

func (self Expanded) HasThemeConstant(name string, theme_type string) bool

Returns true if there is a matching graphics.gd/classdb/Theme in the tree that has a constant item with the specified 'name' and 'theme_type'.

See graphics.gd/classdb/Control.Instance.GetThemeColor for details.

func (Expanded) HasThemeFont 

func (self Expanded) HasThemeFont(name string, theme_type string) bool

Returns true if there is a matching graphics.gd/classdb/Theme in the tree that has a font item with the specified 'name' and 'theme_type'.

See graphics.gd/classdb/Control.Instance.GetThemeColor for details.

func (Expanded) HasThemeFontSize 

func (self Expanded) HasThemeFontSize(name string, theme_type string) bool

Returns true if there is a matching graphics.gd/classdb/Theme in the tree that has a font size item with the specified 'name' and 'theme_type'.

See graphics.gd/classdb/Control.Instance.GetThemeColor for details.

func (Expanded) HasThemeIcon 

func (self Expanded) HasThemeIcon(name string, theme_type string) bool

Returns true if there is a matching graphics.gd/classdb/Theme in the tree that has an icon item with the specified 'name' and 'theme_type'.

See graphics.gd/classdb/Control.Instance.GetThemeColor for details.

func (Expanded) HasThemeStylebox 

func (self Expanded) HasThemeStylebox(name string, theme_type string) bool

Returns true if there is a matching graphics.gd/classdb/Theme in the tree that has a stylebox item with the specified 'name' and 'theme_type'.

See graphics.gd/classdb/Control.Instance.GetThemeColor for details.

func (Expanded) Popup 

func (self Expanded) Popup(rect Rect2i.PositionSize)

Shows the graphics.gd/classdb/Window and makes it transient (see Instance.Transient). If 'rect' is provided, it will be set as the graphics.gd/classdb/Window's size. Fails if called on the main window.

If graphics.gd/classdb/ProjectSettings "display/window/subwindows/embed_subwindows" is true (single-window mode), 'rect”s coordinates are global and relative to the main window's top-left corner (excluding window decorations). If 'rect”s position coordinates are negative, the window will be located outside the main window and may not be visible as a result.

If graphics.gd/classdb/ProjectSettings "display/window/subwindows/embed_subwindows" is false (multi-window mode), 'rect”s coordinates are global and relative to the top-left corner of the leftmost screen. If 'rect”s position coordinates are negative, the window will be placed at the top-left corner of the screen.

Note: 'rect' must be in global coordinates if specified.

func (Expanded) PopupCentered 

func (self Expanded) PopupCentered(minsize Vector2i.XY)

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

Note: Calling it with the default value of 'minsize' is equivalent to calling it with Instance.Size.

func (Expanded) PopupCenteredClamped 

func (self Expanded) PopupCenteredClamped(minsize Vector2i.XY, fallback_ratio Float.X)

Popups the graphics.gd/classdb/Window centered inside its parent graphics.gd/classdb/Window. 'fallback_ratio' determines the maximum size of the graphics.gd/classdb/Window, in relation to its parent.

Note: Calling it with the default value of 'minsize' is equivalent to calling it with Instance.Size.

func (Expanded) PopupCenteredRatio 

func (self Expanded) PopupCenteredRatio(ratio Float.X)

If graphics.gd/classdb/Window is embedded, popups the graphics.gd/classdb/Window centered inside its embedder and sets its size as a 'ratio' of embedder's size.

If graphics.gd/classdb/Window is a native window, popups the graphics.gd/classdb/Window centered inside the screen of its parent graphics.gd/classdb/Window and sets its size as a 'ratio' of the screen size.

func (Expanded) PopupExclusive 

func (self Expanded) PopupExclusive(from_node Node.Instance, rect Rect2i.PositionSize)

Attempts to parent this dialog to the last exclusive window relative to 'from_node', and then calls graphics.gd/classdb/Window.Instance.Popup on it. The dialog must have no current parent, otherwise the method fails.

See also Instance.SetUnparentWhenInvisible and graphics.gd/classdb/Node.Instance.GetLastExclusiveWindow.

func (Expanded) PopupExclusiveCentered 

func (self Expanded) PopupExclusiveCentered(from_node Node.Instance, minsize Vector2i.XY)

Attempts to parent this dialog to the last exclusive window relative to 'from_node', and then calls graphics.gd/classdb/Window.Instance.PopupCentered on it. The dialog must have no current parent, otherwise the method fails.

See also Instance.SetUnparentWhenInvisible and graphics.gd/classdb/Node.Instance.GetLastExclusiveWindow.

func (Expanded) PopupExclusiveCenteredClamped 

func (self Expanded) PopupExclusiveCenteredClamped(from_node Node.Instance, minsize Vector2i.XY, fallback_ratio Float.X)

Attempts to parent this dialog to the last exclusive window relative to 'from_node', and then calls graphics.gd/classdb/Window.Instance.PopupCenteredClamped on it. The dialog must have no current parent, otherwise the method fails.

See also Instance.SetUnparentWhenInvisible and graphics.gd/classdb/Node.Instance.GetLastExclusiveWindow.

func (Expanded) PopupExclusiveCenteredRatio 

func (self Expanded) PopupExclusiveCenteredRatio(from_node Node.Instance, ratio Float.X)

Attempts to parent this dialog to the last exclusive window relative to 'from_node', and then calls graphics.gd/classdb/Window.Instance.PopupCenteredRatio on it. The dialog must have no current parent, otherwise the method fails.

See also Instance.SetUnparentWhenInvisible and graphics.gd/classdb/Node.Instance.GetLastExclusiveWindow.

type Extension 

type Extension[T gdclass.Interface] struct{ gdclass.Extension[T, Instance] }

Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this [Extension]See Interface for methods that can be overridden by T.

func (*Extension[T]) AsNode 

func (self *Extension[T]) AsNode() Node.Instance

func (*Extension[T]) AsObject 

func (self *Extension[T]) AsObject() [1]gd.Object

func (*Extension[T]) AsViewport 

func (self *Extension[T]) AsViewport() Viewport.Instance

func (*Extension[T]) AsWindow 

func (self *Extension[T]) AsWindow() Instance

type Flags 

type Flags int //gd:Window.Flags

const (
	// The window can't be resized by dragging its resize grip. It's still possible to resize the window using [Instance.Size]. This flag is ignored for full screen windows. Set with [Instance.Unresizable].
	FlagResizeDisabled Flags = 0
	// The window do not have native title bar and other decorations. This flag is ignored for full-screen windows. Set with [Instance.Borderless].
	FlagBorderless Flags = 1
	// The window is floating on top of all other windows. This flag is ignored for full-screen windows. Set with [Instance.AlwaysOnTop].
	FlagAlwaysOnTop Flags = 2
	// The window background can be transparent. Set with [Instance.Transparent].
	//
	// Note: This flag has no effect if either [graphics.gd/classdb/ProjectSettings] "display/window/per_pixel_transparency/allowed", or the window's [graphics.gd/classdb/Viewport.Instance.TransparentBg] is set to false.
	FlagTransparent Flags = 3
	// The window can't be focused. No-focus window will ignore all input, except mouse clicks. Set with [Instance.Unfocusable].
	FlagNoFocus Flags = 4
	// Window is part of menu or [graphics.gd/classdb/OptionButton] dropdown. This flag can't be changed when the window is visible. An active popup window will exclusively receive all input, without stealing focus from its parent. Popup windows are automatically closed when uses click outside it, or when an application is switched. Popup window must have transient parent set (see [Instance.Transient]).
	//
	// Note: This flag has no effect in embedded windows (unless said window is a [graphics.gd/classdb/Popup]).
	FlagPopup Flags = 5
	// Window content is expanded to the full size of the window. Unlike borderless window, the frame is left intact and can be used to resize the window, title bar is transparent, but have minimize/maximize/close buttons. Set with [Instance.ExtendToTitle].
	//
	// Note: This flag is implemented only on macOS.
	//
	// Note: This flag has no effect in embedded windows.
	FlagExtendToTitle Flags = 6
	// All mouse events are passed to the underlying window of the same application.
	//
	// Note: This flag has no effect in embedded windows.
	FlagMousePassthrough Flags = 7
	// Window style is overridden, forcing sharp corners.
	//
	// Note: This flag has no effect in embedded windows.
	//
	// Note: This flag is implemented only on Windows (11).
	FlagSharpCorners Flags = 8
	// Windows is excluded from screenshots taken by [graphics.gd/classdb/DisplayServer.ScreenGetImage], [graphics.gd/classdb/DisplayServer.ScreenGetImageRect], and [graphics.gd/classdb/DisplayServer.ScreenGetPixel].
	//
	// Note: This flag is implemented on macOS and Windows.
	//
	// Note: Setting this flag will NOT prevent other apps from capturing an image, it should not be used as a security measure.
	FlagExcludeFromCapture Flags = 9
	// Max value of the [Flags].
	FlagMax Flags = 10
)

type ID 

type ID Object.ID

ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.

func (ID) Instance 

func (id ID) Instance() (Instance, bool)

type Implementation 

type Implementation = implementation

Implementation implements Interface with empty methods.

type Instance 

type Instance [1]gdclass.Window

Instance of the class with convieniently typed arguments and results. 

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func Get 

func Get(peer Node.Instance) Instance

Returns the [Window] that contains this node. If the node is in the main window, this is equivalent to getting the root node ([code]get_tree().get_root()[/code]).

func GetLastExclusive 

func GetLastExclusive(peer Node.Instance) Instance

Returns the [Window] that contains this node, or the last exclusive child in a chain of windows starting with the one that contains this node.

func New 

func New() Instance

func (Instance) AddThemeColorOverride 

func (self Instance) AddThemeColorOverride(name string, color Color.RGBA)

Creates a local override for a theme [Color.RGBA] with the specified 'name'. Local overrides always take precedence when fetching theme items for the control. An override can be removed with Instance.RemoveThemeColorOverride.

See also Instance.GetThemeColor and graphics.gd/classdb/Control.Instance.AddThemeColorOverride for more details.

func (Instance) AddThemeConstantOverride 

func (self Instance) AddThemeConstantOverride(name string, constant int)

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 Instance.RemoveThemeConstantOverride.

See also Instance.GetThemeConstant.

func (Instance) AddThemeFontOverride 

func (self Instance) AddThemeFontOverride(name string, font Font.Instance)

Creates a local override for a theme graphics.gd/classdb/Font with the specified 'name'. Local overrides always take precedence when fetching theme items for the control. An override can be removed with Instance.RemoveThemeFontOverride.

See also Instance.GetThemeFont.

func (Instance) AddThemeFontSizeOverride 

func (self Instance) AddThemeFontSizeOverride(name string, font_size int)

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 Instance.RemoveThemeFontSizeOverride.

See also Instance.GetThemeFontSize.

func (Instance) AddThemeIconOverride 

func (self Instance) AddThemeIconOverride(name string, texture Texture2D.Instance)

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 Instance.RemoveThemeIconOverride.

See also Instance.GetThemeIcon.

func (Instance) AddThemeStyleboxOverride 

func (self Instance) AddThemeStyleboxOverride(name string, stylebox StyleBox.Instance)

Creates a local override for a theme graphics.gd/classdb/StyleBox with the specified 'name'. Local overrides always take precedence when fetching theme items for the control. An override can be removed with Instance.RemoveThemeStyleboxOverride.

See also Instance.GetThemeStylebox and graphics.gd/classdb/Control.Instance.AddThemeStyleboxOverride for more details.

func (Instance) AlwaysOnTop 

func (self Instance) AlwaysOnTop() bool

func (Instance) AsNode 

func (self Instance) AsNode() Node.Instance

func (Instance) AsObject 

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsViewport 

func (self Instance) AsViewport() Viewport.Instance

func (Instance) AsWindow 

func (self Instance) AsWindow() Instance

func (Instance) AutoTranslate 

func (self Instance) AutoTranslate() bool

func (Instance) BeginBulkThemeOverride 

func (self Instance) BeginBulkThemeOverride()

Prevents *_theme_*_override methods from emitting NotificationThemeChanged until Instance.EndBulkThemeOverride is called.

func (Instance) Borderless 

func (self Instance) Borderless() bool

func (Instance) CanDraw 

func (self Instance) CanDraw() bool

Returns whether the window is being drawn to the screen.

func (Instance) ChildControlsChanged 

func (self Instance) ChildControlsChanged()

Requests an update of the graphics.gd/classdb/Window size to fit underlying graphics.gd/classdb/Control nodes.

func (Instance) ContentScaleAspect 

func (self Instance) ContentScaleAspect() ContentScaleAspect

func (Instance) ContentScaleFactor 

func (self Instance) ContentScaleFactor() Float.X

func (Instance) ContentScaleMode 

func (self Instance) ContentScaleMode() ContentScaleMode

func (Instance) ContentScaleSize 

func (self Instance) ContentScaleSize() Vector2i.XY

func (Instance) ContentScaleStretch 

func (self Instance) ContentScaleStretch() ContentScaleStretch

func (Instance) CurrentScreen 

func (self Instance) CurrentScreen() int

func (Instance) EndBulkThemeOverride 

func (self Instance) EndBulkThemeOverride()

Ends a bulk theme override update. See Instance.BeginBulkThemeOverride.

func (Instance) ExcludeFromCapture 

func (self Instance) ExcludeFromCapture() bool

func (Instance) Exclusive 

func (self Instance) Exclusive() bool

func (Instance) ExtendToTitle 

func (self Instance) ExtendToTitle() bool

func (Instance) ForceNative 

func (self Instance) ForceNative() bool

func (Instance) GetContentsMinimumSize 

func (self Instance) GetContentsMinimumSize() Vector2.XY

Returns the combined minimum size from the child graphics.gd/classdb/Control nodes of the window. Use Instance.ChildControlsChanged to update it when child nodes have changed.

The value returned by this method can be overridden with [Interface.GetContentsMinimumSize].

func (Instance) GetEmbeddedInView 

func (self Instance) GetEmbeddedInView(peer Viewport.Instance) []Instance

Returns a list of the visible embedded [Window]s inside the viewport. [b]Note:[/b] [Window]s inside other viewports will not be listed.

func (Instance) GetLayoutDirection 

func (self Instance) GetLayoutDirection() LayoutDirection

Returns layout direction and text writing direction.

func (Instance) GetPositionWithDecorations 

func (self Instance) GetPositionWithDecorations() Vector2i.XY

Returns the window's position including its border.

Note: If Instance.Visible is false, this method returns the same value as Instance.Position.

func (Instance) GetSizeWithDecorations 

func (self Instance) GetSizeWithDecorations() Vector2i.XY

Returns the window's size including its border.

Note: If Instance.Visible is false, this method returns the same value as Instance.Size.

func (Instance) GetThemeColor 

func (self Instance) GetThemeColor(name string) Color.RGBA

Returns a [Color.RGBA] from the first matching graphics.gd/classdb/Theme in the tree if that graphics.gd/classdb/Theme has a color item with the specified 'name' and 'theme_type'.

See graphics.gd/classdb/Control.Instance.GetThemeColor for more details.

func (Instance) GetThemeConstant 

func (self Instance) GetThemeConstant(name string) int

Returns a constant from the first matching graphics.gd/classdb/Theme in the tree if that graphics.gd/classdb/Theme has a constant item with the specified 'name' and 'theme_type'.

See graphics.gd/classdb/Control.Instance.GetThemeColor for more details.

func (Instance) GetThemeDefaultBaseScale 

func (self Instance) GetThemeDefaultBaseScale() Float.X

Returns the default base scale value from the first matching graphics.gd/classdb/Theme in the tree if that graphics.gd/classdb/Theme has a valid graphics.gd/classdb/Theme.Instance.DefaultBaseScale value.

See graphics.gd/classdb/Control.Instance.GetThemeColor for details.

func (Instance) GetThemeDefaultFont 

func (self Instance) GetThemeDefaultFont() Font.Instance

Returns the default font from the first matching graphics.gd/classdb/Theme in the tree if that graphics.gd/classdb/Theme has a valid graphics.gd/classdb/Theme.Instance.DefaultFont value.

See graphics.gd/classdb/Control.Instance.GetThemeColor for details.

func (Instance) GetThemeDefaultFontSize 

func (self Instance) GetThemeDefaultFontSize() int

Returns the default font size value from the first matching graphics.gd/classdb/Theme in the tree if that graphics.gd/classdb/Theme has a valid graphics.gd/classdb/Theme.Instance.DefaultFontSize value.

See graphics.gd/classdb/Control.Instance.GetThemeColor for details.

func (Instance) GetThemeFont 

func (self Instance) GetThemeFont(name string) Font.Instance

Returns a graphics.gd/classdb/Font from the first matching graphics.gd/classdb/Theme in the tree if that graphics.gd/classdb/Theme has a font item with the specified 'name' and 'theme_type'.

See graphics.gd/classdb/Control.Instance.GetThemeColor for details.

func (Instance) GetThemeFontSize 

func (self Instance) GetThemeFontSize(name string) int

Returns a font size from the first matching graphics.gd/classdb/Theme in the tree if that graphics.gd/classdb/Theme has a font size item with the specified 'name' and 'theme_type'.

See graphics.gd/classdb/Control.Instance.GetThemeColor for details.

func (Instance) GetThemeIcon 

func (self Instance) GetThemeIcon(name string) Texture2D.Instance

Returns an icon from the first matching graphics.gd/classdb/Theme in the tree if that graphics.gd/classdb/Theme has an icon item with the specified 'name' and 'theme_type'.

See graphics.gd/classdb/Control.Instance.GetThemeColor for details.

func (Instance) GetThemeStylebox 

func (self Instance) GetThemeStylebox(name string) StyleBox.Instance

Returns a graphics.gd/classdb/StyleBox from the first matching graphics.gd/classdb/Theme in the tree if that graphics.gd/classdb/Theme has a stylebox item with the specified 'name' and 'theme_type'.

See graphics.gd/classdb/Control.Instance.GetThemeColor for details.

func (Instance) GetWindowId 

func (self Instance) GetWindowId() int

Returns the ID of the window.

func (Instance) GrabFocus 

func (self Instance) GrabFocus()

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

func (Instance) HasFocus 

func (self Instance) HasFocus() bool

Returns true if the window is focused.

func (Instance) HasThemeColor 

func (self Instance) HasThemeColor(name string) bool

Returns true if there is a matching graphics.gd/classdb/Theme in the tree that has a color item with the specified 'name' and 'theme_type'.

See graphics.gd/classdb/Control.Instance.GetThemeColor for details.

func (Instance) HasThemeColorOverride 

func (self Instance) HasThemeColorOverride(name string) bool

Returns true if there is a local override for a theme [Color.RGBA] with the specified 'name' in this graphics.gd/classdb/Control node.

See Instance.AddThemeColorOverride.

func (Instance) HasThemeConstant 

func (self Instance) HasThemeConstant(name string) bool

Returns true if there is a matching graphics.gd/classdb/Theme in the tree that has a constant item with the specified 'name' and 'theme_type'.

See graphics.gd/classdb/Control.Instance.GetThemeColor for details.

func (Instance) HasThemeConstantOverride 

func (self Instance) HasThemeConstantOverride(name string) bool

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

See Instance.AddThemeConstantOverride.

func (Instance) HasThemeFont 

func (self Instance) HasThemeFont(name string) bool

Returns true if there is a matching graphics.gd/classdb/Theme in the tree that has a font item with the specified 'name' and 'theme_type'.

See graphics.gd/classdb/Control.Instance.GetThemeColor for details.

func (Instance) HasThemeFontOverride 

func (self Instance) HasThemeFontOverride(name string) bool

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

See Instance.AddThemeFontOverride.

func (Instance) HasThemeFontSize 

func (self Instance) HasThemeFontSize(name string) bool

Returns true if there is a matching graphics.gd/classdb/Theme in the tree that has a font size item with the specified 'name' and 'theme_type'.

See graphics.gd/classdb/Control.Instance.GetThemeColor for details.

func (Instance) HasThemeFontSizeOverride 

func (self Instance) HasThemeFontSizeOverride(name string) bool

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

See Instance.AddThemeFontSizeOverride.

func (Instance) HasThemeIcon 

func (self Instance) HasThemeIcon(name string) bool

Returns true if there is a matching graphics.gd/classdb/Theme in the tree that has an icon item with the specified 'name' and 'theme_type'.

See graphics.gd/classdb/Control.Instance.GetThemeColor for details.

func (Instance) HasThemeIconOverride 

func (self Instance) HasThemeIconOverride(name string) bool

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

See Instance.AddThemeIconOverride.

func (Instance) HasThemeStylebox 

func (self Instance) HasThemeStylebox(name string) bool

Returns true if there is a matching graphics.gd/classdb/Theme in the tree that has a stylebox item with the specified 'name' and 'theme_type'.

See graphics.gd/classdb/Control.Instance.GetThemeColor for details.

func (Instance) HasThemeStyleboxOverride 

func (self Instance) HasThemeStyleboxOverride(name string) bool

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

See Instance.AddThemeStyleboxOverride.

func (Instance) Hide 

func (self Instance) 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 Instance.Show.

func (Instance) ID 

func (self Instance) ID() ID

func (Instance) InitialPosition 

func (self Instance) InitialPosition() WindowInitialPosition

func (Instance) IsEmbedded 

func (self Instance) IsEmbedded() bool

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

func (Instance) IsLayoutRtl 

func (self Instance) IsLayoutRtl() bool

Returns true if layout is right-to-left.

func (Instance) IsMaximizeAllowed 

func (self Instance) IsMaximizeAllowed() bool

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

func (Instance) IsUsingFontOversampling 

func (self Instance) IsUsingFontOversampling() bool

Returns true if font oversampling is enabled. See Instance.SetUseFontOversampling.

func (Instance) KeepTitleVisible 

func (self Instance) KeepTitleVisible() bool

func (Instance) MaxSize 

func (self Instance) MaxSize() Vector2i.XY

func (Instance) MinSize 

func (self Instance) MinSize() Vector2i.XY

func (Instance) Mode 

func (self Instance) Mode() Mode

func (Instance) MousePassthrough 

func (self Instance) MousePassthrough() bool

func (Instance) MousePassthroughPolygon 

func (self Instance) MousePassthroughPolygon() []Vector2.XY

func (Instance) MoveToCenter 

func (self Instance) MoveToCenter()

Centers a native window on the current screen and an embedded window on its embedder graphics.gd/classdb/Viewport.

func (Instance) MoveToForeground 

func (self Instance) MoveToForeground()

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

func (Instance) OnAboutToPopup 

func (self Instance) OnAboutToPopup(cb func(), flags ...Signal.Flags)

func (Instance) OnCloseRequested 

func (self Instance) OnCloseRequested(cb func(), flags ...Signal.Flags)

func (Instance) OnDpiChanged 

func (self Instance) OnDpiChanged(cb func(), flags ...Signal.Flags)

func (Instance) OnFilesDropped 

func (self Instance) OnFilesDropped(cb func(files []string), flags ...Signal.Flags)

func (Instance) OnFocusEntered 

func (self Instance) OnFocusEntered(cb func(), flags ...Signal.Flags)

func (Instance) OnFocusExited 

func (self Instance) OnFocusExited(cb func(), flags ...Signal.Flags)

func (Instance) OnGoBackRequested 

func (self Instance) OnGoBackRequested(cb func(), flags ...Signal.Flags)

func (Instance) OnMouseEntered 

func (self Instance) OnMouseEntered(cb func(), flags ...Signal.Flags)

func (Instance) OnMouseExited 

func (self Instance) OnMouseExited(cb func(), flags ...Signal.Flags)

func (Instance) OnThemeChanged 

func (self Instance) OnThemeChanged(cb func(), flags ...Signal.Flags)

func (Instance) OnTitleChanged 

func (self Instance) OnTitleChanged(cb func(), flags ...Signal.Flags)

func (Instance) OnTitlebarChanged 

func (self Instance) OnTitlebarChanged(cb func(), flags ...Signal.Flags)

func (Instance) OnVisibilityChanged 

func (self Instance) OnVisibilityChanged(cb func(), flags ...Signal.Flags)

func (Instance) OnWindowInput 

func (self Instance) OnWindowInput(cb func(event InputEvent.Instance), flags ...Signal.Flags)

func (Instance) Popup 

func (self Instance) Popup()

Shows the graphics.gd/classdb/Window and makes it transient (see Instance.Transient). If 'rect' is provided, it will be set as the graphics.gd/classdb/Window's size. Fails if called on the main window.

If graphics.gd/classdb/ProjectSettings "display/window/subwindows/embed_subwindows" is true (single-window mode), 'rect”s coordinates are global and relative to the main window's top-left corner (excluding window decorations). If 'rect”s position coordinates are negative, the window will be located outside the main window and may not be visible as a result.

If graphics.gd/classdb/ProjectSettings "display/window/subwindows/embed_subwindows" is false (multi-window mode), 'rect”s coordinates are global and relative to the top-left corner of the leftmost screen. If 'rect”s position coordinates are negative, the window will be placed at the top-left corner of the screen.

Note: 'rect' must be in global coordinates if specified.

func (Instance) PopupCentered 

func (self Instance) PopupCentered()

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

Note: Calling it with the default value of 'minsize' is equivalent to calling it with Instance.Size.

func (Instance) PopupCenteredClamped 

func (self Instance) PopupCenteredClamped()

Popups the graphics.gd/classdb/Window centered inside its parent graphics.gd/classdb/Window. 'fallback_ratio' determines the maximum size of the graphics.gd/classdb/Window, in relation to its parent.

Note: Calling it with the default value of 'minsize' is equivalent to calling it with Instance.Size.

func (Instance) PopupCenteredRatio 

func (self Instance) PopupCenteredRatio()

If graphics.gd/classdb/Window is embedded, popups the graphics.gd/classdb/Window centered inside its embedder and sets its size as a 'ratio' of embedder's size.

If graphics.gd/classdb/Window is a native window, popups the graphics.gd/classdb/Window centered inside the screen of its parent graphics.gd/classdb/Window and sets its size as a 'ratio' of the screen size.

func (Instance) PopupExclusive 

func (self Instance) PopupExclusive(from_node Node.Instance)

Attempts to parent this dialog to the last exclusive window relative to 'from_node', and then calls graphics.gd/classdb/Window.Instance.Popup on it. The dialog must have no current parent, otherwise the method fails.

See also Instance.SetUnparentWhenInvisible and graphics.gd/classdb/Node.Instance.GetLastExclusiveWindow.

func (Instance) PopupExclusiveCentered 

func (self Instance) PopupExclusiveCentered(from_node Node.Instance)

Attempts to parent this dialog to the last exclusive window relative to 'from_node', and then calls graphics.gd/classdb/Window.Instance.PopupCentered on it. The dialog must have no current parent, otherwise the method fails.

See also Instance.SetUnparentWhenInvisible and graphics.gd/classdb/Node.Instance.GetLastExclusiveWindow.

func (Instance) PopupExclusiveCenteredClamped 

func (self Instance) PopupExclusiveCenteredClamped(from_node Node.Instance)

Attempts to parent this dialog to the last exclusive window relative to 'from_node', and then calls graphics.gd/classdb/Window.Instance.PopupCenteredClamped on it. The dialog must have no current parent, otherwise the method fails.

See also Instance.SetUnparentWhenInvisible and graphics.gd/classdb/Node.Instance.GetLastExclusiveWindow.

func (Instance) PopupExclusiveCenteredRatio 

func (self Instance) PopupExclusiveCenteredRatio(from_node Node.Instance)

Attempts to parent this dialog to the last exclusive window relative to 'from_node', and then calls graphics.gd/classdb/Window.Instance.PopupCenteredRatio on it. The dialog must have no current parent, otherwise the method fails.

See also Instance.SetUnparentWhenInvisible and graphics.gd/classdb/Node.Instance.GetLastExclusiveWindow.

func (Instance) PopupExclusiveOnParent 

func (self Instance) PopupExclusiveOnParent(from_node Node.Instance, parent_rect Rect2i.PositionSize)

Attempts to parent this dialog to the last exclusive window relative to 'from_node', and then calls graphics.gd/classdb/Window.Instance.PopupOnParent on it. The dialog must have no current parent, otherwise the method fails.

See also Instance.SetUnparentWhenInvisible and graphics.gd/classdb/Node.Instance.GetLastExclusiveWindow.

func (Instance) PopupOnParent 

func (self Instance) PopupOnParent(parent_rect Rect2i.PositionSize)

Popups the graphics.gd/classdb/Window with a position shifted by parent graphics.gd/classdb/Window's position. If the graphics.gd/classdb/Window is embedded, has the same effect as Instance.Popup.

func (Instance) PopupWindow 

func (self Instance) PopupWindow() bool

func (Instance) Position 

func (self Instance) Position() Vector2i.XY

func (Instance) RemoveThemeColorOverride 

func (self Instance) RemoveThemeColorOverride(name string)

Removes a local override for a theme [Color.RGBA] with the specified 'name' previously added by Instance.AddThemeColorOverride or via the Inspector dock.

func (Instance) RemoveThemeConstantOverride 

func (self Instance) RemoveThemeConstantOverride(name string)

Removes a local override for a theme constant with the specified 'name' previously added by Instance.AddThemeConstantOverride or via the Inspector dock.

func (Instance) RemoveThemeFontOverride 

func (self Instance) RemoveThemeFontOverride(name string)

Removes a local override for a theme graphics.gd/classdb/Font with the specified 'name' previously added by Instance.AddThemeFontOverride or via the Inspector dock.

func (Instance) RemoveThemeFontSizeOverride 

func (self Instance) RemoveThemeFontSizeOverride(name string)

Removes a local override for a theme font size with the specified 'name' previously added by Instance.AddThemeFontSizeOverride or via the Inspector dock.

func (Instance) RemoveThemeIconOverride 

func (self Instance) RemoveThemeIconOverride(name string)

Removes a local override for a theme icon with the specified 'name' previously added by Instance.AddThemeIconOverride or via the Inspector dock.

func (Instance) RemoveThemeStyleboxOverride 

func (self Instance) RemoveThemeStyleboxOverride(name string)

Removes a local override for a theme graphics.gd/classdb/StyleBox with the specified 'name' previously added by Instance.AddThemeStyleboxOverride or via the Inspector dock.

func (Instance) RequestAttention 

func (self Instance) RequestAttention()

Tells the OS that the graphics.gd/classdb/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 (Instance) ResetSize 

func (self Instance) ResetSize()

Resets the size to the minimum size, which is the max of Instance.MinSize and (if Instance.WrapControls is enabled) Instance.GetContentsMinimumSize. This is equivalent to calling set_size(Vector2i()) (or any size below the minimum).

func (Instance) SetAlwaysOnTop 

func (self Instance) SetAlwaysOnTop(value bool)

func (Instance) SetAutoTranslate 

func (self Instance) SetAutoTranslate(value bool)

func (Instance) SetBorderless 

func (self Instance) SetBorderless(value bool)

func (Instance) SetContentScaleAspect 

func (self Instance) SetContentScaleAspect(value ContentScaleAspect)

func (Instance) SetContentScaleFactor 

func (self Instance) SetContentScaleFactor(value Float.X)

func (Instance) SetContentScaleMode 

func (self Instance) SetContentScaleMode(value ContentScaleMode)

func (Instance) SetContentScaleSize 

func (self Instance) SetContentScaleSize(value Vector2i.XY)

func (Instance) SetContentScaleStretch 

func (self Instance) SetContentScaleStretch(value ContentScaleStretch)

func (Instance) SetCurrentScreen 

func (self Instance) SetCurrentScreen(value int)

func (Instance) SetExcludeFromCapture 

func (self Instance) SetExcludeFromCapture(value bool)

func (Instance) SetExclusive 

func (self Instance) SetExclusive(value bool)

func (Instance) SetExtendToTitle 

func (self Instance) SetExtendToTitle(value bool)

func (Instance) SetForceNative 

func (self Instance) SetForceNative(value bool)

func (Instance) SetImeActive 

func (self Instance) SetImeActive(active bool)

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

func (Instance) SetImePosition 

func (self Instance) SetImePosition(position Vector2i.XY)

Moves IME to the given position.

func (Instance) SetInitialPosition 

func (self Instance) SetInitialPosition(value WindowInitialPosition)

func (Instance) SetKeepTitleVisible 

func (self Instance) SetKeepTitleVisible(value bool)

func (Instance) SetLayoutDirection 

func (self Instance) SetLayoutDirection(direction LayoutDirection)

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

func (Instance) SetMaxSize 

func (self Instance) SetMaxSize(value Vector2i.XY)

func (Instance) SetMinSize 

func (self Instance) SetMinSize(value Vector2i.XY)

func (Instance) SetMode 

func (self Instance) SetMode(value Mode)

func (Instance) SetMousePassthrough 

func (self Instance) SetMousePassthrough(value bool)

func (Instance) SetMousePassthroughPolygon 

func (self Instance) SetMousePassthroughPolygon(value []Vector2.XY)

func (*Instance) SetObject 

func (self *Instance) SetObject(obj [1]gd.Object) bool

func (Instance) SetPopupWindow 

func (self Instance) SetPopupWindow(value bool)

func (Instance) SetPosition 

func (self Instance) SetPosition(value Vector2i.XY)

func (Instance) SetSharpCorners 

func (self Instance) SetSharpCorners(value bool)

func (Instance) SetSize 

func (self Instance) SetSize(value Vector2i.XY)

func (Instance) SetTheme 

func (self Instance) SetTheme(value Theme.Instance)

func (Instance) SetThemeTypeVariation 

func (self Instance) SetThemeTypeVariation(value string)

func (Instance) SetTitle 

func (self Instance) SetTitle(value string)

func (Instance) SetTransient 

func (self Instance) SetTransient(value bool)

func (Instance) SetTransientToFocused 

func (self Instance) SetTransientToFocused(value bool)

func (Instance) SetTransparent 

func (self Instance) SetTransparent(value bool)

func (Instance) SetUnfocusable 

func (self Instance) SetUnfocusable(value bool)

func (Instance) SetUnparentWhenInvisible 

func (self Instance) SetUnparentWhenInvisible(unparent bool)

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

Note: Make sure to keep a reference to the node, otherwise it will be orphaned. You also need to manually call graphics.gd/classdb/Node.Instance.QueueFree to free the window if it's not parented.

func (Instance) SetUnresizable 

func (self Instance) SetUnresizable(value bool)

func (Instance) SetUseFontOversampling 

func (self Instance) SetUseFontOversampling(enable bool)

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

func (Instance) SetVisible 

func (self Instance) SetVisible(value bool)

func (Instance) SetWrapControls 

func (self Instance) SetWrapControls(value bool)

func (Instance) SharpCorners 

func (self Instance) SharpCorners() bool

func (Instance) Show 

func (self Instance) Show()

Makes the graphics.gd/classdb/Window appear. This enables interactions with the graphics.gd/classdb/Window and doesn't change any of its property other than visibility (unlike e.g. Instance.Popup).

func (Instance) Size 

func (self Instance) Size() Vector2i.XY

func (Instance) StartDrag 

func (self Instance) StartDrag()

Starts an interactive drag operation on the window, using the current mouse position. Call this method when handling a mouse button being pressed to simulate a pressed event on the window's title bar. Using this method allows the window to participate in space switching, tiling, and other system features.

func (Instance) StartResize 

func (self Instance) StartResize(edge DisplayServer.WindowResizeEdge)

Starts an interactive resize operation on the window, using the current mouse position. Call this method when handling a mouse button being pressed to simulate a pressed event on the window's edge.

func (Instance) Theme 

func (self Instance) Theme() Theme.Instance

func (Instance) ThemeTypeVariation 

func (self Instance) ThemeTypeVariation() string

func (Instance) Title 

func (self Instance) Title() string

func (Instance) Transient 

func (self Instance) Transient() bool

func (Instance) TransientToFocused 

func (self Instance) TransientToFocused() bool

func (Instance) Transparent 

func (self Instance) Transparent() bool

func (Instance) Unfocusable 

func (self Instance) Unfocusable() bool

func (Instance) Unresizable 

func (self Instance) Unresizable() bool

func (Instance) Virtual 

func (self Instance) Virtual(name string) reflect.Value

func (Instance) Visible 

func (self Instance) Visible() bool

func (Instance) WrapControls 

func (self Instance) WrapControls() bool

type Interface 

type Interface interface {
	// Virtual method to be implemented by the user. Overrides the value returned by [Instance.GetContentsMinimumSize].
	GetContentsMinimumSize() Vector2.XY
}

type LayoutDirection 

type LayoutDirection int //gd:Window.LayoutDirection

const (
	// Automatic layout direction, determined from the parent window layout direction.
	LayoutDirectionInherited LayoutDirection = 0
	// Automatic layout direction, determined from the current locale.
	LayoutDirectionApplicationLocale LayoutDirection = 1
	// Left-to-right layout direction.
	LayoutDirectionLtr LayoutDirection = 2
	// Right-to-left layout direction.
	LayoutDirectionRtl LayoutDirection = 3
	// Automatic layout direction, determined from the system locale.
	LayoutDirectionSystemLocale LayoutDirection = 4
	// Represents the size of the [LayoutDirection] enum.
	LayoutDirectionMax    LayoutDirection = 5
	LayoutDirectionLocale LayoutDirection = 1
)

type Mode 

type Mode int //gd:Window.Mode

const (
	// Windowed mode, i.e. [graphics.gd/classdb/Window] doesn't occupy the whole screen (unless set to the size of the screen).
	ModeWindowed Mode = 0
	// Minimized window mode, i.e. [graphics.gd/classdb/Window] is not visible and available on window manager's window list. Normally happens when the minimize button is pressed.
	ModeMinimized Mode = 1
	// Maximized window mode, i.e. [graphics.gd/classdb/Window] will occupy whole screen area except task bar and still display its borders. Normally happens when the maximize button is pressed.
	ModeMaximized Mode = 2
	// Full screen mode with full multi-window support.
	//
	// Full screen window covers the entire display area of a screen and has no decorations. The display's video mode is not changed.
	//
	// On Android: This enables immersive mode.
	//
	// On Windows: Multi-window full-screen mode has a 1px border of the [graphics.gd/classdb/ProjectSettings] "rendering/environment/defaults/default_clear_color" color.
	//
	// On macOS: A new desktop is used to display the running project.
	//
	// Note: Regardless of the platform, enabling full screen will change the window size to match the monitor's size. Therefore, make sure your project supports [multiple resolutions] when enabling full screen mode.
	//
	// [multiple resolutions]: https://docs.godotengine.org/tutorials/rendering/multiple_resolutions.html
	ModeFullscreen Mode = 3
	// A single window full screen mode. This mode has less overhead, but only one window can be open on a given screen at a time (opening a child window or application switching will trigger a full screen transition).
	//
	// Full screen window covers the entire display area of a screen and has no border or decorations. The display's video mode is not changed.
	//
	// On Android: This enables immersive mode.
	//
	// On Windows: Depending on video driver, full screen transition might cause screens to go black for a moment.
	//
	// On macOS: A new desktop is used to display the running project. Exclusive full screen mode prevents Dock and Menu from showing up when the mouse pointer is hovering the edge of the screen.
	//
	// On Linux (X11): Exclusive full screen mode bypasses compositor.
	//
	// Note: Regardless of the platform, enabling full screen will change the window size to match the monitor's size. Therefore, make sure your project supports [multiple resolutions] when enabling full screen mode.
	//
	// [multiple resolutions]: https://docs.godotengine.org/tutorials/rendering/multiple_resolutions.html
	ModeExclusiveFullscreen Mode = 4
)

type WindowInitialPosition 

type WindowInitialPosition int //gd:Window.WindowInitialPosition

const (
	// Initial window position is determined by [Instance.Position].
	WindowInitialPositionAbsolute WindowInitialPosition = 0
	// Initial window position is the center of the primary screen.
	WindowInitialPositionCenterPrimaryScreen WindowInitialPosition = 1
	// Initial window position is the center of the main window screen.
	WindowInitialPositionCenterMainWindowScreen WindowInitialPosition = 2
	// Initial window position is the center of [Instance.CurrentScreen] screen.
	WindowInitialPositionCenterOtherScreen WindowInitialPosition = 3
	// Initial window position is the center of the screen containing the mouse pointer.
	WindowInitialPositionCenterScreenWithMouseFocus WindowInitialPosition = 4
	// Initial window position is the center of the screen containing the window with the keyboard focus.
	WindowInitialPositionCenterScreenWithKeyboardFocus WindowInitialPosition = 5
)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.