Difference between revisions of "love.graphics.newSpriteBatch"

m (not sure how ugly having this template for all these functions but it's probably a good idea)
(Added the SpriteBatch usage hint parameter.)
Line 11: Line 11:
 
=== Returns ===
 
=== Returns ===
 
{{param|SpriteBatch|spriteBatch|The new SpriteBatch.}}
 
{{param|SpriteBatch|spriteBatch|The new SpriteBatch.}}
 +
 +
== Function ==
 +
{{newin|[[0.8.0]]|080|type=variant}}
 +
=== Synopsis ===
 +
<source lang="lua">
 +
spriteBatch = love.graphics.newSpriteBatch( image, size, usage )
 +
</source>
 +
=== Arguments ===
 +
{{param|Image|image|The Image to use for the sprites.}}
 +
{{param|number|size (1000)|The max number of sprites.}}
 +
{{param|SpriteBatchUsage|usage ("dynamic")|The expected usage of the SpriteBatch.}}
 +
=== Returns ===
 +
{{param|SpriteBatch|spriteBatch|The new SpriteBatch.}}
 +
 
== See Also ==
 
== See Also ==
 
* [[parent::love.graphics]]
 
* [[parent::love.graphics]]

Revision as of 12:55, 14 February 2013

Creates a new SpriteBatch object.

O.png This function can be slow if it is called repeatedly, such as from love.update or love.draw. If you need to use a specific resource often, create it once and store it somewhere it can be reused!  



Function

Synopsis

spriteBatch = love.graphics.newSpriteBatch( image, size )

Arguments

Image image
The Image to use for the sprites.
number size (1000)
The max number of sprites.

Returns

SpriteBatch spriteBatch
The new SpriteBatch.

Function

Available since LÖVE 0.8.0
This variant is not supported in earlier versions.

Synopsis

spriteBatch = love.graphics.newSpriteBatch( image, size, usage )

Arguments

Image image
The Image to use for the sprites.
number size (1000)
The max number of sprites.
SpriteBatchUsage usage ("dynamic")
The expected usage of the SpriteBatch.

Returns

SpriteBatch spriteBatch
The new SpriteBatch.

See Also


Other Languages