pixi.js
    Preparing search index...

    Class RenderableGCSystemAdvanced

    The RenderableGCSystem is responsible for cleaning up GPU resources that are no longer being used.

    When rendering objects like sprites, text, etc - GPU resources are created and managed by the renderer. If these objects are no longer needed but not properly destroyed (via sprite.destroy()), their GPU resources would normally leak. This system prevents that by automatically cleaning up unused GPU resources.

    Key features:

    • Runs every 30 seconds by default to check for unused resources
    • Cleans up resources not rendered for over 1 minute
    • Works independently of rendering - will clean up even when not actively rendering
    • When cleaned up resources are needed again, new GPU objects are quickly assigned from a pool
    • Can be disabled with renderableGCActive:false for manual control

    Best practices:

    • Always call destroy() explicitly when done with renderables (e.g. sprite.destroy())
    • This system is a safety net, not a replacement for proper cleanup
    • Adjust frequency and timeouts via options if needed
    // Sprite created but reference lost without destroy
    let sprite = new Sprite(texture);

    // internally the renderer will assign a resource to the sprite
    renderer.render(sprite);

    sprite = null; // Reference lost but GPU resources still exist

    // After 1 minute of not being rendered:
    // - RenderableGC will clean up the sprite's GPU resources
    // - JS garbage collector can then clean up the sprite itself

    Implements

    Index

    Constructors

    constructor

    Properties

    maxUnusedTime defaultOptions

    Accessors

    enabled

    Methods

    addManagedArray addManagedHash addRenderable destroy init prerender run

    Constructors

    Properties

    maxUnusedTime: number

    Maximum time in ms a resource can be unused before being garbage collected

    defaultOptions: RenderableGCSystemOptions = ...

    Default configuration options for the garbage collection system. These can be overridden when initializing the renderer.

    Accessors

    • get enabled(): boolean

      Gets whether the garbage collection system is currently enabled.

      Returns boolean

      True if GC is enabled, false otherwise

    • set enabled(value: boolean): void

      Enables or disables the garbage collection system. When enabled, schedules periodic cleanup of resources. When disabled, cancels all scheduled cleanups.

      Parameters

      • value: boolean

      Returns void

    Methods

    • Adds an array to be managed by the garbage collector.

      Type Parameters

      • T

      Parameters

      • context: T

        The object containing the array

      • hash: string

        The property name of the array

      Returns void

    • Adds a hash table to be managed by the garbage collector.

      Type Parameters

      • T

      Parameters

      • context: T

        The object containing the hash table

      • hash: string

        The property name of the hash table

      Returns void

    • Starts tracking a renderable for garbage collection.

      Parameters

      • renderable: Renderable

        The renderable to track

      Returns void

    • Cleans up the garbage collection system. Disables GC and removes all tracked resources.

      Returns void

    • Updates the GC timestamp and tracking before rendering.

      Parameters

      • options: RenderOptions

        The render options

        The options for rendering a view.

        • Optionalclear?: CLEAR_OR_BOOL

          The clear mode to use.

        • OptionalclearColor?: ColorSource

          The color to clear with.

        • container: Container

          The container to render.

        • Optionaltarget?: RenderSurface

          The render target to render. if this target is a canvas and you are using the WebGL renderer, please ensure you have set multiView to true on renderer.

        • Optionaltransform?: Matrix

          the transform to apply to the container.

      Returns void

    • Performs garbage collection by cleaning up unused renderables. Removes renderables that haven't been used for longer than maxUnusedTime.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods