All checks were successful
Publish To Prod / deploy_and_publish (push) Successful in 35s
125 lines
4.2 KiB
JavaScript
125 lines
4.2 KiB
JavaScript
/**
|
|
* @module ol/webgl/Buffer
|
|
*/
|
|
import { ARRAY_BUFFER, DYNAMIC_DRAW, ELEMENT_ARRAY_BUFFER, STATIC_DRAW, STREAM_DRAW, } from '../webgl.js';
|
|
import { assert } from '../asserts.js';
|
|
/**
|
|
* Used to describe the intended usage for the data: `STATIC_DRAW`, `STREAM_DRAW`
|
|
* or `DYNAMIC_DRAW`.
|
|
* @enum {number}
|
|
*/
|
|
export var BufferUsage = {
|
|
STATIC_DRAW: STATIC_DRAW,
|
|
STREAM_DRAW: STREAM_DRAW,
|
|
DYNAMIC_DRAW: DYNAMIC_DRAW,
|
|
};
|
|
/**
|
|
* @classdesc
|
|
* Object used to store an array of data as well as usage information for that data.
|
|
* Stores typed arrays internally, either Float32Array or Uint16/32Array depending on
|
|
* the buffer type (ARRAY_BUFFER or ELEMENT_ARRAY_BUFFER) and available extensions.
|
|
*
|
|
* To populate the array, you can either use:
|
|
* * A size using `#ofSize(buffer)`
|
|
* * An `ArrayBuffer` object using `#fromArrayBuffer(buffer)`
|
|
* * A plain array using `#fromArray(array)`
|
|
*
|
|
* Note:
|
|
* See the documentation of [WebGLRenderingContext.bufferData](https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/bufferData)
|
|
* for more info on buffer usage.
|
|
* @api
|
|
*/
|
|
var WebGLArrayBuffer = /** @class */ (function () {
|
|
/**
|
|
* @param {number} type Buffer type, either ARRAY_BUFFER or ELEMENT_ARRAY_BUFFER.
|
|
* @param {number} [opt_usage] Intended usage, either `STATIC_DRAW`, `STREAM_DRAW` or `DYNAMIC_DRAW`.
|
|
* Default is `DYNAMIC_DRAW`.
|
|
*/
|
|
function WebGLArrayBuffer(type, opt_usage) {
|
|
/**
|
|
* @private
|
|
* @type {Float32Array|Uint32Array}
|
|
*/
|
|
this.array = null;
|
|
/**
|
|
* @private
|
|
* @type {number}
|
|
*/
|
|
this.type = type;
|
|
assert(type === ARRAY_BUFFER || type === ELEMENT_ARRAY_BUFFER, 62);
|
|
/**
|
|
* @private
|
|
* @type {number}
|
|
*/
|
|
this.usage = opt_usage !== undefined ? opt_usage : BufferUsage.STATIC_DRAW;
|
|
}
|
|
/**
|
|
* Populates the buffer with an array of the given size (all values will be zeroes).
|
|
* @param {number} size Array size
|
|
*/
|
|
WebGLArrayBuffer.prototype.ofSize = function (size) {
|
|
this.array = new (getArrayClassForType(this.type))(size);
|
|
};
|
|
/**
|
|
* Populates the buffer with an array of the given size (all values will be zeroes).
|
|
* @param {Array<number>} array Numerical array
|
|
*/
|
|
WebGLArrayBuffer.prototype.fromArray = function (array) {
|
|
var arrayClass = getArrayClassForType(this.type);
|
|
this.array = arrayClass.from
|
|
? arrayClass.from(array)
|
|
: new arrayClass(array);
|
|
};
|
|
/**
|
|
* Populates the buffer with a raw binary array buffer.
|
|
* @param {ArrayBuffer} buffer Raw binary buffer to populate the array with. Note that this buffer must have been
|
|
* initialized for the same typed array class.
|
|
*/
|
|
WebGLArrayBuffer.prototype.fromArrayBuffer = function (buffer) {
|
|
this.array = new (getArrayClassForType(this.type))(buffer);
|
|
};
|
|
/**
|
|
* @return {number} Buffer type.
|
|
*/
|
|
WebGLArrayBuffer.prototype.getType = function () {
|
|
return this.type;
|
|
};
|
|
/**
|
|
* Will return null if the buffer was not initialized
|
|
* @return {Float32Array|Uint32Array} Array.
|
|
*/
|
|
WebGLArrayBuffer.prototype.getArray = function () {
|
|
return this.array;
|
|
};
|
|
/**
|
|
* @return {number} Usage.
|
|
*/
|
|
WebGLArrayBuffer.prototype.getUsage = function () {
|
|
return this.usage;
|
|
};
|
|
/**
|
|
* Will return 0 if the buffer is not initialized
|
|
* @return {number} Array size
|
|
*/
|
|
WebGLArrayBuffer.prototype.getSize = function () {
|
|
return this.array ? this.array.length : 0;
|
|
};
|
|
return WebGLArrayBuffer;
|
|
}());
|
|
/**
|
|
* Returns a typed array constructor based on the given buffer type
|
|
* @param {number} type Buffer type, either ARRAY_BUFFER or ELEMENT_ARRAY_BUFFER.
|
|
* @return {Float32ArrayConstructor|Uint32ArrayConstructor} The typed array class to use for this buffer.
|
|
*/
|
|
export function getArrayClassForType(type) {
|
|
switch (type) {
|
|
case ARRAY_BUFFER:
|
|
return Float32Array;
|
|
case ELEMENT_ARRAY_BUFFER:
|
|
return Uint32Array;
|
|
default:
|
|
return Float32Array;
|
|
}
|
|
}
|
|
export default WebGLArrayBuffer;
|
|
//# sourceMappingURL=Buffer.js.map
|