Difference between revisions of "Texture.loadAsync"

From GiderosMobile
(removed language stuff)
m (Text replacement - "<source" to "<syntaxhighlight")
Line 5: Line 5:
 
=== Description ===
 
=== Description ===
 
Asynchronously loads a texture from a file.
 
Asynchronously loads a texture from a file.
<source lang="lua">
+
<syntaxhighlight lang="lua">
 
Texture.loadAsync(callback,filename,filtering,options)
 
Texture.loadAsync(callback,filename,filtering,options)
 
</source>
 
</source>
Line 22: Line 22:
  
 
=== Example ===
 
=== Example ===
<source lang="lua">
+
<syntaxhighlight lang="lua">
 
Texture.loadAsync(function (texture, error)
 
Texture.loadAsync(function (texture, error)
 
stage:addChild(Bitmap.new(texture))
 
stage:addChild(Bitmap.new(texture))

Revision as of 14:31, 13 July 2023

Available since: Gideros 2021.8.1
Class: Texture

Description

Asynchronously loads a texture from a file. <syntaxhighlight lang="lua"> Texture.loadAsync(callback,filename,filtering,options) </source>

Parameters

callback: (function) the function will be called with the Texture object as argument or an error as second argument.
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 parameters. The following options are supported:

  • transparentColor: specifies 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 and Texture.REPEAT.
  • format: the GPU pixel format for the texture
  • extend: wether the texture should be extended to a power of two size. Defaults to true.
  • scale: the scale at which this texture was made, if it cannot be determined by a suffix. Defaults to 1.

Example

<syntaxhighlight lang="lua"> Texture.loadAsync(function (texture, error) stage:addChild(Bitmap.new(texture)) end,"image.png", true, {wrap = Texture.REPEAT}) </source>