Difference between revisions of "Texture.new"
m (Text replacement - "<source" to "<syntaxhighlight") |
|||
| Line 5: | Line 5: | ||
=== Description === | === Description === | ||
Creates a new Texture object. | Creates a new Texture object. | ||
| − | < | + | <syntaxhighlight lang="lua"> |
Texture.new(filename,filtering,options) | Texture.new(filename,filtering,options) | ||
</source> | </source> | ||
| Line 23: | Line 23: | ||
=== Examples === | === Examples === | ||
| − | < | + | <syntaxhighlight lang="lua"> |
-- do not filter and make the color 0xff00ff transparent | -- do not filter and make the color 0xff00ff transparent | ||
local texture = Texture.new("image.jpg", false, {transparentColor = 0xff00ff}) | local texture = Texture.new("image.jpg", false, {transparentColor = 0xff00ff}) | ||
| Line 39: | Line 39: | ||
=== Description === | === Description === | ||
Creates a texture from pixel data. | Creates a texture from pixel data. | ||
| − | < | + | <syntaxhighlight lang="lua"> |
Texture.new(pixels,width,height,filtering,options) | Texture.new(pixels,width,height,filtering,options) | ||
</source> | </source> | ||
| Line 59: | Line 59: | ||
=== Example === | === Example === | ||
| − | < | + | <syntaxhighlight lang="lua"> |
-- Create a 300x400 empty texture. Prevent gideros from extending the texture to the next power of two size | -- Create a 300x400 empty texture. Prevent gideros from extending the texture to the next power of two size | ||
local texture = Texture.new(nil, 300, 400, false, {extend=false}) | local texture = Texture.new(nil, 300, 400, false, {extend=false}) | ||
Revision as of 15:31, 13 July 2023
Available since: Gideros 2011.6
Class: Texture
Description
Creates a new Texture object. <syntaxhighlight lang="lua"> Texture.new(filename,filtering,options) </source>
Parameters
filename: (string) the name of the texture file to be loaded
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. The following options are supported:
- transparentColor: specify which color stands for transparent for formats that don't supply an alpha channel such as JPEG
- wrap: how to treat texels outside the texture. Possible values are Texture.CLAMP (default) and Texture.REPEAT
- format: the GPU pixel format for the texture (default = RGBA8888)
- extend: whether the texture should be extended to a power of two size (default = true)
- scale: the scale at which this texture was made, if it cannot be determined by a suffix (default = 1)
- rawalpha: disable alpha premultiplication. This can be helpful if one wants to store specific data in the alpha channel of a texture along with a dedicated shader (new 2022.3) (default = false)
- mipmap: enable mipmaping (new 2022.6) (default = false)
Examples
<syntaxhighlight lang="lua"> -- do not filter and make the color 0xff00ff transparent local texture = Texture.new("image.jpg", false, {transparentColor = 0xff00ff}) -- enable filtering and repeat the texture local texture = Texture.new("image.png", true, {wrap = Texture.REPEAT}) </source>
Available since: Gideros 2016.08
Class: Texture
Description
Creates a texture from pixel data. <syntaxhighlight lang="lua"> Texture.new(pixels,width,height,filtering,options) </source>
Parameters
pixels: (string) a string containing actual R,G,B,A components 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 = false) indicates that the texture should be filtered, that is smoothing the image optional
options: (table) a table that specifies optional parameters optional. The following options are supported:
- transparentColor: specify which color stands for transparent for formats that don't supply an alpha channel such as JPEG
- wrap: how to treat texels outside the texture. Possible values are Texture.CLAMP (default) and Texture.REPEAT
- format: the GPU pixel format for the texture (default = RGBA8888)
- extend: whether the texture should be extended to a power of two size (default = true)
- scale: the scale at which this texture was made, if it cannot be determined by a suffix (default = 1)
- rawalpha: disable alpha premultiplication. This can be helpful if one wants to store specific data in the alpha channel of a texture along with a dedicated shader (new 2022.3) (default = false)
- mipmap: enable mipmaping (new 2022.6) (default = false)
Example
<syntaxhighlight lang="lua"> -- Create a 300x400 empty texture. Prevent gideros from extending the texture to the next power of two size local texture = Texture.new(nil, 300, 400, false, {extend=false}) </source>
