Difference between revisions of "TexturePack"
From GiderosMobile
m |
|||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| − | + | '''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/> |
| − | ''' | + | '''Inherits from:''' [[TextureBase]]<br/> |
| − | ''' | ||
| − | === | + | === Description === |
| − | The | + | The '''TexturePack''' class specifies a texture pack (or texture atlas). A texture atlas is a large image which contains many smaller sub-images. |
Gideros supports dynamic creation of texture atlases and pre-packed texture atlasses by using "Gideros Texture Packer" tool. | Gideros supports dynamic creation of texture atlases and pre-packed texture atlasses by using "Gideros Texture Packer" tool. | ||
==== Dynamic Creation of Texture Packs ==== | ==== Dynamic Creation of Texture Packs ==== | ||
| − | To create a texture pack dynamically (at run-time), create [[ | + | To create a texture pack dynamically (at run-time), create a [[TexturePack]] object with a table of file names of textures. |
| − | |||
<source lang="lua"> | <source lang="lua"> | ||
local pack = TexturePack.new({"1.png", "2.png", "3.png", "4.png"}) | local pack = TexturePack.new({"1.png", "2.png", "3.png", "4.png"}) | ||
| Line 22: | Line 20: | ||
[[File:Texture packer.png]] | [[File:Texture packer.png]] | ||
| − | This tool exports two files: | + | This tool exports two files: a ''.txt'' file that specifies the positions of texture regions and a ''.png'' file of packed texture. |
| − | Use these two files to create texture pack: | + | Use these two files to create a texture pack: |
<source lang="lua"> | <source lang="lua"> | ||
local pack = TexturePack.new("pack.txt", "pack.png") | local pack = TexturePack.new("pack.txt", "pack.png") | ||
| Line 31: | Line 29: | ||
{|- | {|- | ||
| style="width: 50%; vertical-align:top;"| | | style="width: 50%; vertical-align:top;"| | ||
| − | === | + | === Methods === |
| − | [[ | + | [[TexturePack.new]] ''creates a new TexturePack object from textures''<br/><!--GIDEROSMTD:TexturePack.new(textures,padding,filtering,options) creates a new TexturePack object from textures--> |
| − | [[ | + | [[TexturePack.new]] ''creates a new TexturePack object from texture pack files''<br/><!--GIDEROSMTD:TexturePack.new(txtfile,imagefile,filtering,options) creates a new TexturePack object from texture pack files--> |
| − | [[ | + | [[TexturePack:getLocation]] ''returns the location of the given texture in this pack''<br/><!--GIDEROSMTD:TexturePack:getLocation(texturename) returns the location of the given texture in this pack--> |
| − | [[ | + | [[TexturePack:getRegionsNames]] ''returns all the region names of this pack''<br/><!--GIDEROSMTD:TexturePack:getRegionsNames() returns all the region names of this pack--> |
| − | [[ | + | [[TexturePack:getTextureRegion]] ''returns the texture region for the given texture name''<br/><!--GIDEROSMTD:TexturePack:getTextureRegion(texturename) returns the texture region for the given texture name--> |
| − | [[ | + | [[TexturePack.loadAsync]] ''asynchronously loads a TexturePack object from texture pack files''<br/><!--GIDEROSMTD:TexturePack.loadAsync(callback,txtfile,imagefile,filtering,options) asynchronously loads a TexturePack object from texture pack files--> |
| style="width: 50%; vertical-align:top;"| | | style="width: 50%; vertical-align:top;"| | ||
| − | + | === Events === | |
| − | === | + | === Constants === |
| − | === | ||
|} | |} | ||
{{GIDEROS IMPORTANT LINKS}} | {{GIDEROS IMPORTANT LINKS}} | ||
Revision as of 00:17, 30 January 2023
Supported platforms: 
Available since: Gideros 2011.6
Inherits from: TextureBase
Description
The TexturePack class specifies a texture pack (or texture atlas). A texture atlas is a large image which contains many smaller sub-images.
Gideros supports dynamic creation of texture atlases and pre-packed texture atlasses by using "Gideros Texture Packer" tool.
Dynamic Creation of Texture Packs
To create a texture pack dynamically (at run-time), create a TexturePack object with a table of file names of textures.
local pack = TexturePack.new({"1.png", "2.png", "3.png", "4.png"})
Static Creation of Texture Packs
To create a pre-packed texture atlas, use "Gideros Texture Packer" tool:
This tool exports two files: a .txt file that specifies the positions of texture regions and a .png file of packed texture.
Use these two files to create a texture pack:
local pack = TexturePack.new("pack.txt", "pack.png")
MethodsTexturePack.new creates a new TexturePack object from textures |
EventsConstants |
