Class App

constructor

• new App(element, ck, plugins): App

• The Constructor of App

  Parameters

  • element: HTMLCanvasElement

    The <canvas> element.
  • ck: CanvasKit

    The CanvasKit Namespace.
  • plugins: GlobalPlugin[]

    The plugins provided by CarEngine.

  Returns App

cleared

config

element

scene

surface

updates

checkout

• checkout(scene): this

• Checkout a scene.

  Parameters

  • scene: Scene

    The scene that is going to be changed.

  Returns this

  this

clear

• clear(): void

• Returns void

pause

• pause(frame?): this

• Pause the animation of this app.

  Parameters

  • Optional frame: number

    pause at frame

  Returns this

  this

play

• play(frame?): this

• Start to play this animation app

  Parameters

  • Optional frame: number

    Play at frame

  Returns this

  this

setBackgroundColor

• setBackgroundColor(color): this

• Set the background color

  Parameters

  • color: Color | "transparent"

    The Color object

  Returns this

  this

setUpdate

• setUpdate(updateFunc): void

• Set up a update function to call it when the widget is changed.

  Parameters

  • updateFunc: ((elapsed) => void)

    The frame from having gone to current frame.

    • • (elapsed): void

      • Parameters

        • elapsed: number

        Returns void

  Returns void

use

• use(plugin): void

• Add a plugin for this app.

  Parameters

  • plugin: GlobalPlugin

    The CarPlugin

  Returns void

Static update

• update(app, canvas): void

• The rendering and uodate function, which called every frame.

  Parameters

  • app: App

    The App object.
  • canvas: Canvas

    The Canvas object of CanvasKit-WASM

  Returns void