[name]

A loader for loading an [page:Image]. This 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', // onLoad callback function(image) { // use the image, e.g. draw part of it on a canvas var canvas = document.createElement('canvas'); var context = canvas.getContext('2d'); context.drawImage(image, 100, 100); }, // onProgress callback currently not supported undefined, // onError callback function() { console.error('An error happened.'); } );

Please note Verge3D r84 dropped support for ImageLoader progress events. For an ImageLoader that supports progress events, see [link:https://github.com/mrdoob/three.js/issues/10439#issuecomment-275785639 this thread].

Constructor

[name]([param: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 *"anonymous"*.

[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*.

Methods

[method:HTMLImageElement load]([param:String url], [param:Function onLoad], [param:Function onProgress], [param: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] — This callback function is currently not supported.
[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]([param:String value])

Set the [page:.crossOrigin] attribute.

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

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

[sourceHint]