Class RenderWindowInformation

Structure that is used for initializing a render window.

Constructors

constructor

Properties

_customTitleBarHeightInPoints _isAlphaBlendingEnabled _isBorderEnabled _isCustomChromeEnabled _isDepthBufferEnabled _isFocusable _isFullScreen _isHardwareGammaEncodingEnabled _isHiddenOnStart _isHiddenUntilSwap _isModalWindow _isResizeAllowed _isRoundedEdgesEnabled _isSheet _isTitleBarEnabled _isToolWindow _isVSyncEnabled _leftOrigin _multisampleCount _multisampleHint _noGUIEvents _title _topOrigin _videoMode _vSyncInterval

Accessors

customTitleBarHeightInPoints isAlphaBlendingEnabled isBorderEnabled isCustomChromeEnabled isDepthBufferEnabled isFocusable isFullScreen isHardwareGammaEncodingEnabled isHiddenOnStart isHiddenUntilSwap isModalWindow isResizeAllowed isRoundedEdgesEnabled isSheet isTitleBarEnabled isToolWindow isVSyncEnabled leftOrigin multisampleCount multisampleHint noGUIEvents title topOrigin videoMode vSyncInterval

Methods

assign clone isEqual isEqual

Constructors

constructor

  • new RenderWindowInformation(videoMode?, isFullScreen?, isVSyncEnabled?, vSyncInterval?, isHiddenOnStart?, isDepthBufferEnabled?, multisampleCount?, multisampleHint?, isHardwareGammaEncodingEnabled?, leftOrigin?, topOrigin?, title?, isTitleBarEnabled?, isBorderEnabled?, isRoundedEdgesEnabled?, isResizeAllowed?, isToolWindow?, isModalWindow?, isSheet?, isHiddenUntilSwap?, isAlphaBlendingEnabled?, isCustomChromeEnabled?, customTitleBarHeightInPoints?, isFocusable?, noGUIEvents?): 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): 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): 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): 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): 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): 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): void

  • Parameters

    • value: boolean

    Returns void

isFullScreen

  • get isFullScreen(): boolean

  • Should the window be opened in fullscreen mode.

    Returns boolean

  • set isFullScreen(value): 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): void

  • Parameters

    • value: boolean

    Returns void

isHiddenOnStart

  • get isHiddenOnStart(): boolean

  • Should the window be hidden initially.

    Returns boolean

  • set isHiddenOnStart(value): 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): 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): 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): 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): 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): 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): 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): 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): 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): 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): 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): 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): void

  • Parameters

    • value: boolean

    Returns void

title

  • get title(): string

  • Title of the window.

    Returns string

  • set title(value): 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): void

  • Parameters

    • value: number

    Returns void

videoMode

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): void

  • Parameters

    • value: number

    Returns void

Methods

assign

clone

isEqual

StaticisEqual

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods