Class LineBatcher

Hierarchy (View Summary)

SizedBatcher<LineLike, LineBatchStorage>
- LineBatcher

Index

Constructors

Properties

_batches batches batchPool changeTracker entryPool maxSize objectBatches queuedAdds

Methods

add addEntryQueued addToBatch canBatchInclude change changeEntry clear delete finalize has

Constructors

constructor

new LineBatcher(options: LineBatcherOptions): LineBatcher
Parameters
- options: LineBatcherOptions
Returns LineBatcher
Overrides SizedBatcher.constructor
- Defined in renderers/lines/line-batching.ts:27

Properties

`Protected` `Readonly`_batches

_batches: Batch<LineLike, BatchEntry<LineLike>, LineBatchStorage>[] = []

`Readonly`batches

batches: readonly Batch<LineLike, BatchEntry<LineLike>, LineBatchStorage>[] = ...

Batches. All batches in this collection are at least partially occupied.

`Protected` `Readonly`batchPool

batchPool: Pool<Batch<LineLike, BatchEntry<LineLike>, LineBatchStorage>>

Object pool for batches

`Protected` `Readonly`changeTracker

changeTracker: ChangeTracker

Changes to objects will be propagated to the change tracker

`Protected` `Readonly`entryPool

entryPool: Pool<BatchEntry<LineLike>>

Object pool for batch entries

`Readonly`maxSize

maxSize: number

Max size of a batch. Unit depends on batcher.

`Protected` `Readonly`objectBatches

objectBatches: Map<
LineLike,
Batch<LineLike, BatchEntry<LineLike>, LineBatchStorage>,
> = ...

For faster lookup of object -> batch.

`Protected` `Readonly`queuedAdds

queuedAdds: BatchEntry<LineLike>[] = []

Newly added entries are queued until all changes are applied to a batch.

Methods

add

add(object: LineLike): this
Add an object to the batcher.
Parameters
- object: LineLike
  Object to add
Returns this
Inherited from SizedBatcher.add
- Defined in rendering/batching/sized.ts:55

`Protected`addEntryQueued

addEntryQueued(entry: BatchEntry): void
Queue an entry for adding. Apply with Batcher.finalize.
Parameters
- entry: BatchEntry
  Entry to add
Returns void
Inherited from SizedBatcher.addEntryQueued
- Defined in rendering/batching/batcher.ts:77

`Protected`addToBatch

addToBatch(batch: Batch<LineLike>, entry: BatchEntry<LineLike>): void
Add an entry to a batch.
Parameters
- batch: Batch<LineLike>
  Batch to add entry to
- entry: BatchEntry<LineLike>
  Entry to add
Returns void
Inherited from SizedBatcher.addToBatch
- Defined in rendering/batching/sized.ts:98

`Protected`canBatchInclude

canBatchInclude(batch: Batch<LineLike>, entry: BatchEntry<LineLike>): boolean
Check if a batch can contain an entry.
Parameters
- batch: Batch<LineLike>
  Batch to check
- entry: BatchEntry<LineLike>
  Entry
Returns boolean
Inherited from SizedBatcher.canBatchInclude
- Defined in rendering/batching/sized.ts:102

change

change(object: LineLike): void
Mark an object as changed. Changes are queued, apply with Batcher.finalize.
Parameters
- object: LineLike
  Changed object
Returns void
Inherited from SizedBatcher.change
- Defined in rendering/batching/batcher.ts:113

`Protected`changeEntry

changeEntry(
    batch:
        | undefined
        | Batch<
            LineLike,
            BatchEntry<LineLike>,
            BatchStorage<BatchEntry<LineLike>>,
        >,
    entry: BatchEntry<LineLike>,
    object: LineLike,
): void
Apply changes of an object to its entry (and possible batch).
Parameters
- batch:
  | undefined
  | Batch<LineLike, BatchEntry<LineLike>, BatchStorage<BatchEntry<LineLike>>>
  Batch entry belongs to. Can be undefined in case entry does not have a batch (e.g., when only queued for an add)
- entry: BatchEntry<LineLike>
  Entry to change
- object: LineLike
  Associated object
Returns void
Inherited from SizedBatcher.changeEntry
- Defined in rendering/batching/sized.ts:71

clear

clear(): void
Returns void
Inherited from SizedBatcher.clear
- Defined in rendering/batching/batcher.ts:179

delete

delete(object: LineLike): boolean
Delete an object and its entry. Deletes are queued, apply with Batcher.finalize.
Parameters
- object: LineLike
  Object to delete
Returns boolean
true if an entry was deleted
Inherited from SizedBatcher.delete
- Defined in rendering/batching/batcher.ts:146

finalize

finalize(): readonly Batch<LineLike, BatchEntry<LineLike>, LineBatchStorage>[]
Finalize batches for this tick by applying all queued changes, adding all queued new entries, and cleaning up unused batches.

Returns readonly Batch<LineLike, BatchEntry<LineLike>, LineBatchStorage>[]
Finalized batches
Inherited from SizedBatcher.finalize
- Defined in rendering/batching/batcher.ts:200

has

has(object: LineLike): boolean
Check if object is part of this batcher.
Parameters
- object: LineLike
  Object
Returns boolean
true if batcher contains the object
Inherited from SizedBatcher.has
- Defined in rendering/batching/batcher.ts:88