Class WebGLRenderer

constructor

• new WebGLRenderer(
      params?: {
          debugging?: boolean;
          memoryConfigs?: Partial<MemoryConfigs>;
          viewer?: Viewer;
      },
  ): WebGLRenderer

  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.

  Parameters

  • params: { debugging?: boolean; memoryConfigs?: Partial<MemoryConfigs>; viewer?: Viewer } = {}

    • Optionaldebugging?: boolean

    • OptionalmemoryConfigs?: Partial<MemoryConfigs>

      Optional overrides for GPU memory budgeting and allocation behavior.

    • Optionalviewer?: Viewer

      Optional Viewer to attach during construction.

  Returns WebGLRenderer

Internal_viewManager

events

logging

debugging

• get debugging(): boolean

  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.

  Returns boolean
• set debugging(value: boolean): void

  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.

  Parameters

  • value: boolean

  Returns void

rendering

• get rendering(): boolean

  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.

  Returns boolean

viewer

• get viewer(): Viewer

  Retrieves the Viewer currently attached to this WebGLRenderer, if any.

  Returns Viewer

attachViewer

• attachViewer(viewer: Viewer): SDKResult<void>

  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.

  Parameters

  • viewer: Viewer

    Viewer to attach.

  Returns SDKResult<void>

  Success or failure. Attaching while another Viewer is already attached is an error.

destroy

• destroy(): void

  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.

  Returns void

detachViewer

• detachViewer(): void

  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.

  Returns void

getCapabilities

• getCapabilities(capabilities: Capabilities): void

  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.

  Parameters

  • capabilities: Capabilities

    The object to populate with capability information.

  Returns void

getDrawInspector

• getDrawInspector(): SDKResult<DrawInspector>
  Internal

  Sets a DrawInspector to inspect draw calls during rendering.

  Returns SDKResult<DrawInspector>

getMemoryConfigs

• getMemoryConfigs(): MemoryConfigs

  Retrieves the GPU memory configuration used by this WebGLRenderer.

  Returns MemoryConfigs

getMemoryInspector

• getMemoryInspector(): SDKResult<MemoryInspector>
  Internal

  Returns 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.

  Returns SDKResult<MemoryInspector>

  { ok: true, value } when a Viewer with an attached Scene is present; otherwise { ok: false } with SDKErrorType.InvalidOperation.

getMemoryUsage

• getMemoryUsage(): MemoryUsage

  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.

  Returns MemoryUsage

getShaderInspector

• getShaderInspector(): SDKResult<ShaderInspector>
  Internal

  Returns a inspectors view of program shaders used by the renderer.

  This API is intended for diagnostics, debugging tools, and monitoring UIs.

  Returns SDKResult<ShaderInspector>

  { ok: true, value } when a Viewer with an attached Scene is present; otherwise { ok: false } with SDKErrorType.InvalidOperation.

pick

• pick(view: View, pickParams: PickParams): SDKResult<PickResult>

  Performs a GPU-accelerated pick operation in the specified View.

  This method queries the renderer to identify the ViewObject (and optionally 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

  • view: View

    The View in which to perform the pick. Must belong to the currently attached Viewer.
  • pickParams: PickParams

    Parameters specifying the pick mode and target (canvas coordinates or world-space ray).

  Returns SDKResult<PickResult>

  An SDKResult containing the PickResult on success, or an error result on failure.

  Remarks

  • Returns an error if no Viewer with an attached Scene is present, or if the View does not belong to the attached Viewer.
  • The returned PickResult is a transient, renderer-owned instance. Its contents are valid only until the next pick operation. Do not modify or retain the result.