API Docs for: 1.2.1
Show:

WebGLBatch Class

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.

Methods

init

(
  • sprite
)

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

insertAfter

(
  • sprite
  • previousSprite
)

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
)

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

merge

(
  • batch
)

Merges two batchs together

Parameters:

refresh

()

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

remove

(
  • sprite
)

removes a sprite from the batch

Parameters:

  • sprite Sprite

    the sprite to be removed

render

()

Draws the batch to the frame buffer

split

(
  • sprite
)
WebGLBatch

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

()

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