Class VideoModeInformation

Video mode contains information about how a render window presents its information to an output device like a monitor.

Index

Constructors

Properties

_dotsPerInch _height _outputIndex _refreshRate _width

Accessors

dotsPerInch height outputIndex refreshRate width

Methods

assign clone isEqual isEqual

Constructors

constructor

new VideoModeInformation(width?, height?, refreshRate?, outputIndex?, dotsPerInch?): VideoModeInformation
Parameters
- Optionalwidth: number
- Optionalheight: number
- OptionalrefreshRate: number
- OptionaloutputIndex: number
- OptionaldotsPerInch: number
Returns VideoModeInformation

Properties

`Protected`_dotsPerInch

_dotsPerInch: number

`Protected`_height

_height: number

`Protected`_outputIndex

_outputIndex: number

`Protected`_refreshRate

_refreshRate: number

`Protected`_width

_width: number

Accessors

dotsPerInch

get dotsPerInch(): number
The dots per inch for the video mode.

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

height

get height(): number
Height of the front/back buffer in pixels.

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

outputIndex

get outputIndex(): number
Index of the parent video output.

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

refreshRate

get refreshRate(): number
Refresh rate in hertz.

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

width

get width(): number
Width of the front/back buffer in pixels.

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

Methods

assign

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

clone

clone(): VideoModeInformation
Clones this instance and returns a new VideoModeInformation with identical values.

Returns VideoModeInformation

isEqual

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

`Static`isEqual

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