⬅️ Back to Table of Contents

📄 RenderContext.js

📊 Analysis Summary

Metric	Count
🔧 Functions	2
🧱 Classes	1
📦 Imports	2
📊 Variables & Constants	2

📚 Table of Contents

• Imports
• Variables & Constants
• Functions
• Classes

🛠️ File Location:

📂 src/renderers/common/RenderContext.js

📦 Imports

Name	Source
Vector4	../../math/Vector4.js
hashArray	../../nodes/core/NodeUtils.js

---

Variables & Constants

Name	Type	Kind	Value	Exported
_id	number	let/var	0	✗
values	number[]	let/var	[ activeCubeFace ]	✗

---

Functions

RenderContext.getCacheKey(): number

JSDoc:

/**
     * Returns the cache key of this render context.
     *
     * @return {number} The cache key.
     */

Returns: number

Calls:

• getCacheKey

Code

getCacheKey() {

        return getCacheKey( this );

    }

getCacheKey(renderContext: RenderContext): number

JSDoc:

/**
 * Computes a cache key for the given render context. This key
 * should identify the render target state so it is possible to
 * configure the correct attachments in the respective backend.
 *
 * @param {RenderContext} renderContext - The render context.
 * @return {number} The cache key.
 */

Parameters:

• renderContext RenderContext

Returns: number

Calls:

• values.push
• hashArray (from ../../nodes/core/NodeUtils.js)

Code

export function getCacheKey( renderContext ) {

    const { textures, activeCubeFace } = renderContext;

    const values = [ activeCubeFace ];

    for ( const texture of textures ) {

        values.push( texture.id );

    }

    return hashArray( values );

}

---

Classes

RenderContext

Class Code

class RenderContext {

    /**
     * Constructs a new render context.
     */
    constructor() {

        /**
         * The context's ID.
         *
         * @type {number}
         */
        this.id = _id ++;

        /**
         * Whether the current active framebuffer has a color attachment.
         *
         * @type {boolean}
         * @default true
         */
        this.color = true;

        /**
         * Whether the color attachment should be cleared or not.
         *
         * @type {boolean}
         * @default true
         */
        this.clearColor = true;

        /**
         * The clear color value.
         *
         * @type {Object}
         * @default true
         */
        this.clearColorValue = { r: 0, g: 0, b: 0, a: 1 };

        /**
         * Whether the current active framebuffer has a depth attachment.
         *
         * @type {boolean}
         * @default true
         */
        this.depth = true;

        /**
         * Whether the depth attachment should be cleared or not.
         *
         * @type {boolean}
         * @default true
         */
        this.clearDepth = true;

        /**
         * The clear depth value.
         *
         * @type {number}
         * @default 1
         */
        this.clearDepthValue = 1;

        /**
         * Whether the current active framebuffer has a stencil attachment.
         *
         * @type {boolean}
         * @default false
         */
        this.stencil = false;

        /**
         * Whether the stencil attachment should be cleared or not.
         *
         * @type {boolean}
         * @default true
         */
        this.clearStencil = true;

        /**
         * The clear stencil value.
         *
         * @type {number}
         * @default 1
         */
        this.clearStencilValue = 1;

        /**
         * By default the viewport encloses the entire framebuffer If a smaller
         * viewport is manually defined, this property is to `true` by the renderer.
         *
         * @type {boolean}
         * @default false
         */
        this.viewport = false;

        /**
         * The viewport value. This value is in physical pixels meaning it incorporates
         * the renderer's pixel ratio. The viewport property of render targets or
         * the renderer is in logical pixels.
         *
         * @type {Vector4}
         */
        this.viewportValue = new Vector4();

        /**
         * When the scissor test is active and scissor rectangle smaller than the
         * framebuffers dimensions, this property is to `true` by the renderer.
         *
         * @type {boolean}
         * @default false
         */
        this.scissor = false;

        /**
         * The scissor rectangle.
         *
         * @type {Vector4}
         */
        this.scissorValue = new Vector4();

        /**
         * The active render target.
         *
         * @type {?RenderTarget}
         * @default null
         */
        this.renderTarget = null;

        /**
         * The textures of the active render target.
         * `null` when no render target is set.
         *
         * @type {?Array<Texture>}
         * @default null
         */
        this.textures = null;

        /**
         * The depth texture of the active render target.
         * `null` when no render target is set.
         *
         * @type {?DepthTexture}
         * @default null
         */
        this.depthTexture = null;

        /**
         * The active cube face.
         *
         * @type {number}
         * @default 0
         */
        this.activeCubeFace = 0;

        /**
         * The active mipmap level.
         *
         * @type {number}
         * @default 0
         */
        this.activeMipmapLevel = 0;

        /**
         * The number of MSAA samples. This value is always `1` when
         * MSAA isn't used.
         *
         * @type {number}
         * @default 1
         */
        this.sampleCount = 1;

        /**
         * The active render target's width in physical pixels.
         *
         * @type {number}
         * @default 0
         */
        this.width = 0;

        /**
         * The active render target's height in physical pixels.
         *
         * @type {number}
         * @default 0
         */
        this.height = 0;

        /**
         * The occlusion query count.
         *
         * @type {number}
         * @default 0
         */
        this.occlusionQueryCount = 0;

        /**
         * The current clipping context.
         *
         * @type {?ClippingContext}
         * @default null
         */
        this.clippingContext = null;

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

    }

    /**
     * Returns the cache key of this render context.
     *
     * @return {number} The cache key.
     */
    getCacheKey() {

        return getCacheKey( this );

    }

}

Methods

getCacheKey(): number

Code

getCacheKey() {

        return getCacheKey( this );

    }

---