Interface: CullerPluginOptions

Defined in: node_modules/pixi.js/lib/culling/CullerPlugin.d.ts:22

Application options for the CullerPlugin. These options control how your application handles culling of display objects.

Example

import { Application } from 'pixi.js';

// Create application
const app = new Application();
await app.init({
    culler: {
        updateTransform: false // Skip updating transforms for culled objects
    }
});

Standard

Properties

culler?

> optional culler?: object

Defined in: node_modules/pixi.js/lib/culling/CullerPlugin.d.ts:34

Options for the culler behavior.

updateTransform?

> optional updateTransform?: boolean

Update the transform of culled objects.

> [!IMPORTANT] Keeping this as false can improve performance by avoiding unnecessary calculations, > however, the transform used for culling may not be up-to-date if the object has moved since the last render.

Default

true

Example

const app = new Application();
await app.init({
    culler: {
        updateTransform: false // Skip updating transforms for culled objects
    }
});

Example

// Basic culling options
const app = new Application();
await app.init({
    culler: {...}
});