tsParticles - v4.3.2
    Preparing search index...

    Canvas manager

    Index

    Constructors

    Accessors

    • get settings(): CanvasRenderingContext2DSettings | undefined

      Canvas rendering context settings

      Returns CanvasRenderingContext2DSettings | undefined

      the canvas context settings

    Methods

    • Clears the canvas content through the layer system.

      First checks plugins registered in the dedicated #canvasClearPlugins array (plugins that implement canvasClear as their only rendering hook, e.g. trail), then iterates all layers in ordinal order (0–7) for any additional canvasClear implementations.

      The first plugin that returns true short-circuits the clear. If no plugin handles it, falls back to canvasClear which respects actualOptions.clear.

      Returns void

      IContainerPlugin.canvasClear

    • Draws all particles for the current frame via the layer-based rendering pipeline.

      Layer order (back to front): 0. BackgroundElement — auto-draw background.element via ctx.drawImage

      1. BackgroundDraw — execute background.draw(ctx, delta) callback
      2. BackgroundMask — plugin.canvasPaint() for each plugin
      3. CanvasSetup — plugin.drawSettingsSetup(ctx, delta) for each plugin
      4. PluginContent — plugin.draw(ctx, delta) for each plugin
      5. Particles — particles.drawParticles(delta) (core particle rendering)
      6. CanvasCleanup — plugin.clearDraw() + plugin.drawSettingsCleanup() for each plugin
      7. Foreground — reserved for future overlay/fx

      Parameters

      Returns void

      DrawLayer

    • Initializes the plugins needed by canvas.

      Assigns each plugin to ALL layers where it has relevant hooks, not just one primary layer. This enables plugins like BackgroundMaskPluginInstance that implement multiple hooks (canvasPaint→BackgroundMask, drawSettingsSetup→CanvasSetup, drawSettingsCleanup→CanvasCleanup) to participate in all the layers they need.

      Hook-independent features (particleFillColor, particleStrokeColor, drawParticle, drawParticleSetup, drawParticleCleanup) are collected into separate arrays for per-particle use during rendering.

      Returns void

      • DrawLayer
      • IContainerPlugin
    • Paints the canvas background with an optional base color

      Parameters

      • OptionalbaseColor: string

        The baseColor

      Returns void

    • Sets the canvas rendering context settings

      Parameters

      • settings: CanvasRenderingContext2DSettings

        The settings

      Returns void