Difference between revisions of "love.graphics.newSpriteBatch"

m (Typo)
m (Added new variant for 0.9.1)
Line 20: Line 20:
 
=== Arguments ===
 
=== Arguments ===
 
{{param|Image|image|The Image to use for the sprites.}}
 
{{param|Image|image|The Image to use for the sprites.}}
 +
{{param|number|size (1000)|The max number of sprites.}}
 +
{{param|SpriteBatchUsage|usagehint ("dynamic")|The expected usage of the SpriteBatch.}}
 +
=== Returns ===
 +
{{param|SpriteBatch|spriteBatch|The new SpriteBatch.}}
 +
 +
== Function ==
 +
{{newin|[[0.9.1]]|091|type=variant}}
 +
=== Synopsis ===
 +
<source lang="lua">
 +
spriteBatch = love.graphics.newSpriteBatch( texture, size, usagehint )
 +
</source>
 +
=== Arguments ===
 +
{{param|Texture|texture|The [[Image]] or [[Canvas]] to use for the sprites.}}
 
{{param|number|size (1000)|The max number of sprites.}}
 
{{param|number|size (1000)|The max number of sprites.}}
 
{{param|SpriteBatchUsage|usagehint ("dynamic")|The expected usage of the SpriteBatch.}}
 
{{param|SpriteBatchUsage|usagehint ("dynamic")|The expected usage of the SpriteBatch.}}

Revision as of 08:15, 26 April 2014

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, usagehint )

Arguments

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

Returns

SpriteBatch spriteBatch
The new SpriteBatch.

Function

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

Synopsis

spriteBatch = love.graphics.newSpriteBatch( texture, size, usagehint )

Arguments

Texture texture
The Image or Canvas to use for the sprites.
number size (1000)
The max number of sprites.
SpriteBatchUsage usagehint ("dynamic")
The expected usage of the SpriteBatch.

Returns

SpriteBatch spriteBatch
The new SpriteBatch.

See Also


Other Languages