Class Resolution

A resolution.

Hierarchy (View Summary)

EventDispatcher<BaseEventMap>
- Resolution
  - Viewport

Implements

Vector2Like

Index

Constructors

Properties

Accessors

aspectRatio baseHeight baseWidth height pixelRatio preferredHeight preferredWidth scale scaledPixelRatio width x y

Methods

copy copyBaseSize copyPreferredSize equals resetPreferredSize setBaseSize setChanged setPreferredSize setSize

Constructors

constructor

new Resolution(width?: number, height?: number, scale?: number): Resolution
Constructs a new resolution.
Parameters
- width: number = AUTO_SIZE
  The preferred width.
- height: number = AUTO_SIZE
  The preferred height.
- scale: number = 1.0
  A resolution scale.
Returns Resolution
Overrides EventDispatcher<BaseEventMap>.constructor
- Defined in src/utils/Resolution.ts:68

Properties

`Static` `Readonly`AUTO_SIZE

AUTO_SIZE: -1 = AUTO_SIZE

An auto sizing constant.

Can be used to automatically calculate the width or height based on the original aspect ratio.

Accessors

aspectRatio

get aspectRatio(): number
The aspect ratio.

Returns number
- Defined in src/utils/Resolution.ts:148

baseHeight

get baseHeight(): number
The unscaled base height in logical pixels.

Returns number
Default Value
```
1
```
- Defined in src/utils/Resolution.ts:240
set baseHeight(value: number): void
Parameters
- value: number
Returns void
- Defined in src/utils/Resolution.ts:246

baseWidth

get baseWidth(): number
The unscaled base width in logical pixels.

Returns number
Default Value
```
1
```
- Defined in src/utils/Resolution.ts:217
set baseWidth(value: number): void
Parameters
- value: number
Returns void
- Defined in src/utils/Resolution.ts:223

height

get height(): number
The effective height, calculated based on the preferred size, pixel ratio and resolution scale.

Returns number
- Defined in src/utils/Resolution.ts:138

pixelRatio

get pixelRatio(): number
The device pixel ratio.

Returns number
Default Value
```
1.0
```
- Defined in src/utils/Resolution.ts:160
set pixelRatio(value: number): void
Parameters
- value: number
Returns void
- Defined in src/utils/Resolution.ts:166

preferredHeight

get preferredHeight(): number
The unscaled preferred height in logical pixels.

Returns number
Default Value
Resolution.AUTO_SIZE
- Defined in src/utils/Resolution.ts:334
set preferredHeight(value: number): void
Parameters
- value: number
Returns void
- Defined in src/utils/Resolution.ts:340

preferredWidth

get preferredWidth(): number
The unscaled preferred width in logical pixels.

Returns number
Default Value
Resolution.AUTO_SIZE
- Defined in src/utils/Resolution.ts:311
set preferredWidth(value: number): void
Parameters
- value: number
Returns void
- Defined in src/utils/Resolution.ts:317

scale

get scale(): number
The resolution scale.

Returns number
Default Value
```
1.0
```
- Defined in src/utils/Resolution.ts:183
set scale(value: number): void
Parameters
- value: number
Returns void
- Defined in src/utils/Resolution.ts:189

scaledPixelRatio

get scaledPixelRatio(): number
The pixelRatio multiplied by the scale.

Returns number
- Defined in src/utils/Resolution.ts:205

width

get width(): number
The effective width, calculated based on the preferred size, pixel ratio and resolution scale.

Returns number
- Defined in src/utils/Resolution.ts:128

x

get x(): number
Returns number
Implementation of Vector2Like.x
- Defined in src/utils/Resolution.ts:457

y

get y(): number
Returns number
Implementation of Vector2Like.y
- Defined in src/utils/Resolution.ts:458

Methods

copy

copy(resolution: Resolution): void
Copies the given resolution.
Parameters
- resolution: Resolution
  The resolution.
Returns void
- Defined in src/utils/Resolution.ts:407

copyBaseSize

copyBaseSize(resolution: Resolution): void
Copies the base size of a given resolution.
Parameters
- resolution: Resolution
  A resolution.
Returns void
- Defined in src/utils/Resolution.ts:294

copyPreferredSize

copyPreferredSize(resolution: Resolution): void
Copies the preferred size of a given resolution.
Parameters
- resolution: Resolution
  A resolution.
Returns void
- Defined in src/utils/Resolution.ts:375

equals

equals(resolution: Resolution): boolean
Checks if this resolution equals the given resolution.
Parameters
- resolution: Resolution
  A resolution.
Returns boolean
True if the resolutions are the same.
- Defined in src/utils/Resolution.ts:428

resetPreferredSize

resetPreferredSize(): void
Resets the preferred size to AUTO_SIZE.

Returns void
- Defined in src/utils/Resolution.ts:390

setBaseSize

setBaseSize(width: number, height: number): void
Sets the base size in logical pixels.
Parameters
- width: number
  The width.
- height: number
  The height.
Returns void
- Defined in src/utils/Resolution.ts:264

setChanged

setChanged(): void
Dispatches a change event.

Returns void
- Defined in src/utils/Resolution.ts:443

setPreferredSize

setPreferredSize(width: number, height: number): void
Sets the preferred size in logical pixels.
Parameters
- width: number
  The width.
- height: number
  The height.
Returns void
- Defined in src/utils/Resolution.ts:358

setSize

setSize(width: number, height: number): void
Alias for setBaseSize.
Parameters
- width: number
  The width.
- height: number
  The height.
Returns void
- Defined in src/utils/Resolution.ts:282