Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AbstractRenderer

Hierarchy

  • EventEmitter

Index

Interfaces

Type aliases

Constructors

Properties

Methods

Type aliases

Static ArgumentMap

ArgumentMap<T>: {}

Type parameters

  • T: object

Type declaration

Static EventArgs

EventArgs<T, K>: Parameters<EventListener<T, K>>

Type parameters

Static EventListener

EventListener<T, K>: T extends string | symbol ? (...args: any[]) => void : (...args: ArgumentMap<Exclude<T, string | symbol>>[Extract<K, keyof T>]) => void

Type parameters

Static EventNames

EventNames<T>: T extends string | symbol ? T : keyof T

Type parameters

Static ValidEventTypes

ValidEventTypes: string | symbol | object

object should be in either of the following forms:

interface EventTypes {
  'event-with-parameters': any[]
  'event-with-example-handler': (...args: any[]) => void
}

Constructors

constructor

Properties

Private _canvas

_canvas: HTMLCanvasElement = null

Static EventEmitter

EventEmitter: EventEmitterStatic

Static prefixed

prefixed: string | boolean

Methods

addListener

  • addListener<T>(event: T, fn: EventEmitter.EventListener<string | symbol, T>, context?: any): this

  • Type parameters

    • T: EventEmitter.EventNames<string | symbol>

    Parameters

    • event: T
    • fn: EventEmitter.EventListener<string | symbol, T>
    • Optional context: any

    Returns this

destroy

  • destroy(): void

emit

  • emit<T>(event: T, ...args: EventEmitter.EventArgs<string | symbol, T>): boolean

  • Calls each of the listeners registered for a given event.

    Type parameters

    • T: EventEmitter.EventNames<string | symbol>

    Parameters

    • event: T
    • Rest ...args: EventEmitter.EventArgs<string | symbol, T>

    Returns boolean

eventNames

  • eventNames(): Array<EventEmitter.EventNames<string | symbol>>

  • Return an array listing the events for which the emitter has registered listeners.

    Returns Array<EventEmitter.EventNames<string | symbol>>

getCanvas

  • getCanvas(): HTMLCanvasElement

getHeight

  • getHeight(): number

getWidth

  • getWidth(): number

listenerCount

  • listenerCount(event: EventEmitter.EventNames<string | symbol>): number

  • Return the number of listeners listening to a given event.

    Parameters

    • event: EventEmitter.EventNames<string | symbol>

    Returns number

listeners

  • listeners<T>(event: T): Array<EventEmitter.EventListener<string | symbol, T>>

  • Return the listeners registered for a given event.

    Type parameters

    • T: EventEmitter.EventNames<string | symbol>

    Parameters

    • event: T

    Returns Array<EventEmitter.EventListener<string | symbol, T>>

off

  • off<T>(event: T, fn?: EventEmitter.EventListener<string | symbol, T>, context?: any, once?: boolean): this

  • Type parameters

    • T: EventEmitter.EventNames<string | symbol>

    Parameters

    • event: T
    • Optional fn: EventEmitter.EventListener<string | symbol, T>
    • Optional context: any
    • Optional once: boolean

    Returns this

on

  • on<T>(event: T, fn: EventEmitter.EventListener<string | symbol, T>, context?: any): this

  • Add a listener for a given event.

    Type parameters

    • T: EventEmitter.EventNames<string | symbol>

    Parameters

    • event: T
    • fn: EventEmitter.EventListener<string | symbol, T>
    • Optional context: any

    Returns this

once

  • once<T>(event: T, fn: EventEmitter.EventListener<string | symbol, T>, context?: any): this

  • Add a one-time listener for a given event.

    Type parameters

    • T: EventEmitter.EventNames<string | symbol>

    Parameters

    • event: T
    • fn: EventEmitter.EventListener<string | symbol, T>
    • Optional context: any

    Returns this

removeAllListeners

  • removeAllListeners(event?: EventEmitter.EventNames<string | symbol>): this

  • Remove all listeners, or those of the specified event.

    Parameters

    • Optional event: EventEmitter.EventNames<string | symbol>

    Returns this

removeListener

  • removeListener<T>(event: T, fn?: EventEmitter.EventListener<string | symbol, T>, context?: any, once?: boolean): this

  • Remove the listeners of a given event.

    Type parameters

    • T: EventEmitter.EventNames<string | symbol>

    Parameters

    • event: T
    • Optional fn: EventEmitter.EventListener<string | symbol, T>
    • Optional context: any
    • Optional once: boolean

    Returns this

Abstract render

  • render(frame: Frame): void

resize

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

  • Resize the rendering surface

    Parameters

    • width: number

      The destination width after resize

    • height: number

      The destination height after resize

    Returns void

Generated using TypeDoc