|
|
@@ -0,0 +1,133 @@
|
|
|
+<!DOCTYPE html>
|
|
|
+<html lang="en">
|
|
|
+ <head>
|
|
|
+ <meta charset="utf-8" />
|
|
|
+ <base href="../../../" />
|
|
|
+ <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 KTX 2.0 GPU Texture containers.<br><br>
|
|
|
+
|
|
|
+ [link:http://github.khronos.org/KTX-Specification/ KTX 2.0] is a container format for various GPU texture formats. The loader
|
|
|
+ supports Basis Universal GPU textures, which can be quickly transcoded to
|
|
|
+ a wide variety of GPU texture compression formats. While KTX 2.0 also allows
|
|
|
+ other hardware-specific formats, this loader does not yet parse them.
|
|
|
+ </p>
|
|
|
+
|
|
|
+ <p>
|
|
|
+ This loader parses the KTX 2.0 container and then relies on
|
|
|
+ [page:BasisTextureLoader] to complete the transcoding process.
|
|
|
+ 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>Code Example</h2>
|
|
|
+
|
|
|
+ <code>
|
|
|
+ var ktx2Loader = new THREE.KTX2Loader();
|
|
|
+ ktx2Loader.setTranscoderPath( 'examples/js/libs/basis/' );
|
|
|
+ ktx2Loader.detectSupport( renderer );
|
|
|
+ ktx2Loader.load( 'diffuse.ktx2', function ( texture ) {
|
|
|
+
|
|
|
+ var material = new THREE.MeshStandardMaterial( { map: texture } );
|
|
|
+
|
|
|
+ }, function () {
|
|
|
+
|
|
|
+ console.log( 'onProgress' );
|
|
|
+
|
|
|
+ }, function ( e ) {
|
|
|
+
|
|
|
+ console.error( e );
|
|
|
+
|
|
|
+ } );
|
|
|
+ </code>
|
|
|
+
|
|
|
+ <h2>Examples</h2>
|
|
|
+
|
|
|
+ <p>
|
|
|
+ [example:webgl_loader_texture_ktx2]
|
|
|
+ </p>
|
|
|
+
|
|
|
+ <h2>Browser compatibility</h2>
|
|
|
+
|
|
|
+ <p>
|
|
|
+ See notes for [page:BasisTextureLoader]. 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>Properties</h2>
|
|
|
+ <p>See the base [page:Loader] class for common properties.</p>
|
|
|
+
|
|
|
+ <h2>Methods</h2>
|
|
|
+ <p>See the base [page:Loader] class for common methods.</p>
|
|
|
+
|
|
|
+ <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 detectSupport]( [param:WebGLRenderer renderer] )</h3>
|
|
|
+ <p>
|
|
|
+ [page:WebGLRenderer renderer] — A renderer instance.
|
|
|
+ </p>
|
|
|
+ <p>
|
|
|
+ Detects hardware support for available compressed texture formats, to determine
|
|
|
+ the output format for the transcoder. Must be called before loading a texture.
|
|
|
+ </p>
|
|
|
+
|
|
|
+ <h3>[method:this setTranscoderPath]( [param:String path] )</h3>
|
|
|
+ <p>
|
|
|
+ [page:String path] — Path to folder containing the WASM transcoder and JS wrapper.
|
|
|
+ </p>
|
|
|
+ <p>
|
|
|
+ The 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>
|
|
|
+
|
|
|
+ <h3>[method:this setWorkerLimit]( [param:Number limit] )</h3>
|
|
|
+ <p>
|
|
|
+ [page:Number limit] — Maximum number of workers. Default is '4'.
|
|
|
+ </p>
|
|
|
+ <p>
|
|
|
+ Sets the maximum number of web workers to be allocated by this instance.
|
|
|
+ </p>
|
|
|
+
|
|
|
+ <h3>[method:this dispose]()</h3>
|
|
|
+ <p>
|
|
|
+ Disposes the loader object, de-allocating any Web Workers created.
|
|
|
+ </p>
|
|
|
+
|
|
|
+ <h2>Source</h2>
|
|
|
+
|
|
|
+ <p>
|
|
|
+ [link:https://github.com/mrdoob/three.js/blob/master/examples/jsm/loaders/KTX2Loader.js examples/jsm/loaders/KTX2Loader.js]
|
|
|
+ </p>
|
|
|
+ </body>
|
|
|
+</html>
|
Emmett Lalish