383 lines
48 KiB
HTML
383 lines
48 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
<html lang="en">
|
||
|
|
<head>
|
||
|
|
<meta charset="utf-8">
|
||
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
|
|
<title>loadKTX - Cesium Documentation</title>
|
||
|
|
|
||
|
|
<!--[if lt IE 9]>
|
||
|
|
<script src="javascript/html5.js"></script>
|
||
|
|
<![endif]-->
|
||
|
|
<link href="styles/jsdoc-default.css" rel="stylesheet">
|
||
|
|
<link href="styles/prism.css" rel="stylesheet">
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
|
||
|
|
<div id="main">
|
||
|
|
|
||
|
|
<h1 class="page-title">
|
||
|
|
<a href="index.html"><img src="Images/CesiumLogo.png" class="cesiumLogo"></a>
|
||
|
|
loadKTX
|
||
|
|
<div class="titleCenterer"></div>
|
||
|
|
</h1>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<section>
|
||
|
|
|
||
|
|
<header>
|
||
|
|
|
||
|
|
</header>
|
||
|
|
|
||
|
|
<article>
|
||
|
|
<div class="container-overview">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="nameContainer">
|
||
|
|
<h4 class="name" id="loadKTX">
|
||
|
|
<a href="#loadKTX" class="doc-link"></a>
|
||
|
|
loadKTX<span class="signature">(resourceOrUrlOrBuffer)</span> → <span class="type-signature returnType">Promise.<<a href="CompressedTextureBuffer.html">CompressedTextureBuffer</a>>|undefined</span>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="source-link rightLinks">
|
||
|
|
<a href="https://github.com/AnalyticalGraphicsInc/cesium/blob/1.58/Source/Core/loadKTX.js#L72">Core/loadKTX.js 72</a>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</h4>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="description">
|
||
|
|
Asynchronously loads and parses the given URL to a KTX file or parses the raw binary data of a KTX file.
Returns a promise that will resolve to an object containing the image buffer, width, height and format once loaded,
or reject if the URL failed to load or failed to parse the data. The data is loaded
using XMLHttpRequest, which means that in order to make requests to another origin,
the server must have Cross-Origin Resource Sharing (CORS) headers enabled.
<p>
The following are part of the KTX format specification but are not supported:
<ul>
<li>Big-endian files</li>
<li>Metadata</li>
<li>3D textures</li>
<li>Texture Arrays</li>
<li>Cubemaps</li>
<li>Mipmaps</li>
</ul>
</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<table class="params">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<th>Name</th>
|
||
|
|
|
||
|
|
|
||
|
|
<th>Type</th>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<th class="last">Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
|
||
|
|
<tbody>
|
||
|
|
|
||
|
|
|
||
|
|
<tr>
|
||
|
|
|
||
|
|
<td class="name"><code>resourceOrUrlOrBuffer</code></td>
|
||
|
|
|
||
|
|
|
||
|
|
<td class="type">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="param-type"><a href="Resource.html">Resource</a></span>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type">String</span>
|
||
|
|
|
|
||
|
|
|
||
|
|
<span class="param-type">ArrayBuffer</span>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</td>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<td class="description last">
|
||
|
|
|
||
|
|
The URL of the binary data or an ArrayBuffer.</td>
|
||
|
|
</tr>
|
||
|
|
|
||
|
|
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Returns:</h5>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="param-desc">
|
||
|
|
A promise that will resolve to the requested data when loaded. Returns undefined if <code>request.throttle</code> is true and the request does not have high enough priority.
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Throws:</h5>
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
|
||
|
|
<div class="param-desc">
|
||
|
|
|
||
|
|
<span class="param-type"><a href="RuntimeError.html">RuntimeError</a></span>
|
||
|
|
|
||
|
|
: Invalid KTX file.
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>
|
||
|
|
|
||
|
|
<div class="param-desc">
|
||
|
|
|
||
|
|
<span class="param-type"><a href="RuntimeError.html">RuntimeError</a></span>
|
||
|
|
|
||
|
|
: File is the wrong endianness.
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>
|
||
|
|
|
||
|
|
<div class="param-desc">
|
||
|
|
|
||
|
|
<span class="param-type"><a href="RuntimeError.html">RuntimeError</a></span>
|
||
|
|
|
||
|
|
: glInternalFormat is not a valid format.
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>
|
||
|
|
|
||
|
|
<div class="param-desc">
|
||
|
|
|
||
|
|
<span class="param-type"><a href="RuntimeError.html">RuntimeError</a></span>
|
||
|
|
|
||
|
|
: glType must be zero when the texture is compressed.
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>
|
||
|
|
|
||
|
|
<div class="param-desc">
|
||
|
|
|
||
|
|
<span class="param-type"><a href="RuntimeError.html">RuntimeError</a></span>
|
||
|
|
|
||
|
|
: The type size for compressed textures must be 1.
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>
|
||
|
|
|
||
|
|
<div class="param-desc">
|
||
|
|
|
||
|
|
<span class="param-type"><a href="RuntimeError.html">RuntimeError</a></span>
|
||
|
|
|
||
|
|
: glFormat must be zero when the texture is compressed.
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>
|
||
|
|
|
||
|
|
<div class="param-desc">
|
||
|
|
|
||
|
|
<span class="param-type"><a href="RuntimeError.html">RuntimeError</a></span>
|
||
|
|
|
||
|
|
: Generating mipmaps for a compressed texture is unsupported.
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>
|
||
|
|
|
||
|
|
<div class="param-desc">
|
||
|
|
|
||
|
|
<span class="param-type"><a href="RuntimeError.html">RuntimeError</a></span>
|
||
|
|
|
||
|
|
: The base internal format must be the same as the format for uncompressed textures.
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>
|
||
|
|
|
||
|
|
<div class="param-desc">
|
||
|
|
|
||
|
|
<span class="param-type"><a href="RuntimeError.html">RuntimeError</a></span>
|
||
|
|
|
||
|
|
: 3D textures are not supported.
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>
|
||
|
|
|
||
|
|
<div class="param-desc">
|
||
|
|
|
||
|
|
<span class="param-type"><a href="RuntimeError.html">RuntimeError</a></span>
|
||
|
|
|
||
|
|
: Texture arrays are not supported.
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li>
|
||
|
|
|
||
|
|
<div class="param-desc">
|
||
|
|
|
||
|
|
<span class="param-type"><a href="RuntimeError.html">RuntimeError</a></span>
|
||
|
|
|
||
|
|
: Cubemaps are not supported.
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<dl class="details">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>Example:</h5>
|
||
|
|
|
||
|
|
<pre><code class="language-javascript">// load a single URL asynchronously
Cesium.loadKTX('some/url').then(function(ktxData) {
var width = ktxData.width;
var height = ktxData.height;
var format = ktxData.internalFormat;
var arrayBufferView = ktxData.bufferView;
// use the data to create a texture
}).otherwise(function(error) {
// an error occurred
});</code></pre>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h5>See:</h5>
|
||
|
|
<ul class="see-list">
|
||
|
|
<li><a href="https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/">KTX file format</a></li>
|
||
|
|
|
||
|
|
<li><a href="http://www.w3.org/TR/cors/">Cross-Origin Resource Sharing</a></li>
|
||
|
|
|
||
|
|
<li><a href="http://wiki.commonjs.org/wiki/Promises/A">CommonJS Promises/A</a></li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</article>
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<footer>
|
||
|
|
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.2</a>
|
||
|
|
</footer>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="nav">
|
||
|
|
<div class="menu">
|
||
|
|
<input type="text" class="classFilter" id="ClassFilter" placeholder="Search">
|
||
|
|
<ul id="ClassList"><li data-name="Animation"><a href="Animation.html">Animation</a></li><li data-name="AnimationViewModel"><a href="AnimationViewModel.html">AnimationViewModel</a></li><li data-name="Appearance"><a href="Appearance.html">Appearance</a></li><li data-name="ArcGisMapServerImageryProvider"><a href="ArcGisMapServerImageryProvider.html">ArcGisMapServerImageryProvider</a></li><li data-name="ArcType"><a href="ArcType.html">ArcType</a></li><li data-name="AssociativeArray"><a href="AssociativeArray.html">AssociativeArray</a></li><li data-name="AxisAlignedBoundingBox"><a href="AxisAlignedBoundingBox.html">AxisAlignedBoundingBox</a></li><li data-name="barycentricCoordinates"><a href="barycentricCoordinates.html">barycentricCoordinates</a></li><li data-name="BaseLayerPicker"><a href="BaseLayerPicker.html">BaseLayerPicker</a></li><li data-name="BaseLayerPickerViewModel"><a href="BaseLayerPickerViewModel.html">BaseLayerPickerViewModel</a></li><li data-name="Billboard"><a href="Billboard.html">Billboard</a></li><li data-name="BillboardCollection"><a href="BillboardCollection.html">BillboardCollection</a></li><li data-name="BillboardGraphics"><a href="BillboardGraphics.html">BillboardGraphics</a></li><li data-name="BillboardVisualizer"><a href="BillboardVisualizer.html">BillboardVisualizer</a></li><li data-name="binarySearch"><a href="binarySearch.html">binarySearch</a></li><li data-name="BingMapsApi"><a href="BingMapsApi.html">BingMapsApi</a></li><li data-name="BingMapsGeocoderService"><a href="BingMapsGeocoderService.html">BingMapsGeocoderService</a></li><li data-name="BingMapsImageryProvider"><a href="BingMapsImageryProvider.html">BingMapsImageryProvider</a></li><li data-name="BingMapsStyle"><a href="BingMapsStyle.html">BingMapsStyle</a></li><li data-name="BlendEquation"><a href="BlendEquation.html">BlendEquation</a></li><li data-name="BlendFunction"><a href="BlendFunction.html">BlendFunction</a></li><li data-name="BlendingState"><a href="BlendingState.html">BlendingState</a></li><li data-name="BlendOption"><a href="BlendOption.html">BlendOption</a></li><li data-name="BoundingRectangle"><a href="BoundingRectangle.html">BoundingRectangle</a></li><li data-name="BoundingSphere"><a href="BoundingSphere.html">BoundingSphere</a></li><li data-name="BoxEmitter"><a href="BoxEmitter.html">BoxEmitter</a></li><li data-name="BoxGeometry"><a href="BoxGeometry.html">BoxGeometry</a></li><li data-name="BoxGeometryUpdater"><a href="BoxGeometryUpdater.html">BoxGeometryUpdater</a></li><li data-name="BoxGraphics"><a href="BoxGraphics.html">BoxGraphics</a></li><li data-name="BoxOutlineGeometry"><a href="BoxOutlineGeometry.html">BoxOutlineGeometry</a></li><li data-name="CallbackProperty"><a href="CallbackProperty.html">CallbackProperty</a></li><li data-name="Camera"><a href="Camera.html">Camera</a></li><li data-name="CameraEventAggregator"><a href="CameraEventAggregator.html">CameraEventAggregator</a></li><li data-name="CameraEventType"><a href="CameraEventType.html">CameraEventType</a></li><li data-name="cancelAnimationFrame"><a href="cancelAnimationFrame.html">cancelAnimationFrame</a></li><li data-name="Cartesian2"><a href="Cartesian2.html">Cartesian2</a></li><li data-name="Cartesian3"><a href="Cartesian3.html">Cartesian3</a></li><li data-name="Cartesian4"><a href="Cartesian4.html">Cartesian4</a></li><li data-name="Cartographic"><a href="Cartographic.html">Cartographic</a></li><li data-name="CartographicGeocoderService"><a href="CartographicGeocoderService.html">CartographicGeocoderService</a></li><li data-name="CatmullRomSpline"><a href="CatmullRomSpline.html">CatmullRomSpline</a></li><li data-name="Cesium3DTile"><a href="Cesium3DTile.html">Cesium3DTile</a></li><li data-name="Cesium3DTileColorBlendMode"><a href="Cesium3DTileColorBlendMode.html">Cesium3DTileColorBlendMode</a></li><li data-name="Cesium3DTileContent"><a href="Cesium3DTileContent.html">Cesium3DTileContent</a></li><li data-name="Cesium3DTileFeature"><a href="Cesium3DTileFeature.html">Cesium3DTileFeature</a></li><li data-name="Cesium3DTilePointFeature"><a href="Cesium3
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<script>
|
||
|
|
if (window.frameElement) {
|
||
|
|
document.body.className = 'embedded';
|
||
|
|
|
||
|
|
var ele = document.createElement('a');
|
||
|
|
ele.className = 'popout';
|
||
|
|
ele.target = '_blank';
|
||
|
|
ele.href = window.location.href;
|
||
|
|
ele.title = 'Pop out';
|
||
|
|
document.getElementById('main').appendChild(ele);
|
||
|
|
}
|
||
|
|
|
||
|
|
// Set targets on external links. Sandcastle and GitHub shouldn't be embedded in any iframe.
|
||
|
|
Array.prototype.forEach.call(document.getElementsByTagName('a'), function(a) {
|
||
|
|
if (/^https?:/i.test(a.getAttribute('href'))) {
|
||
|
|
a.target='_blank';
|
||
|
|
}
|
||
|
|
});
|
||
|
|
</script>
|
||
|
|
|
||
|
|
<script src="javascript/prism.js"></script>
|
||
|
|
<script src="javascript/cesiumDoc.js"></script>
|
||
|
|
|
||
|
|
</body>
|
||
|
|
</html>
|