Class ImageLoader

A loader for loading an image. Unlike other loaders, this one emits events instead of using predefined callbacks. So if you're interested in getting notified when things happen, you need to add listeners to the object.

Hierarchy (view full)

  • Loader<HTMLImageElement>
    • ImageLoader

Constructors

constructor

Properties

DEFAULT_MATERIAL_NAME crossOrigin withCredentials path resourcePath manager requestHeader

Methods

load loadAsync setCrossOrigin setWithCredentials setPath setResourcePath setRequestHeader

Constructors

constructor

Properties

StaticDEFAULT_MATERIAL_NAME

DEFAULT_MATERIAL_NAME: string

crossOrigin

crossOrigin: string

Default

'anonymous'

withCredentials

withCredentials: boolean

Default

false

path

path: string

Default

''

resourcePath

resourcePath: string

Default

''

manager

manager: LoadingManager

requestHeader

requestHeader: {
    [header: string]: string;
}

Default

{}

Methods

load

  • load(url, onLoad?, onProgress?, onError?): HTMLImageElement

  • Parameters

    • url: string
    • OptionalonLoad: ((data: HTMLImageElement) => void)
        • (data): void

        • Parameters

          • data: HTMLImageElement

          Returns void

    • OptionalonProgress: ((event: ProgressEvent<EventTarget>) => void)
        • (event): void

        • Parameters

          • event: ProgressEvent<EventTarget>

          Returns void

    • OptionalonError: ((err: unknown) => void)
        • (err): void

        • Parameters

          • err: unknown

          Returns void

    Returns HTMLImageElement

loadAsync

  • loadAsync(url, onProgress?): Promise<HTMLImageElement>

  • Parameters

    • url: string
    • OptionalonProgress: ((event: ProgressEvent<EventTarget>) => void)
        • (event): void

        • Parameters

          • event: ProgressEvent<EventTarget>

          Returns void

    Returns Promise<HTMLImageElement>

setCrossOrigin

  • setCrossOrigin(crossOrigin): this

  • Parameters

    • crossOrigin: string

    Returns this

setWithCredentials

setPath

  • setPath(path): this

  • Parameters

    • path: string

    Returns this

setResourcePath

  • setResourcePath(resourcePath): this

  • Parameters

    • resourcePath: string

    Returns this

setRequestHeader

  • setRequestHeader(requestHeader): this

  • Parameters

    • requestHeader: {
          [header: string]: string;
      }
      • [header: string]: string

    Returns this

Settings

Member Visibility

On This Page

Constructors
Properties
Methods