Class Viewport

A viewport.

Hierarchy (View Summary)

Resolution
- Viewport
  - Scissor

Implements

Vector4Like

Index

Constructors

Properties

Accessors

aspectRatio baseHeight baseWidth enabled height offsetX offsetY pixelRatio preferredHeight preferredWidth scale scaledPixelRatio w width x y z

Methods

copy copyBaseSize copyPreferredSize equals resetPreferredSize set setBaseSize setChanged setOffset setPreferredSize setSize

Constructors

constructor

new Viewport(): Viewport
Constructs a new viewport.

Returns Viewport
Overrides Resolution.constructor
- Defined in src/utils/Viewport.ts:34

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
Inherited from Resolution.aspectRatio
- Defined in src/utils/Resolution.ts:148

baseHeight

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

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

baseWidth

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

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

enabled

get enabled(): boolean
Indicates whether this viewport is enabled.

Returns boolean
Default Value
```
false
```
- Defined in src/utils/Viewport.ts:62
set enabled(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/utils/Viewport.ts:68

height

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

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

offsetX

get offsetX(): number
The effective offset along the X-axis, calculated based on the scale and pixel ratio.

Returns number
Default Value
```
0
```
- Defined in src/utils/Viewport.ts:85

offsetY

get offsetY(): number
The effective offset along the Y-axis, calculated based on the scale and pixel ratio.

Returns number
Default Value
```
0
```
- Defined in src/utils/Viewport.ts:97

pixelRatio

get pixelRatio(): number
The device pixel ratio.

Returns number
Default Value
```
1.0
```
Inherited from Resolution.pixelRatio
- Defined in src/utils/Resolution.ts:160
set pixelRatio(value: number): void
Parameters
- value: number
Returns void
Inherited from Resolution.pixelRatio
- 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
Inherited from Resolution.preferredHeight
- Defined in src/utils/Resolution.ts:334
set preferredHeight(value: number): void
Parameters
- value: number
Returns void
Inherited from Resolution.preferredHeight
- 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
Inherited from Resolution.preferredWidth
- Defined in src/utils/Resolution.ts:311
set preferredWidth(value: number): void
Parameters
- value: number
Returns void
Inherited from Resolution.preferredWidth
- Defined in src/utils/Resolution.ts:317

scale

get scale(): number
The resolution scale.

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

scaledPixelRatio

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

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

w

get w(): number
Returns number
Implementation of Vector4Like.w
- Defined in src/utils/Viewport.ts:183

width

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

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

x

get x(): number
Returns number
Implementation of Vector4Like.x
Overrides Resolution.x
- Defined in src/utils/Viewport.ts:180

y

get y(): number
Returns number
Implementation of Vector4Like.y
Overrides Resolution.y
- Defined in src/utils/Viewport.ts:181

z

get z(): number
Returns number
Implementation of Vector4Like.z
- Defined in src/utils/Viewport.ts:182

Methods

copy

copy(viewport: Resolution | Viewport): void
Copies the given resolution.
Parameters
- viewport: Resolution | Viewport
Returns void
Overrides Resolution.copy
- Defined in src/utils/Viewport.ts:149

copyBaseSize

copyBaseSize(resolution: Resolution): void
Copies the base size of a given resolution.
Parameters
- resolution: Resolution
  A resolution.
Returns void
Inherited from Resolution.copyBaseSize
- 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
Inherited from Resolution.copyPreferredSize
- Defined in src/utils/Resolution.ts:375

equals

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

resetPreferredSize

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

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

set

set(x: number, y: number, width?: number, height?: number): void
Sets the offset and the preferred size in logical pixels.

If the width and height are omitted, x and y will be used for the size instead.
Parameters
- x: number
  The X-offset.
- y: number
  The Y-offset.
- Optionalwidth: number
  The width.
- Optionalheight: number
  The height.
Returns void
- Defined in src/utils/Viewport.ts:133

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
Inherited from Resolution.setBaseSize
- Defined in src/utils/Resolution.ts:264

setChanged

setChanged(): void
Dispatches a change event.

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

setOffset

setOffset(x: number, y: number): void
Sets the offset in logical pixels.
Parameters
- x: number
  The X-offset.
- y: number
  The Y-offset.
Returns void
- Defined in src/utils/Viewport.ts:110

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
Inherited from Resolution.setPreferredSize
- 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
Inherited from Resolution.setSize
- Defined in src/utils/Resolution.ts:282