ImageSource

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

Implements

• Loadable<HTMLImageElement>

Index

Constructors

• constructor

Properties

• data
• filtering
• path
• ready
• wrapping

Accessors

• bustCache
• height
• image
• width

Methods

• isLoaded
• load
• toSprite
• unload
• fromHtmlCanvasElement
• fromHtmlImageElement
• fromSvgString

Constructors

constructor

• new ImageSource(pathOrBase64: string, options?: ImageSourceOptions): ImageSource
• new ImageSource(pathOrBase64: string, bustCache: boolean, filtering?: ImageFiltering): ImageSource

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

  ---

  Parameters

  • pathOrBase64: string

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

  • optionaloptions: ImageSourceOptions

  Returns ImageSource

Properties

publicdata

data: HTMLImageElement = ...

Implementation of Loadable.data

Access to the underlying html image element

publicoptionalfiltering

filtering?: ImageFiltering

publicreadonlypath

path: string

publicready

ready: Promise<HTMLImageElement> = ...

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

publicoptionalwrapping

wrapping?: ImageWrapConfiguration

Accessors

publicbustCache

• get bustCache(): boolean
• set bustCache(val: boolean): void

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

  ---

  Returns boolean

• Parameters

  • val: boolean

  Returns void

publicheight

• get height(): number

• The original height of the source image in pixels

  ---

  Returns number

publicimage

• get image(): HTMLImageElement

• Returns HTMLImageElement

publicwidth

• get width(): number

• The original size of the source image in pixels

  ---

  Returns number

Methods

publicisLoaded

• isLoaded(): boolean

• Implementation of Loadable.isLoaded

  Returns true if the Texture is completely loaded and is ready to be drawn.

  ---

  Returns boolean

load

• load(): Promise<HTMLImageElement>

• Implementation of Loadable.load

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

  ---

  Returns Promise<HTMLImageElement>

publictoSprite

• toSprite(options?: Omit<GraphicOptions & SpriteOptions, image>): Sprite

• Build a sprite from this ImageSource

  ---

  Parameters

  • optionaloptions: Omit<GraphicOptions & SpriteOptions, image>

  Returns Sprite

unload

• unload(): void

• Unload images from memory

  ---

  Returns void

staticfromHtmlCanvasElement

• fromHtmlCanvasElement(image: HTMLCanvasElement, options?: ImageSourceOptions): ImageSource

• Parameters

  • image: HTMLCanvasElement

  • optionaloptions: ImageSourceOptions

  Returns ImageSource

staticfromHtmlImageElement

• fromHtmlImageElement(image: HTMLImageElement, options?: ImageSourceOptions): ImageSource

• Create an ImageSource from and HTML

  <image>

  tag element

  ---

  Parameters

  • image: HTMLImageElement

  • optionaloptions: ImageSourceOptions

  Returns ImageSource

staticfromSvgString

• fromSvgString(svgSource: string, options?: ImageSourceOptions): ImageSource

• Parameters

  • svgSource: string

  • optionaloptions: ImageSourceOptions

  Returns ImageSource