Class C3DEngine

constructor

• new C3DEngine(target: HTMLDivElement, options?: EngineOptions): C3DEngine

  Parameters

  • target: HTMLDivElement

    The parent div that will contain the canvas.

  • Optionaloptions: EngineOptions

    The options.

  Returns C3DEngine

clearAlpha

clearColor

height

ReadonlylabelRenderer

Readonlyrenderer

renderingOptions

width

dispose

• dispose(): void

  Returns void

getWindowSize

• getWindowSize(target?: Vector2): Vector2

  Gets the viewport size, in pixels.

  Parameters

  • Optionaltarget: Vector2

  Returns Vector2

  The viewport size, in pixels.

onWindowResize

• onWindowResize(w: number, h: number): void

  Parameters

  • w: number
  • h: number

  Returns void

render

• render(scene: Scene, camera: Camera): void

  Renders the scene.

  Parameters

  • scene: Scene

    The scene to render.

  • camera: Camera

    The camera.

  Returns void

renderToBuffer

• renderToBuffer(options: RenderToBufferOptions): Uint8Array | Float32Array

  Renders the scene into a readable buffer.

  Parameters

  • options: RenderToBufferOptions

    Options.

  Returns Uint8Array | Float32Array

  The buffer. The first pixel in the buffer is the bottom-left pixel.

renderUsingCustomPipeline

• renderUsingCustomPipeline(scene: Object3D, camera: Camera): void

  Use a custom pipeline when post-processing is required.

  Parameters

  • scene: Object3D

    The scene to render.

  • camera: Camera

    The camera.

  Returns void

StaticbufferToImage

• bufferToImage(
      pixelBuffer: ArrayLike<number>,
      width: number,
      height: number,
  ): HTMLImageElement

  Converts the pixel buffer into an image element.

  Parameters

  • pixelBuffer: ArrayLike<number>

    The 8-bit RGBA buffer.

  • width: number

    The width of the buffer, in pixels.

  • height: number

    The height of the buffer, in pixels.

  Returns HTMLImageElement

  The image.