Difference between revisions of "SpriteBatch:add"

m
m (Quads are no longer replaced by Geometry)
Line 22: Line 22:
 
== Function ==
 
== Function ==
 
{{newin|[[0.9.0]]|090|type=variant|text=This variant has replaced [[SpriteBatch:addq]]}}
 
{{newin|[[0.9.0]]|090|type=variant|text=This variant has replaced [[SpriteBatch:addq]]}}
Adds a [[Geometry]] to the batch.
+
Adds a [[Quad]] to the batch.
{{notice|Geometry with more than 4 vertices cannot be added to SpriteBatches.}}
 
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
id = SpriteBatch:add( geometry, x, y, r, sx, sy, ox, oy, kx, ky )
+
id = SpriteBatch:add( quad, x, y, r, sx, sy, ox, oy, kx, ky )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
{{param|Geometry|geometry|The Geometry to add.}}
+
{{param|Quad|quad|The Quad to add.}}
 
{{param|number|x|The position to draw the object (x-axis).}}
 
{{param|number|x|The position to draw the object (x-axis).}}
 
{{param|number|y|The position to draw the object (y-axis).}}
 
{{param|number|y|The position to draw the object (y-axis).}}

Revision as of 05:32, 8 October 2013

Adds a sprite to the batch.

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.

See Also


Other Languages