Class SpriteBatch<O, E>

Type Parameters

O extends SpriteLike = SpriteLike
E extends SpriteBatchEntry<O> = SpriteBatchEntry<O>

Hierarchy (View Summary)

SpriteBatchBase<O, E>
- SpriteBatch

Index

Constructors

Properties

entries queuedChanges size sizes storage? textureOrderChanged

Accessors

textureCount textures

Methods

addEntry clear getTextureIndex hasTexture onDeleteEntry

Constructors

constructor

new SpriteBatch<
O extends SpriteLike = SpriteLike,
E extends SpriteBatchEntry<O> = SpriteBatchEntry<O>,
>(): SpriteBatch<O, E>
Type Parameters
- O extends SpriteLike = SpriteLike
- E extends SpriteBatchEntry<O> = SpriteBatchEntry<O>
Returns SpriteBatch<O, E>
Inherited from SpriteBatchBase.constructor

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.

`Optional`storage

storage?: SpriteBatchStorage<O>

textureOrderChanged

textureOrderChanged: boolean = false

Accessors

textureCount

get textureCount(): number
Returns number
Inherited from SpriteBatchBase.textureCount
- Defined in renderers/textured/batching.ts:19

textures

get textures(): readonly TextureHandle[]
Returns readonly TextureHandle[]
Inherited from SpriteBatchBase.textures
- Defined in renderers/textured/batching.ts:23

Methods

addEntry

addEntry(entry: E): this
Add an entry to the batch.
Parameters
- entry: E
  Entry to add
Returns this
Self
Inherited from SpriteBatchBase.addEntry
- Defined in renderers/textured/batching.ts:41

clear

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

Returns void
Inherited from SpriteBatchBase.clear
- Defined in renderers/textured/batching.ts:67

getTextureIndex

getTextureIndex(tex: TextureHandle): undefined | number
Parameters
- tex: TextureHandle
Returns undefined | number
Inherited from SpriteBatchBase.getTextureIndex
- Defined in renderers/textured/batching.ts:31

hasTexture

hasTexture(tex: TextureHandle): boolean
Parameters
- tex: TextureHandle
Returns boolean
Inherited from SpriteBatchBase.hasTexture
- Defined in renderers/textured/batching.ts:27

onDeleteEntry

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