Class Batcher<O, E, B>`Abstract`

Manages a collection of objects and distributes them into a set of batches, based on batcher-specific criteria (like size, number of textures, ...).

Remarks

A new batcher derived from Batcher must:

Define an add method. There is no default/overridable add method because the needs of a batcher can change it. This method should ultimately call Batcher.addEntryQueued.
Implement Batcher.changeEntry. It is the job of the batcher to find out what actually changed after a consumer calls Batcher.change. Any actual change must then be propagated to the batch and optionally stored in the entry.
Implement Batcher.addToBatch. Adds an entry to a batch, with any additional data necessary.
Implement Batcher.canBatchInclude. Returns if a batch can fit the given entry.

Implementing these allows for batching on many different criteria.

Depending on what is being batched and what the criteria for when a batch is 'full' are, derived versions of Batch and BatchEntry may be necessary.

Type Parameters

O
E extends BatchEntry<O> = BatchEntry<O>
B extends Batch<O, E> = Batch<O, E>

Hierarchy (View Summary)

Batcher

Implements

ObjectSet<O>

Index

Constructors

constructor

new Batcher<
    O,
    E extends BatchEntry<O> = BatchEntry<O>,
    B extends Batch<O, E, BatchStorage<E>> = Batch<O, E, BatchStorage<E>>,
>(
    maxSize: number,
    entryPool: Pool<E>,
    batchPool: Pool<B>,
    changeTracker: ChangeTracker,
): Batcher<O, E, B>
Create a new instance.
Type Parameters
- O
- E extends BatchEntry<O> = BatchEntry<O>
- B extends Batch<O, E, BatchStorage<E>> = Batch<O, E, BatchStorage<E>>
Parameters
- maxSize: number
  Max size of a batch. Unit depends on batcher.
- entryPool: Pool<E>
  Object pool for batch entries
- batchPool: Pool<B>
  Object pool for batches
- changeTracker: ChangeTracker
  Changes to objects will be propagated to the change tracker
Returns Batcher<O, E, B>
- Defined in rendering/batching/batcher.ts:60

Properties

`Protected` `Readonly`_batches

_batches: B[] = []

`Readonly`batches

batches: readonly B[] = ...

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

`Protected` `Readonly`batchPool

batchPool: Pool<B>

Object pool for batches

`Protected` `Readonly`changeTracker

changeTracker: ChangeTracker

Changes to objects will be propagated to the change tracker

`Protected` `Readonly`entryPool

entryPool: Pool<E>

Object pool for batch entries

`Readonly`maxSize

maxSize: number

Max size of a batch. Unit depends on batcher.

`Protected` `Readonly`objectBatches

objectBatches: Map<O, B> = ...

For faster lookup of object -> batch.

`Protected` `Readonly`queuedAdds

queuedAdds: E[] = []

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

Methods

`Abstract`add

add(object: O): this
Add an object to the batcher.
Parameters
- object: O
  Object to add
Returns this
Implementation of ObjectSet.add
- Defined in rendering/batching/batcher.ts:71

`Protected`addEntryQueued

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

`Protected` `Abstract`addToBatch

addToBatch(batch: B, entry: E): void
Add an entry to a batch.
Parameters
- batch: B
  Batch to add entry to
- entry: E
  Entry to add
Returns void
- Defined in rendering/batching/batcher.ts:274

`Protected` `Abstract`canBatchInclude

canBatchInclude(batch: B, entry: E): boolean
Check if a batch can contain an entry.
Parameters
- batch: B
  Batch to check
- entry: E
  Entry
Returns boolean
- Defined in rendering/batching/batcher.ts:281

change

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

`Protected` `Abstract`changeEntry

changeEntry(batch: undefined | B, entry: E, object: O): void
Apply changes of an object to its entry (and possible batch).
Parameters
- batch: undefined | B
  Batch entry belongs to. Can be undefined in case entry does not have a batch (e.g., when only queued for an add)
- entry: E
  Entry to change
- object: O
  Associated object
Returns void
- Defined in rendering/batching/batcher.ts:263

clear

clear(): void
Returns void
Implementation of ObjectSet.clear
- Defined in rendering/batching/batcher.ts:179

delete

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

finalize

finalize(): readonly B[]
Finalize batches for this tick by applying all queued changes, adding all queued new entries, and cleaning up unused batches.

Returns readonly B[]
Finalized batches
- Defined in rendering/batching/batcher.ts:200

has

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

Class Batcher<O, E, B>Abstract

Remarks

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Batcher<O, E, B>

Properties

Protected Readonly_batches

Readonlybatches

Protected ReadonlybatchPool

Protected ReadonlychangeTracker

Protected ReadonlyentryPool

ReadonlymaxSize

Protected ReadonlyobjectBatches

Protected ReadonlyqueuedAdds

Methods

Abstractadd

Parameters

Returns this

ProtectedaddEntryQueued

Parameters

Returns void

Protected AbstractaddToBatch

Parameters

Returns void

Protected AbstractcanBatchInclude

Parameters

Returns boolean

change

Parameters

Returns void

Protected AbstractchangeEntry

Parameters

Returns void

clear

Returns void

delete

Parameters

Returns boolean

finalize

Returns readonly B[]

has

Parameters

Returns boolean

Settings

On This Page

Class Batcher<O, E, B>`Abstract`

`Protected` `Readonly`_batches

`Readonly`batches

`Protected` `Readonly`batchPool

`Protected` `Readonly`changeTracker

`Protected` `Readonly`entryPool

`Readonly`maxSize

`Protected` `Readonly`objectBatches

`Protected` `Readonly`queuedAdds

`Abstract`add

`Protected`addEntryQueued

`Protected` `Abstract`addToBatch

`Protected` `Abstract`canBatchInclude

`Protected` `Abstract`changeEntry