⬅️ Back to Table of Contents

📄 Storage3DTexture.js

📊 Analysis Summary

Metric	Count
🔧 Functions	1
🧱 Classes	1
📦 Imports	3

📚 Table of Contents

• Imports
• Functions
• Classes

🛠️ File Location:

📂 src/renderers/common/Storage3DTexture.js

📦 Imports

Name	Source
Texture	../../textures/Texture.js
LinearFilter	../../constants.js
ClampToEdgeWrapping	../../constants.js

---

Functions

Storage3DTexture.setSize(width: number, height: number, depth: number): void

JSDoc:

/**
     * Sets the size of the storage 3d texture.
     *
     * @param {number} width - The new width of the storage texture.
     * @param {number} height - The new height of the storage texture.
     * @param {number} depth - The new depth of the storage texture.
     */

Parameters:

• width number
• height number
• depth number

Returns: void

Calls:

• this.dispose

Code

setSize( width, height, depth ) {

        if ( this.image.width !== width || this.image.height !== height || this.image.depth !== depth ) {

            this.image.width = width;
            this.image.height = height;
            this.image.depth = depth;

            this.dispose();

        }

    }

---

Classes

Storage3DTexture

Class Code

class Storage3DTexture extends Texture {

    /**
     * Constructs a new storage texture.
     *
     * @param {number} [width=1] - The storage texture's width.
     * @param {number} [height=1] - The storage texture's height.
     * @param {number} [depth=1] - The storage texture's depth.
     */
    constructor( width = 1, height = 1, depth = 1 ) {

        super();

        //inherited from texture. Must be false for 3DTexture
        this.isArrayTexture = false;

        /**
         * The image object which just represents the texture's dimension.
         *
         * @type {{width: number, height: number, depth: number}}
         */
        this.image = { width, height, depth };

        /**
         * The default `magFilter` for storage textures is `THREE.LinearFilter`.
         *
         * @type {number}
         */
        this.magFilter = LinearFilter;

        /**
         * The default `minFilter` for storage textures is `THREE.LinearFilter`.
         *
         * @type {number}
         */
        this.minFilter = LinearFilter;

        /**
         * This defines how the texture is wrapped in the depth direction and corresponds to
         * *W* in UVW mapping.
         *
         * @type {number}
         */
        this.wrapR = ClampToEdgeWrapping;

        /**
         * This flag can be used for type testing.
         *
         * @type {boolean}
         * @readonly
         * @default true
         */
        this.isStorageTexture = true;

        /**
         * Indicates whether this texture is a 3D texture.
         *
         * @type {boolean}
         *
         */
        this.is3DTexture = true;

    }

    /**
     * Sets the size of the storage 3d texture.
     *
     * @param {number} width - The new width of the storage texture.
     * @param {number} height - The new height of the storage texture.
     * @param {number} depth - The new depth of the storage texture.
     */
    setSize( width, height, depth ) {

        if ( this.image.width !== width || this.image.height !== height || this.image.depth !== depth ) {

            this.image.width = width;
            this.image.height = height;
            this.image.depth = depth;

            this.dispose();

        }

    }

}

Methods

setSize(width: number, height: number, depth: number): void

Code

setSize( width, height, depth ) {

        if ( this.image.width !== width || this.image.height !== height || this.image.depth !== depth ) {

            this.image.width = width;
            this.image.height = height;
            this.image.depth = depth;

            this.dispose();

        }

    }

---