SpriteBatch

Using a single image, draw any number of identical copies of the image using a single call to love.graphics.draw(). This can be used, for example, to draw repeating copies of a single background image with high performance.

A SpriteBatch can be even more useful when the underlying image is a texture atlas (a single image file containing many independent images); by adding Quads to the batch, different sub-images from within the atlas can be drawn.

Constructors

love.graphics.newSpriteBatch Creates a new SpriteBatch.

Functions

Object:type Gets the type of the object as a string.
Object:typeOf Checks whether an object is of a certain type.
SpriteBatch:add Adds a sprite to the batch.
SpriteBatch:addq Adds a Quad to the batch. 0.9.0
SpriteBatch:attachAttribute Attaches a per-vertex attribute from a Mesh onto this SpriteBatch, for use when drawing. 0.10.0
SpriteBatch:bind Binds the SpriteBatch to memory for more efficient updating. 0.8.0 0.10.0
SpriteBatch:clear Removes all sprites from the buffer.
SpriteBatch:flush Immediately sends all new and modified sprite data to the graphics card. 0.9.2
SpriteBatch:getBufferSize Gets the maximum number of sprites the SpriteBatch can hold. 0.9.0
SpriteBatch:getColor Gets the color that will be used for the next add and set operations. 0.9.0
SpriteBatch:getCount Gets the number of sprites currently in the SpriteBatch. 0.9.0
SpriteBatch:getImage Returns the image used by the SpriteBatch. 0.8.0 0.10.0
SpriteBatch:getTexture Gets the texture (Image or Canvas) used by the SpriteBatch. 0.9.1
SpriteBatch:set Changes a sprite in the batch. 0.8.0
SpriteBatch:setBufferSize Sets the maximum number of sprites the SpriteBatch can hold. 0.9.0
SpriteBatch:setColor Sets the color that will be used for the next add or set operations. 0.8.0
SpriteBatch:setImage Replaces the image used for the sprites. 0.7.2 0.10.0
SpriteBatch:setTexture Sets the texture (Image or Canvas) used for the sprites in the batch. 0.9.1
SpriteBatch:setq Changes a sprite with a quad in the batch. 0.8.0 0.9.0
SpriteBatch:unbind Unbinds the SpriteBatch. 0.8.0 0.10.0

Enums

SpriteBatchUsage Usage hints for SpriteBatches and Meshes. 0.8.0

Supertypes

See Also


SpriteBatch:setBufferSize

SpriteBatch:setBufferSize Available since LÖVE 0.9.0 This function is not supported in earlier versions. Sets the maximum number of sprites

2017-03-21 15:53:40
SpriteBatch:lock

SpriteBatch:lock This has been changed to SpriteBatch:bind

2017-03-21 15:53:39
SpriteBatch:getTexture

SpriteBatch:getTexture Available since LÖVE 0.9.1 This function is not supported in earlier versions. Gets the texture (

2017-03-21 15:53:38
SpriteBatch:getImage

SpriteBatch:getImage Available since LÖVE 0.8.0 This method is not supported in earlier versions. Removed in LÖVE

2017-03-21 15:53:38
SpriteBatch:attachAttribute

SpriteBatch:attachAttribute Available since LÖVE 0.10.0 This function is not supported in earlier versions. Attaches a per-vertex attribute

2017-03-21 15:53:35
SpriteBatch:set

SpriteBatch:set Available since LÖVE 0.8.0 This method is not supported in earlier versions. Changes a sprite in the batch. This requires the

2017-03-21 15:53:39
SpriteBatch:addq

SpriteBatch:addq Removed in LÖVE 0.9.0 It has been merged into

2017-03-21 15:53:34
SpriteBatch:flush

SpriteBatch:flush Available since LÖVE 0.9.2 This function is not supported in earlier versions. Immediately sends all new and modified sprite

2017-03-21 15:53:36
SpriteBatch:setImage

SpriteBatch:setImage Available since LÖVE 0.7.2 This method is not supported in earlier versions. Removed in LÖVE

2017-03-21 15:53:41
SpriteBatch:getBufferSize

SpriteBatch:getBufferSize Available since LÖVE 0.9.0 This function is not supported in earlier versions. Gets the maximum number of sprites

2017-03-21 15:53:36