Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Resolution

A resolution.

Hierarchy

  • EventDispatcher<Event>
    • Resolution

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Resolution(resizable: Resizable, width?: number, height?: number, scale?: number): Resolution

  • Constructs a new resolution.

    TODO Remove resizable param.

    Parameters

    • resizable: Resizable

      A resizable object.

    • Optional width: number
    • Optional height: number
    • Optional scale: number

    Returns Resolution

Properties

resizable

resizable: Resizable

A resizable object.

deprecated

Use an event listener for "change" events instead.

target

target: Vector2

The preferred resolution.

deprecated

Added for backward-compatibility.

Accessors

Static AUTO_SIZE

  • get AUTO_SIZE(): number

  • An auto sizing constant.

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

    Returns number

baseHeight

  • get baseHeight(): number
  • set baseHeight(arg: number): void

  • The base height.

    Returns number

  • Parameters

    • arg: number

    Returns void

baseWidth

  • get baseWidth(): number
  • set baseWidth(arg: number): void

  • The base width.

    Returns number

  • Parameters

    • arg: number

    Returns void

height

  • get height(): number
  • set height(arg: number): void

  • The effective height.

    If the preferred width and height are set to {@link Resizer.AUTO_SIZE}, the base height will be returned.

    Returns number

  • Parameters

    • arg: number

    Returns void

preferredHeight

  • get preferredHeight(): number
  • set preferredHeight(arg: number): void

  • The preferred height.

    Returns number

  • Parameters

    • arg: number

    Returns void

preferredWidth

  • get preferredWidth(): number
  • set preferredWidth(arg: number): void

  • The preferred width.

    Returns number

  • Parameters

    • arg: number

    Returns void

scale

  • get scale(): number
  • set scale(arg: number): void

  • The resolution scale.

    Returns number

  • Parameters

    • arg: number

    Returns void

width

  • get width(): number
  • set width(arg: number): void

  • The effective width.

    If the preferred width and height are set to {@link Resizer.AUTO_SIZE}, the base width will be returned.

    Returns number

  • Parameters

    • arg: number

    Returns void

Methods

addEventListener

  • addEventListener<T>(type: T, listener: EventListener<Event<string, unknown>[T], T, Resolution>): void
  • addEventListener<T>(type: T, listener: EventListener<{}, T, Resolution>): void

  • Adds a listener to an event type.

    Type Parameters

    • T extends keyof Event<string, unknown>

    Parameters

    • type: T

      The type of event to listen to.

    • listener: EventListener<Event<string, unknown>[T], T, Resolution>

      The function that gets called when the event is fired.

    Returns void

  • Type Parameters

    • T extends string

    Parameters

    Returns void

copy

  • Copies the given resolution.

    Parameters

    Returns void

dispatchEvent

  • dispatchEvent<T>(event: BaseEvent<T> & Event<string, unknown>[T]): void

  • Fire an event type.

    Type Parameters

    • T extends keyof Event<string, unknown>

    Parameters

    • event: BaseEvent<T> & Event<string, unknown>[T]

      The event that gets fired.

    Returns void

getBaseHeight

  • getBaseHeight(): number

  • Returns the base height.

    deprecated

    Use baseHeight instead.

    Returns number

    The base height.

getBaseWidth

  • getBaseWidth(): number

  • Returns the base width.

    deprecated

    Use baseWidth instead.

    Returns number

    The base width.

getHeight

  • getHeight(): number

  • Returns the effective height.

    If the preferred width and height are set to {@link Resizer.AUTO_SIZE}, the base height will be returned.

    deprecated

    Use height instead.

    Returns number

    The effective height.

getPreferredHeight

  • getPreferredHeight(): number

  • Returns the preferred height.

    deprecated

    Use preferredHeight instead.

    Returns number

    The preferred height.

getPreferredWidth

  • getPreferredWidth(): number

  • Returns the preferred width.

    deprecated

    Use preferredWidth instead.

    Returns number

    The preferred width.

getScale

  • getScale(): number

  • Returns the current resolution scale.

    deprecated

    Use scale instead.

    Returns number

    The scale.

getWidth

  • getWidth(): number

  • Returns the effective width.

    If the preferred width and height are set to {@link Resizer.AUTO_SIZE}, the base width will be returned.

    deprecated

    Use width instead.

    Returns number

    The effective width.

hasEventListener

  • hasEventListener<T>(type: T, listener: EventListener<Event<string, unknown>[T], T, Resolution>): boolean
  • hasEventListener<T>(type: T, listener: EventListener<{}, T, Resolution>): boolean

  • Checks if listener is added to an event type.

    Type Parameters

    • T extends keyof Event<string, unknown>

    Parameters

    • type: T

      The type of event to listen to.

    • listener: EventListener<Event<string, unknown>[T], T, Resolution>

      The function that gets called when the event is fired.

    Returns boolean

  • Type Parameters

    • T extends string

    Parameters

    Returns boolean

removeEventListener

  • removeEventListener<T>(type: T, listener: EventListener<Event<string, unknown>[T], T, Resolution>): void
  • removeEventListener<T>(type: T, listener: EventListener<{}, T, Resolution>): void

  • Removes a listener from an event type.

    Type Parameters

    • T extends keyof Event<string, unknown>

    Parameters

    • type: T

      The type of the listener that gets removed.

    • listener: EventListener<Event<string, unknown>[T], T, Resolution>

      The listener function that gets removed.

    Returns void

  • Type Parameters

    • T extends string

    Parameters

    Returns void

setBaseHeight

  • setBaseHeight(value: number): void

  • Sets the base height.

    deprecated

    Use baseHeight instead.

    Parameters

    • value: number

      The height.

    Returns void

setBaseSize

  • setBaseSize(width: number, height: number): void

  • Sets the base size.

    Parameters

    • width: number

      The width.

    • height: number

      The height.

    Returns void

setBaseWidth

  • setBaseWidth(value: number): void

  • Sets the base width.

    deprecated

    Use baseWidth instead.

    Parameters

    • value: number

      The width.

    Returns void

setPreferredHeight

  • setPreferredHeight(value: number): void

  • Sets the preferred height.

    Use {@link Resizer.AUTO_SIZE} to automatically calculate the height based on the width and aspect ratio.

    deprecated

    Use preferredHeight instead.

    Parameters

    • value: number

      The height.

    Returns void

setPreferredSize

  • setPreferredSize(width: number, height: number): void

  • Sets the preferred size.

    Parameters

    • width: number

      The width.

    • height: number

      The height.

    Returns void

setPreferredWidth

  • setPreferredWidth(value: number): void

  • Sets the preferred width.

    Use {@link Resizer.AUTO_SIZE} to automatically calculate the width based on the height and aspect ratio.

    deprecated

    Use preferredWidth instead.

    Parameters

    • value: number

      The width.

    Returns void

setScale

  • setScale(value: number): void

  • Sets the resolution scale.

    Also sets the preferred resolution to {@link Resizer.AUTO_SIZE}.

    deprecated

    Use scale instead.

    Parameters

    • value: number

      The scale.

    Returns void