Class OutlineRenderer

constructor

• new OutlineRenderer(scene: Scene): OutlineRenderer

  Instantiates a new outline renderer. (There could be only one per scene).

  Parameters

  • scene: Scene

    Defines the scene it belongs to

  Returns OutlineRenderer

enabled

name

scene

zOffset

zOffsetUnits

shaderLanguage

• get shaderLanguage(): ShaderLanguage

  Gets the shader language used in the Outline renderer.

  Returns ShaderLanguage

dispose

• dispose(): void

  Disposes the component and the associated resources.

  Returns void

isReady

• isReady(subMesh: SubMesh, useInstances: boolean, renderPassId?: number): boolean

  Returns whether or not the outline renderer is ready for a given submesh. All the dependencies e.g. submeshes, texture, effect... mus be ready

  Parameters

  • subMesh: SubMesh

    Defines the submesh to check readiness for

  • useInstances: boolean

    Defines whether wee are trying to render instances or not

  • OptionalrenderPassId: number

    Render pass id to use to render the mesh

  Returns boolean

  true if ready otherwise false

rebuild

• rebuild(): void

  Rebuilds the elements related to this component in case of context lost for instance.

  Returns void

register

• register(): void

  Register the component to one instance of a scene.

  Returns void

render

• render(
      subMesh: SubMesh,
      batch: _InstancesBatch,
      useOverlay?: boolean,
      renderPassId?: number,
  ): void

  Renders the outline in the canvas.

  Parameters

  • subMesh: SubMesh

    Defines the sumesh to render

  • batch: _InstancesBatch

    Defines the batch of meshes in case of instances

  • useOverlay: boolean = false

    Defines if the rendering is for the overlay or the outline

  • OptionalrenderPassId: number

    Render pass id to use to render the mesh

  Returns void