Class ImageBitmapLoader

Base class for implementing loaders.

Hierarchy (view full)

  • Loader<ImageBitmap>
    • ImageBitmapLoader

Constructors

constructor

Properties

crossOrigin isImageBitmapLoader manager options path requestHeader resourcePath withCredentials DEFAULT_MATERIAL_NAME

Methods

load loadAsync setCrossOrigin setOptions setPath setRequestHeader setResourcePath setWithCredentials

Constructors

constructor

Properties

crossOrigin

crossOrigin: string

Default

'anonymous'

Readonly isImageBitmapLoader

isImageBitmapLoader: true

manager

manager: LoadingManager

options

options: undefined | object

Default

{ premultiplyAlpha: 'none' }

path

path: string

Default

''

requestHeader

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

Type declaration

  • [header: string]: string

Default

{}

resourcePath

resourcePath: string

Default

''

withCredentials

withCredentials: boolean

Default

false

Static DEFAULT_MATERIAL_NAME

DEFAULT_MATERIAL_NAME: string

Methods

load

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

  • Parameters

    • url: string
    • Optional onLoad: ((data) => void)
        • (data): void

        • Parameters

          • data: ImageBitmap

          Returns void

    • Optional onProgress: ((event) => void)
        • (event): void

        • Parameters

          • event: ProgressEvent<EventTarget>

          Returns void

    • Optional onError: ((err) => void)
        • (err): void

        • Parameters

          • err: unknown

          Returns void

    Returns void

loadAsync

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

  • Parameters

    • url: string
    • Optional onProgress: ((event) => void)
        • (event): void

        • Parameters

          • event: ProgressEvent<EventTarget>

          Returns void

    Returns Promise<ImageBitmap>

setCrossOrigin

  • setCrossOrigin(crossOrigin): this

  • Parameters

    • crossOrigin: string

    Returns this

setOptions

setPath

  • setPath(path): this

  • Parameters

    • path: string

    Returns this

setRequestHeader

  • setRequestHeader(requestHeader): this

  • Parameters

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

    Returns this

setResourcePath

  • setResourcePath(resourcePath): this

  • Parameters

    • resourcePath: string

    Returns this

setWithCredentials

  • setWithCredentials(value): this

  • Parameters

    • value: boolean

    Returns this

Settings

Member Visibility

On This Page

constructorcrossOriginisImageBitmapLoadermanageroptionspathrequestHeaderresourcePathwithCredentialsDEFAULT_MATERIAL_NAMEloadloadAsyncsetCrossOriginsetOptionssetPathsetRequestHeadersetResourcePathsetWithCredentials