Difference between revisions of "TexturePack"

From GiderosMobile
m (Text replacement - "<source" to "<syntaxhighlight")
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
<!-- GIDEROSOBJ:TexturePack -->
 
<!-- GIDEROSOBJ:TexturePack -->
'''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/>
+
'''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]][[File:Platform linux.png]]<br/>
 
'''Available since:''' Gideros 2011.6<br/>
 
'''Available since:''' Gideros 2011.6<br/>
 
'''Inherits from:''' [[TextureBase]]<br/>
 
'''Inherits from:''' [[TextureBase]]<br/>
Line 14: Line 14:
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight 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"})
</source>
+
</syntaxhighlight>
  
 
Example
 
Example
Line 21: Line 21:
 
local bmp = Bitmap.new(tp:getTextureRegion("gfx/button01.png"))
 
local bmp = Bitmap.new(tp:getTextureRegion("gfx/button01.png"))
 
stage:addChild(bmp)
 
stage:addChild(bmp)
</source>
+
</syntaxhighlight>
  
 
==== Static Creation of Texture Packs ====
 
==== Static Creation of Texture Packs ====
Line 33: Line 33:
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
 
local pack = TexturePack.new("pack.txt", "pack.png")
 
local pack = TexturePack.new("pack.txt", "pack.png")
</source>
+
</syntaxhighlight>
  
 
{|-
 
{|-
Line 40: Line 40:
 
[[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.new]] ''creates an open TexturePack based on a RT'' '''''NEW'''''<br/><!--GIDEROSMTD:TexturePack.new(renderTarget) creates an open TexturePack based on a RT-->
 
[[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.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-->
  

Latest revision as of 23:36, 4 September 2025

Supported platforms: Platform android.pngPlatform ios.pngPlatform mac.pngPlatform pc.pngPlatform html5.pngPlatform winrt.pngPlatform win32.pngPlatform linux.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"})

Example

local tp = TexturePack.new({"gfx/2_2.png", "gfx/button01.png", "gfx/button02.png", "gfx/cat.jpg"})
local bmp = Bitmap.new(tp:getTextureRegion("gfx/button01.png"))
stage:addChild(bmp)

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.new creates an open TexturePack based on a RT NEW
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