Class CullerPlugin

Example

import { Application, CullerPlugin, Container, Rectangle } from 'pixi.js';

// Register the plugin
extensions.add(CullerPlugin);

// Create application
const app = new Application();
await app.init({...});

// Create a container with culling enabled
const container = new Container();
container.cullable = true;         // Enable culling for this container
container.cullableChildren = true; // Enable culling for children (default)
app.stage.addChild(container);

// Optional: Set custom cull area to avoid expensive bounds calculations
container.cullArea = new Rectangle(0, 0, app.screen.width, app.screen.height);

// Add many sprites to the group
for (let j = 0; j < 100; j++) {
    const sprite = Sprite.from('texture.png');
    sprite.x = Math.random() * 2000;
    sprite.y = Math.random() * 2000;

    sprite.cullable = true; // Enable culling for each sprite

    // Set cullArea if needed
    // sprite.cullArea = new Rectangle(0, 0, 100, 100); // Optional

    // Add to container
    container.addChild(sprite);
}
Copy