Class System

The system class is the entry point of the Rhodonite library.

Example

await Rn.System.init({
  approach: Rn.ProcessApproach.DataTexture,
  canvas: document.getElementById('world') as HTMLCanvasElement,
});

... (create something) ...

Rn.System.startRenderLoop((time, _myArg1, _myArg2) => {
  Rn.System.process([expression]);
}, myArg1, myArg2);

Accessors

processApproach processTime timeAtProcessBegin timeAtProcessEnd

Methods

getCanvasSize getCurrentWebGLContextWrapper init process processAuto resizeCanvas restartRenderLoop startRenderLoop stopRenderLoop

Accessors

StaticprocessApproach

StaticprocessTime

StatictimeAtProcessBegin

StatictimeAtProcessEnd

Methods

StaticgetCanvasSize

StaticgetCurrentWebGLContextWrapper

Staticinit

  • init(desc): Promise<void>

  • Initialize the Rhodonite system.

    Parameters

    • desc: SystemInitDescription

    Returns Promise<void>

    Remarks

    Don't forget await to use this method.

    Example

    await Rn.System.init({
      approach: Rn.ProcessApproach.DataTexture,
      canvas: document.getElementById('world') as HTMLCanvasElement,
    });

Staticprocess

StaticprocessAuto

  • processAuto(clearColor?): void

  • A Simple version of process method

    Parameters

    • clearColor: Vector4 = ...

      color to clear the canvas

    Returns void

    Remarks

    No need to create expressions and renderPasses and to register entities, etc... It's suitable for simple use cases like sample apps.

StaticresizeCanvas

StaticrestartRenderLoop

StaticstartRenderLoop

  • startRenderLoop(renderLoopFunc, ...args): void

  • Starts a render loop.

    Parameters

    • renderLoopFunc: ((time: number, ...args: any[]) => void)

      function to be called in each frame

        • (time, ...args): void

        • Parameters

          • time: number
          • Rest...args: any[]

          Returns void

    • Rest...args: any[]

      arguments you want to be passed to renderLoopFunc

    Returns void

    Example

    Rn.System.startRenderLoop((time, _myArg1, _myArg2) => {
      Rn.System.process([expression]);
    }, myArg1, myArg2);

StaticstopRenderLoop

Settings

Member Visibility

On This Page

Accessors
Methods