Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Screen

Hierarchy

  • Screen

Index

Constructors

constructor

Properties

CLIENT_HEIGHT

CLIENT_HEIGHT: number = 600

CLIENT_WIDTH

CLIENT_WIDTH: number = 800

FRAMERATE

FRAMERATE: number = 30

MAX_VIRTUAL_PIXELS

MAX_VIRTUAL_PIXELS: number = 30000

Readonly animations

animations: AnimateElement[] = []

Readonly ctx

Readonly fetch

fetch: typeof defaultFetch

Private frameDuration

frameDuration: number = 0

Private intervalId

intervalId: any = null

Private isFirstRender

isFirstRender: boolean = true

Private isReadyLock

isReadyLock: boolean = false

Readonly mouse

mouse: Mouse = new Mouse(this)

Private readyPromise

readyPromise: Promise<void>

Private resolveReady

resolveReady: () => void

Type declaration

    • (): void
    • Returns void

Readonly viewPort

viewPort: ViewPort = new ViewPort()

Private waits

waits: (() => boolean)[] = []

Optional Readonly window

window: Window

Static Readonly defaultFetch

defaultFetch: fetch = defaultFetch

Static Readonly defaultWindow

defaultWindow: Window & globalThis = defaultWindow

Methods

isReady

  • isReady(): boolean

ready

  • ready(): Promise<void>

Private render

  • render(element: Element, ignoreDimensions: boolean, ignoreClear: boolean, scaleWidth: number, scaleHeight: number, offsetX: number, offsetY: number): void
  • Parameters

    • element: Element
    • ignoreDimensions: boolean
    • ignoreClear: boolean
    • scaleWidth: number
    • scaleHeight: number
    • offsetX: number
    • offsetY: number

    Returns void

setDefaults

setViewBox

  • setViewBox(__namedParameters: { aspectRatio: string; clip: boolean; clipX: number; clipY: number; ctx: RenderingContext2D; desiredHeight: number; desiredWidth: number; document: Document; height: number; minX: number; minY: number; refX: number; refY: number; width: number }): void
  • Parameters

    • __namedParameters: { aspectRatio: string; clip: boolean; clipX: number; clipY: number; ctx: RenderingContext2D; desiredHeight: number; desiredWidth: number; document: Document; height: number; minX: number; minY: number; refX: number; refY: number; width: number }
      • aspectRatio: string
      • clip: boolean
      • clipX: number
      • clipY: number
      • ctx: RenderingContext2D
      • desiredHeight: number
      • desiredWidth: number
      • document: Document
      • height: number
      • minX: number
      • minY: number
      • refX: number
      • refY: number
      • width: number

    Returns void

Private shouldUpdate

  • shouldUpdate(ignoreAnimation: boolean, forceRedraw: () => boolean): boolean
  • Parameters

    • ignoreAnimation: boolean
    • forceRedraw: () => boolean
        • (): boolean
        • Returns boolean

    Returns boolean

start

  • start(element: Element, __namedParameters?: { enableRedraw: boolean; forceRedraw: forceRedraw; ignoreAnimation: boolean; ignoreClear: boolean; ignoreDimensions: boolean; ignoreMouse: boolean; offsetX: number; offsetY: number; scaleHeight: number; scaleWidth: number }): void
  • Parameters

    • element: Element
    • Default value __namedParameters: { enableRedraw: boolean; forceRedraw: forceRedraw; ignoreAnimation: boolean; ignoreClear: boolean; ignoreDimensions: boolean; ignoreMouse: boolean; offsetX: number; offsetY: number; scaleHeight: number; scaleWidth: number } = {}
      • enableRedraw: boolean
      • forceRedraw: forceRedraw
      • ignoreAnimation: boolean
      • ignoreClear: boolean
      • ignoreDimensions: boolean
      • ignoreMouse: boolean
      • offsetX: number
      • offsetY: number
      • scaleHeight: number
      • scaleWidth: number

    Returns void

stop

  • stop(): void

wait

  • wait(checker: () => boolean): void
  • Parameters

    • checker: () => boolean
        • (): boolean
        • Returns boolean

    Returns void

Generated using TypeDoc