Difference between revisions of "SpriteBatch:add"

m
(Added geometry variant for 0.9.0)
Line 8: Line 8:
 
</source>
 
</source>
 
=== Arguments ===
 
=== 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 ==
 +
{{notice|Geometry with more than 4 vertices cannot be added to SpriteBatches.}}
 +
{{newin|[[0.9.0]]|090|type=variant|text=This variant has replaced [[SpriteBatch:addq]]}}
 +
=== Synopsis ===
 +
<source lang="lua">
 +
id = SpriteBatch:add( geometry, x, y, r, sx, sy, ox, oy, kx, ky )
 +
</source>
 +
=== Arguments ===
 +
{{param|Geometry|geometry|The Geometry 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 18:22, 11 August 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

O.png Geometry with more than 4 vertices cannot be added to SpriteBatches.  


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

Synopsis

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

Arguments

Geometry geometry
The Geometry 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