Difference between revisions of "TexturePack"

From GiderosMobile
m
Line 32: Line 32:
 
[[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 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.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.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-->
 +
 
[[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: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: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: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 ===
 
=== Events ===
 
=== Constants ===
 
=== Constants ===

Revision as of 00:41, 30 January 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: 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:

Texture packer.png

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")

Methods

TexturePack.new creates a new TexturePack object from textures
TexturePack.new creates a new TexturePack object from texture pack files
TexturePack.loadAsync asynchronously loads a TexturePack object from texture pack files

TexturePack:getLocation returns the location of the given texture in this pack
TexturePack:getRegionsNames returns all the region names of this pack
TexturePack:getTextureRegion returns the texture region for the given texture name

Events

Constants