Skip to content

⬅️ Back to Table of Contents

📄 NodeFunctionInput.js

📊 Analysis Summary

Metric Count
🧱 Classes 1

📚 Table of Contents

🛠️ File Location:

📂 src/nodes/core/NodeFunctionInput.js

Classes

NodeFunctionInput

Class Code
class NodeFunctionInput {

    /**
     * Constructs a new node function input.
     *
     * @param {string} type - The input type.
     * @param {string} name - The input name.
     * @param {?number} [count=null] - If the input is an Array, count will be the length.
     * @param {('in'|'out'|'inout')} [qualifier=''] - The parameter qualifier (only relevant for GLSL).
     * @param {boolean} [isConst=false] - Whether the input uses a const qualifier or not (only relevant for GLSL).
     */
    constructor( type, name, count = null, qualifier = '', isConst = false ) {

        /**
         *  The input type.
         *
         * @type {string}
         */
        this.type = type;

        /**
         * The input name.
         *
         * @type {string}
         */
        this.name = name;

        /**
         * If the input is an Array, count will be the length.
         *
         * @type {?number}
         * @default null
         */
        this.count = count;

        /**
         *The parameter qualifier (only relevant for GLSL).
         *
         * @type {('in'|'out'|'inout')}
         * @default ''
         */
        this.qualifier = qualifier;

        /**
         * Whether the input uses a const qualifier or not (only relevant for GLSL).
         *
         * @type {boolean}
         * @default false
         */
        this.isConst = isConst;

    }

}