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

Loader
- ImageLoader

Index

Constructors

constructor

new ImageLoader(manager?: LoadingManager): ImageLoader
Parameters
- Optional manager: LoadingManager
Returns ImageLoader
Overrides Loader.constructor
- Defined in node_modules/@types/three/src/loaders/ImageLoader.d.ts:9

Properties

crossOrigin

crossOrigin: string

Default

'anonymous'

manager

manager: LoadingManager

path

path: string

Default

requestHeader

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

Default

Type declaration

[header: string]: string

resourcePath

resourcePath: string

Default

withCredentials

withCredentials: boolean

@default: false

Methods

load

load(url: string, onLoad?: ((image: HTMLImageElement) => void), onProgress?: ((event: ProgressEvent<EventTarget>) => void), onError?: ((event: ErrorEvent) => void)): HTMLImageElement
Parameters
- url: string
- Optional onLoad: ((image: HTMLImageElement) => void)
  - - (image: HTMLImageElement): void
    - Parameters
      
      image: HTMLImageElement
      
      Returns void
- Optional onProgress: ((event: ProgressEvent<EventTarget>) => void)
  - - (event: ProgressEvent<EventTarget>): void
    - Parameters
      
      event: ProgressEvent<EventTarget>
      
      Returns void
- Optional onError: ((event: ErrorEvent) => void)
  - - (event: ErrorEvent): void
    - Parameters
      
      event: ErrorEvent
      
      Returns void
Returns HTMLImageElement
- Defined in node_modules/@types/three/src/loaders/ImageLoader.d.ts:11

loadAsync

loadAsync(url: string, onProgress?: ((event: ProgressEvent<EventTarget>) => void)): Promise<HTMLImageElement>
Parameters
- url: string
- Optional onProgress: ((event: ProgressEvent<EventTarget>) => void)
  - - (event: ProgressEvent<EventTarget>): void
    - Parameters
      
      event: ProgressEvent<EventTarget>
      
      Returns void
Returns Promise<HTMLImageElement>
Overrides Loader.loadAsync
- Defined in node_modules/@types/three/src/loaders/ImageLoader.d.ts:18

setCrossOrigin

setCrossOrigin(crossOrigin: string): ImageLoader
Parameters
- crossOrigin: string
Returns ImageLoader
Inherited from Loader.setCrossOrigin
- Defined in node_modules/@types/three/src/loaders/Loader.d.ts:42

setPath

setPath(path: string): ImageLoader
Parameters
- path: string
Returns ImageLoader
Inherited from Loader.setPath
- Defined in node_modules/@types/three/src/loaders/Loader.d.ts:44

setRequestHeader

setRequestHeader(requestHeader: {
[header: string]: string;
}): ImageLoader
Parameters
- requestHeader: {
  [header: string]: string;
  }
  - [header: string]: string
Returns ImageLoader
Inherited from Loader.setRequestHeader
- Defined in node_modules/@types/three/src/loaders/Loader.d.ts:46

setResourcePath

setResourcePath(resourcePath: string): ImageLoader
Parameters
- resourcePath: string
Returns ImageLoader
Inherited from Loader.setResourcePath
- Defined in node_modules/@types/three/src/loaders/Loader.d.ts:45

setWithCredentials

setWithCredentials(value: boolean): ImageLoader
Parameters
- value: boolean
Returns ImageLoader
Inherited from Loader.setWithCredentials
- Defined in node_modules/@types/three/src/loaders/Loader.d.ts:43

Class ImageLoader

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional manager: LoadingManager

Returns ImageLoader

Properties

crossOrigin

Default

manager

path

Default

requestHeader

Default

Type declaration

[header: string]: string

resourcePath

Default

withCredentials

Methods

load

Parameters

url: string

Optional onLoad: ((image: HTMLImageElement) => void)

Parameters

image: HTMLImageElement

Returns void

Optional onProgress: ((event: ProgressEvent<EventTarget>) => void)

Parameters

event: ProgressEvent<EventTarget>

Returns void

Optional onError: ((event: ErrorEvent) => void)

Parameters

event: ErrorEvent

Returns void

Returns HTMLImageElement

loadAsync

Parameters

url: string

Optional onProgress: ((event: ProgressEvent<EventTarget>) => void)

Parameters

event: ProgressEvent<EventTarget>

Returns void

Returns Promise<HTMLImageElement>

setCrossOrigin

Parameters

crossOrigin: string

Returns ImageLoader

setPath

Parameters

path: string

Returns ImageLoader

setRequestHeader

Parameters

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

[header: string]: string

Returns ImageLoader

setResourcePath

Parameters

resourcePath: string

Returns ImageLoader

setWithCredentials

Parameters

value: boolean

Returns ImageLoader

Settings

Member Visibility

Theme

`Optional` manager: LoadingManager

`Optional` onLoad: ((image: HTMLImageElement) => void)

`Optional` onProgress: ((event: ProgressEvent<EventTarget>) => void)

`Optional` onError: ((event: ErrorEvent) => void)

`Optional` onProgress: ((event: ProgressEvent<EventTarget>) => void)

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