Difference between revisions of "TexturePack.new"

From GiderosMobile
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
−
'''<translate>Available since</translate>:''' Gideros 2011.6<br/>
+
'''Available since:''' Gideros 2011.6<br/>
−
'''<translate>Class</translate>:''' [[Special:MyLanguage/TexturePack|TexturePack]]<br/>
+
'''Class:''' [[TexturePack]]<br/>
−
=== <translate>Description</translate> ===
+
 
−
<translate><br />
+
=== Description ===
−
Creates a new [[Special:MyLanguage/TexturePack|TexturePack]] object. This function creates the texture pack at runtime.<br />
+
Creates a new '''TexturePack''' object. This function creates the texture pack at runtime.
−
<br /></translate>
+
<syntaxhighlight lang="lua">
−
<source lang="lua">
+
TexturePack.new(textures,padding,filtering,options)
−
TexturePack.new(textures,padding,filtering,options)
+
</syntaxhighlight>
−
</source>
+
 
−
=== <translate>Parameters</translate> ===
+
=== Parameters ===
−
'''textures''': (table) <translate>file names of textures.</translate> <br/>
+
'''textures''': (table) file names of textures<br/>
−
'''padding''': (number) <translate>the spacing between textures in pixels</translate> <br/>
+
'''padding''': (number) the spacing between textures in pixels '''optional'''<br/>
−
'''filtering''': (boolean, default = false) <translate>Whether or not the texture is filtered.</translate> <br/>
+
'''filtering''': (boolean, default = false) whether or not the texture is filtered, that is smoothing the image '''optional'''<br/>
−
'''options''': (table, optional) <translate>A table that specifies optional paramaters. Currently, &quot;transparentColor&quot; and &quot;format&quot fields are supported.</translate> <br/>
+
'''options''': (table) a table that specifies optional parameters '''optional'''. Currently, "transparentColor" and "format" fields are supported<br/>
 +
 
 +
=== Examples ===
 +
'''A snippet using Tiled'''
 +
<syntaxhighlight lang="lua">
 +
local bgtpt = {} -- background texture pack table
 +
for i = 1, #layer.objects do
 +
bgtpt[#bgtpt+1] = tilesetimages[layer.objects[i].gid].path
 +
end
 +
local bgtp = TexturePack.new(bgtpt, nil, nil, { format=TextureBase.RGBA4444, } ) -- perfs
 +
</syntaxhighlight>
 +
 
 +
'''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__
−
'''<translate>Available since</translate>:''' Gideros 2011.6<br/>
+
'''Available since:''' Gideros 2011.6<br/>
−
'''<translate>Class</translate>:''' [[Special:MyLanguage/TexturePack|TexturePack]]<br/>
+
'''Class:''' [[TexturePack]]<br/>
−
=== <translate>Description</translate> ===
+
 
−
<translate><br />
+
=== Description ===
−
Creates a new [[Special:MyLanguage/TexturePack|TexturePack]] object. This function loads the pre-packed texture atlas created by &quot;Gideros Texture Packer&quot; tool.<br />
+
Creates a new '''TexturePack''' object. This function loads the pre-packed texture atlas created by "'''Gideros Texture Packer'''" tool.
−
<br /></translate>
+
<syntaxhighlight lang="lua">
−
<source lang="lua">
+
TexturePack.new(txtfile,imagefile,filtering,options)
−
TexturePack.new(txtfile,imagefile,filtering,options)
+
</syntaxhighlight>
−
</source>
+
 
−
=== <translate>Parameters</translate> ===
+
=== Parameters ===
−
'''txtfile''': (string) <translate></translate> <br/>
+
'''txtfile''': (string) '''Gideros Texture Packer''' text file path<br/>
−
'''imagefile''': (string) <translate></translate> <br/>
+
'''imagefile''': (string) '''Gideros Texture Packer''' image file path<br/>
−
'''filtering''': (boolean, default = false) <translate>Whether or not the texture is filtered.</translate> <br/>
+
'''filtering''': (boolean, default = false) whether or not the texture is filtered, that is smoothing the image '''optional'''<br/>
−
'''options''': (table, optional) <translate>A table that specifies optional paramaters. Currently, &quot;transparentColor&quot; and &quot;format&quot fields are supported.</translate> <br/>
+
'''options''': (table) a table that specifies optional parameters '''optional'''. Currently, "transparentColor" and "format" fields are supported<br/>
 +
 
 +
=== Example ===
 +
<syntaxhighlight lang="lua">
 +
--[[
 +
Texture pack example
 +
This code is MIT licensed, see http://www.opensource.org/licenses/mit-license.php
 +
(C) 2010 - 2011 Gideros Mobile
 +
]]
 +
 
 +
AnimatedSprite = Core.class(Sprite)
 +
 
 +
function AnimatedSprite:init()
 +
local pack = TexturePack.new("anim.txt", "anim.png")
 +
self.anim = {
 +
Bitmap.new(pack:getTextureRegion("anim_01.png")),
 +
Bitmap.new(pack:getTextureRegion("anim_02.png")),
 +
Bitmap.new(pack:getTextureRegion("anim_03.png")),
 +
Bitmap.new(pack:getTextureRegion("anim_04.png")),
 +
Bitmap.new(pack:getTextureRegion("anim_05.png")),
 +
Bitmap.new(pack:getTextureRegion("anim_06.png")),
 +
Bitmap.new(pack:getTextureRegion("anim_07.png")),
 +
Bitmap.new(pack:getTextureRegion("anim_08.png")),
 +
Bitmap.new(pack:getTextureRegion("anim_09.png")),
 +
Bitmap.new(pack:getTextureRegion("anim_10.png")),
 +
Bitmap.new(pack:getTextureRegion("anim_11.png")),
 +
Bitmap.new(pack:getTextureRegion("anim_12.png")),
 +
Bitmap.new(pack:getTextureRegion("anim_13.png")),
 +
}
 +
self.frame = 1
 +
self:addChild(self.anim[1])
 +
self.nframes = #self.anim
 +
self.subframe = 0
 +
self:addEventListener(Event.ENTER_FRAME, self.onEnterFrame, self)
 +
end
 +
 
 +
function AnimatedSprite:onEnterFrame()
 +
self.subframe += 1
 +
if self.subframe > 4 then -- speed
 +
self:removeChild(self.anim[self.frame])
 +
self.frame += 1
 +
if self.frame > self.nframes then
 +
self.frame = 1
 +
end
 +
self:addChild(self.anim[self.frame])
 +
self.subframe = 0
 +
end
 +
end
 +
 
 +
-- let's go
 +
stage:setOrientation(Stage.LANDSCAPE_LEFT)
 +
stage:addChild(AnimatedSprite.new())
 +
</syntaxhighlight>
 +
 
 +
 
 +
----
 +
 
 +
__NOTOC__
 +
'''Available since:''' Gideros 2025.9<br/>
 +
'''Class:''' [[TexturePack]]<br/>
 +
 
 +
=== Description ===
 +
Creates an open '''TexturePack''' object based on a RenderTarget.
 +
<syntaxhighlight lang="lua">
 +
TexturePack.new(rt)
 +
</syntaxhighlight>
 +
 
 +
=== Parameters ===
 +
'''rt''': (RenderTarget) a RenderTarget<br/>
 +
 
 +
{{TexturePack}}

Latest revision as of 22:42, 4 September 2025

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

Examples

A snippet using Tiled 

local bgtpt = {} -- background texture pack table
for i = 1, #layer.objects do
	bgtpt[#bgtpt+1] = tilesetimages[layer.objects[i].gid].path
end
local bgtp = TexturePack.new(bgtpt, nil, nil, { format=TextureBase.RGBA4444, } ) -- perfs

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

Example

--[[
Texture pack example
This code is MIT licensed, see http://www.opensource.org/licenses/mit-license.php
(C) 2010 - 2011 Gideros Mobile 
]]

AnimatedSprite = Core.class(Sprite)

function AnimatedSprite:init()
	local pack = TexturePack.new("anim.txt", "anim.png")
	self.anim = {
		Bitmap.new(pack:getTextureRegion("anim_01.png")),
		Bitmap.new(pack:getTextureRegion("anim_02.png")),
		Bitmap.new(pack:getTextureRegion("anim_03.png")),
		Bitmap.new(pack:getTextureRegion("anim_04.png")),
		Bitmap.new(pack:getTextureRegion("anim_05.png")),
		Bitmap.new(pack:getTextureRegion("anim_06.png")),
		Bitmap.new(pack:getTextureRegion("anim_07.png")),
		Bitmap.new(pack:getTextureRegion("anim_08.png")),
		Bitmap.new(pack:getTextureRegion("anim_09.png")),
		Bitmap.new(pack:getTextureRegion("anim_10.png")),
		Bitmap.new(pack:getTextureRegion("anim_11.png")),
		Bitmap.new(pack:getTextureRegion("anim_12.png")),
		Bitmap.new(pack:getTextureRegion("anim_13.png")),
	}
	self.frame = 1
	self:addChild(self.anim[1])
	self.nframes = #self.anim
	self.subframe = 0
	self:addEventListener(Event.ENTER_FRAME, self.onEnterFrame, self)
end

function AnimatedSprite:onEnterFrame()
	self.subframe += 1
	if self.subframe > 4 then -- speed
		self:removeChild(self.anim[self.frame])
		self.frame += 1
		if self.frame > self.nframes then
			self.frame = 1
		end
		self:addChild(self.anim[self.frame])
		self.subframe = 0
	end
end

-- let's go
stage:setOrientation(Stage.LANDSCAPE_LEFT)
stage:addChild(AnimatedSprite.new())



Available since: Gideros 2025.9
Class: TexturePack

Description

Creates an open TexturePack object based on a RenderTarget. 

TexturePack.new(rt)

Parameters

rt: (RenderTarget) a RenderTarget



Retrieved from ‘https://wiki.gideros.rocks/index.php?title=TexturePack.new&oldid=24641’