Class WebGLRenderer

constructor

• new WebGLRenderer(
      params: { textureTranscoder?: TextureTranscoder },
  ): WebGLRenderer

  Creates a WebGLRenderer.

  Parameters

  • params: { textureTranscoder?: TextureTranscoder }

    Configs

    • OptionaltextureTranscoder?: TextureTranscoder

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

  Returns WebGLRenderer

InternalrenderContext

InternalrendererObjects

InternalrenderStats

InternaltileManager

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: 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 scene!RendererModel on SceneModel.rendererModel
  • Sets a scene!RendererObject on each SceneObject.rendererObject
  • Sets a scene!RendererMesh on each SceneMesh.rendererMesh
  • Sets a scene!RendererTextureSet on each SceneTextureSet.rendererTextureSet
  • Sets a 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: View): void | SDKError
  Internal

  Attaches a !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 WebGLRenderer.getCapabilities.

  Parameters

  • view: View

    The View to attach.

  Returns void | SDKError

  void

  • View successfully attached.

attachViewer

• attachViewer(viewer: Viewer): void
  Internal

  Initializes this WebGLRenderer by attaching a !Viewer | Viewer.

  Parameters

  • viewer: Viewer

    Viewer to attach.

  Returns void

  void

  • Viewer successfully attached.

beginSnapshot

• beginSnapshot(
      viewIndex: number,
      params?: { height: number; width: number },
  ): void
  Internal

  Begins snapshot mode for the given View.

  Parameters

  • viewIndex: number

    The View index. This matches !View.viewIndex | View.viewIndex on a View that is currently attached to this Renderer.
  • Optionalparams: { height: number; width: number }

    Snapshot configuration.

  Returns void

clear

• clear(viewIndex: number): 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: SceneModel): void | SDKError
  Internal

  Detaches a SceneModel from this WebGLRenderer.

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

  Parameters

  • sceneModel: SceneModel

  Returns void | SDKError

  void

  • SceneModel successfully detached.

detachView

• detachView(view: View): void | SDKError
  Internal

  Detaches the given !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 | 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: Capabilities): void
  Internal

  Gets the capabilities of this WebGLRenderer.

  Parameters

  • capabilities: Capabilities

    Returns the capabilities of this WebGLRenderer.

  Returns void

getNeedsRender

• getNeedsRender(viewIndex?: number): boolean
  Internal

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

  Parameters

  • OptionalviewIndex: 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
  Internal

  Checks if Screen Space Ambient Occlusion (SAO) is supported by this Renderer.

  Returns boolean

  boolean indicating SAO support.

pick

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

  TODO

  Parameters

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

  Returns PickResult

readSnapshot

• readSnapshot(): string
  Internal

  Retrieves an image of the snapshot canvas as a data URI.

  Returns string

  The image data URI.

readSnapshotAsCanvas

• readSnapshotAsCanvas(): HTMLCanvasElement

  Returns an HTMLCanvasElement containing a snapshot image.

  Returns HTMLCanvasElement

  The snapshot canvas.

render

• render(
      viewIndex: number,
      params?: { force?: boolean; opaqueOnly?: boolean },
  ): void | SDKError
  Internal

  Renders a frame for a View.

  Parameters

  • viewIndex: number

    Handle to the View.
  • Optionalparams: { force?: boolean; opaqueOnly?: boolean }

    • Optionalforce?: boolean

      True to force a render, else only render if needed.

    • OptionalopaqueOnly?: 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
  Internal

  Renders a snapshot frame of the current scene state.

  Returns void

setEdgesEnabled

• setEdgesEnabled(viewIndex: number, enabled: boolean): void
  Internal

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

  Parameters

  • viewIndex: number
  • enabled: boolean

  Returns void

setImageDirty

• setImageDirty(viewIndex?: number): void
  Internal

  Indicates that the WebGLRenderer needs to draw a new frame.

  Parameters

  • OptionalviewIndex: number

  Returns void

setNeedsRebuild

• setNeedsRebuild(viewIndex?: number): void
  Internal

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

  Parameters

  • OptionalviewIndex: number

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

  Returns void

  void

  • Success.

setPBREnabled

• setPBREnabled(viewIndex: number, enabled: boolean): 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: number, enabled: boolean): void
  Internal

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

  Parameters

  • viewIndex: number
  • enabled: boolean

  Returns void

setTransparentEnabled

• setTransparentEnabled(viewIndex: number, enabled: boolean): 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 InternalonCompiled

Readonly InternalonDestroyed