Difference between revisions of "love.graphics.newSpriteBatch"

m (Added new variant for 0.9.1)
m
Line 4: Line 4:
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
spriteBatch = love.graphics.newSpriteBatch( image, size )
+
spriteBatch = love.graphics.newSpriteBatch( image, maxsprites )
 
</source>
 
</source>
 
=== 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|number|maxsprites (1000)|The maximum number of sprites that the SpriteBatch can contain at any given time.}}
 
=== Returns ===
 
=== Returns ===
 
{{param|SpriteBatch|spriteBatch|The new SpriteBatch.}}
 
{{param|SpriteBatch|spriteBatch|The new SpriteBatch.}}
Line 16: Line 16:
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
spriteBatch = love.graphics.newSpriteBatch( image, size, usagehint )
+
spriteBatch = love.graphics.newSpriteBatch( image, maxsprites, usage )
 
</source>
 
</source>
 
=== 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|number|maxsprites (1000)|The maximum number of sprites that the SpriteBatch can contain at any given time..}}
{{param|SpriteBatchUsage|usagehint ("dynamic")|The expected usage of the SpriteBatch.}}
+
{{param|SpriteBatchUsage|usage ("dynamic")|The expected usage of the SpriteBatch. The specified usage mode affects the SpriteBatch's memory usage and performance.}}
 
=== Returns ===
 
=== Returns ===
 
{{param|SpriteBatch|spriteBatch|The new SpriteBatch.}}
 
{{param|SpriteBatch|spriteBatch|The new SpriteBatch.}}
Line 29: Line 29:
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
spriteBatch = love.graphics.newSpriteBatch( texture, size, usagehint )
+
spriteBatch = love.graphics.newSpriteBatch( texture, maxsprites, usage )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
 
{{param|Texture|texture|The [[Image]] or [[Canvas]] to use for the sprites.}}
 
{{param|Texture|texture|The [[Image]] or [[Canvas]] to use for the sprites.}}
{{param|number|size (1000)|The max number of sprites.}}
+
{{param|number|maxsprites (1000)|The maximum number of sprites that the SpriteBatch can contain at any given time.}}
{{param|SpriteBatchUsage|usagehint ("dynamic")|The expected usage of the SpriteBatch.}}
+
{{param|SpriteBatchUsage|usage ("dynamic")|The expected usage of the SpriteBatch. The specified usage mode affects the SpriteBatch's memory usage and performance.}}
 
=== Returns ===
 
=== Returns ===
 
{{param|SpriteBatch|spriteBatch|The new SpriteBatch.}}
 
{{param|SpriteBatch|spriteBatch|The new SpriteBatch.}}

Revision as of 14:13, 29 December 2015

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

Arguments

Image image
The Image to use for the sprites.
number maxsprites (1000)
The maximum number of sprites that the SpriteBatch can contain at any given time.

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, maxsprites, usage )

Arguments

Image image
The Image to use for the sprites.
number maxsprites (1000)
The maximum number of sprites that the SpriteBatch can contain at any given time..
SpriteBatchUsage usage ("dynamic")
The expected usage of the SpriteBatch. The specified usage mode affects the SpriteBatch's memory usage and performance.

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, maxsprites, usage )

Arguments

Texture texture
The Image or Canvas to use for the sprites.
number maxsprites (1000)
The maximum number of sprites that the SpriteBatch can contain at any given time.
SpriteBatchUsage usage ("dynamic")
The expected usage of the SpriteBatch. The specified usage mode affects the SpriteBatch's memory usage and performance.

Returns

SpriteBatch spriteBatch
The new SpriteBatch.

See Also


Other Languages