API

Interface SpriteRendererOptions

Options accepted by createSpriteRenderer.

interface SpriteRendererOptions {
    clear?: boolean;
    clearValue?: GPUColorDict;
    layers: readonly Sprite2DLayer[];
}
Index
clear?: boolean

Default true. Set false for HUD overlays so the sprite pass preserves existing scene color.

clearValue?: GPUColorDict

Default { r: 0, g: 0, b: 0, a: 1 }.

layers: readonly Sprite2DLayer[]

Layers to draw, in registration order. The renderer also re-sorts internally each frame.