API Docs for: 1.5.0
Show:

WebGLSpriteBatch Class

Defined in: src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js:11
Module: PIXI

Constructor

WebGLSpriteBatch

(
  • gl
)
private

Defined in src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js:11

Parameters:

  • gl WebGLContext

    the current WebGL drawing context

Methods

begin

(
  • renderSession
)

Defined in src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js:108

Parameters:

  • renderSession RenderSession

    the RenderSession

destroy

()

Defined in src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js:477

Destroys the SpriteBatch

flush

()

Defined in src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js:376

Renders the content and empties the current batch

render

(
  • sprite
)

Defined in src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js:132

Parameters:

  • sprite Sprite

    the sprite to render when using this spritebatch

renderTilingSprite

(
  • sprite
)

Defined in src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js:251

Renders a tilingSprite using the spriteBatch

Parameters:

setBlendMode

(
  • blendMode
)

Defined in src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js:461

Sets-up the given blendMode from WebGL's point of view

Parameters:

  • blendMode Number

    the blendMode, should be a Pixi const, such as PIXI.BlendModes.ADD

setContext

(
  • gl
)

Defined in src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js:81

Parameters:

  • gl WebGLContext

    the current WebGL drawing context

Properties

indices

Uint16Array

Defined in src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js:53

Holds the indices

size

Number

Defined in src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js:30

The number of images in the SpriteBatch before it flushes

vertices

Float32Array

Defined in src/pixi/renderers/webgl/utils/WebGLSpriteBatch.js:44

Holds the vertices