API Docs for: 1.3.0
Show:

WebGLBatch Class

Defined in: src/pixi/renderers/webgl/WebGLRenderGroup.js:5
Module: PIXI

A WebGLBatch Enables a group of sprites to be drawn using the same settings. if a group of sprites all have the same baseTexture and blendMode then they can be grouped into a batch. All the sprites in a batch can then be drawn in one go by the GPU which is hugely efficient. ALL sprites in the webGL renderer are added to a batch even if the batch only contains one sprite. Batching is handled automatically by the webGL renderer. A good tip is: the smaller the number of batchs there are, the faster the webGL renderer will run.

Constructor

WebGLBatch

(
  • gl
)

Defined in src/pixi/renderers/webgl/WebGLRenderGroup.js:5

Parameters:

  • gl WebGLContext

    an instance of the webGL context

Methods

addDisplayObjectAndChildren

(
  • displayObject
)
private

Defined in src/pixi/renderers/webgl/WebGLRenderGroup.js:430

Adds a display object and children to the webgl context

Parameters:

addFilterBlocks

(
  • start
  • end
)
private

Defined in src/pixi/renderers/webgl/WebGLRenderGroup.js:376

Adds filter blocks

Parameters:

  • start FilterBlock
  • end FilterBlock

clean

()

Defined in src/pixi/renderers/webgl/WebGLBatch.js:71

Cleans the batch so that is can be returned to an object pool and reused

growBatch

()

Defined in src/pixi/renderers/webgl/WebGLBatch.js:292

Grows the size of the batch. As the elements in the batch cannot have a dynamic size this function is used to increase the size of the batch. It also creates a little extra room so that the batch does not need to be resized every time a sprite is added

init

(
  • sprite
)

Defined in src/pixi/renderers/webgl/WebGLBatch.js:105

inits the batch's texture and blend mode based if the supplied sprite

Parameters:

  • sprite Sprite

    the first sprite to be added to the batch. Only sprites with the same base texture and blend mode will be allowed to be added to this batch

initStrip

(
  • strip
)
private

Defined in src/pixi/renderers/webgl/WebGLRenderGroup.js:974

Initializes a strip to be rendered

Parameters:

  • strip Strip

    The strip to initialize

initTilingSprite

(
  • sprite
)
private

Defined in src/pixi/renderers/webgl/WebGLRenderGroup.js:781

Initializes a tiling sprite

Parameters:

insertAfter

(
  • item
  • displayObject
)
private

Defined in src/pixi/renderers/webgl/WebGLRenderGroup.js:647

Inserts a displayObject into the linked list

Parameters:

insertAfter

(
  • sprite
  • previousSprite
)

Defined in src/pixi/renderers/webgl/WebGLBatch.js:153

inserts a sprite after the specified sprite

Parameters:

  • sprite Sprite

    the sprite to be added

  • previousSprite Sprite

    the first sprite will be inserted after this sprite

insertBefore

(
  • sprite
  • nextSprite
)

Defined in src/pixi/renderers/webgl/WebGLBatch.js:125

inserts a sprite before the specified sprite

Parameters:

  • sprite Sprite

    the sprite to be added

  • nextSprite NextSprite

    the first sprite will be inserted before this sprite

insertObject

(
  • displayObject
  • previousObject
  • nextObject
)
private

Defined in src/pixi/renderers/webgl/WebGLRenderGroup.js:509

Inserts a displayObject into the linked list

Parameters:

merge

(
  • batch
)

Defined in src/pixi/renderers/webgl/WebGLBatch.js:267

Merges two batchs together

Parameters:

refresh

()

Defined in src/pixi/renderers/webgl/WebGLBatch.js:347

Refresh's all the data in the batch and sync's it with the webGL buffers

remove

(
  • sprite
)

Defined in src/pixi/renderers/webgl/WebGLBatch.js:182

removes a sprite from the batch

Parameters:

  • sprite Sprite

    the sprite to be removed

removeDisplayObjectAndChildren

(
  • displayObject
)
private

Defined in src/pixi/renderers/webgl/WebGLRenderGroup.js:487

Removes a display object and children to the webgl context

Parameters:

removeFilterBlocks

(
  • start
  • end
)
private

Defined in src/pixi/renderers/webgl/WebGLRenderGroup.js:416

Remove filter blocks

Parameters:

  • start FilterBlock
  • end FilterBlock

removeObject

(
  • displayObject
)
private

Defined in src/pixi/renderers/webgl/WebGLRenderGroup.js:702

Removes a displayObject from the linked list

Parameters:

render

()

Defined in src/pixi/renderers/webgl/WebGLBatch.js:508

Draws the batch to the frame buffer

render

(
  • projection
)

Defined in src/pixi/renderers/webgl/WebGLRenderGroup.js:55

Renders the stage to its webgl view

Parameters:

  • projection Object

renderSpecial

(
  • renderable
  • projection
)
private

Defined in src/pixi/renderers/webgl/WebGLRenderGroup.js:251

Renders a specific renderable

Parameters:

renderSpecific

(
  • displayObject
  • projection
)
private

Defined in src/pixi/renderers/webgl/WebGLRenderGroup.js:91

Renders a specific displayObject

Parameters:

renderStrip

(
  • strip
  • projection
)
private

Defined in src/pixi/renderers/webgl/WebGLRenderGroup.js:840

Renders a Strip

Parameters:

  • strip Strip

    The strip to render

  • projection Object

renderTilingSprite

(
  • sprite
  • projectionMatrix
)
private

Defined in src/pixi/renderers/webgl/WebGLRenderGroup.js:932

Renders a TilingSprite

Parameters:

  • sprite TilingSprite

    The tiling sprite to render

  • projectionMatrix Object

restoreLostContext

(
  • gl
)

Defined in src/pixi/renderers/webgl/WebGLBatch.js:90

Recreates the buffers in the event of a context loss

Parameters:

  • gl WebGLContext

setRenderable

(
  • displayObject
)
private

Defined in src/pixi/renderers/webgl/WebGLRenderGroup.js:33

Add a display object to the webgl renderer

Parameters:

split

(
  • sprite
)
WebGLBatch

Defined in src/pixi/renderers/webgl/WebGLBatch.js:226

Splits the batch into two with the specified sprite being the start of the new batch.

Parameters:

  • sprite Sprite

    the sprite that indicates where the batch should be split

Returns:

WebGLBatch:

the new batch

update

()

Defined in src/pixi/renderers/webgl/WebGLBatch.js:403

Updates all the relevant geometry and uploads the data to the GPU

updateTexture

(
  • displayObject
)
private

Defined in src/pixi/renderers/webgl/WebGLRenderGroup.js:334

Updates a webgl texture

Parameters: