Class Batch<O, E>

A generic batch of objects.

Type Parameters

O
E extends BatchEntry<O> = BatchEntry<O>

Hierarchy (View Summary)

Batch

Index

Constructors

Properties

entries queuedChanges size sizes

Methods

addEntry clear onDeleteEntry

Constructors

constructor

new Batch<O, E extends BatchEntry<O> = BatchEntry<O>>(): Batch<O, E>
Type Parameters
- O
- E extends BatchEntry<O> = BatchEntry<O>
Returns Batch<O, E>

Properties

`Readonly`entries

entries: E[] = []

Entries in this batch.

Changes to this array must be done through the associated batcher (Batcher#add, Batcher#change, Batcher#delete).

`Readonly`queuedChanges

queuedChanges: E[] = []

Ordered array of entries that have a change queued.

size

size: number = 0

Batch size. Unit depends on how the batch is used in its batcher.

`Readonly`sizes

sizes: FenwickTree = ...

Acceleration structure to speed up offset lookups when applying changes non-sequentially.

Methods

addEntry

addEntry(entry: E): this
Add an entry to the batch.
Parameters
- entry: E
  Entry to add
Returns this
Self
- Defined in rendering/batching/batch.ts:32

clear

clear(): void
Clear all data from this batch.

Returns void
- Defined in rendering/batching/batch.ts:59

onDeleteEntry

onDeleteEntry(entry: E): void
Called when an entry is removed from the batch.
Parameters
- entry: E
  Deleted entry
Returns void
- Defined in rendering/batching/batch.ts:51