Class SpriteBatcher<O>

Type Parameters

O extends SpriteLike = SpriteLike

Hierarchy (View Summary)

SpriteBatcherBase<O, E<O>, B<O>>
- SpriteBatcher

Constructors

constructor

new SpriteBatcher<O extends SpriteLike = SpriteLike>(
changeTracker: ChangeTracker,
): SpriteBatcher<O>
Create a new instance.
Type Parameters
- O extends SpriteLike = SpriteLike
Parameters
- changeTracker: ChangeTracker
  Changes to objects will be propagated to the change tracker
Returns SpriteBatcher<O>
Inherited from SpriteBatcherBase.constructor
- Defined in rendering/batching/batcher.ts:69

Properties

`Protected` `Readonly`batches

batches: B<O>[] = []

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

`Protected` `Readonly`batchPool

batchPool: Pool<SpriteBatch<O, E<O>>> = ...

`Protected` `Readonly`changeTracker

changeTracker: ChangeTracker

Changes to objects will be propagated to the change tracker

`Protected` `Readonly`entryPool

entryPool: Pool<SpriteBatchEntry<O>> = ...

`Protected` `Optional`maximums

maximums?: { maxSpriteCount: number; maxTextureCount: number }

`Protected` `Readonly`queuedEntries

queuedEntries: E<O>[] = []

New entries are queued until all changes are applied to a batch.

Accessors

maxSpriteCount

get maxSpriteCount(): undefined | number
Returns undefined | number
Inherited from SpriteBatcherBase.maxSpriteCount
- Defined in renderers/sprite/sprite-batcher-base.ts:38

maxTextureCount

get maxTextureCount(): undefined | number
Returns undefined | number
Inherited from SpriteBatcherBase.maxTextureCount
- Defined in renderers/sprite/sprite-batcher-base.ts:34

size

get size(): number
Entries across all batches. Does not respect queued adds/deletes.

Returns number
Inherited from SpriteBatcherBase.size
- Defined in rendering/batching/batcher.ts:51

Methods

add

add(object: O): E
Add an object to the batcher. Additions are queued, apply with Batcher#finalize.
Parameters
- object: O
  Object to add
Returns E
Created entry

Remarks
If called more than once with the same object, more than one entry will be created.
Inherited from SpriteBatcherBase.add
- Defined in rendering/batching/batcher.ts:78

`Protected`addToBatch

addToBatch(entry: E, batch: B): void
Add entry to batch.
Parameters
- entry: E
  Entry
- batch: B
  Batch
Returns void
Inherited from SpriteBatcherBase.addToBatch
- Defined in rendering/batching/batcher.ts:590

`Protected`applyBatchChanges

applyBatchChanges(batch: B<O>): void
Apply only entries with queued changes. Entries in between will may be moved if gaps occur or space is needed.
Parameters
- batch: B<O>
  Batch
Returns void
Overrides SpriteBatcherBase.applyBatchChanges
- Defined in renderers/sprite/sprite-batcher.ts:34

`Protected`applyEntryChange

applyEntryChange(entry: E<O>, batch: B<O>, offset: number): void
Called when an entry change is applied.
Parameters
- entry: E<O>
  Changed entry
- batch: B<O>
  Batch containing entry
- offset: number
  Element offset in batch
Returns void
Overrides SpriteBatcherBase.applyEntryChange
- Defined in renderers/sprite/sprite-batcher.ts:66

`Protected`applyQueuedChanges

applyQueuedChanges(): void
Apply all queued changes.

Returns void
Inherited from SpriteBatcherBase.applyQueuedChanges
- Defined in rendering/batching/batcher.ts:237

`Protected`applyQueuedEntries

applyQueuedEntries(): void
Distribute queued new entries into batches. May create new batches if needed.

Returns void
Inherited from SpriteBatcherBase.applyQueuedEntries
- Defined in rendering/batching/batcher.ts:473

`Protected`canAddToBatch

canAddToBatch(entry: E, batch: B, additionalSize?: number): boolean
Check if entry can be added to batch.
Parameters
- entry: E
  Entry
- batch: B
  Batch
- OptionaladditionalSize: number
  Optional, if set this is the additional size required
Returns boolean
true if entry fits into batch
Inherited from SpriteBatcherBase.canAddToBatch
- Defined in renderers/sprite/sprite-batcher-base.ts:64

change

change(entry: E): boolean
Mark an entry as changed. Changes are queued, apply with Batcher#finalize.
Parameters
- entry: E
  Changed entry
Returns boolean
true if the entry was present

Remarks
Change handling code for the given entry will only be called once, even if this method is called multiple times with the same entry.
Inherited from SpriteBatcherBase.change
- Defined in rendering/batching/batcher.ts:138

`Protected`changeEntry

changeEntry(entry: E, batch: undefined | B<O>): void
Called when an entry is marked as changed. Should set sizes and any other properties.
Parameters
- entry: E
  Entry
- batch: undefined | B<O>
  Batch containing entry
Returns void
Inherited from SpriteBatcherBase.changeEntry
- Defined in renderers/sprite/sprite-batcher-base.ts:87

clear

clear(): void
Clear batcher of all batches and entries.

Returns void
Inherited from SpriteBatcherBase.clear
- Defined in rendering/batching/batcher.ts:204

`Protected`clearBatch

clearBatch(batch: B): void
Clear a batch of all its entries. Batcher#discardEntry should be called for each entry.
Parameters
- batch: B
  Batch
Returns void
Inherited from SpriteBatcherBase.clearBatch
- Defined in rendering/batching/batcher.ts:563

`Protected`copyWithinStorage

copyWithinStorage(batch: B<O>, target: number, start: number, end: number): void
Move data within a batch. Used if e.g. entries change size and multiple entries must be moved to fill gaps or crate space.
Parameters
- batch: B<O>
  Affected batch
- target: number
  Target element offset
- start: number
  Start element offset
- end: number
  End element offset
Returns void
Remarks
Generally should call copyWithin on batch storage or its buffer.
Overrides SpriteBatcherBase.copyWithinStorage
- Defined in renderers/sprite/sprite-batcher.ts:78

`Protected`createBatch

createBatch(): B<O>
Create a batch.

Returns B<O>
Remarks
If using a batch pool, take from the pool here.
Overrides SpriteBatcherBase.createBatch
- Defined in renderers/sprite/sprite-batcher.ts:42

`Protected`createEntry

createEntry(object: O): E<O>
Create an entry for object.
Parameters
- object: O
  Object
Returns E<O>
Created entry

Remarks
If using an entry pool, take from pool here.
Overrides SpriteBatcherBase.createEntry
- Defined in renderers/sprite/sprite-batcher.ts:52

delete

delete(entry: E): boolean
Delete an entry. Deletes are queued unless the entry is itself queued for add, apply with Batcher#finalize.
Parameters
- entry: E
  Entry
Returns boolean
true if an entry was deleted/queued

Remarks
Deletion be done once, even if this method is called multiple times with the same entry.
Inherited from SpriteBatcherBase.delete
- Defined in rendering/batching/batcher.ts:173

`Protected`discardBatch

discardBatch(batch: B<O>): void
Discard a batch. Should call Batcher#clearBatch.
Parameters
- batch: B<O>
  Batch
Returns void
Remarks
If using a batch pool, return to the pool here.
Overrides SpriteBatcherBase.discardBatch
- Defined in renderers/sprite/sprite-batcher.ts:46

`Protected`discardBatches

discardBatches(): void
Discard empty batches.

Returns void
Inherited from SpriteBatcherBase.discardBatches
- Defined in rendering/batching/batcher.ts:523

`Protected`discardEntry

discardEntry(entry: E<O>): void
Discard an entry.
Parameters
- entry: E<O>
  Entry
Returns void
Remarks
If using an entry pool, return to pool here.
Overrides SpriteBatcherBase.discardEntry
- Defined in renderers/sprite/sprite-batcher.ts:62

finalize

finalize(): readonly B<O>[]
Applies all queued additions, changes, and deletions.

Returns readonly B<O>[]
Finalized batches
Inherited from SpriteBatcherBase.finalize
- Defined in rendering/batching/batcher.ts:224

getEntry

getEntry(object: O): undefined | E<O>
Find an entry for object by doing a linear search through all batches and entries.
Parameters
- object: O
  Object to find entry for
Returns undefined | E<O>
First entry, if present

Remarks
If Batcher#add was called multiple times with the same object, multiple entries can exist for the same object. In this case this method returns only the first entry it finds.

Generally, the returned entry from Batcher#add should be stored to then reuse it for Batcher#change and Batcher#change calls.
Inherited from SpriteBatcherBase.getEntry
- Defined in rendering/batching/batcher.ts:97

`Protected`onDeleteEntry

onDeleteEntry(entry: E, batch: B): void
Called when an entry was removed from a batch.
Parameters
- entry: E
  Deleted entry
- batch: B
  Batch containing entry
Returns void
Inherited from SpriteBatcherBase.onDeleteEntry
- Defined in rendering/batching/batcher.ts:648

`Protected`queueEntry

queueEntry(entry: E): void
Queue an entry to be added.
Parameters
- entry: E
  New entry
Returns void
Inherited from SpriteBatcherBase.queueEntry
- Defined in rendering/batching/batcher.ts:658

`Protected`queueEntryChange

queueEntryChange(entry: E, batch: B): void
Queue an entry change.
Parameters
- entry: E
  Changed entry
- batch: B
  Batch containing entry
Returns void
Inherited from SpriteBatcherBase.queueEntryChange
- Defined in rendering/batching/batcher.ts:669

`Protected`rebuildBatch

rebuildBatch(batch: B): void
Completely rebuild batch, going through all entries.
Parameters
- batch: B
  Batch
Returns void
Inherited from SpriteBatcherBase.rebuildBatch
- Defined in rendering/batching/batcher.ts:270

setMaximums

setMaximums(maxTextureCount: number, maxSpriteCount?: number): void
Parameters
- maxTextureCount: number
- OptionalmaxSpriteCount: number
Returns void
Inherited from SpriteBatcherBase.setMaximums
- Defined in renderers/sprite/sprite-batcher-base.ts:42

`Protected`shouldRebuildBatch

shouldRebuildBatch(batch: B): boolean
Decide if a batch should be completely rebuilt. Generally this should be true if most/all of the batch's entries must be processed anyways.
Parameters
- batch: B
  Batch
Returns boolean
true if batch should be rebuilt.
Inherited from SpriteBatcherBase.shouldRebuildBatch
- Defined in renderers/sprite/sprite-batcher-base.ts:56

`Protected`updateBatch

updateBatch(batch: B): void
Update batch. Should call either Batcher#rebuildBatch or Batcher#applyBatchChanges.
Parameters
- batch: B
  Batch
Returns void
Inherited from SpriteBatcherBase.updateBatch
- Defined in rendering/batching/batcher.ts:258

Class SpriteBatcher<O>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns SpriteBatcher<O>

Properties

Protected Readonlybatches

Protected ReadonlybatchPool

Protected ReadonlychangeTracker

Protected ReadonlyentryPool

Protected Optionalmaximums

Protected ReadonlyqueuedEntries

Accessors

maxSpriteCount

Returns undefined | number

maxTextureCount

Returns undefined | number

size

Returns number

Methods

add

Parameters

Returns E

Remarks

ProtectedaddToBatch

Parameters

Returns void

ProtectedapplyBatchChanges

Parameters

Returns void

ProtectedapplyEntryChange

Parameters

Returns void

ProtectedapplyQueuedChanges

Returns void

ProtectedapplyQueuedEntries

Returns void

ProtectedcanAddToBatch

Parameters

Returns boolean

change

Parameters

Returns boolean

Remarks

ProtectedchangeEntry

Parameters

Returns void

clear

Returns void

ProtectedclearBatch

Parameters

Returns void

ProtectedcopyWithinStorage

Parameters

Returns void

Remarks

ProtectedcreateBatch

Returns B<O>

Remarks

ProtectedcreateEntry

Parameters

Returns E<O>

Remarks

delete

Parameters

Returns boolean

Remarks

ProtecteddiscardBatch

Parameters

Returns void

Remarks

ProtecteddiscardBatches

`Protected` `Readonly`batches

`Protected` `Readonly`batchPool

`Protected` `Readonly`changeTracker

`Protected` `Readonly`entryPool

`Protected` `Optional`maximums

`Protected` `Readonly`queuedEntries

`Protected`addToBatch

`Protected`applyBatchChanges

`Protected`applyEntryChange

`Protected`applyQueuedChanges

`Protected`applyQueuedEntries

`Protected`canAddToBatch

`Protected`changeEntry

`Protected`clearBatch

`Protected`copyWithinStorage

`Protected`createBatch

`Protected`createEntry

`Protected`discardBatch

`Protected`discardBatches

`Protected`discardEntry

`Protected`onDeleteEntry

`Protected`queueEntry

`Protected`queueEntryChange

`Protected`rebuildBatch

`Protected`shouldRebuildBatch

`Protected`updateBatch