Renderer · interface

BudgetLine

One ceiling's frame. Updated in place, so holding a reference to it is the intended use.

Explained in Hello world.

interface BudgetLine
import type { BudgetLine } from '@driftengine/core';

Properties

NameTypeDescription
namereadonlystringWhat a consumer would call the thing, not what the ring holding it is called.
usedreadonlynumberHow many were asked for, including any that were refused.
More

The distinction is the whole value of this field. A ring naturally knows how many slots it handed out, which tops out at the ceiling and says a frame is exactly full; what a consumer needs is how far past it the scene went, because that is the number that says how much to cut.

ceilingreadonlynumber | nullThe ceiling, or null where this backend imposes none.
droppedreadonlynumberHow many were asked for and not drawn.