@types/three/src/renderers/common/Buffer.d.ts

TypeScript definitions for three

import { TypedArray } from "../../core/BufferAttribute.js";
import Binding from "./Binding.js";

/**
 * Represents a buffer binding type.
 *
 * @private
 * @abstract
 * @augments Binding
 */
declare class Buffer extends Binding {
    /**
     * Constructs a new buffer.
     *
     * @param {string} name - The buffer's name.
     * @param {TypedArray} [buffer=null] - The buffer.
     */
    constructor(name: string, buffer?: TypedArray);
    /**
     * This flag can be used for type testing.
     *
     * @type {boolean}
     * @readonly
     * @default true
     */
    readonly isBuffer: boolean;
    /**
     * The bytes per element.
     *
     * @type {number}
     */
    bytesPerElement: number;
    /**
     * A reference to the internal buffer.
     *
     * @private
     * @type {TypedArray}
     */
    private _buffer;
    /**
     * An array of update ranges.
     *
     * @private
     * @type {Array<{start: number, count: number}>}
     */
    private _updateRanges;
    /**
     * The array of update ranges.
     *
     * @type {Array<{start: number, count: number}>}
     */
    get updateRanges(): Array<{
        start: number;
        count: number;
    }>;
    /**
     * Adds an update range.
     *
     * @param {number} start - The start index.
     * @param {number} count - The number of elements.
     */
    addUpdateRange(start: number, count: number): void;
    /**
     * Clears all update ranges.
     */
    clearUpdateRanges(): void;
    /**
     * The buffer's byte length.
     *
     * @type {number}
     * @readonly
     */
    get byteLength(): number;
    /**
     * A reference to the internal buffer.
     *
     * @type {Float32Array}
     * @readonly
     */
    get buffer(): TypedArray;
    /**
     * Updates the binding.
     *
     * @return {boolean} Whether the buffer has been updated and must be
     * uploaded to the GPU.
     */
    update(): boolean;
}

export default Buffer;