Hatch Game Engine Documentation v1.4.0
The documentation for the Hatch Game Engine
Loading...
Searching...
No Matches
Window Class Reference

Window manipulation functions. More...

Public Member Functions

void SetSize (number width, number height)
 Sets the size of the active window.
void SetFullscreen (boolean isFullscreen)
 Sets the fullscreen state of the active window.
void SetScale (integer scale)
 Sets the scale of the active window.
void SetBorderless (boolean isBorderless)
 Sets the bordered state of the active window.
void SetVSync (boolean enableVsync)
 Enables or disables V-Sync for the active window.
void SetPosition (number x, number y)
 Sets the position of the active window.
void SetPositionCentered ()
 Sets the position of the active window to the center of the display.
void SetTitle (string title)
 Sets the title of the active window.
void SetPostProcessingShader (Shader shader)
 Sets a post-processing shader for the active window.
integer GetWidth ()
 Gets the width of the active window.
integer GetHeight ()
 Gets the height of the active window.
boolean GetFullscreen ()
 Gets whether the active window is currently fullscreen.
integer GetScale ()
 Gets the scale of the active window.
boolean IsResizeable ()
 Gets whether the active window is resizeable.

Detailed Description

Window manipulation functions.

Member Function Documentation

◆ GetFullscreen()

boolean Window.GetFullscreen ( )

Gets whether the active window is currently fullscreen.

Returns
Returns whether the window is fullscreen.

◆ GetHeight()

integer Window.GetHeight ( )

Gets the height of the active window.

Returns
Returns the height of the active window.

◆ GetScale()

integer Window.GetScale ( )

Gets the scale of the active window.

Returns
Returns the scale of the window.

◆ GetWidth()

integer Window.GetWidth ( )

Gets the width of the active window.

Returns
Returns the width of the active window.

◆ IsResizeable()

boolean Window.IsResizeable ( )

Gets whether the active window is resizeable.

Returns
Returns whether the window is resizeable.

◆ SetBorderless()

void Window.SetBorderless ( boolean isBorderless)

Sets the bordered state of the active window.

Parameters
isBorderlessWhether the window should be borderless.

◆ SetFullscreen()

void Window.SetFullscreen ( boolean isFullscreen)

Sets the fullscreen state of the active window.

Parameters
isFullscreenWhether the window should be fullscreen.

◆ SetPosition()

void Window.SetPosition ( number x,
number y )

Sets the position of the active window.

Parameters
xWindow x
yWindow y

◆ SetPostProcessingShader()

void Window.SetPostProcessingShader ( Shader shader)

Sets a post-processing shader for the active window.

Parameters
shaderThe shader, or null to unset the shader.

◆ SetScale()

void Window.SetScale ( integer scale)

Sets the scale of the active window.

Parameters
scaleWindow scale.

◆ SetSize()

void Window.SetSize ( number width,
number height )

Sets the size of the active window.

Parameters
widthWindow width
heightWindow height

◆ SetTitle()

void Window.SetTitle ( string title)

Sets the title of the active window.

Parameters
titleWindow title

◆ SetVSync()

void Window.SetVSync ( boolean enableVsync)

Enables or disables V-Sync for the active window.

Parameters
enableVsyncWhether the window should use V-Sync.