Constructs a new WebGLRenderer.
If a Viewer is provided, the renderer immediately attempts to attach to it. Any errors encountered during attachment are emitted via events.onError.
Optionaldebugging?: booleanOptionalmemoryConfigs?: Partial<MemoryConfigs>Optional overrides for GPU memory budgeting and allocation behavior.
Optionalviewer?: ViewerOptional Viewer to attach during construction.
Internal_viewManages views and their rendering lifecycle - only exists when a Viewer with a Scene is attached to the renderer.
The ViewManager core is a central part of the renderer’s internal state, managing views, batches, and GPU resources. It only exists while a Viewer with an attached Scene is present.
This API is exposed on the renderer for internal developer docs and debugging/telemetry only and is not covered by semantic versioning. It may change or be removed at any time.
Events emitted by this renderer.
These events describe lifecycle transitions (Viewer attachment, rendering start/stop), WebGL context issues, and error reporting.
Enables or disables logging of errors to the console.
Indicates whether debugging features are enabled.
When true, the renderer and its components may emit additional events
and perform extra checks to facilitate debugging and diagnostics.
This may incur performance overhead, so it should be disabled in production.
Enables or disables debugging features.
When true, the renderer and its components may emit additional events
and perform extra checks to facilitate debugging and diagnostics.
Indicates whether the renderer is actively rendering.
Rendering is considered active when a Viewer with an attached Scene is present and the renderer’s internal rendering state has been initialized.
Retrieves the Viewer currently attached to this WebGLRenderer, if any.
Attaches a Viewer to this renderer.
If the Viewer already has an active Scene, the renderer immediately initializes its internal rendering state and begins rendering. Otherwise, rendering begins once a Scene is attached to the Viewer.
Viewer to attach.
Success or failure. Attaching while another Viewer is already attached is an error.
InternalDiagnostic: read back every mip × face of the GGX-prefiltered IBL cubemap for the given view and tile them onto an HTMLCanvasElement for visual inspection. Returns null when IBL hasn't been initialised for the view, or when the prefilter pipeline isn't allocated.
Used to localise IBL artifacts to a specific mip without guessing. Call from the browser console:
const c = studio.renderer.debugDumpPrefilteredCubemap(0);
document.body.appendChild(c);
Destroys this renderer instance.
Detaches any attached Viewer, releases internal resources and subscriptions, and emits events.onRendererDestroyed. After this call, the instance should be considered unusable.
Detaches the currently attached Viewer, if any.
If rendering is active, this also tears down the renderer’s internal rendering state before emitting lifecycle events.
InternalEnables (or disables) opt-in step-level timing inside the
renderer's MeshManager, which fires synchronously on every
SceneModel.createMesh call. Use to attribute time across the
substeps (getMeshBatch, batchAddMesh, rendererMeshCtor)
during a workload like a model load. Off by default so the hot
path takes no performance.now() hit in normal use.
Read the recorded numbers with getMeshManagerStepStats.
Retrieves the capabilities of the WebGLRenderer.
Populates the provided Capabilities object with information about supported
WebGL features, such as texture compression formats and WebGL2 support.
The object to populate with capability information.
Retrieves the GPU memory configuration used by this WebGLRenderer.
InternalReturns a read-only view of GPU-resident data used by the renderer.
This API is intended for diagnostics, debugging tools, and monitoring UIs. The returned object exposes structured access to DataTextures while rendering is active.
{ ok: true, value } when a Viewer with an attached Scene is present;
otherwise { ok: false } with SDKErrorType.InvalidOperation.
Returns the renderer’s current GPU memory usage summary.
When the renderer is not actively rendering (no attached Viewer with a Scene), this returns zero usage.
InternalReturns a snapshot of the MeshManager step-stats. Safe to call
whether or not enableMeshManagerStepStats is on; values
stay at the last-recorded numbers when disabled. Returns null
before a viewer is attached.
InternalSets a RenderInspector to inspect draw calls during rendering.
InternalReturns a inspectors view of program shaders used by the renderer.
This API is intended for diagnostics, debugging tools, and monitoring UIs.
{ ok: true, value } when a Viewer with an attached Scene is present;
otherwise { ok: false } with SDKErrorType.InvalidOperation.
Returns submitted-geometry stats for a View's most recently completed frame: the total number of draw calls and primitives issued across all render passes (color, shadow cascades, SAO, …).
numPrimitives is summed from the per-view packed draw ranges, so
it reflects visibility and culling — culled meshes drop out of the
count. It's the metric to watch to confirm culling is reducing GPU
work, since it moves even while the display caps the frame rate.
numDrawCalls, by contrast, barely changes with culling: this
renderer draws a whole batch per call, so culling trims primitives
within a draw rather than removing draws.
Returns null when no Viewer is attached or the render inspector
has not recorded a frame for this view yet. The inspector is
enabled by Studio; in a bare WebGLRenderer
setup, enable it first via getRenderInspector.
Performs a GPU-accelerated pick operation in the specified View.
This method queries the renderer to identify the ViewObject and the 3D surface position at a given canvas coordinate or along a specified world-space ray. Picking is performed using the renderer's internal GPU resources and shaders.
Parameters specifying the pick mode and target (canvas coordinates or world-space ray).
An SDKResult containing the PickResult on success, or an error result on failure.
InternalZeroes the MeshManager step-stats counters. Call before the workload you want to attribute.
WebGL renderer backing a Viewer.
WebGLRenderer owns and manages the WebGL rendering pipeline for a Viewer. It is responsible for:
See @xeokit/webGLRenderer for usage.