60 lines
2.1 KiB
TypeScript
60 lines
2.1 KiB
TypeScript
type TypedArray = Float32Array | Uint32Array | Int32Array | Uint8Array;
|
|
/**
|
|
* Flexible wrapper around `ArrayBuffer` that also provides typed array views on demand.
|
|
* @memberof utils
|
|
*/
|
|
export declare class ViewableBuffer {
|
|
/** The size of the buffer in bytes. */
|
|
size: number;
|
|
/** Underlying `ArrayBuffer` that holds all the data and is of capacity `this.size`. */
|
|
rawBinaryData: ArrayBuffer;
|
|
/** View on the raw binary data as a `Uint32Array`. */
|
|
uint32View: Uint32Array;
|
|
/** View on the raw binary data as a `Float32Array`. */
|
|
float32View: Float32Array;
|
|
uint16View: Uint16Array;
|
|
private _int8View;
|
|
private _uint8View;
|
|
private _int16View;
|
|
private _int32View;
|
|
private _float64Array;
|
|
private _bigUint64Array;
|
|
/**
|
|
* @param length - The size of the buffer in bytes.
|
|
*/
|
|
constructor(length: number);
|
|
/**
|
|
* @param arrayBuffer - The source array buffer.
|
|
*/
|
|
constructor(arrayBuffer: ArrayBuffer);
|
|
/** View on the raw binary data as a `Int8Array`. */
|
|
get int8View(): Int8Array;
|
|
/** View on the raw binary data as a `Uint8Array`. */
|
|
get uint8View(): Uint8Array;
|
|
/** View on the raw binary data as a `Int16Array`. */
|
|
get int16View(): Int16Array;
|
|
/** View on the raw binary data as a `Int32Array`. */
|
|
get int32View(): Int32Array;
|
|
/** View on the raw binary data as a `Float64Array`. */
|
|
get float64View(): Float64Array;
|
|
/** View on the raw binary data as a `BigUint64Array`. */
|
|
get bigUint64View(): BigUint64Array;
|
|
/**
|
|
* Returns the view of the given type.
|
|
* @param type - One of `int8`, `uint8`, `int16`,
|
|
* `uint16`, `int32`, `uint32`, and `float32`.
|
|
* @returns - typed array of given type
|
|
*/
|
|
view(type: string): TypedArray;
|
|
/** Destroys all buffer references. Do not use after calling this. */
|
|
destroy(): void;
|
|
/**
|
|
* Returns the size of the given type in bytes.
|
|
* @param type - One of `int8`, `uint8`, `int16`,
|
|
* `uint16`, `int32`, `uint32`, and `float32`.
|
|
* @returns - size of the type in bytes
|
|
*/
|
|
static sizeOf(type: string): number;
|
|
}
|
|
export {};
|