Class RenderWindowInformation

Structure that is used for initializing a render window.

Index

Constructors

constructor

Methods

assign clone isEqual isEqual

Constructors

constructor

new RenderWindowInformation(
    videoMode?: Immutable<VideoModeInformation>,
    isFullScreen?: boolean,
    isVSyncEnabled?: boolean,
    vSyncInterval?: number,
    isHiddenOnStart?: boolean,
    isDepthBufferEnabled?: boolean,
    multisampleCount?: number,
    multisampleHint?: string,
    isHardwareGammaEncodingEnabled?: boolean,
    leftOrigin?: number,
    topOrigin?: number,
    title?: string,
    isTitleBarEnabled?: boolean,
    isBorderEnabled?: boolean,
    isRoundedEdgesEnabled?: boolean,
    isResizeAllowed?: boolean,
    isToolWindow?: boolean,
    isModalWindow?: boolean,
    isSheet?: boolean,
    isHiddenUntilSwap?: boolean,
    isAlphaBlendingEnabled?: boolean,
    isCustomChromeEnabled?: boolean,
    customTitleBarHeightInPoints?: number,
    isFocusable?: boolean,
    noGUIEvents?: boolean,
): RenderWindowInformation
Parameters
- OptionalvideoMode: Immutable<VideoModeInformation>
- OptionalisFullScreen: boolean
- OptionalisVSyncEnabled: boolean
- OptionalvSyncInterval: number
- OptionalisHiddenOnStart: boolean
- OptionalisDepthBufferEnabled: boolean
- OptionalmultisampleCount: number
- OptionalmultisampleHint: string
- OptionalisHardwareGammaEncodingEnabled: boolean
- OptionalleftOrigin: number
- OptionaltopOrigin: number
- Optionaltitle: string
- OptionalisTitleBarEnabled: boolean
- OptionalisBorderEnabled: boolean
- OptionalisRoundedEdgesEnabled: boolean
- OptionalisResizeAllowed: boolean
- OptionalisToolWindow: boolean
- OptionalisModalWindow: boolean
- OptionalisSheet: boolean
- OptionalisHiddenUntilSwap: boolean
- OptionalisAlphaBlendingEnabled: boolean
- OptionalisCustomChromeEnabled: boolean
- OptionalcustomTitleBarHeightInPoints: number
- OptionalisFocusable: boolean
- OptionalnoGUIEvents: boolean
Returns RenderWindowInformation

Properties

`Protected`_customTitleBarHeightInPoints

_customTitleBarHeightInPoints: number

`Protected`_isAlphaBlendingEnabled

_isAlphaBlendingEnabled: boolean

`Protected`_isBorderEnabled

_isBorderEnabled: boolean

`Protected`_isCustomChromeEnabled

_isCustomChromeEnabled: boolean

`Protected`_isDepthBufferEnabled

_isDepthBufferEnabled: boolean

`Protected`_isFocusable

_isFocusable: boolean

`Protected`_isFullScreen

_isFullScreen: boolean

`Protected`_isHardwareGammaEncodingEnabled

_isHardwareGammaEncodingEnabled: boolean

`Protected`_isHiddenOnStart

_isHiddenOnStart: boolean

`Protected`_isHiddenUntilSwap

_isHiddenUntilSwap: boolean

`Protected`_isModalWindow

_isModalWindow: boolean

`Protected`_isResizeAllowed

_isResizeAllowed: boolean

`Protected`_isRoundedEdgesEnabled

_isRoundedEdgesEnabled: boolean

`Protected`_isSheet

_isSheet: boolean

`Protected`_isTitleBarEnabled

_isTitleBarEnabled: boolean

`Protected`_isToolWindow

_isToolWindow: boolean

`Protected`_isVSyncEnabled

_isVSyncEnabled: boolean

`Protected`_leftOrigin

_leftOrigin: number

`Protected`_multisampleCount

_multisampleCount: number

`Protected`_multisampleHint

_multisampleHint: string

`Protected`_noGUIEvents

_noGUIEvents: boolean

`Protected`_title

_title: string

`Protected`_topOrigin

_topOrigin: number

`Protected`_videoMode

_videoMode: VideoModeInformation

`Protected`_vSyncInterval

_vSyncInterval: number

Accessors

customTitleBarHeightInPoints

get customTitleBarHeightInPoints(): number

The size of the custom title bar, used for RSX Engine's main window on macOS.

Returns number
set customTitleBarHeightInPoints(value: number): void
Parameters
- value: number
Returns void

isAlphaBlendingEnabled

get isAlphaBlendingEnabled(): boolean

If true the window will support transparency based on the alpha channel of the render target.

Returns boolean
set isAlphaBlendingEnabled(value: boolean): void
Parameters
- value: boolean
Returns void

isBorderEnabled

get isBorderEnabled(): boolean

Determines if the window border should be shown or not.

Returns boolean
set isBorderEnabled(value: boolean): void
Parameters
- value: boolean
Returns void

isCustomChromeEnabled

get isCustomChromeEnabled(): boolean

If true the window will have a custom chrome, used for RSX Engine's main window on macOS.

Returns boolean
set isCustomChromeEnabled(value: boolean): void
Parameters
- value: boolean
Returns void

isDepthBufferEnabled

get isDepthBufferEnabled(): boolean

Should the window be created with a depth/stencil buffer.

Returns boolean
set isDepthBufferEnabled(value: boolean): void
Parameters
- value: boolean
Returns void

isFocusable

get isFocusable(): boolean

If set to false, indicates the window should not be focusable by the user, that is after creation or calling show() won't set the focus to this window neither remove the focus from any currently focused window.

By default, true.

Returns boolean
set isFocusable(value: boolean): void
Parameters
- value: boolean
Returns void

isFullScreen

get isFullScreen(): boolean

Should the window be opened in fullscreen mode.

Returns boolean
set isFullScreen(value: boolean): void
Parameters
- value: boolean
Returns void

isHardwareGammaEncodingEnabled

get isHardwareGammaEncodingEnabled(): boolean

Should the written color pixels be gamma corrected before write.

Returns boolean
set isHardwareGammaEncodingEnabled(value: boolean): void
Parameters
- value: boolean
Returns void

isHiddenOnStart

get isHiddenOnStart(): boolean

Should the window be hidden initially.

Returns boolean
set isHiddenOnStart(value: boolean): void
Parameters
- value: boolean
Returns void

isHiddenUntilSwap

get isHiddenUntilSwap(): boolean

Window will be created as hidden and only be shown when the first framebuffer swap happens.

Returns boolean
set isHiddenUntilSwap(value: boolean): void
Parameters
- value: boolean
Returns void

isModalWindow

get isModalWindow(): boolean

When a modal window is open all other windows will be locked until modal window is closed.

Returns boolean
set isModalWindow(value: boolean): void
Parameters
- value: boolean
Returns void

isResizeAllowed

get isResizeAllowed(): boolean

Determines if the user can resize the window by dragging on the window edges.

Returns boolean
set isResizeAllowed(value: boolean): void
Parameters
- value: boolean
Returns void

isRoundedEdgesEnabled

get isRoundedEdgesEnabled(): boolean

Determines if the window will attempt to round edges. Currently supported on MacOS and Windows 11 and up.

Returns boolean
set isRoundedEdgesEnabled(value: boolean): void
Parameters
- value: boolean
Returns void

isSheet

get isSheet(): boolean

Should the window be displayed as sheet. Specific to macOS.

Returns boolean
set isSheet(value: boolean): void
Parameters
- value: boolean
Returns void

isTitleBarEnabled

get isTitleBarEnabled(): boolean

Determines if the title-bar should be shown or not.

Returns boolean
set isTitleBarEnabled(value: boolean): void
Parameters
- value: boolean
Returns void

isToolWindow

get isToolWindow(): boolean

Tool windows have no task bar entry and always remain on top of their parent window.

Returns boolean
set isToolWindow(value: boolean): void
Parameters
- value: boolean
Returns void

isVSyncEnabled

get isVSyncEnabled(): boolean

Should the window wait for vertical sync before swapping buffers.

Returns boolean
set isVSyncEnabled(value: boolean): void
Parameters
- value: boolean
Returns void

leftOrigin

get leftOrigin(): number

Window origin on X axis in pixels. -1 == screen center. Relative to monitor provided in videoMode.

Returns number
set leftOrigin(value: number): void
Parameters
- value: number
Returns void

multisampleCount

get multisampleCount(): number

If higher than 1, texture containing multiple samples per pixel is created.

Returns number
set multisampleCount(value: number): void
Parameters
- value: number
Returns void

multisampleHint

get multisampleHint(): string

Hint about what kind of multisampling to use. Render system specific.

Returns string
set multisampleHint(value: string): void
Parameters
- value: string
Returns void

noGUIEvents

get noGUIEvents(): boolean

If enabled, no UI events will be dispatched to the window.

Returns boolean
set noGUIEvents(value: boolean): void
Parameters
- value: boolean
Returns void

title

get title(): string

Title of the window.

Returns string
set title(value: string): void
Parameters
- value: string
Returns void

topOrigin

get topOrigin(): number

Window origin on Y axis in pixels. -1 == screen center. Relative to monitor provided in videoMode.

Returns number
set topOrigin(value: number): void
Parameters
- value: number
Returns void

videoMode

get videoMode(): VideoModeInformation

Output monitor, frame buffer resize and refresh rate.

Returns VideoModeInformation
set videoMode(value: Immutable<VideoModeInformation>): void
Parameters
- value: Immutable<VideoModeInformation>
Returns void

vSyncInterval

get vSyncInterval(): number

Determines how many vsync intervals occur per frame. FPS = refreshRate/interval. Usually 1 when vsync active.

Returns number
set vSyncInterval(value: number): void
Parameters
- value: number
Returns void

Methods

assign

assign(other: Immutable<RenderWindowInformation>): RenderWindowInformation
Copies all properties defined by the prototype of RenderWindowInformation from other to this instance.
Parameters
- other: Immutable<RenderWindowInformation>
Returns RenderWindowInformation

clone

clone(): RenderWindowInformation

Clones this instance and returns a new RenderWindowInformation with identical values.

Returns RenderWindowInformation

isEqual

isEqual(
this: Immutable<RenderWindowInformation>,
other: Immutable<RenderWindowInformation>,
): boolean
Determines if this RenderWindowInformation instance is equal to the other instance.
Parameters
- this: Immutable<RenderWindowInformation>
- other: Immutable<RenderWindowInformation>
Returns boolean

`Static`isEqual

isEqual(
lhs: Immutable<RenderWindowInformation>,
rhs: Immutable<RenderWindowInformation>,
): boolean
Determines if both RenderWindowInformation instances are equal.
Parameters
- lhs: Immutable<RenderWindowInformation>
- rhs: Immutable<RenderWindowInformation>
Returns boolean

Class RenderWindowInformation

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns RenderWindowInformation

Properties

Protected_customTitleBarHeightInPoints

Protected_isAlphaBlendingEnabled

Protected_isBorderEnabled

Protected_isCustomChromeEnabled

Protected_isDepthBufferEnabled

Protected_isFocusable

Protected_isFullScreen

Protected_isHardwareGammaEncodingEnabled

Protected_isHiddenOnStart

Protected_isHiddenUntilSwap

Protected_isModalWindow

Protected_isResizeAllowed

Protected_isRoundedEdgesEnabled

Protected_isSheet

Protected_isTitleBarEnabled

Protected_isToolWindow

Protected_isVSyncEnabled

Protected_leftOrigin

Protected_multisampleCount

Protected_multisampleHint

Protected_noGUIEvents

Protected_title

Protected_topOrigin

Protected_videoMode

Protected_vSyncInterval

Accessors

customTitleBarHeightInPoints

Returns number

Parameters

Returns void

isAlphaBlendingEnabled

Returns boolean

Parameters

Returns void

isBorderEnabled

Returns boolean

Parameters

Returns void

isCustomChromeEnabled

Returns boolean

Parameters

Returns void

isDepthBufferEnabled

Returns boolean

Parameters

Returns void

isFocusable

Returns boolean

Parameters

Returns void

isFullScreen

Returns boolean

Parameters

Returns void

isHardwareGammaEncodingEnabled

Returns boolean

Parameters

Returns void

isHiddenOnStart

Returns boolean

Parameters

Returns void

isHiddenUntilSwap

Returns boolean

Parameters

Returns void

isModalWindow

Returns boolean

Parameters

`Protected`_customTitleBarHeightInPoints

`Protected`_isAlphaBlendingEnabled

`Protected`_isBorderEnabled

`Protected`_isCustomChromeEnabled

`Protected`_isDepthBufferEnabled

`Protected`_isFocusable

`Protected`_isFullScreen

`Protected`_isHardwareGammaEncodingEnabled

`Protected`_isHiddenOnStart

`Protected`_isHiddenUntilSwap

`Protected`_isModalWindow

`Protected`_isResizeAllowed

`Protected`_isRoundedEdgesEnabled

`Protected`_isSheet

`Protected`_isTitleBarEnabled

`Protected`_isToolWindow

`Protected`_isVSyncEnabled

`Protected`_leftOrigin

`Protected`_multisampleCount

`Protected`_multisampleHint

`Protected`_noGUIEvents

`Protected`_title

`Protected`_topOrigin

`Protected`_videoMode

`Protected`_vSyncInterval

`Static`isEqual