Class ImageSource

An interface describing loadable resources in Excalibur. Built-in loadable resources include Texture, Sound, and a generic Resource.

Hierarchy

  • ImageSource

Implements

Constructors

constructor

Properties

data filtering path ready

Accessors

bustCache height image width

Methods

isLoaded load toSprite unload

Constructors

constructor

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

    Parameters

    • path: string

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

    • bustCache: boolean = false

      {boolean} Should excalibur add a cache busting querystring?

    • Optional filtering: ImageFiltering

      {ImageFiltering} Optionally override the image filtering set by EngineOptions.antialiasing

    Returns ImageSource

Properties

data

data: HTMLImageElement = ...

Access to the underlying html image element

filtering

filtering: ImageFiltering

Readonly path

path: string

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

ready

ready: Promise<HTMLImageElement> = ...

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

Accessors

bustCache

  • get bustCache(): boolean

  • Should excalibur add a cache busting querystring? By default false. Must be set before loading

    Returns boolean

  • set bustCache(val: boolean): void

  • Parameters

    • val: boolean

    Returns void

height

image

width

Methods

isLoaded

load

  • Begins loading the image and returns a promise that resolves when the image is loaded

    Returns Promise<HTMLImageElement>

toSprite

unload

Settings

Member Visibility

Theme