TextureLoader

Manages loading image sources into webgl textures, a unique id is associated with all sources

Index

Constructors

• constructor

Properties

• filtering
• wrapping

Methods

• delete
• dispose
• get
• has
• load
• checkImageSizeSupportedAndLog

Constructors

constructor

• new TextureLoader(gl: WebGL2RenderingContext, _garbageCollector?: { collectionInterval: number; garbageCollector: GarbageCollector }): TextureLoader

• Parameters

  • gl: WebGL2RenderingContext

  • optional_garbageCollector: { collectionInterval: number; garbageCollector: GarbageCollector }

  • collectionInterval: number

  • garbageCollector: GarbageCollector

  Returns TextureLoader

Properties

publicstaticfiltering

filtering: ImageFiltering = ImageFiltering.Blended

Sets the default filtering for the Excalibur texture loader, default ImageFiltering.Blended

publicstaticwrapping

wrapping: ImageWrapConfiguration = ...

Methods

publicdelete

• delete(image: HTMLImageSource): void

• Parameters

  • image: HTMLImageSource

  Returns void

publicdispose

• dispose(): void

• Returns void

publicget

• get(image: HTMLImageSource): WebGLTexture

• Get the WebGL Texture from a source image

  ---

  Parameters

  • image: HTMLImageSource

  Returns WebGLTexture

publichas

• has(image: HTMLImageSource): boolean

• Returns whether a source image has been loaded as a texture

  ---

  Parameters

  • image: HTMLImageSource

  Returns boolean

publicload

• load(image: HTMLImageSource, options?: ImageSourceOptions, forceUpdate?: boolean): WebGLTexture

• Loads a graphic into webgl and returns it's texture info, a webgl context must be previously registered

  ---

  Parameters

  • image: HTMLImageSource

    Source graphic

  • optionaloptions: ImageSourceOptions

    {ImageSourceOptions} Optionally configure the ImageFiltering and ImageWrapping mode to apply to the loaded texture

  • forceUpdate: boolean = false

    Optionally force a texture to be reloaded, useful if the source graphic has changed

  Returns WebGLTexture

publicstaticcheckImageSizeSupportedAndLog

• checkImageSizeSupportedAndLog(image: HTMLImageSource): boolean

• Takes an image and returns if it meets size criteria for hardware

  ---

  Parameters

  • image: HTMLImageSource

  Returns boolean

  if the image will be supported at runtime