Class WebGLRenderer

constructor

• new WebGLRenderer(params): WebGLRenderer

• Creates a WebGLRenderer.

  Parameters

  • params: {
        textureTranscoder?: TextureTranscoder;
    }

    Configs

    • Optional textureTranscoder?: TextureTranscoder

      Injects an optional transcoder that will be used internally by rendererModel.createTexture to convert transcoded texture data. The transcoder is only required when we'll be providing transcoded data to rendererModel.createTexture. We assume that all transcoded texture data added to a rendererModel will then be in a format supported by this transcoder.

  Returns WebGLRenderer

renderContext

Internal renderStats

Internal rendererObjects

Internal tileManager

textureTranscoder

• get textureTranscoder(): void | TextureTranscoder
• Internal

  Gets the TextureTranscoder this WebGLRenderer was configured with, if any.

  Returns void | TextureTranscoder

viewer

• get viewer(): Viewer

• The Viewer this WebGLRenderer is currently attached to, if any.

  Returns Viewer

attachSceneModel

• attachSceneModel(sceneModel): void | SDKError
• Internal

  Attaches a SceneModel to this WebGLRenderer.

  This method attaches various hooks to the elements within the SceneModel, through which they can upload state updates to the Renderer.

  • Sets a @xeokit/scene!RendererModel on SceneModel.rendererModel
  • Sets a @xeokit/scene!RendererObject on each SceneObject.rendererObject
  • Sets a @xeokit/scene!RendererMesh on each SceneMesh.rendererMesh
  • Sets a @xeokit/scene!RendererTextureSet on each SceneTextureSet.rendererTextureSet
  • Sets a @xeokit/scene!RendererTexture on each SceneTexture.rendererTexture

  Then, when we make any state updates to those components, they will upload the updates into the Renderer.

  You must first attach a View with Renderer.attachView before you can attach a SceneModel.

  Parameters

  • sceneModel: SceneModel

  Returns void | SDKError

  void

  • SceneModel successfully attached.

attachView

• attachView(view): void | SDKError
• Internal

  Attaches a @xeokit/viewer!View to this WebGLRenderer.

  The WebGLRenderer will then begin rendering each SceneModel previously or subsequently created with Scene.createModel, for the new View.

  You can only attach as many Views as indicated in Capabilities.maxViews, as returned by Renderer.getCapabilities.

  You must attach a View before you can attach a SceneModel.

  Parameters

  • view: View

    The View to attach.

  Returns void | SDKError

  void

  • View successfully attached.

attachViewer

• attachViewer(viewer): void
• Internal

  Initializes this WebGLRenderer by attaching a Viewer.

  Parameters

  • viewer: Viewer

    Viewer to attach.

  Returns void

  void

  • Viewer successfully attached.

beginSnapshot

• beginSnapshot(viewIndex, params?): void

• Parameters

  • viewIndex: number
  • Optional params: {
        height: number;
        width: number;
    }

    • height: number

    • width: number

  Returns void

clear

• clear(viewIndex): void | SDKError
• Internal

  Clears this WebGLRenderer for the given view.

  Parameters

  • viewIndex: number

    Handle to the View, returned earlier by Renderer.attachView.

  Returns void | SDKError

  void

  • Success.

destroy

• destroy(): void

• Returns void

detachSceneModel

• detachSceneModel(sceneModel): void | SDKError
• Internal

  Detaches a SceneModel from this WebGLRenderer.

  Detaches and destroys the @xeokit/scene!RendererModel, @xeokit/scene!RendererObject and @xeokit/scene!RendererMesh, @xeokit/scene!RendererTexture instances that were attached in @xeokit/webglrenderer!WebGLRenderer.attachSceneModel.

  Parameters

  • sceneModel: SceneModel

  Returns void | SDKError

  void

  • SceneModel successfully detached.

detachView

• detachView(view): void | SDKError
• Internal

  Detaches the given @xeokit/viewer!View from this Renderer.

  The Renderer will then cease rendering for that View.

  Parameters

  • view: View

    The View to detach.

  Returns void | SDKError

  void

  • View successfully detached.

detachViewer

• detachViewer(): void | SDKError
• Internal

  Detaches the Viewer that is currently attached, if any.

  Returns void | SDKError

  void

  • Viewer successfully detached.

endSnapshot

• endSnapshot(): void

• Exits snapshot mode.

  Switches rendering back to the main canvas.

  Returns void

getCapabilities

• getCapabilities(capabilities): void
• Internal

  Gets the capabilities of this WebGLRenderer.

  Parameters

  • capabilities: Capabilities

    Returns the capabilities of this WebGLRenderer.

  Returns void

getNeedsRender

• getNeedsRender(viewIndex?): boolean
• Internal

  Gets if a new frame needs to be rendered for the given View.

  Parameters

  • Optional viewIndex: number

    Handle to the View, returned earlier by Renderer.attachView.

  Returns boolean

  boolean

  • True if a new frame needs to be rendered for the View.

getSAOSupported

• getSAOSupported(): boolean

• Returns boolean

pick

• pick(viewIndex, pickParams, pickResult?): PickResult
• Internal

  TODO

  Parameters

  • viewIndex: number
  • pickParams: PickParams
  • pickResult: PickResult = ...

  Returns PickResult

readSnapshot

• readSnapshot(): string

• Returns string

readSnapshotAsCanvas

• readSnapshotAsCanvas(): HTMLCanvasElement

• Returns HTMLCanvasElement

render

• render(viewIndex, params?): void | SDKError
• Internal

  Renders a frame for a View.

  Parameters

  • viewIndex: number

    Handle to the View, returned earlier by {@param params Rendering params. @param [params.force=false] True to force a render, else only render if needed. @link @xeokit/webglrenderer!WebGLRenderer.attachView | Renderer.attachView}.
  • Optional params: {
        force: boolean;
        opaqueOnly: boolean;
    }

    • force: boolean

    • opaqueOnly: boolean

  Returns void | SDKError

  SDKError

  • No View is currently attached to this Renderer.
  • Can't find a View attached to this Renderer with the given handle.

renderSnapshot

• renderSnapshot(): void

• Returns void

setEdgesEnabled

• setEdgesEnabled(viewIndex, enabled): void
• Internal

  Sets whether the WebGLRenderer draws edges. Triggers a new frame render.

  Parameters

  • viewIndex: number
  • enabled: boolean

  Returns void

setImageDirty

• setImageDirty(viewIndex?): void
• Internal

  Indicates that the WebGLRenderer needs to draw a new frame.

  Parameters

  • Optional viewIndex: number

  Returns void

setNeedsRebuild

• setNeedsRebuild(viewIndex?): void
• Internal

  Triggers a rebuild of the shaders within this WebGLRenderer for the given View.

  Parameters

  • Optional viewIndex: number

    Handle to the View, returned earlier by Renderer.attachView.

  Returns void

  void

  • Success.

setPBREnabled

• setPBREnabled(viewIndex, enabled): void
• Internal

  Sets whether the WebGLRenderer draws with physically-based rendering. Triggers a new frame render.

  Parameters

  • viewIndex: number
  • enabled: boolean

  Returns void

setSAOEnabled

• setSAOEnabled(viewIndex, enabled): void
• Internal

  Sets whether the WebGLRenderer draws with SAO. Triggers a new frame render.

  Parameters

  • viewIndex: number
  • enabled: boolean

  Returns void

setTransparentEnabled

• setTransparentEnabled(viewIndex, enabled): void
• Internal

  Enable/disable rendering of transparent objects for the given View.

  Parameters

  • viewIndex: number

    Handle to the View, returned earlier by Renderer.attachView.
  • enabled: boolean

    Whether to enable or disable transparent objects for the View.

  Returns void

  void

  • Success.

Readonly Internal onCompiled

Readonly Internal onDestroyed