Difference between revisions of "Mesh:getVertex"

m (See Also)
(Updated for 11.0)
 
(3 intermediate revisions by 3 users not shown)
Line 2: Line 2:
 
Gets the properties of a vertex in the Mesh.
 
Gets the properties of a vertex in the Mesh.
  
 +
In versions prior to [[11.0]], color and byte component values were within the range of 0 to 255 instead of 0 to 1.
 
== Function ==
 
== Function ==
 
{{newin|[[0.10.0]]|100|type=variant}}
 
{{newin|[[0.10.0]]|100|type=variant}}
Line 9: Line 10:
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
{{param|number|index|The index of the vertex you want to retrieve the information for.}}
+
{{param|number|index|The one-based index of the vertex you want to retrieve the information for.}}
 
=== Returns ===
 
=== Returns ===
 
{{param|number|attributecomponent|The first component of the first vertex attribute in the specified vertex.}}
 
{{param|number|attributecomponent|The first component of the first vertex attribute in the specified vertex.}}
Line 25: Line 26:
 
{{param|number|index|The index of the vertex you want to retrieve the information for.}}
 
{{param|number|index|The index of the vertex you want to retrieve the information for.}}
 
=== Returns ===
 
=== Returns ===
{{param|number|x|The position of the vertex (x-axis).}}
+
{{param|number|x|The position of the vertex on the x-axis.}}
{{param|number|y|The position of the vertex (y-axis).}}
+
{{param|number|y|The position of the vertex on the y-axis.}}
 
{{param|number|u|The horizontal component of the texture coordinate.}}
 
{{param|number|u|The horizontal component of the texture coordinate.}}
 
{{param|number|v|The vertical component of the texture coordinate.}}
 
{{param|number|v|The vertical component of the texture coordinate.}}
Line 38: Line 39:
 
* [[Mesh:setVertex]]
 
* [[Mesh:setVertex]]
 
* [[Mesh:getVertexCount]]
 
* [[Mesh:getVertexCount]]
 +
* [[Mesh:getVertexAttribute]]
 
* [[Mesh:getVertexFormat]]
 
* [[Mesh:getVertexFormat]]
 
* [[love.graphics.newMesh]]
 
* [[love.graphics.newMesh]]

Latest revision as of 20:23, 1 April 2018

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

Gets the properties of a vertex in the Mesh.

In versions prior to 11.0, color and byte component values were within the range of 0 to 255 instead of 0 to 1.

Function

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

Synopsis

attributecomponent, ... = Mesh:getVertex( index )

Arguments

number index
The one-based index of the vertex you want to retrieve the information for.

Returns

number attributecomponent
The first component of the first vertex attribute in the specified vertex.
number ...
Additional components of all vertex attributes in the specified vertex.

Notes

The values are returned in the same order as the vertex attributes in the Mesh's vertex format. A standard Mesh that wasn't created with a custom vertex format will return two position numbers, two texture coordinate numbers, and four color components: x, y, u, v, r, g, b, a.

Function

Gets the vertex components of a Mesh that wasn't created with a custom vertex format.

Synopsis

x, y, u, v, r, g, b, a = Mesh:getVertex( index )

Arguments

number index
The index of the vertex you want to retrieve the information for.

Returns

number x
The position of the vertex on the x-axis.
number y
The position of the vertex on the y-axis.
number u
The horizontal component of the texture coordinate.
number v
The vertical component of the texture coordinate.
number r
The red component of the vertex's color.
number g
The green component of the vertex's color.
number b
The blue component of the vertex's color.
number a
The alpha component of the vertex's color.

See Also


Other Languages