245 lines
8.0 KiB
JavaScript
245 lines
8.0 KiB
JavaScript
import defined from "../../Core/defined.js";
|
|
import destroyObject from "../../Core/destroyObject.js";
|
|
import getImageFromTypedArray from "../../Core/getImageFromTypedArray.js";
|
|
import CesiumMath from "../../Core/Math.js";
|
|
import resizeImageToNextPowerOfTwo from "../../Core/resizeImageToNextPowerOfTwo.js";
|
|
import PixelDatatype from "../../Renderer/PixelDatatype.js";
|
|
import Texture from "../../Renderer/Texture.js";
|
|
import TextureMinificationFilter from "../../Renderer/TextureMinificationFilter.js";
|
|
import TextureWrap from "../../Renderer/TextureWrap.js";
|
|
|
|
/**
|
|
* An object to manage loading textures
|
|
*
|
|
* @alias TextureManager
|
|
* @constructor
|
|
*
|
|
* @private
|
|
* @experimental This feature is using part of the 3D Tiles spec that is not final and is subject to change without Cesium's standard deprecation policy.
|
|
*/
|
|
function TextureManager() {
|
|
this._defaultTexture = undefined;
|
|
this._textures = {};
|
|
this._loadedImages = [];
|
|
|
|
// Keep track of the last time update() was called to avoid
|
|
// calling update() twice.
|
|
this._lastUpdatedFrame = -1;
|
|
}
|
|
|
|
/**
|
|
* Get one of the loaded textures
|
|
* @param {string} textureId The unique ID of the texture loaded by {@link TextureManager#loadTexture2D}
|
|
* @return {Texture} The texture or <code>undefined</code> if no texture exists
|
|
*/
|
|
TextureManager.prototype.getTexture = function (textureId) {
|
|
return this._textures[textureId];
|
|
};
|
|
|
|
function fetchTexture2D(textureManager, textureId, textureUniform) {
|
|
textureUniform.resource
|
|
.fetchImage()
|
|
.then(function (image) {
|
|
textureManager._loadedImages.push({
|
|
id: textureId,
|
|
image: image,
|
|
textureUniform: textureUniform,
|
|
});
|
|
})
|
|
.catch(function () {
|
|
const texture = textureManager._textures[textureId];
|
|
if (defined(texture) && texture !== textureManager._defaultTexture) {
|
|
texture.destroy();
|
|
}
|
|
|
|
textureManager._textures[textureId] = textureManager._defaultTexture;
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Load a texture 2D asynchronously. Note that {@link TextureManager#update}
|
|
* must be called in the render loop to finish processing the textures.
|
|
*
|
|
* @param {string} textureId A unique ID to identify this texture.
|
|
* @param {TextureUniform} textureUniform A description of the texture
|
|
*
|
|
* @private
|
|
*/
|
|
TextureManager.prototype.loadTexture2D = function (textureId, textureUniform) {
|
|
if (defined(textureUniform.typedArray)) {
|
|
this._loadedImages.push({
|
|
id: textureId,
|
|
textureUniform: textureUniform,
|
|
});
|
|
} else {
|
|
fetchTexture2D(this, textureId, textureUniform);
|
|
}
|
|
};
|
|
|
|
function createTexture(textureManager, loadedImage, context) {
|
|
const { id, textureUniform, image } = loadedImage;
|
|
|
|
// If the context is WebGL1, and the sampler needs mipmaps or repeating
|
|
// boundary conditions, the image may need to be resized first
|
|
const texture = context.webgl2
|
|
? getTextureAndMips(textureUniform, image, context)
|
|
: getWebGL1Texture(textureUniform, image, context);
|
|
|
|
// Destroy the old texture once the new one is loaded for more seamless
|
|
// transitions between values
|
|
const oldTexture = textureManager._textures[id];
|
|
if (defined(oldTexture) && oldTexture !== context.defaultTexture) {
|
|
oldTexture.destroy();
|
|
}
|
|
textureManager._textures[id] = texture;
|
|
}
|
|
|
|
function getTextureAndMips(textureUniform, image, context) {
|
|
const { typedArray, sampler } = textureUniform;
|
|
|
|
const texture = defined(typedArray)
|
|
? getTextureFromTypedArray(textureUniform, context)
|
|
: new Texture({ context, source: image, sampler });
|
|
|
|
if (samplerRequiresMipmap(sampler)) {
|
|
texture.generateMipmap();
|
|
}
|
|
|
|
return texture;
|
|
}
|
|
|
|
function getWebGL1Texture(textureUniform, image, context) {
|
|
const { typedArray, sampler } = textureUniform;
|
|
|
|
// WebGL1 requires power-of-two texture dimensions for mipmapping and REPEAT wrap modes
|
|
const needMipmap = samplerRequiresMipmap(sampler);
|
|
|
|
const samplerRepeats =
|
|
sampler.wrapS === TextureWrap.REPEAT ||
|
|
sampler.wrapS === TextureWrap.MIRRORED_REPEAT ||
|
|
sampler.wrapT === TextureWrap.REPEAT ||
|
|
sampler.wrapT === TextureWrap.MIRRORED_REPEAT;
|
|
|
|
const { width, height } = defined(typedArray) ? textureUniform : image;
|
|
const isPowerOfTwo = [width, height].every(CesiumMath.isPowerOfTwo);
|
|
const requiresResize = (needMipmap || samplerRepeats) && !isPowerOfTwo;
|
|
|
|
if (!requiresResize) {
|
|
return getTextureAndMips(textureUniform, image, context);
|
|
} else if (!defined(typedArray)) {
|
|
const resizedImage = resizeImageToNextPowerOfTwo(image);
|
|
return getTextureAndMips(textureUniform, resizedImage, context);
|
|
} else if (textureUniform.pixelDatatype === PixelDatatype.UNSIGNED_BYTE) {
|
|
const imageFromArray = getImageFromTypedArray(typedArray, width, height);
|
|
const resizedImage = resizeImageToNextPowerOfTwo(imageFromArray);
|
|
return getTextureAndMips({ sampler }, resizedImage, context);
|
|
}
|
|
|
|
// typedArray is non-power-of-two but can't be resized. Warn and return raw texture (no mipmaps)
|
|
if (needMipmap) {
|
|
console.warn(
|
|
"Texture requires resizing for mipmaps but pixelDataType cannot be resized. The texture may be rendered incorrectly."
|
|
);
|
|
} else if (samplerRepeats) {
|
|
console.warn(
|
|
"Texture requires resizing for wrapping but pixelDataType cannot be resized. The texture may be rendered incorrectly."
|
|
);
|
|
}
|
|
return getTextureFromTypedArray(textureUniform, context);
|
|
}
|
|
|
|
function samplerRequiresMipmap(sampler) {
|
|
return [
|
|
TextureMinificationFilter.NEAREST_MIPMAP_NEAREST,
|
|
TextureMinificationFilter.NEAREST_MIPMAP_LINEAR,
|
|
TextureMinificationFilter.LINEAR_MIPMAP_NEAREST,
|
|
TextureMinificationFilter.LINEAR_MIPMAP_LINEAR,
|
|
].includes(sampler.minificationFilter);
|
|
}
|
|
|
|
function getTextureFromTypedArray(textureUniform, context) {
|
|
const {
|
|
pixelFormat,
|
|
pixelDatatype,
|
|
width,
|
|
height,
|
|
typedArray: arrayBufferView,
|
|
sampler,
|
|
} = textureUniform;
|
|
|
|
return new Texture({
|
|
context,
|
|
pixelFormat,
|
|
pixelDatatype,
|
|
source: { arrayBufferView, width, height },
|
|
sampler,
|
|
flipY: false,
|
|
});
|
|
}
|
|
|
|
TextureManager.prototype.update = function (frameState) {
|
|
// update only needs to be called once a frame.
|
|
if (frameState.frameNumber === this._lastUpdatedFrame) {
|
|
return;
|
|
}
|
|
this._lastUpdatedFrame = frameState.frameNumber;
|
|
|
|
const context = frameState.context;
|
|
this._defaultTexture = context.defaultTexture;
|
|
|
|
// If any images were loaded since the last frame, create Textures
|
|
// for them and store in the uniform dictionary
|
|
const loadedImages = this._loadedImages;
|
|
for (let i = 0; i < loadedImages.length; i++) {
|
|
const loadedImage = loadedImages[i];
|
|
createTexture(this, loadedImage, context);
|
|
}
|
|
loadedImages.length = 0;
|
|
};
|
|
|
|
/**
|
|
* Returns true if this object was destroyed; otherwise, false.
|
|
* <br /><br />
|
|
* If this object was destroyed, it should not be used; calling any function other than
|
|
* <code>isDestroyed</code> will result in a {@link DeveloperError} exception.
|
|
*
|
|
* @returns {boolean} True if this object was destroyed; otherwise, false.
|
|
*
|
|
* @see TextureManager#destroy
|
|
* @private
|
|
*/
|
|
TextureManager.prototype.isDestroyed = function () {
|
|
return false;
|
|
};
|
|
|
|
/**
|
|
* Destroys the WebGL resources held by this object. Destroying an object allows for deterministic
|
|
* release of WebGL resources, instead of relying on the garbage collector to destroy this object.
|
|
* <br /><br />
|
|
* Once an object is destroyed, it should not be used; calling any function other than
|
|
* <code>isDestroyed</code> will result in a {@link DeveloperError} exception. Therefore,
|
|
* assign the return value (<code>undefined</code>) to the object as done in the example.
|
|
*
|
|
* @exception {DeveloperError} This object was destroyed, i.e., destroy() was called.
|
|
*
|
|
* @example
|
|
* textureManager = textureManager && textureManager.destroy();
|
|
*
|
|
* @see TextureManager#isDestroyed
|
|
* @private
|
|
*/
|
|
TextureManager.prototype.destroy = function () {
|
|
const textures = this._textures;
|
|
for (const texture in textures) {
|
|
if (textures.hasOwnProperty(texture)) {
|
|
const instance = textures[texture];
|
|
if (instance !== this._defaultTexture) {
|
|
instance.destroy();
|
|
}
|
|
}
|
|
}
|
|
return destroyObject(this);
|
|
};
|
|
|
|
export default TextureManager;
|