Class RenderWindowAbstract

Operating system window with a specific position, size and style. Each window serves as a surface that can be rendered into by RenderAPI operations.

Hierarchy (view full)

Constructors

constructor

Accessors

dotsPerInch dpiScale gammaCorrection height information isFullscreen isWindow priority sampleCount screen width x y

Methods

center hide maximize minimize move raise resize restore screenToWindowPosition setFullscreen setMaximumSize setMinimumSize setWindowed show windowToScreenPosition

Constructors

Protectedconstructor

Accessors

dotsPerInch

  • get dotsPerInch(): number

  • Returns the DPI scale factor of the render texture.

    Returns number

dpiScale

  • get dpiScale(): number

  • Returns the DPI scale factor of the render texture.

    Returns number

gammaCorrection

  • get gammaCorrection(): boolean

  • Returns boolean

height

  • get height(): number

  • Height of the render target, in pixels.

    Returns number

information

isFullscreen

  • get isFullscreen(): boolean

  • Determines if the window is fullscreen.

    Returns boolean

isWindow

  • get isWindow(): boolean

  • Returns true if the render target is a window.

    Returns boolean

priority

  • get priority(): number

  • Controls in what order is the render target rendered to compared to other render targets. Targets with higher priority will be rendered before ones with lower priority.

    Returns number

  • set priority(value): void

  • Parameters

    • value: number

    Returns void

sampleCount

  • get sampleCount(): number

  • Controls how many samples are used for multisampling. (0 or 1 if multisampling is not used).

    Returns number

screen

  • get screen(): Screen

  • Get the screen on which the window is diaplayed.

    Returns Screen

width

  • get width(): number

  • Width of the render target, in pixels.

    Returns number

x

  • get x(): number

  • Horizontal origin of the window in pixels.

    Returns number

y

  • get y(): number

  • Vertical origin of the window in pixels.

    Returns number

Methods

center

  • center(): boolean

  • Moves the window so that it is positioned in the center of the current screen.

    Returns boolean

    True if the move was succesful. False if something failed, for example if it can not find current Screen for the window.

hide

  • hide(): void

  • Hides the window.

    Returns void

    Note

    This is an "asynchronous method".

maximize

  • maximize(): void

  • Maximizes the window over the entire current screen.

    Returns void

minimize

  • minimize(): void

  • Minimizes the window to the taskbar.

    Returns void

move

  • move(left, top): void

  • Move the window to specified screen coordinates.

    Parameters

    • left: number

      Position of the left border of the window on the screen.

    • top: number

      Position of the top border of the window on the screen.

    Returns void

    Note

    This is an "asynchronous method".

raise

  • raise(): void

  • Raises the window to be on top of the other ones as the main active one.

    Returns void

resize

  • resize(width, height): void

  • Resize the window to specified width and height in pixels.

    Parameters

    • width: number

      Width of the window in pixels.

    • height: number

      Height of the window in pixels.

    Returns void

restore

  • restore(): void

  • Restores the window to original position and size if it is minimized or maximized.

    Returns void

screenToWindowPosition

  • screenToWindowPosition(screenPositionInPixels): Vector2

  • Converts screen position in pixels into window local position.

    Parameters

    Returns Vector2

setFullscreen

  • setFullscreen(width, height, refreshRate?, monitorIdx?, dotsPerInch?): any

  • Switches the window to fullscreen mode. Child windows cannot go into fullscreen mode.

    Parameters

    • width: number

      Width of the window frame buffer in pixels.

    • height: number

      Height of the window frame buffer in pixels.

    • OptionalrefreshRate: number

      Refresh rate of the window in Hertz.

    • OptionalmonitorIdx: number

      Index of the monitor to go fullscreen on.

    • OptionaldotsPerInch: number

      The dots per inch.

    Returns any

    Note

    If the exact provided mode isn't available, closest one is used instead.

  • setFullscreen(videoMode): any

  • Switches the window to fullscreen mode. Child windows cannot go into fullscreen mode.

    Parameters

    Returns any

    Note

    If the exact provided mode isn't available, closest one is used instead.

setMaximumSize

  • setMaximumSize(maxWidth, maxHeight): void

  • Defines the window maximum width and height in pixels.

    Parameters

    • maxWidth: number
    • maxHeight: number

    Returns void

setMinimumSize

  • setMinimumSize(minWidth, minHeight): void

  • Defines the window minimum width and height in pixels.

    Parameters

    • minWidth: number
    • minHeight: number

    Returns void

setWindowed

  • setWindowed(width?, height?): void

  • Switches the window to windowed mode. If the optionals are empty, it will use cached values of the screen rectangle before transitioning to fullscreen mode. If those values are missing (i.e. no fullscreen transition was made), it will log a warning.

    Parameters

    • Optionalwidth: number

      Window width in pixels.

    • Optionalheight: number

      Window height in pixels.

    Returns void

    Note

    This is an "asynchronous method".

show

  • show(): void

  • Shows a previously hidden window.

    Returns void

    Note

    This is an "asynchronous method".

windowToScreenPosition

  • windowToScreenPosition(windowPositionInPixels): Vector2

  • Converts window local position in pixels to screen position.

    Parameters

    Returns Vector2

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods