Difference between revisions of "Noise:getTexture"
From GiderosMobile
(Created page with "__NOTOC__ <languages /> '''<translate>Available since</translate>:''' Gideros 2020.5<br/> '''<translate>Class</translate>:''' Noise<br/> === <tran...") |
m (Text replacement - "</source>" to "</syntaxhighlight>") |
||
| (4 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| − | + | '''Available since:''' Gideros 2020.5<br/> | |
| − | ''' | + | '''Class:''' [[Noise]]<br/> |
| − | ''' | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | * '''transparentColor''': | + | === Description === |
| − | * '''wrap''': | + | Gets the noise texture. |
| − | * '''format''': | + | <syntaxhighlight lang="lua"> |
| − | * '''extend''': | + | (texture) = Noise:getTexture(width,height,[filtering,options]) |
| − | * '''scale''': | + | </syntaxhighlight> |
| − | === | + | |
| − | ''' | + | === Parameters === |
| + | '''width''': (number) texture width<br/> | ||
| + | '''height''': (number) texture height<br/> | ||
| + | '''filtering''': (boolean) whether or not the texture is filtered, '''optional''', default = false<br/> | ||
| + | '''options''': (table) a table that specifies optional paramaters, '''optional'''. The following options are supported:<br/> | ||
| + | |||
| + | * '''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''': whether 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 | ||
| + | |||
| + | === Return values === | ||
| + | '''Returns''' a [[Texture]] object<br/> | ||
{{Noise}} | {{Noise}} | ||
Revision as of 14:30, 13 July 2023
Available since: Gideros 2020.5
Class: Noise
Description
Gets the noise texture.
(texture) = Noise:getTexture(width,height,[filtering,options])
Parameters
width: (number) texture width
height: (number) texture height
filtering: (boolean) whether or not the texture is filtered, optional, default = false
options: (table) a table that specifies optional paramaters, optional. 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: whether 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
Return values
Returns a Texture object
