Difference between revisions of "TextureRegion:getRegion"

From GiderosMobile
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
<languages />
+
'''Available since:''' Gideros 2012.08.2<br/>
'''<translate>Available since</translate>:''' Gideros 2012.08.2<br/>
+
'''Class:''' [[TextureRegion]]<br/>
'''<translate>Class</translate>:''' [[Special:MyLanguage/TextureRegion|TextureRegion]]<br/>
+
 
=== <translate>Description</translate> ===
+
=== Description ===
<translate><br />
+
Returns the coordinates of the region.
Returns the coordinates of the region.<br />
+
<syntaxhighlight lang="lua">
 +
(number), (number), (number), (number), (number), (number), (number), (number) = TextureRegion:getRegion(baseCoordinates)
 +
</syntaxhighlight>
 +
 
 
If transparent areas were trimmed during texture pack export, also reports the amount trimmed.
 
If transparent areas were trimmed during texture pack export, also reports the amount trimmed.
<br /></translate>
+
 
<source lang="lua">
+
'''When creating a TextureRegion using ''TextureRegion.new'', the dimensions will still be that of the underlying Texture. Using ''TextureRegion.set'' should work?'''
(number), (number), (number), (number), (number), (number), (number), (number) = TextureRegion:getRegion(baseCoordiniates)
+
 
</source>
+
=== Parameters ===
=== <translate>Parameters</translate> ===
+
'''baseCoordinates''': (boolean) returns values in base (@1) size '''optional'''<br/>
'''baseCoordiniates''': (boolean) <translate>Returns values in base (@1) size</translate> '''optional'''<br/>
+
 
=== <translate>Return values</translate> ===
+
=== Return values ===
'''<translate>Returns</translate>''' (number) <translate>x coordinate from texture</translate><br/>
+
'''Returns''' (number) x coordinate from texture<br/>
'''<translate>Returns</translate>''' (number) <translate>y coordinate from texture</translate><br/>
+
'''Returns''' (number) y coordinate from texture<br/>
'''<translate>Returns</translate>''' (number) <translate>width of region</translate><br/>
+
'''Returns''' (number) width of region<br/>
'''<translate>Returns</translate>''' (number) <translate>height of region</translate><br/>
+
'''Returns''' (number) height of region<br/>
'''<translate>Returns</translate>''' (number) <translate>left trim</translate><br/>
+
'''Returns''' (number) left trim<br/>
'''<translate>Returns</translate>''' (number) <translate>top trim</translate><br/>
+
'''Returns''' (number) top trim<br/>
'''<translate>Returns</translate>''' (number) <translate>right trim</translate><br/>
+
'''Returns''' (number) right trim<br/>
'''<translate>Returns</translate>''' (number) <translate>bottom trim</translate><br/>
+
'''Returns''' (number) bottom trim<br/>
 +
 
 +
{{TextureRegion}}

Latest revision as of 23:22, 1 December 2025

Available since: Gideros 2012.08.2
Class: TextureRegion

Description

Returns the coordinates of the region.

(number), (number), (number), (number), (number), (number), (number), (number) = TextureRegion:getRegion(baseCoordinates)

If transparent areas were trimmed during texture pack export, also reports the amount trimmed.

When creating a TextureRegion using TextureRegion.new, the dimensions will still be that of the underlying Texture. Using TextureRegion.set should work?

Parameters

baseCoordinates: (boolean) returns values in base (@1) size optional

Return values

Returns (number) x coordinate from texture
Returns (number) y coordinate from texture
Returns (number) width of region
Returns (number) height of region
Returns (number) left trim
Returns (number) top trim
Returns (number) right trim
Returns (number) bottom trim