Difference between revisions of "TexturePack.new"
From GiderosMobile
(corrected some typos) |
m (Text replacement - "</source>" to "</syntaxhighlight>") |
||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| − | + | '''Available since:''' Gideros 2011.6<br/> | |
| − | ''' | + | '''Class:''' [[TexturePack]]<br/> |
| − | ''' | ||
=== Description === | === Description === | ||
| − | Creates a new | + | Creates a new '''TexturePack''' object. This function creates the texture pack at runtime. |
| − | < | + | <syntaxhighlight lang="lua"> |
TexturePack.new(textures,padding,filtering,options) | TexturePack.new(textures,padding,filtering,options) | ||
| − | </ | + | </syntaxhighlight> |
=== Parameters === | === Parameters === | ||
'''textures''': (table) file names of textures<br/> | '''textures''': (table) file names of textures<br/> | ||
| − | '''padding''': (number) the spacing between textures in pixels<br/> | + | '''padding''': (number) the spacing between textures in pixels '''optional'''<br/> |
| − | '''filtering''': (boolean, default = false) whether or not the texture is filtered<br/> | + | '''filtering''': (boolean, default = false) whether or not the texture is filtered, that is smoothing the image '''optional'''<br/> |
| − | '''options''': (table | + | '''options''': (table) a table that specifies optional parameters '''optional'''. Currently, "transparentColor" and "format" fields are supported<br/> |
| + | |||
| + | === Example === | ||
| + | '''Store all images in a folder to a table for use in TexturePack''' | ||
| + | <syntaxhighlight lang="lua"> | ||
| + | local lfs = require "lfs" | ||
| + | |||
| + | |||
| + | local list = {} | ||
| + | |||
| + | function attrdir(path) | ||
| + | for file in lfs.dir(path) do | ||
| + | if file ~= "." and file ~= ".." then | ||
| + | local f = path..'/'..file | ||
| + | local attr = lfs.attributes(f) | ||
| + | if attr.mode == "file" then table.insert(list, f) end | ||
| + | end | ||
| + | end | ||
| + | end | ||
| + | attrdir("gfx/hero") -- folder to fetch images from | ||
| + | |||
| + | --local tp = TexturePack.new({"gfx/hero/HQ_Trooper_all.png", "gfx/hero/caverman.png", "gfx/hero/test01.png"}) | ||
| + | local tp = TexturePack.new(list) | ||
| + | local bmp = Bitmap.new(tp:getTextureRegion("gfx/hero/caverman.png")) | ||
| + | stage:addChild(bmp) | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | |||
| + | ---- | ||
__NOTOC__ | __NOTOC__ | ||
| − | ''' | + | '''Available since:''' Gideros 2011.6<br/> |
| − | ''' | + | '''Class:''' [[TexturePack]]<br/> |
=== Description === | === Description === | ||
| − | Creates a new | + | Creates a new '''TexturePack''' object. This function loads the pre-packed texture atlas created by "'''Gideros Texture Packer'''" tool. |
| − | < | + | <syntaxhighlight lang="lua"> |
TexturePack.new(txtfile,imagefile,filtering,options) | TexturePack.new(txtfile,imagefile,filtering,options) | ||
| − | </ | + | </syntaxhighlight> |
=== Parameters === | === Parameters === | ||
| − | '''txtfile''': (string) | + | '''txtfile''': (string) '''Gideros Texture Packer''' text file path<br/> |
| − | '''imagefile''': (string) | + | '''imagefile''': (string) '''Gideros Texture Packer''' image file path<br/> |
| − | '''filtering''': (boolean, default = false) | + | '''filtering''': (boolean, default = false) whether or not the texture is filtered, that is smoothing the image '''optional'''<br/> |
| − | '''options''': (table | + | '''options''': (table) a table that specifies optional parameters '''optional'''. Currently, "transparentColor" and "format" fields are supported<br/> |
{{TexturePack}} | {{TexturePack}} | ||
Latest revision as of 15:33, 13 July 2023
Available since: Gideros 2011.6
Class: TexturePack
Description
Creates a new TexturePack object. This function creates the texture pack at runtime.
TexturePack.new(textures,padding,filtering,options)
Parameters
textures: (table) file names of textures
padding: (number) the spacing between textures in pixels optional
filtering: (boolean, default = false) whether or not the texture is filtered, that is smoothing the image optional
options: (table) a table that specifies optional parameters optional. Currently, "transparentColor" and "format" fields are supported
Example
Store all images in a folder to a table for use in TexturePack
local lfs = require "lfs"
local list = {}
function attrdir(path)
for file in lfs.dir(path) do
if file ~= "." and file ~= ".." then
local f = path..'/'..file
local attr = lfs.attributes(f)
if attr.mode == "file" then table.insert(list, f) end
end
end
end
attrdir("gfx/hero") -- folder to fetch images from
--local tp = TexturePack.new({"gfx/hero/HQ_Trooper_all.png", "gfx/hero/caverman.png", "gfx/hero/test01.png"})
local tp = TexturePack.new(list)
local bmp = Bitmap.new(tp:getTextureRegion("gfx/hero/caverman.png"))
stage:addChild(bmp)
Available since: Gideros 2011.6
Class: TexturePack
Description
Creates a new TexturePack object. This function loads the pre-packed texture atlas created by "Gideros Texture Packer" tool.
TexturePack.new(txtfile,imagefile,filtering,options)
Parameters
txtfile: (string) Gideros Texture Packer text file path
imagefile: (string) Gideros Texture Packer image file path
filtering: (boolean, default = false) whether or not the texture is filtered, that is smoothing the image optional
options: (table) a table that specifies optional parameters optional. Currently, "transparentColor" and "format" fields are supported
