meo-canvas - v8.0.1
    Preparing search index...

    Function Root

    WorkerCanvas is what Root resolves to in worker mode, so a caller cannot annotate the result of their own render without it. The node types come with their factories for the same reason: Children is written in terms of them, and a helper returning one has to be able to say so.

    • Creates and renders a new root node with the given properties. Rendering runs in worker threads by default for non-blocking operation.

      Parameters

      Returns Promise<WorkerCanvas>

      Canvas with .release() in worker mode, plain Canvas otherwise

      // Worker mode (default) - .release() available
      const canvas = await Root({ width: 400, children: [...] })
      canvas.release() // ✓ OK

      // Worker mode explicit - .release() available
      const canvas = await Root({ width: 400, workerMode: true, workers: 2 })
      canvas.release() // ✓ OK

      // Non-worker mode - .release() NOT available, workers not allowed
      const canvas = await Root({ width: 400, workerMode: false })
      canvas.release() // ✗ TypeScript error

    • Creates and renders a new root node with the given properties. Rendering runs in worker threads by default for non-blocking operation.

      Parameters

      Returns Promise<RenderedCanvas>

      Canvas with .release() in worker mode, plain Canvas otherwise

      // Worker mode (default) - .release() available
      const canvas = await Root({ width: 400, children: [...] })
      canvas.release() // ✓ OK

      // Worker mode explicit - .release() available
      const canvas = await Root({ width: 400, workerMode: true, workers: 2 })
      canvas.release() // ✓ OK

      // Non-worker mode - .release() NOT available, workers not allowed
      const canvas = await Root({ width: 400, workerMode: false })
      canvas.release() // ✗ TypeScript error

    Settings
    Member Visibility