Class ImageLoader

Loader for image assets.

Hierarchy (View Summary)

AbstractLoader<ImageBitmap | HTMLImageElement>
- ImageLoader

Index

Constructors

Properties

Methods

addEventListener dispatchEvent load removeEventListener setBasePath

Constructors

constructor

new ImageLoader(options?: ImageLoaderOptions): ImageLoader
Creates a new ImageLoader.
Parameters
- options: ImageLoaderOptions = {}
  Optional configuration options.
Returns ImageLoader
Overrides AbstractLoader.constructor
- Defined in loaders/ImageLoader.ts:19

Properties

basePath

basePath: string = ""

The base path for resource URLs.

flipY

flipY: boolean = false

Whether the image should be flipped vertically during loading.

Methods

addEventListener

addEventListener(type: string, listener: EventHandler): void
Registers an event listener.
Parameters
- type: string
  The event type.
- listener: EventHandler
  The callback function.
Returns void
Inherited from AbstractLoader.addEventListener
- Defined in loaders/AbstractLoader.ts:35

dispatchEvent

dispatchEvent(type: string, eventData?: Record<string, unknown>): void
Dispatches an event.
Parameters
- type: string
  The event type.
- eventData: Record<string, unknown> = {}
  Optional data associated with the event.
Returns void
Inherited from AbstractLoader.dispatchEvent
- Defined in loaders/AbstractLoader.ts:45

load

load(url: string): Promise<ImageBitmap | HTMLImageElement>
Loads a resource from the given URL.
Parameters
- url: string
  The relative URL to the resource.
Returns Promise<ImageBitmap | HTMLImageElement>
A promise resolving to the loaded resource.
Overrides AbstractLoader.load
- Defined in loaders/ImageLoader.ts:25

removeEventListener

removeEventListener(type: string, listener: EventHandler): void
Removes a registered event listener.
Parameters
- type: string
  The event type.
- listener: EventHandler
  The callback function to remove.
Returns void
Inherited from AbstractLoader.removeEventListener
- Defined in loaders/AbstractLoader.ts:40

setBasePath

setBasePath(path: string): this
Sets the base path for the loader.
Parameters
- path: string
  The base path string.
Returns this
this
Inherited from AbstractLoader.setBasePath
- Defined in loaders/AbstractLoader.ts:29