Difference between revisions of "Texture.new"
| Line 8: | Line 8: | ||
Texture.new(filename,filtering,options) | Texture.new(filename,filtering,options) | ||
</source> | </source> | ||
| − | '''filename''': (string) The name of the texture file to be loaded. | + | === Parameters === |
| − | '''filtering''': (boolean, default = false) Whether or not the texture is filtered. | + | '''filename''': (string) The name of the texture file to be loaded. <br/> |
| + | '''filtering''': (boolean, default = false) Whether or not the texture is filtered. <br/> | ||
'''options''': (table, optional) A table that specifies optional paramaters. Currently, "transparentColor", "wrap", "format" and "extend" fields are supported. '''optional'''<br/> | '''options''': (table, optional) A table that specifies optional paramaters. Currently, "transparentColor", "wrap", "format" and "extend" fields are supported. '''optional'''<br/> | ||
| + | === Examples === | ||
| + | '''Example'''<br/> | ||
| + | <source lang="lua">local texture = Texture.new("image.png", false, {transparentColor = 0xff00ff}) -- do not filter and make the color 0xff00ff transparent<br /> | ||
| + | local texture = Texture.new("image.png", true, {wrap = Texture.REPEAT}) -- enable filtering and repeat the texture<br /></source> | ||
__NOTOC__ | __NOTOC__ | ||
'''Available since:''' Gideros 2016.08<br/> | '''Available since:''' Gideros 2016.08<br/> | ||
| Line 18: | Line 23: | ||
Texture.new(pixels,width,height,filtering,options) | Texture.new(pixels,width,height,filtering,options) | ||
</source> | </source> | ||
| − | '''pixels''': (string) A string containing actual R,G,B,A compoents of each pixel in the new texture. Each component is stored as a byte. You can pass nil if you don't need to initialize texture content | + | === Parameters === |
| − | '''width''': (number) width of the texture to create | + | '''pixels''': (string) A string containing actual R,G,B,A compoents of each pixel in the new texture. Each component is stored as a byte. You can pass nil if you don't need to initialize texture content <br/> |
| − | '''height''': (number) Height of the texture to create | + | '''width''': (number) width of the texture to create <br/> |
| + | '''height''': (number) Height of the texture to create <br/> | ||
'''filtering''': (boolean, default to false) indicate that the texture should be filtered '''optional'''<br/> | '''filtering''': (boolean, default to false) indicate that the texture should be filtered '''optional'''<br/> | ||
'''options''': (table, optional) A table that specifies optional paramaters. Currently, "transparentColor", "wrap", "format" and "extend" fields are supported. '''optional'''<br/> | '''options''': (table, optional) A table that specifies optional paramaters. Currently, "transparentColor", "wrap", "format" and "extend" fields are supported. '''optional'''<br/> | ||
| + | === Examples === | ||
| + | '''Example'''<br/> | ||
| + | <source lang="lua">local texture = Texture.new(nil,300,400;, false, {extend=false}) -- Create a 300x400 empty texture. Prevent gideros from extending the texture to the next power of two size<br /></source> | ||
Revision as of 10:40, 23 August 2018
Available since: Gideros 2011.6
Description
Creates a new Texture object.
Texture.new(filename,filtering,options)
Parameters
filename: (string) The name of the texture file to be loaded.
filtering: (boolean, default = false) Whether or not the texture is filtered.
options: (table, optional) A table that specifies optional paramaters. Currently, "transparentColor", "wrap", "format" and "extend" fields are supported. optional
Examples
Example
local texture = Texture.new("image.png", false, {transparentColor = 0xff00ff}) -- do not filter and make the color 0xff00ff transparent<br />
local texture = Texture.new("image.png", true, {wrap = Texture.REPEAT}) -- enable filtering and repeat the texture<br />
Available since: Gideros 2016.08
Description
Create a texture from pixel data.
Texture.new(pixels,width,height,filtering,options)
Parameters
pixels: (string) A string containing actual R,G,B,A compoents of each pixel in the new texture. Each component is stored as a byte. You can pass nil if you don't need to initialize texture content
width: (number) width of the texture to create
height: (number) Height of the texture to create
filtering: (boolean, default to false) indicate that the texture should be filtered optional
options: (table, optional) A table that specifies optional paramaters. Currently, "transparentColor", "wrap", "format" and "extend" fields are supported. optional
Examples
Example
local texture = Texture.new(nil,300,400;, false, {extend=false}) -- Create a 300x400 empty texture. Prevent gideros from extending the texture to the next power of two size<br />
