Difference between revisions of "Noise:getTexture"
From GiderosMobile
(removed language stuff) |
|||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
− | + | '''Available since:''' Gideros 2020.5<br/> | |
− | ''' | + | '''Class:''' [[Noise]]<br/> |
− | ''' | + | |
− | === | + | === Description === |
− | + | Gets the noise texture. | |
− | |||
− | |||
<source lang="lua"> | <source lang="lua"> | ||
(texture) = Noise:getTexture(width, height, [filtering, options]) | (texture) = Noise:getTexture(width, height, [filtering, options]) | ||
</source> | </source> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | * '''transparentColor''': | + | === Parameters === |
− | * '''wrap''': | + | '''width''': (number) texture width<br/> |
− | * '''format''': | + | '''height''': (number) texture height<br/> |
− | * '''extend''': | + | '''filtering''': (boolean, default = false) whether or not the texture is filtered<br/> |
− | * '''scale''': | + | '''options''': (table, '''optional''') a table that specifies optional paramaters. 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 21:13, 18 March 2021
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, default = false) whether or not the texture is filtered
options: (table, optional) a table that specifies optional paramaters. 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