[name]

A loader for loading an [page:Image]. This uses the [page:FileLoader] internally for loading files, and is used internally by the [page:CubeTextureLoader], [page:ObjectLoader] and [page:TextureLoader].

Example

[example:webgl_loader_obj WebGL / loader / obj]
[example:webgl_shaders_ocean WebGL / shaders / ocean]
// instantiate a loader var loader = new v3d.ImageLoader(); // load a image resource loader.load( // resource URL 'textures/skyboxsun25degtest.png', // Function when resource is loaded function(image) { // do something with it // like drawing a part of it on a canvas var canvas = document.createElement('canvas'); var context = canvas.getContext('2d'); context.drawImage(image, 100, 100); }, // Function called when download progresses function(xhr) { console.log((xhr.loaded / xhr.total * 100) + '% loaded'); }, // Function called when download errors function(xhr) { console.log('An error happened'); } );

Constructor

[name]([page:LoadingManager manager])

[page:LoadingManager manager] — The [page:LoadingManager loadingManager] for the loader to use. Default is [page:LoadingManager v3d.DefaultLoadingManager].

Creates a new [name].

Properties

[property:String crossOrigin]

If set, assigns the [link:https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_settings_attributes crossOrigin] attribute of the image to the value of *crossOrigin*, prior to starting the load. Default is *undefined*.

[property:LoadingManager manager]

The [page:LoadingManager loadingManager] the loader is using. Default is [page:DefaultLoadingManager].

[property:String path]

The base path from which files will be loaded. See [page:.setPath]. Default is *undefined*.

[property:String withCredentials]

Whether the XMLHttpRequest uses credentials - see [page:.setWithCredentials]. Default is *undefined*.

Methods

[method:null load]([page:String url], [page:Function onLoad], [page:Function onProgress], [page:Function onError])

[page:String url] — the path or URL to the file. This can also be a [link:https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs Data URI].
[page:Function onLoad] — Will be called when load completes. The argument will be the loaded [page:Image image].
[page:Function onProgress] — Will be called while load progresses. The argument will be the progress event.
[page:Function onError] — Will be called when load errors.
Begin loading from url and return the [page:Image image] object that will contain the data.

[method:null setCrossOrigin]([page:String value])

Set the [page:.crossOrigin] attribute.

[method:FileLoader setPath]([page:String path])

Set the base path or URL from which to load files. This can be useful if you are loading many models from the same directory.

[method:FileLoader setWithCredentials]([page:Boolean value])

Whether the XMLHttpRequest uses credentials such as cookies, authorization headers or TLS client certificates. See [link:https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials XMLHttpRequest.withCredentials].
Note that this has no effect if you are loading files locally or from the same domain.
[sourceHint]