⬅️ Back to Table of Contents

📄 Attributes.js

📊 Analysis Summary

Metric	Count
🔧 Functions	3
🧱 Classes	1
📦 Imports	3

📚 Table of Contents

• Imports
• Functions
• Classes

🛠️ File Location:

📂 src/renderers/common/Attributes.js

📦 Imports

Name	Source
DataMap	./DataMap.js
AttributeType	./Constants.js
DynamicDrawUsage	../../constants.js

---

Functions

Attributes.delete(attribute: BufferAttribute): any

JSDoc:

/**
     * Deletes the data for the given attribute.
     *
     * @param {BufferAttribute} attribute - The attribute.
     * @return {Object|null} The deleted attribute data.
     */

Parameters:

• attribute BufferAttribute

Returns: any

Calls:

• super.delete
• this.backend.destroyAttribute

Code

delete( attribute ) {

        const attributeData = super.delete( attribute );

        if ( attributeData !== null ) {

            this.backend.destroyAttribute( attribute );

        }

        return attributeData;

    }

Attributes.update(attribute: BufferAttribute, type: number): void

JSDoc:

/**
     * Updates the given attribute. This method creates attribute buffers
     * for new attributes and updates data for existing ones.
     *
     * @param {BufferAttribute} attribute - The attribute to update.
     * @param {number} type - The attribute type.
     */

Parameters:

• attribute BufferAttribute
• type number

Returns: void

Calls:

• this.get
• this.backend.createAttribute
• this.backend.createIndexAttribute
• this.backend.createStorageAttribute
• this.backend.createIndirectStorageAttribute
• this._getBufferAttribute
• this.backend.updateAttribute

Code

update( attribute, type ) {

        const data = this.get( attribute );

        if ( data.version === undefined ) {

            if ( type === AttributeType.VERTEX ) {

                this.backend.createAttribute( attribute );

            } else if ( type === AttributeType.INDEX ) {

                this.backend.createIndexAttribute( attribute );

            } else if ( type === AttributeType.STORAGE ) {

                this.backend.createStorageAttribute( attribute );

            } else if ( type === AttributeType.INDIRECT ) {

                this.backend.createIndirectStorageAttribute( attribute );

            }

            data.version = this._getBufferAttribute( attribute ).version;

        } else {

            const bufferAttribute = this._getBufferAttribute( attribute );

            if ( data.version < bufferAttribute.version || bufferAttribute.usage === DynamicDrawUsage ) {

                this.backend.updateAttribute( attribute );

                data.version = bufferAttribute.version;

            }

        }

    }

Attributes._getBufferAttribute(attribute: BufferAttribute): any

JSDoc:

/**
     * Utility method for handling interleaved buffer attributes correctly.
     * To process them, their `InterleavedBuffer` is returned.
     *
     * @param {BufferAttribute} attribute - The attribute.
     * @return {BufferAttribute|InterleavedBuffer}
     */

Parameters:

• attribute BufferAttribute

Returns: any

Code

_getBufferAttribute( attribute ) {

        if ( attribute.isInterleavedBufferAttribute ) attribute = attribute.data;

        return attribute;

    }

---

Classes

Attributes

Class Code

class Attributes extends DataMap {

    /**
     * Constructs a new attribute management component.
     *
     * @param {Backend} backend - The renderer's backend.
     */
    constructor( backend ) {

        super();

        /**
         * The renderer's backend.
         *
         * @type {Backend}
         */
        this.backend = backend;

    }

    /**
     * Deletes the data for the given attribute.
     *
     * @param {BufferAttribute} attribute - The attribute.
     * @return {Object|null} The deleted attribute data.
     */
    delete( attribute ) {

        const attributeData = super.delete( attribute );

        if ( attributeData !== null ) {

            this.backend.destroyAttribute( attribute );

        }

        return attributeData;

    }

    /**
     * Updates the given attribute. This method creates attribute buffers
     * for new attributes and updates data for existing ones.
     *
     * @param {BufferAttribute} attribute - The attribute to update.
     * @param {number} type - The attribute type.
     */
    update( attribute, type ) {

        const data = this.get( attribute );

        if ( data.version === undefined ) {

            if ( type === AttributeType.VERTEX ) {

                this.backend.createAttribute( attribute );

            } else if ( type === AttributeType.INDEX ) {

                this.backend.createIndexAttribute( attribute );

            } else if ( type === AttributeType.STORAGE ) {

                this.backend.createStorageAttribute( attribute );

            } else if ( type === AttributeType.INDIRECT ) {

                this.backend.createIndirectStorageAttribute( attribute );

            }

            data.version = this._getBufferAttribute( attribute ).version;

        } else {

            const bufferAttribute = this._getBufferAttribute( attribute );

            if ( data.version < bufferAttribute.version || bufferAttribute.usage === DynamicDrawUsage ) {

                this.backend.updateAttribute( attribute );

                data.version = bufferAttribute.version;

            }

        }

    }

    /**
     * Utility method for handling interleaved buffer attributes correctly.
     * To process them, their `InterleavedBuffer` is returned.
     *
     * @param {BufferAttribute} attribute - The attribute.
     * @return {BufferAttribute|InterleavedBuffer}
     */
    _getBufferAttribute( attribute ) {

        if ( attribute.isInterleavedBufferAttribute ) attribute = attribute.data;

        return attribute;

    }

}

Methods

delete(attribute: BufferAttribute): any

Code

delete( attribute ) {

        const attributeData = super.delete( attribute );

        if ( attributeData !== null ) {

            this.backend.destroyAttribute( attribute );

        }

        return attributeData;

    }

update(attribute: BufferAttribute, type: number): void

Code

update( attribute, type ) {

        const data = this.get( attribute );

        if ( data.version === undefined ) {

            if ( type === AttributeType.VERTEX ) {

                this.backend.createAttribute( attribute );

            } else if ( type === AttributeType.INDEX ) {

                this.backend.createIndexAttribute( attribute );

            } else if ( type === AttributeType.STORAGE ) {

                this.backend.createStorageAttribute( attribute );

            } else if ( type === AttributeType.INDIRECT ) {

                this.backend.createIndirectStorageAttribute( attribute );

            }

            data.version = this._getBufferAttribute( attribute ).version;

        } else {

            const bufferAttribute = this._getBufferAttribute( attribute );

            if ( data.version < bufferAttribute.version || bufferAttribute.usage === DynamicDrawUsage ) {

                this.backend.updateAttribute( attribute );

                data.version = bufferAttribute.version;

            }

        }

    }

_getBufferAttribute(attribute: BufferAttribute): any

Code

_getBufferAttribute( attribute ) {

        if ( attribute.isInterleavedBufferAttribute ) attribute = attribute.data;

        return attribute;

    }

---