Difference between revisions of "SpriteBatch:add"

m (1 revision: Imported docs from potato.)
(Add note about exceeding the buffer size)
 
(16 intermediate revisions by 8 users not shown)
Line 1: Line 1:
 +
Adds a sprite to the batch. Sprites are drawn in the order they are added.
  
 +
== Function ==
 +
{{newin|[[0.8.0]]|080|type=variant}}
 +
=== Synopsis ===
 +
<source lang="lua">
 +
id = SpriteBatch:add( x, y, r, sx, sy, ox, oy, kx, ky )
 +
</source>
 +
=== Arguments ===
 +
{{param|number|x|The position to draw the object (x-axis).}}
 +
{{param|number|y|The position to draw the object (y-axis).}}
 +
{{param|number|r (0)|Orientation (radians).}}
 +
{{param|number|sx (1)|Scale factor (x-axis).}}
 +
{{param|number|sy (sx)|Scale factor (y-axis).}}
 +
{{param|number|ox (0)|Origin offset (x-axis).}}
 +
{{param|number|oy (0)|Origin offset (y-axis).}}
 +
{{param|number|kx (0)|Shear factor (x-axis).}}
 +
{{param|number|ky (0)|Shear factor (y-axis).}}
 +
=== Returns ===
 +
{{param|number|id|An identifier for the added sprite.}}
  
 
== Function ==
 
== Function ==
 +
{{newin|[[0.9.0]]|090|type=variant|text=This variant has replaced [[SpriteBatch:addq]]}}
 +
Adds a [[Quad]] to the batch.
 +
=== Synopsis ===
 +
<source lang="lua">
 +
id = SpriteBatch:add( quad, x, y, r, sx, sy, ox, oy, kx, ky )
 +
</source>
 +
=== Arguments ===
 +
{{param|Quad|quad|The Quad to add.}}
 +
{{param|number|x|The position to draw the object (x-axis).}}
 +
{{param|number|y|The position to draw the object (y-axis).}}
 +
{{param|number|r (0)|Orientation (radians).}}
 +
{{param|number|sx (1)|Scale factor (x-axis).}}
 +
{{param|number|sy (sx)|Scale factor (y-axis).}}
 +
{{param|number|ox (0)|Origin offset (x-axis).}}
 +
{{param|number|oy (0)|Origin offset (y-axis).}}
 +
{{param|number|kx (0)|Shear factor (x-axis).}}
 +
{{param|number|ky (0)|Shear factor (y-axis).}}
 +
=== Returns ===
 +
{{param|number|id|An identifier for the added sprite.}}
 +
 +
== Function ==
 +
{{oldin|[[0.8.0]]|080|type=variant}}
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
Line 16: Line 57:
 
=== Returns ===
 
=== Returns ===
 
Nothing.
 
Nothing.
 +
 +
== Notes ==
 +
The returned <code>id</code>s range from 1 to the set [[SpriteBatch:setBufferSize|buffer size]]. If the buffer size is exceeded the returned <code>id</code> will default to 0 and the sprite won't be drawn.
 +
 
== See Also ==
 
== See Also ==
 
* [[parent::SpriteBatch]]
 
* [[parent::SpriteBatch]]
 +
* [[SpriteBatch:set]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=}}
+
{{#set:Description=Adds a sprite to the batch.}}
 +
{{#set:Since=000}}
 +
== Other Languages ==
 +
{{i18n|SpriteBatch:add}}

Latest revision as of 16:14, 16 June 2016

Adds a sprite to the batch. Sprites are drawn in the order they are added.

Function

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

Synopsis

id = SpriteBatch:add( x, y, r, sx, sy, ox, oy, kx, ky )

Arguments

number x
The position to draw the object (x-axis).
number y
The position to draw the object (y-axis).
number r (0)
Orientation (radians).
number sx (1)
Scale factor (x-axis).
number sy (sx)
Scale factor (y-axis).
number ox (0)
Origin offset (x-axis).
number oy (0)
Origin offset (y-axis).
number kx (0)
Shear factor (x-axis).
number ky (0)
Shear factor (y-axis).

Returns

number id
An identifier for the added sprite.

Function

Available since LÖVE 0.9.0
This variant has replaced SpriteBatch:addq.

Adds a Quad to the batch.

Synopsis

id = SpriteBatch:add( quad, x, y, r, sx, sy, ox, oy, kx, ky )

Arguments

Quad quad
The Quad to add.
number x
The position to draw the object (x-axis).
number y
The position to draw the object (y-axis).
number r (0)
Orientation (radians).
number sx (1)
Scale factor (x-axis).
number sy (sx)
Scale factor (y-axis).
number ox (0)
Origin offset (x-axis).
number oy (0)
Origin offset (y-axis).
number kx (0)
Shear factor (x-axis).
number ky (0)
Shear factor (y-axis).

Returns

number id
An identifier for the added sprite.

Function

Removed in LÖVE 0.8.0
This variant is not supported in that and later versions.

Synopsis

SpriteBatch:add( x, y, r, sx, sy, ox, oy )

Arguments

number x
The position to draw the object (x-axis).
number y
The position to draw the object (y-axis).
number r (0)
Orientation (radians).
number sx (1)
Scale factor (x-axis).
number sy (sx)
Scale factor (y-axis).
number ox (0)
Origin offset (x-axis).
number oy (0)
Origin offset (y-axis).

Returns

Nothing.

Notes

The returned ids range from 1 to the set buffer size. If the buffer size is exceeded the returned id will default to 0 and the sprite won't be drawn.

See Also


Other Languages