Class default

SpriteBatch for WebGl 1

Hierarchy

SpriteBatchBase
- default

Index

Constructors

constructor

new default(context: default, capacity: number, depthOffset: number, yOffset: number, enableAlphaMultiplcation: boolean, enforceBeginAndEnd: boolean): default
Parameters
- context: default
- capacity: number
- depthOffset: number
- yOffset: number
- enableAlphaMultiplcation: boolean
- enforceBeginAndEnd: boolean
Returns default
Inherited from SpriteBatchBase.constructor
- Defined in src/game/renderer/spriteBatch/SpriteBatchBase.ts:57

Properties

`Protected` _setup

_setup: boolean

`Protected` begun

begun: boolean

`Readonly` capacity

capacity: number

`Protected` colorArray

colorArray: Uint8Array

`Protected` `Readonly` colorBuffer

colorBuffer: WebGLBuffer

`Protected` `Readonly` context

context: default

`Protected` dataArray

dataArray: Float32Array

`Protected` `Readonly` dataBuffer

dataBuffer: WebGLBuffer

`Protected` `Readonly` depthOffset

depthOffset: number

`Protected` `Readonly` enableAlphaMultiplcation

enableAlphaMultiplcation: boolean

`Protected` `Readonly` enforceBeginAndEnd

enforceBeginAndEnd: boolean

inverseSpriteTextureSize

inverseSpriteTextureSize: undefined | default

`Protected` `Readonly` shaderProgram

shaderProgram: default

`Protected` spriteCount

spriteCount: number

`Protected` `Readonly` texCordBuffer

texCordBuffer: WebGLBuffer

texSprites

texSprites: undefined | WebGLTexture

`Protected` `Readonly` yOffset

yOffset: number

Methods

add

add(tileX: number, tileY: number, spriteSize: number, sourceX: number, sourceY: number, sourceSize: number, offsetX?: number, offsetY?: number, red?: number, green?: number, blue?: number, alpha?: number): undefined | number
Parameters
- tileX: number
- tileY: number
- spriteSize: number
- sourceX: number
- sourceY: number
- sourceSize: number
- offsetX: number = 0
- offsetY: number = 0
- red: number = 255
- green: number = 255
- blue: number = 255
- alpha: number = 255
Returns undefined | number
Inherited from SpriteBatchBase.add
- Defined in src/game/renderer/spriteBatch/SpriteBatchBase.ts:106

begin

begin(): void
Returns void
Inherited from SpriteBatchBase.begin
- Defined in src/game/renderer/spriteBatch/SpriteBatchBase.ts:97

bindBuffers

bindBuffers(): void
Returns void
Overrides SpriteBatchBase.bindBuffers
- Defined in src/game/renderer/spriteBatch/SpriteBatch1.ts:50

delete

delete(): void
Returns void
Inherited from SpriteBatchBase.delete
- Defined in src/game/renderer/spriteBatch/SpriteBatchBase.ts:91

end

end(): number
Binds sprites to be included in the next render

Returns
number of sprites being rendered

Returns number
Inherited from SpriteBatchBase.end
- Defined in src/game/renderer/spriteBatch/SpriteBatchBase.ts:177

remove

remove(index: number): boolean
Parameters
- index: number
Returns boolean
Inherited from SpriteBatchBase.remove
- Defined in src/game/renderer/spriteBatch/SpriteBatchBase.ts:163

render

render(x: number, y: number, tileScale: number, viewportWidth: number, viewportHeight: number): void
Parameters
- x: number
- y: number
- tileScale: number
- viewportWidth: number
- viewportHeight: number
Returns void
Overrides SpriteBatchBase.render
- Defined in src/game/renderer/spriteBatch/SpriteBatch1.ts:62

setup

setup(): void
Returns void
Overrides SpriteBatchBase.setup
- Defined in src/game/renderer/spriteBatch/SpriteBatch1.ts:20

update

update(index: number, tileX: number, tileY: number, spriteSize: number, sourceX: number, sourceY: number, sourceSize: number, offsetX?: number, offsetY?: number, red?: number, green?: number, blue?: number, alpha?: number): void
Parameters
- index: number
- tileX: number
- tileY: number
- spriteSize: number
- sourceX: number
- sourceY: number
- sourceSize: number
- offsetX: number = 0
- offsetY: number = 0
- red: number = 255
- green: number = 255
- blue: number = 255
- alpha: number = 255
Returns void
Inherited from SpriteBatchBase.update
- Defined in src/game/renderer/spriteBatch/SpriteBatchBase.ts:143

`Static` initializePrograms

initializePrograms(webGlContext: default): Promise<void>
Parameters
- webGlContext: default
Returns Promise<void>
Inherited from SpriteBatchBase.initializePrograms
- Defined in src/game/renderer/spriteBatch/SpriteBatchBase.ts:53

Generated using TypeDoc