Class default

SpriteBatch for WebGl 2

Hierarchy

SpriteBatchWebGlBase
- default

Constructors

constructor

new default(context: WebGlRendererContext, id: string, capacity: number, depthOffset: number, yOffset: number, enableAlphaMultiplcation: boolean, enforceBeginAndEnd: boolean): default
Parameters
- context: WebGlRendererContext
- id: string
- capacity: number
- depthOffset: number
- yOffset: number
- enableAlphaMultiplcation: boolean
- enforceBeginAndEnd: boolean
Returns default
Overrides SpriteBatchWebGlBase.constructor
- Defined in src/game/renderer/platform/webgl/SpriteBatchWebGl2.ts:23

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: WebGlRendererContext

`Protected` dataArray

dataArray: Float32Array

`Protected` `Readonly` dataBuffer

dataBuffer: WebGLBuffer

`Protected` `Readonly` depthOffset

depthOffset: number

`Protected` `Readonly` enableAlphaMultiplcation

enableAlphaMultiplcation: boolean

`Protected` `Readonly` enforceBeginAndEnd

enforceBeginAndEnd: boolean

`Readonly` id

id: string

inverseSpriteTextureSize

inverseSpriteTextureSize: undefined | default

`Protected` requiresSubpixels

requiresSubpixels: boolean

`Protected` `Readonly` shaderProgram

shaderProgram: default

`Protected` spriteCount

spriteCount: number

`Protected` `Readonly` texCordBuffer

texCordBuffer: WebGLBuffer

texSprites

texSprites: undefined | WebGLTexture

`Protected` `Readonly` vertexArray

vertexArray: WebGLVertexArrayObject

`Protected` `Readonly` yRenderOffset

yRenderOffset: 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 SpriteBatchWebGlBase.add
- Defined in src/game/renderer/platform/webgl/SpriteBatchWebGlBase.ts:110

begin

begin(): void
Returns void
Inherited from SpriteBatchWebGlBase.begin
- Defined in src/game/renderer/platform/webgl/SpriteBatchWebGlBase.ts:100

bindBuffers

bindBuffers(): void
Returns void
Overrides SpriteBatchWebGlBase.bindBuffers
- Defined in src/game/renderer/platform/webgl/SpriteBatchWebGl2.ts:120

delete

delete(): void
Returns void
Overrides SpriteBatchWebGlBase.delete
- Defined in src/game/renderer/platform/webgl/SpriteBatchWebGl2.ts:114

end

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

Returns
number of sprites being rendered

Returns number
Inherited from SpriteBatchWebGlBase.end
- Defined in src/game/renderer/platform/webgl/SpriteBatchWebGlBase.ts:186

remove

remove(index: number): boolean
Parameters
- index: number
Returns boolean
Inherited from SpriteBatchWebGlBase.remove
- Defined in src/game/renderer/platform/webgl/SpriteBatchWebGlBase.ts:172

render

render(x: number, y: number, tileScale: number, viewportWidth: number, viewportHeight: number, blend?: boolean): void
Parameters
- x: number
- y: number
- tileScale: number
- viewportWidth: number
- viewportHeight: number
- Optional blend: boolean
Returns void
Overrides SpriteBatchWebGlBase.render
- Defined in src/game/renderer/platform/webgl/SpriteBatchWebGl2.ts:132

setup

setup(): void
Returns void
Overrides SpriteBatchWebGlBase.setup
- Defined in src/game/renderer/platform/webgl/SpriteBatchWebGl2.ts:78

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 SpriteBatchWebGlBase.update
- Defined in src/game/renderer/platform/webgl/SpriteBatchWebGlBase.ts:152

`Static` initializePrograms

initializePrograms(webGlContext: WebGlContext): Promise<void>
Parameters
- webGlContext: WebGlContext
Returns Promise<void>
Inherited from SpriteBatchWebGlBase.initializePrograms
- Defined in src/game/renderer/platform/webgl/SpriteBatchWebGlBase.ts:55

Class default

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

context: WebGlRendererContext

id: string

capacity: number

depthOffset: number

yOffset: number

enableAlphaMultiplcation: boolean

enforceBeginAndEnd: boolean

Returns default

Properties

Protected _setup

Protected begun

Readonly capacity

Protected colorArray

Protected Readonly colorBuffer

Protected Readonly context

Protected dataArray

Protected Readonly dataBuffer

Protected Readonly depthOffset

Protected Readonly enableAlphaMultiplcation

Protected Readonly enforceBeginAndEnd

Readonly id

inverseSpriteTextureSize

Protected requiresSubpixels

Protected Readonly shaderProgram

Protected spriteCount

Protected Readonly texCordBuffer

texSprites

Protected Readonly vertexArray

Protected Readonly yRenderOffset

Methods

add

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

begin

Returns void

bindBuffers

Returns void

delete

Returns void

end

Returns

Returns number

remove

Parameters

index: number

Returns boolean

render

Parameters

x: number

y: number

tileScale: number

viewportWidth: number

viewportHeight: number

Optional blend: boolean

Returns void

setup

Returns void

update

Parameters

`Protected` _setup

`Protected` begun

`Readonly` capacity

`Protected` colorArray

`Protected` `Readonly` colorBuffer

`Protected` `Readonly` context

`Protected` dataArray

`Protected` `Readonly` dataBuffer

`Protected` `Readonly` depthOffset

`Protected` `Readonly` enableAlphaMultiplcation

`Protected` `Readonly` enforceBeginAndEnd

`Readonly` id

`Protected` requiresSubpixels

`Protected` `Readonly` shaderProgram

`Protected` spriteCount

`Protected` `Readonly` texCordBuffer

`Protected` `Readonly` vertexArray

`Protected` `Readonly` yRenderOffset

`Optional` blend: boolean

`Static` initializePrograms