Difference between revisions of "love.graphics.newSpriteBatch"
m (→Arguments) |
m |
||
Line 8: | Line 8: | ||
=== Arguments === | === Arguments === | ||
{{param|Image|image|The Image to use for the sprites.}} | {{param|Image|image|The Image to use for the sprites.}} | ||
− | {{param|number|maxsprites (1000)|The maximum number of sprites that the SpriteBatch can contain at any given time.}} | + | {{param|number|maxsprites (1000)|The maximum number of sprites that the SpriteBatch can contain at any given time. Since version [[11.0]], additional sprites added past this number will automatically grow the spritebatch.}} |
=== Returns === | === Returns === | ||
{{param|SpriteBatch|spriteBatch|The new SpriteBatch.}} | {{param|SpriteBatch|spriteBatch|The new SpriteBatch.}} | ||
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|maxsprites (1000)|The maximum number of sprites that the SpriteBatch can contain at any given time.}} | + | {{param|number|maxsprites (1000)|The maximum number of sprites that the SpriteBatch can contain at any given time. Since version [[11.0]], additional sprites added past this number will automatically grow the spritebatch.}} |
{{param|SpriteBatchUsage|usage ("dynamic")|The expected usage of the SpriteBatch. The specified usage mode affects the SpriteBatch's memory usage and performance.}} | {{param|SpriteBatchUsage|usage ("dynamic")|The expected usage of the SpriteBatch. The specified usage mode affects the SpriteBatch's memory usage and performance.}} | ||
Line 34: | Line 34: | ||
=== 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|maxsprites (1000)|The maximum number of sprites that the SpriteBatch can contain at any given time.}} | + | {{param|number|maxsprites (1000)|The maximum number of sprites that the SpriteBatch can contain at any given time. Since version [[11.0]], additional sprites added past this number will automatically grow the spritebatch.}} |
{{param|SpriteBatchUsage|usage ("dynamic")|The expected usage of the SpriteBatch. The specified usage mode affects the SpriteBatch's memory usage and performance.}} | {{param|SpriteBatchUsage|usage ("dynamic")|The expected usage of the SpriteBatch. The specified usage mode affects the SpriteBatch's memory usage and performance.}} | ||
=== Returns === | === Returns === |
Revision as of 13:46, 9 June 2018
Creates a new SpriteBatch object.
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! |
Contents
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. Since version 11.0, additional sprites added past this number will automatically grow the spritebatch.
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. Since version 11.0, additional sprites added past this number will automatically grow the spritebatch.
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. Since version 11.0, additional sprites added past this number will automatically grow the spritebatch.
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
Dansk –
Deutsch –
English –
Español –
Français –
Indonesia –
Italiano –
Lietuviškai –
Magyar –
Nederlands –
Polski –
Português –
Română –
Slovenský –
Suomi –
Svenska –
Türkçe –
Česky –
Ελληνικά –
Български –
Русский –
Српски –
Українська –
עברית –
ไทย –
日本語 –
正體中文 –
简体中文 –
Tiếng Việt –
한국어
More info