Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

constructor

  • new DisplayInfo(width?: number, height?: number, autoSizeToFrame?: boolean, frameWidth?: number, frameHeight?: number, screenWidth?: number, screenHeight?: number, screenDpiScale?: number, orientation?: DisplayOrientation, renderMode?: RenderMode, focused?: boolean, visible?: boolean): DisplayInfo
  • Parameters

    • Optional width: number
    • Optional height: number
    • Optional autoSizeToFrame: boolean
    • Optional frameWidth: number
    • Optional frameHeight: number
    • Optional screenWidth: number
    • Optional screenHeight: number
    • Optional screenDpiScale: number
    • Optional orientation: DisplayOrientation
    • Optional renderMode: RenderMode
    • Optional focused: boolean
    • Optional visible: boolean

    Returns DisplayInfo

Properties

autoSizeToFrame

autoSizeToFrame: boolean

If set to true, the output automatically resizes to fill the frame (the browser or application window), and match the orientation. Changing output width or height manually has no effect.

focused

focused: boolean

Specifies whether the browser or application window has focus.

frameHeight

frameHeight: number

Specifies the frame height, in pixels. This is the height of the browser or application window.

frameWidth

frameWidth: number

Specifies the frame width, in pixels. This is the width of the browser or application window.

height

height: number

Specifies the output height, in pixels.

orientation

orientation: DisplayOrientation

Specifies the device display (screen) orientation. Can be Horizontal or Vertical.

renderMode

renderMode: RenderMode

Forces DisplayInfo to use a specific renderer. This allows switching between WebGL and Canvas rendering in the HTML runtime. The RenderMode enum defines Possible renderers. The default is Auto. Switching renderers at runtime is usually possible, but may not be seamless.

screenDpiScale

screenDpiScale: number

Specifies the scale of the device display (screen) DPI relative to. 96 DPI. For example, a value of 2.0 yields 192 DPI (200% of 96).

screenHeight

screenHeight: number

Specifies the device display (screen) height, in pixels.

screenWidth

screenWidth: number

Specifies the device display (screen) width, in pixels.

visible

visible: boolean

Specifies whether the browser or application window is currently visible on the screen/device display.

width

width: number

Specifies the output width, in pixels.

Static _isSharedComp

_isSharedComp: boolean

Static _size

_size: number

Static _view

_view: any

Static autoSizeToFrame

autoSizeToFrame: ComponentFieldDesc

Static cid

cid: number

Static focused

Static frameHeight

frameHeight: ComponentFieldDesc

Static frameWidth

frameWidth: ComponentFieldDesc

Static height

Static screenDpiScale

screenDpiScale: ComponentFieldDesc

Static screenHeight

screenHeight: ComponentFieldDesc

Static screenWidth

screenWidth: ComponentFieldDesc

Static visible

Static width

Methods

Static _dtorFn

  • Parameters

    Returns void

Static _fromPtr

Static _tempHeapPtr

  • Parameters

    Returns number

Static _toPtr

  • Parameters

    Returns void

Generated using TypeDoc