Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • ImageSource

Implements

Index

Constructors

  • The path to the image, can also be a data url like 'data:image/'

    Parameters

    • path: string

      Path to the image resource relative from the HTML document hosting the game, or absolute

    • bustCache: boolean = false

      Should excalibur add a cache busting querystring?

    • Optional filtering: ImageFiltering

      Optionally override the image filtering set by EngineOptions.antialiasing

    Returns ImageSource

Properties

data: HTMLImageElement = ...

Access to the underlying html image element

path: string
ready: Promise<HTMLImageElement> = ...

Promise the resolves when the image is loaded and ready for use, does not initiate loading

Accessors

  • get height(): number
  • get image(): HTMLImageElement
  • get width(): number

Methods

  • isLoaded(): boolean
  • load(): Promise<HTMLImageElement>
  • unload(): void