|
|
@@ -0,0 +1,124 @@
|
|
|
+<!DOCTYPE html>
|
|
|
+<html lang="en">
|
|
|
+ <head>
|
|
|
+ <meta charset="utf-8" />
|
|
|
+ <base href="../../" />
|
|
|
+ <script src="list.js"></script>
|
|
|
+ <script src="page.js"></script>
|
|
|
+ <link type="text/css" rel="stylesheet" href="page.css" />
|
|
|
+ </head>
|
|
|
+ <body>
|
|
|
+ [page:Loader] →
|
|
|
+ <h1>[name]</h1>
|
|
|
+
|
|
|
+ <p class="desc">
|
|
|
+ Loader for Basis Universal GPU Texture Codec.<br><br>
|
|
|
+
|
|
|
+ [link:https://github.com/BinomialLLC/basis_universal/ Basis Universal] is a
|
|
|
+ "supercompressed" GPU texture and texture video compression system that
|
|
|
+ outputs a highly compressed intermediate file format (.basis) that can be
|
|
|
+ quickly transcoded to a wide variety of GPU texture compression formats.
|
|
|
+ </p>
|
|
|
+
|
|
|
+ <p>
|
|
|
+ This loader parallelizes the transcoding process across a configurable number
|
|
|
+ of web workers, before transferring the transcoded compressed texture back
|
|
|
+ to the main thread. The required WASM transcoder and JS wrapper are available from the
|
|
|
+ [link:https://github.com/mrdoob/three.js/tree/dev/examples/js/libs/basis examples/js/libs/basis]
|
|
|
+ directory.
|
|
|
+ </p>
|
|
|
+
|
|
|
+ <h2>Example</h2>
|
|
|
+
|
|
|
+ <code>
|
|
|
+ var basisLoader = new THREE.BasisTextureLoader();
|
|
|
+ basisLoader.setTranscoderPath( 'examples/js/libs/basis/' );
|
|
|
+ basisLoader.detectSupport( renderer );
|
|
|
+ basisLoader.load( 'diffuse.basis', function ( texture ) {
|
|
|
+
|
|
|
+ var material = new THREE.MeshStandardMaterial( { map: texture } );
|
|
|
+
|
|
|
+ }, function () {
|
|
|
+
|
|
|
+ console.log( 'onProgress' );
|
|
|
+
|
|
|
+ }, function ( e ) {
|
|
|
+
|
|
|
+ console.error( e );
|
|
|
+
|
|
|
+ } );
|
|
|
+ </code>
|
|
|
+
|
|
|
+ [example:webgl_loader_texture_basis]
|
|
|
+
|
|
|
+ <h2>Browser compatibility</h2>
|
|
|
+
|
|
|
+ <p>
|
|
|
+ BasisTextureLoader transcodes input textures in '.basis' format to an
|
|
|
+ appropriate compressed texture format for the target device, where
|
|
|
+ possible. This allows the same source texture to be served across
|
|
|
+ desktop, Android, and iOS devices, and transcoded into DXT, ETC1, or
|
|
|
+ PVRTC1. Other output formats may be supported in the future.
|
|
|
+ </p>
|
|
|
+ <p>
|
|
|
+ This loader relies on ES6 Promises and Web Assembly, which are not
|
|
|
+ supported in IE11.
|
|
|
+ </p>
|
|
|
+
|
|
|
+ <br>
|
|
|
+ <hr>
|
|
|
+
|
|
|
+ <h2>Constructor</h2>
|
|
|
+
|
|
|
+ <h3>[name]( [param:LoadingManager manager] )</h3>
|
|
|
+ <p>
|
|
|
+ [page:LoadingManager manager] — The [page:LoadingManager] for the loader to use. Default is [page:LoadingManager THREE.DefaultLoadingManager].
|
|
|
+ </p>
|
|
|
+ <p>
|
|
|
+ Creates a new [name].
|
|
|
+ </p>
|
|
|
+
|
|
|
+ <h2>Methods</h2>
|
|
|
+
|
|
|
+ <h3>[method:null load]( [param:String url], [param:Function onLoad], [param:Function onProgress], [param:Function onError] )</h3>
|
|
|
+ <p>
|
|
|
+ [page:String url] — A string containing the path/URL of the <em>.basis</em> file.<br />
|
|
|
+ [page:Function onLoad] — A function to be called after the loading is successfully completed.<br />
|
|
|
+ [page:Function onProgress] — (optional) A function to be called while the loading is in progress. The argument will be the XMLHttpRequest instance, that contains .[page:Integer total] and .[page:Integer loaded] bytes.<br />
|
|
|
+ [page:Function onError] — (optional) A function to be called if an error occurs during loading. The function receives error as an argument.<br />
|
|
|
+ </p>
|
|
|
+ <p>
|
|
|
+ Load from url and call the <em>onLoad</em> function with the transcoded [page:CompressedTexture].
|
|
|
+ </p>
|
|
|
+
|
|
|
+ <h3>[method:this setCrossOrigin]( [param:String crossOrigin] )</h3>
|
|
|
+ <p>
|
|
|
+ [page:String crossOrigin] — Options are '', 'anonymous', or 'use-credentials'. Default is 'anonymous'.
|
|
|
+ </p>
|
|
|
+ <p>
|
|
|
+ Sets options for CORS requests.
|
|
|
+ </p>
|
|
|
+
|
|
|
+ <h3>[method:this setTranscoderPath]( [param:String value] )</h3>
|
|
|
+ <p>
|
|
|
+ [page:String value] — Path to folder containing the WASM transcoder and JS wrapper.
|
|
|
+ </p>
|
|
|
+
|
|
|
+ <h3>[method:this setWorkerLimit]( [param:Number limit] )</h3>
|
|
|
+ <p>
|
|
|
+ [page:Number limit] — Maximum number of workers.
|
|
|
+ </p>
|
|
|
+ <p>
|
|
|
+ Sets the maximum number of web workers to be allocated by this instance. Default is '4'.
|
|
|
+ </p>
|
|
|
+
|
|
|
+ <h3>[method:this dispose]()</h3>
|
|
|
+ <p>
|
|
|
+ Disposes the loader object, de-allocating any Web Workers created.
|
|
|
+ </p>
|
|
|
+
|
|
|
+ <h2>Source</h2>
|
|
|
+
|
|
|
+ [link:https://github.com/mrdoob/three.js/blob/master/examples/js/loaders/BasisTextureLoader.js examples/js/loaders/BasisTextureLoader.js]
|
|
|
+ </body>
|
|
|
+</html>
|
Don McCurdy