Difference between revisions of "TexturePack:getTextureRegion"

From GiderosMobile
(Created page with "__NOTOC__ '''Available since:''' Gideros 2011.6<br/> === Description === <br /> Returns the texture region of texture pack.<br /> <br /> <source lang="lua"> (TextureRegion), =...")
 
m (Text replacement - "</source>" to "</syntaxhighlight>")
 
(13 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
'''Available since:''' Gideros 2011.6<br/>
 
'''Available since:''' Gideros 2011.6<br/>
 +
'''Class:''' [[TexturePack]]<br/>
 +
 
=== Description ===
 
=== Description ===
<br />
+
Returns the texture region for the given texture name.
Returns the texture region of texture pack.<br />
+
<syntaxhighlight lang="lua">
<br />
+
(TextureRegion) = TexturePack:getTextureRegion(texturename)
<source lang="lua">
+
</syntaxhighlight>
(TextureRegion), = TexturePack:getTextureRegion(texturename,)
+
 
</source>
+
=== Parameters ===
'''texturename:''' (string) ''''''<br/>
+
'''texturename''': (string) packed texture path<br/>
 +
 
 +
=== Return values ===
 
'''Returns''' (TextureRegion) TextureRegion by specified name<br/>
 
'''Returns''' (TextureRegion) TextureRegion by specified name<br/>
 +
 +
=== Example ===
 +
<syntaxhighlight lang="lua">
 +
local pack = TexturePack.new({"gfx/1.png", "gfx/2.png", "gfx/3.png", "gfx/4.png"})
 +
 +
local region1 = pack:getTextureRegion("gfx/1.png")
 +
local region2 = pack:getTextureRegion("gfx/2.png")
 +
local region3 = pack:getTextureRegion("gfx/3.png")
 +
local region4 = pack:getTextureRegion("gfx/4.png")
 +
</syntaxhighlight>
 +
 +
{{TexturePack}}

Latest revision as of 15:33, 13 July 2023

Available since: Gideros 2011.6
Class: TexturePack

Description

Returns the texture region for the given texture name.

(TextureRegion) = TexturePack:getTextureRegion(texturename)

Parameters

texturename: (string) packed texture path

Return values

Returns (TextureRegion) TextureRegion by specified name

Example

local pack = TexturePack.new({"gfx/1.png", "gfx/2.png", "gfx/3.png", "gfx/4.png"})

local region1 = pack:getTextureRegion("gfx/1.png")
local region2 = pack:getTextureRegion("gfx/2.png")
local region3 = pack:getTextureRegion("gfx/3.png")
local region4 = pack:getTextureRegion("gfx/4.png")