Class RenderWindow`Abstract`

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)

RenderTarget
- RenderWindow

Index

Constructors

`Protected`constructor

new RenderWindow(isInternalConstructor?): RenderWindow
Parameters
- OptionalisInternalConstructor: boolean
Returns RenderWindow
Overrides RenderTarget.constructor

Accessors

gammaCorrection

get gammaCorrection(): boolean
Returns boolean
Inherited from RenderTarget.gammaCorrection

height

get height(): number
Height of the render target, in pixels.

Returns number
Inherited from RenderTarget.height

information

get information(): Immutable<RenderWindowInformation>
Returns a reference to the window information passed during window creation.

Returns Immutable<RenderWindowInformation>

isFullscreen

get isFullscreen(): boolean
Determines if the window is fullscreen.

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
Inherited from RenderTarget.priority
set priority(value): void
Parameters
- value: number
Returns void
Inherited from RenderTarget.priority

sampleCount

get sampleCount(): number
Controls how many samples are used for multisampling. (0 or 1 if multisampling is not used).

Returns number
Inherited from RenderTarget.sampleCount

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
Inherited from RenderTarget.width

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
- screenPositionInPixels: Immutable<Vector2>
Returns Vector2

setFullscreen

setFullscreen(options): void
Switches the window to fullscreen mode. Child windows cannot go into fullscreen mode.
Parameters
- options: {
      dotsPerInch?: number;
      height: number;
      monitorIdx?: number;
      refreshRate?: number;
      width: number;
  } | {
      videoMode: Immutable<VideoModeInformation>;
  }
  Options object for the function call.
Returns void
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.
Parameters
- width: number
  Window width in pixels.
- height: number
  Window height in pixels.
Returns void

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
- windowPositionInPixels: Immutable<Vector2>
Returns Vector2