SDF-2D - v0.3.2

compile

• compile(canvas: HTMLCanvasElement, descriptors: Array<DrawableDescriptor>, settingsOverrides?: Partial<StartupSettings>): Promise<Renderer>

• Compiles a new renderer instance. There can multiple renderers on a single page.

  Asynchronous behaviour is required for parallel shader compiling. Trying to draw before the returned promise resolves, results in no action taken. Settings can be set before promise resolution and they will be applied later.

  The descriptors of every to-be-drawn objects are required before creating the renderer, allowing the compiler to only create the shaders that will actually be used.

  Example usage:

   import { compile, Circle, CircleLight } from 'sdf-2d';
  
   const canvas = document.querySelector('canvas');
   const renderer = await compile(canvas, [Circle.descriptor, CircleLight.descriptor]);

  Parameters

  • canvas: HTMLCanvasElement

    The returned renderer will only be able to draw to this canvas.

  • descriptors: Array<DrawableDescriptor>

    The descriptor of every single object (and light) that ever needs to be drawn by this renderer has to be given before compiling.

  • Default value settingsOverrides: Partial<StartupSettings> = {}

    Sensible defaults are provided, but these can be overridden.

  Returns Promise<Renderer>