Difference between revisions of "TextureRegion"

From GiderosMobile
m (Text replacement - "</source>" to "</syntaxhighlight>")
 
(19 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
−
'''Supported platforms:''' android, ios, mac, pc<br/>
+
<!-- GIDEROSOBJ:TextureRegion -->
 +
'''Supported platforms:''' [[File:Platform android.png]][[File:Platform ios.png]][[File:Platform mac.png]][[File:Platform pc.png]][[File:Platform html5.png]][[File:Platform winrt.png]][[File:Platform win32.png]]<br/>
 
'''Available since:''' Gideros 2011.6<br/>
 
'''Available since:''' Gideros 2011.6<br/>
 +
'''Inherits from:''' [[Object]]<br/>
 +
 
=== Description ===
 
=== Description ===
−
<br />
+
The '''TextureRegion class''' specifies a texture and a rectangular region in it. It is used to define independent texture regions within a texture atlas (a large image which contains many smaller sub-images).
−
The `TextureRegion` class specifies a texture and a rectangular region in it. It is used to define independent texture regions<br />
+
 
−
within a texture atlas which is a large image, which contains many smaller sub-images.<br />
+
=== Example ===
−
<br />
+
<syntaxhighlight lang="lua">
−
=== Examples ===
+
local texture = Texture.new("atlas.png")
−
'''Example'''<br/>
+
 
−
<source lang="lua">local texture = Texture.new(&quot;atlas.png&quot;)<br />
+
-- define 4 equal regions of size 100x100 from "atlas.png"
−
<br />
+
local region1 = TextureRegion.new(texture, 0,  0,  100, 100)
−
-- define 4 equal regions of size 100x100 from &quot;atlas.png&quot;<br />
+
local region2 = TextureRegion.new(texture, 100, 0,  100, 100)
−
local region1 = TextureRegion.new(texture, 0,  0,  100, 100)<br />
+
local region3 = TextureRegion.new(texture, 100, 100, 100, 100)
−
local region2 = TextureRegion.new(texture, 100, 0,  100, 100)<br />
+
local region4 = TextureRegion.new(texture, 0,  100, 100, 100)
−
local region3 = TextureRegion.new(texture, 100, 100, 100, 100)<br />
+
 
−
local region4 = TextureRegion.new(texture, 0,  100, 100, 100)<br />
+
-- add these regions to scene tree
−
<br />
+
local bitmap1 = Bitmap.new(region1)
−
-- add these regions to scene tree<br />
+
local bitmap2 = Bitmap.new(region2)
−
local bitmap1 = Bitmap.new(region1)<br />
+
local bitmap3 = Bitmap.new(region3)
−
local bitmap2 = Bitmap.new(region2)<br />
+
local bitmap4 = Bitmap.new(region4)
−
local bitmap3 = Bitmap.new(region3)<br />
+
 
−
local bitmap4 = Bitmap.new(region4)<br />
+
stage:addChild(bitmap1)
−
<br />
+
stage:addChild(bitmap2)
−
stage:addChild(bitmap1)<br />
+
stage:addChild(bitmap3)
−
stage:addChild(bitmap2)<br />
+
stage:addChild(bitmap4)
−
stage:addChild(bitmap3)<br />
+
</syntaxhighlight>
−
stage:addChild(bitmap4)</source>
+
 
 
{|-
 
{|-
−
| style="width: 50%;"|
+
| style="width: 50%; vertical-align:top;"|
 
=== Methods ===
 
=== Methods ===
−
[[TextureRegion.new]] - creates a new TextureRegion object<br/>
+
[[TextureRegion.new]] ''creates a new TextureRegion object''<br/><!--GIDEROSMTD:TextureRegion.new(texture) creates a new TextureRegion object-->
−
[[TextureRegion.new]] - <br/>
+
[[TextureRegion.new]] <br/><!--GIDEROSMTD:TextureRegion.new(texture,x,y,width,height) -->
−
[[TextureRegion:getRegion]] - returns the coordinates of the region<br/>
+
[[TextureRegion:getRegion]] ''returns the coordinates of the region''<br/><!--GIDEROSMTD:TextureRegion:getRegion(baseCoordiniates) returns the coordinates of the region-->
−
[[TextureRegion:getScale]] - returns the scale ratio of the underlying atlas<br/>
+
[[TextureRegion:getScale]] ''returns the scale ratio of the underlying atlas''<br/><!--GIDEROSMTD:TextureRegion:getScale() returns the scale ratio of the underlying atlas-->
−
[[TextureRegion:setRegion]] - sets the coordinates of the region<br/>
+
[[TextureRegion:setRegion]] ''sets the coordinates of the region''<br/><!--GIDEROSMTD:TextureRegion:setRegion(x,y,width,height) sets the coordinates of the region-->
−
| style="width: 50%;"|
+
 
 +
| style="width: 50%; vertical-align:top;"|
 
=== Events ===
 
=== Events ===
 
=== Constants ===
 
=== Constants ===
 
|}
 
|}
 +
 +
{{GIDEROS IMPORTANT LINKS}}

Latest revision as of 14:33, 13 July 2023

Supported platforms: Platform android.pngPlatform ios.pngPlatform mac.pngPlatform pc.pngPlatform html5.pngPlatform winrt.pngPlatform win32.png
Available since: Gideros 2011.6
Inherits from: Object

Description

The TextureRegion class specifies a texture and a rectangular region in it. It is used to define independent texture regions within a texture atlas (a large image which contains many smaller sub-images).

Example

local texture = Texture.new("atlas.png")

-- define 4 equal regions of size 100x100 from "atlas.png"
local region1 = TextureRegion.new(texture, 0,   0,   100, 100)
local region2 = TextureRegion.new(texture, 100, 0,   100, 100)
local region3 = TextureRegion.new(texture, 100, 100, 100, 100)
local region4 = TextureRegion.new(texture, 0,   100, 100, 100)

-- add these regions to scene tree
local bitmap1 = Bitmap.new(region1)
local bitmap2 = Bitmap.new(region2)
local bitmap3 = Bitmap.new(region3)
local bitmap4 = Bitmap.new(region4)

stage:addChild(bitmap1)
stage:addChild(bitmap2)
stage:addChild(bitmap3)
stage:addChild(bitmap4)

Methods

TextureRegion.new creates a new TextureRegion object
TextureRegion.new
TextureRegion:getRegion returns the coordinates of the region
TextureRegion:getScale returns the scale ratio of the underlying atlas
TextureRegion:setRegion sets the coordinates of the region

Events

Constants


Retrieved from ‘https://wiki.gideros.rocks/index.php?title=TextureRegion&oldid=22331’