Difference between revisions of "Mesh:getDrawRange"

(Created page)
 
m
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
 
{{newin|[[0.9.1]]|091|type=function}}
 
{{newin|[[0.9.1]]|091|type=function}}
Gets the range of vertices in the Mesh used when drawing.
+
Gets the range of vertices used when drawing the Mesh.
  
 
== Function ==
 
== Function ==
Line 10: Line 10:
 
None.
 
None.
 
=== Returns ===
 
=== Returns ===
{{param|number|min (nil)|The index of the first vertex to use when drawing, or the index of the first value in the vertex map to use if one is set for this Mesh.}}
+
{{param|number|min (nil)|The index of the first vertex used when drawing, or the index of the first value in the vertex map used if one is set for this Mesh.}}
{{param|number|max (nil)|The index of the last vertex to use when drawing, or the index of the last value in the vertex map to use if one is set for this Mesh.}}
+
{{param|number|max (nil)|The index of the last vertex used when drawing, or the index of the last value in the vertex map used if one is set for this Mesh.}}
 
=== Notes ===
 
=== Notes ===
 
If the Mesh's draw range has not been set previously with [[Mesh:setDrawRange]], this function will return nil.
 
If the Mesh's draw range has not been set previously with [[Mesh:setDrawRange]], this function will return nil.
Line 19: Line 19:
 
* [[Mesh:setDrawRange]]
 
* [[Mesh:setDrawRange]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=Gets the range of vertices in the Mesh used when drawing.}}
+
{{#set:Description=Gets the range of vertices used when drawing the Mesh.}}
 
== Other Languages ==
 
== Other Languages ==
 
{{i18n|Mesh:getDrawRange}}
 
{{i18n|Mesh:getDrawRange}}

Latest revision as of 09:23, 9 February 2014

Available since LÖVE 0.9.1
This function is not supported in earlier versions.

Gets the range of vertices used when drawing the Mesh.

Function

Synopsis

min, max = Mesh:getDrawRange( )

Arguments

None.

Returns

number min (nil)
The index of the first vertex used when drawing, or the index of the first value in the vertex map used if one is set for this Mesh.
number max (nil)
The index of the last vertex used when drawing, or the index of the last value in the vertex map used if one is set for this Mesh.

Notes

If the Mesh's draw range has not been set previously with Mesh:setDrawRange, this function will return nil.

See Also

Other Languages