Constructor
new ImageLoader(manageropt)
Constructs a new image loader.
| Name | Type | Attributes | Description |
|---|---|---|---|
manager | LoadingManager | <optional> | The loading manager. |
Extends
Members
crossOrigin :string
The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS.
- string
- Overrides
- Default Value
- 'anonymous'
manager :LoadingManager
The loading manager.
- Overrides
- Default Value
- DefaultLoadingManager
path :string
The base path from which the asset will be loaded.
- string
- Overrides
- Default Value
- ''
requestHeader :object
The request header used in HTTP request.
- object
- Overrides
- Default Value
- {}
withCredentials :boolean
Whether the XMLHttpRequest uses credentials.
- boolean
- Overrides
- Default Value
- false
Methods
load(url, onLoadopt, onProgressopt, onErroropt) → {HTMLImageElement}
Starts loading from the given URL and passes the loaded image to the onLoad() callback. The method also returns a new Image object which can directly be used for texture creation. If you do it this way, the texture may pop up in your scene once the respective loading process is finished.
| Name | Type | Attributes | Description |
|---|---|---|---|
url | string | The path/URL of the file to be loaded. This can also be a data URI. | |
onLoad | function | <optional> | Executed when the loading process has been finished. The argument is an |
onProgress | onProgressCallback | <optional> | Unsupported in this loader. |
onError | onErrorCallback | <optional> | Executed when errors occur. |
- Overrides
The image.
- Type:
- HTMLImageElement
loadAsync(url, onProgressopt) → {Promise}
A async version of Loader#load.
| Name | Type | Attributes | Description |
|---|---|---|---|
url | string | The path/URL of the file to be loaded. | |
onProgress | function | <optional> | Executed while the loading is in progress. |
- Overrides
A Promise that resolves when the asset has been loaded.
- Type:
- Promise
setCrossOrigin(crossOrigin) → {Loader}
Sets the crossOrigin String to implement CORS for loading the URL from a different domain that allows CORS.
| Name | Type | Description |
|---|---|---|
crossOrigin | string | The |
- Overrides
A reference to this instance.
- Type:
- Loader
setPath(path) → {Loader}
Sets the base path for the asset.
| Name | Type | Description |
|---|---|---|
path | string | The base path. |
- Overrides
A reference to this instance.
- Type:
- Loader
setRequestHeader(requestHeader) → {Loader}
Sets the given request header.
| Name | Type | Description |
|---|---|---|
requestHeader | object | A request header for configuring the HTTP request. |
- Overrides
A reference to this instance.
- Type:
- Loader
setWithCredentials(value) → {Loader}
Whether the XMLHttpRequest uses credentials such as cookies, authorization headers or TLS client certificates, see XMLHttpRequest.withCredentials. Note: This setting has no effect if you are loading files locally or from the same domain.
| Name | Type | Description |
|---|---|---|
value | boolean | The |
- Overrides
A reference to this instance.
- Type:
- Loader