⬅️ Back to Table of Contents

📄 ColorSpaceNode.js

📊 Analysis Summary

Metric	Count
🔧 Functions	5
🧱 Classes	1
📦 Imports	10
📊 Variables & Constants	3

📚 Table of Contents

• Imports
• Variables & Constants
• Functions
• Classes

🛠️ File Location:

📂 src/nodes/display/ColorSpaceNode.js

📦 Imports

Name	Source
TempNode	../core/TempNode.js
addMethodChaining	../tsl/TSLCore.js
mat3	../tsl/TSLCore.js
nodeObject	../tsl/TSLCore.js
vec4	../tsl/TSLCore.js
SRGBTransfer	../../constants.js
ColorManagement	../../math/ColorManagement.js
sRGBTransferEOTF	./ColorSpaceFunctions.js
sRGBTransferOETF	./ColorSpaceFunctions.js
Matrix3	../../math/Matrix3.js

---

Variables & Constants

Name	Type	Kind	Value	Exported
WORKING_COLOR_SPACE	"WorkingColorSpace"	let/var	'WorkingColorSpace'	✗
OUTPUT_COLOR_SPACE	"OutputColorSpace"	let/var	'OutputColorSpace'	✗
outputNode	Node	let/var	colorNode	✗

---

Functions

ColorSpaceNode.resolveColorSpace(builder: NodeBuilder, colorSpace: string): string

JSDoc:

/**
     * This method resolves the constants `WORKING_COLOR_SPACE` and
     * `OUTPUT_COLOR_SPACE` based on the current configuration of the
     * color management and renderer.
     *
     * @param {NodeBuilder} builder - The current node builder.
     * @param {string} colorSpace - The color space to resolve.
     * @return {string} The resolved color space.
     */

Parameters:

• builder NodeBuilder
• colorSpace string

Returns: string

Code

resolveColorSpace( builder, colorSpace ) {

        if ( colorSpace === WORKING_COLOR_SPACE ) {

            return ColorManagement.workingColorSpace;

        } else if ( colorSpace === OUTPUT_COLOR_SPACE ) {

            return builder.context.outputColorSpace || builder.renderer.outputColorSpace;

        }

        return colorSpace;

    }

ColorSpaceNode.setup(builder: any): Node

Parameters:

• builder any

Returns: Node

Calls:

• this.resolveColorSpace
• ColorManagement.getTransfer
• vec4 (from ../tsl/TSLCore.js)
• sRGBTransferEOTF (from ./ColorSpaceFunctions.js)
• ColorManagement.getPrimaries
• mat3( ColorManagement._getMatrix( new Matrix3(), source, target ) ).mul
• sRGBTransferOETF (from ./ColorSpaceFunctions.js)

Code

setup( builder ) {

        const { colorNode } = this;

        const source = this.resolveColorSpace( builder, this.source );
        const target = this.resolveColorSpace( builder, this.target );

        let outputNode = colorNode;

        if ( ColorManagement.enabled === false || source === target || ! source || ! target ) {

            return outputNode;

        }

        if ( ColorManagement.getTransfer( source ) === SRGBTransfer ) {

            outputNode = vec4( sRGBTransferEOTF( outputNode.rgb ), outputNode.a );

        }

        if ( ColorManagement.getPrimaries( source ) !== ColorManagement.getPrimaries( target ) ) {

            outputNode = vec4(
                mat3( ColorManagement._getMatrix( new Matrix3(), source, target ) ).mul( outputNode.rgb ),
                outputNode.a
            );

        }

        if ( ColorManagement.getTransfer( target ) === SRGBTransfer ) {

            outputNode = vec4( sRGBTransferOETF( outputNode.rgb ), outputNode.a );

        }

        return outputNode;

    }

workingToColorSpace(node: Node, targetColorSpace: string): ColorSpaceNode

Parameters:

• node Node
• targetColorSpace string

Returns: ColorSpaceNode

Calls:

• nodeObject (from ../tsl/TSLCore.js)

Code

( node, targetColorSpace ) => nodeObject( new ColorSpaceNode( nodeObject( node ), WORKING_COLOR_SPACE, targetColorSpace ) )

colorSpaceToWorking(node: Node, sourceColorSpace: string): ColorSpaceNode

Parameters:

• node Node
• sourceColorSpace string

Returns: ColorSpaceNode

Calls:

• nodeObject (from ../tsl/TSLCore.js)

Code

( node, sourceColorSpace ) => nodeObject( new ColorSpaceNode( nodeObject( node ), sourceColorSpace, WORKING_COLOR_SPACE ) )

convertColorSpace(node: Node, sourceColorSpace: string, targetColorSpace: string): ColorSpaceNode

Parameters:

• node Node
• sourceColorSpace string
• targetColorSpace string

Returns: ColorSpaceNode

Calls:

• nodeObject (from ../tsl/TSLCore.js)

Code

( node, sourceColorSpace, targetColorSpace ) => nodeObject( new ColorSpaceNode( nodeObject( node ), sourceColorSpace, targetColorSpace ) )

---

Classes

ColorSpaceNode

Class Code

class ColorSpaceNode extends TempNode {

    static get type() {

        return 'ColorSpaceNode';

    }

    /**
     * Constructs a new color space node.
     *
     * @param {Node} colorNode - Represents the color to convert.
     * @param {string} source - The source color space.
     * @param {string} target - The target color space.
     */
    constructor( colorNode, source, target ) {

        super( 'vec4' );

        /**
         * Represents the color to convert.
         *
         * @type {Node}
         */
        this.colorNode = colorNode;

        /**
         * The source color space.
         *
         * @type {string}
         */
        this.source = source;

        /**
         * The target color space.
         *
         * @type {string}
         */
        this.target = target;

    }

    /**
     * This method resolves the constants `WORKING_COLOR_SPACE` and
     * `OUTPUT_COLOR_SPACE` based on the current configuration of the
     * color management and renderer.
     *
     * @param {NodeBuilder} builder - The current node builder.
     * @param {string} colorSpace - The color space to resolve.
     * @return {string} The resolved color space.
     */
    resolveColorSpace( builder, colorSpace ) {

        if ( colorSpace === WORKING_COLOR_SPACE ) {

            return ColorManagement.workingColorSpace;

        } else if ( colorSpace === OUTPUT_COLOR_SPACE ) {

            return builder.context.outputColorSpace || builder.renderer.outputColorSpace;

        }

        return colorSpace;

    }

    setup( builder ) {

        const { colorNode } = this;

        const source = this.resolveColorSpace( builder, this.source );
        const target = this.resolveColorSpace( builder, this.target );

        let outputNode = colorNode;

        if ( ColorManagement.enabled === false || source === target || ! source || ! target ) {

            return outputNode;

        }

        if ( ColorManagement.getTransfer( source ) === SRGBTransfer ) {

            outputNode = vec4( sRGBTransferEOTF( outputNode.rgb ), outputNode.a );

        }

        if ( ColorManagement.getPrimaries( source ) !== ColorManagement.getPrimaries( target ) ) {

            outputNode = vec4(
                mat3( ColorManagement._getMatrix( new Matrix3(), source, target ) ).mul( outputNode.rgb ),
                outputNode.a
            );

        }

        if ( ColorManagement.getTransfer( target ) === SRGBTransfer ) {

            outputNode = vec4( sRGBTransferOETF( outputNode.rgb ), outputNode.a );

        }

        return outputNode;

    }

}

Methods

resolveColorSpace(builder: NodeBuilder, colorSpace: string): string

Code

resolveColorSpace( builder, colorSpace ) {

        if ( colorSpace === WORKING_COLOR_SPACE ) {

            return ColorManagement.workingColorSpace;

        } else if ( colorSpace === OUTPUT_COLOR_SPACE ) {

            return builder.context.outputColorSpace || builder.renderer.outputColorSpace;

        }

        return colorSpace;

    }

setup(builder: any): Node

Code

setup( builder ) {

        const { colorNode } = this;

        const source = this.resolveColorSpace( builder, this.source );
        const target = this.resolveColorSpace( builder, this.target );

        let outputNode = colorNode;

        if ( ColorManagement.enabled === false || source === target || ! source || ! target ) {

            return outputNode;

        }

        if ( ColorManagement.getTransfer( source ) === SRGBTransfer ) {

            outputNode = vec4( sRGBTransferEOTF( outputNode.rgb ), outputNode.a );

        }

        if ( ColorManagement.getPrimaries( source ) !== ColorManagement.getPrimaries( target ) ) {

            outputNode = vec4(
                mat3( ColorManagement._getMatrix( new Matrix3(), source, target ) ).mul( outputNode.rgb ),
                outputNode.a
            );

        }

        if ( ColorManagement.getTransfer( target ) === SRGBTransfer ) {

            outputNode = vec4( sRGBTransferOETF( outputNode.rgb ), outputNode.a );

        }

        return outputNode;

    }

---