Class TextureLoader

Class for loading a texture. 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
- TextureLoader

Index

Constructors

constructor

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

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?: ((texture: Texture) => void), onProgress?: ((event: ProgressEvent<EventTarget>) => void), onError?: ((event: ErrorEvent) => void)): Texture
Parameters
- url: string
- Optional onLoad: ((texture: Texture) => void)
  - - (texture: Texture): void
    - Parameters
      
      texture: Texture
      
      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 Texture
- Defined in node_modules/@types/three/src/loaders/TextureLoader.d.ts:12

loadAsync

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

setCrossOrigin

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

setPath

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

setRequestHeader

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

setResourcePath

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

setWithCredentials

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

Class TextureLoader

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional manager: LoadingManager

Returns TextureLoader

Properties

crossOrigin

Default

manager

path

Default

requestHeader

Default

Type declaration

[header: string]: string

resourcePath

Default

withCredentials

Methods

load

Parameters

url: string

Optional onLoad: ((texture: Texture) => void)

Parameters

texture: Texture

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 Texture

loadAsync

Parameters

url: string

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

Parameters

event: ProgressEvent<EventTarget>

Returns void

Returns Promise<Texture>

setCrossOrigin

Parameters

crossOrigin: string

Returns TextureLoader

setPath

Parameters

path: string

Returns TextureLoader

setRequestHeader

Parameters

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

[header: string]: string

Returns TextureLoader

setResourcePath

Parameters

resourcePath: string

Returns TextureLoader

setWithCredentials

Parameters

value: boolean

Returns TextureLoader

Settings

Member Visibility

Theme

`Optional` manager: LoadingManager

`Optional` onLoad: ((texture: Texture) => void)

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

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

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

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