Difference between revisions of "Noise:getTexture"

From GiderosMobile
(removed language stuff)
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
'''Available since:''' Gideros 2020.5<br/>
 
'''Available since:''' Gideros 2020.5<br/>
'''Class:''' [[Noise]]<br/>
+
'''Class:''' [[FastNoise]]<br/>
  
 
=== Description ===
 
=== Description ===
 
Gets the noise texture.
 
Gets the noise texture.
<source lang="lua">
+
<syntaxhighlight lang="lua">
(texture) = Noise:getTexture(width, height, [filtering, options])
+
(texture) = Noise:getTexture(width,height,[filtering,options])
</source>
+
</syntaxhighlight>
  
 
=== Parameters ===
 
=== Parameters ===
 
'''width''': (number) texture width<br/>
 
'''width''': (number) texture width<br/>
 
'''height''': (number) texture height<br/>
 
'''height''': (number) texture height<br/>
'''filtering''': (boolean, default = false) whether or not the texture is filtered<br/>
+
'''filtering''': (boolean) whether or not the texture is filtered, '''optional''', default = false<br/>
'''options''': (table, '''optional''') a table that specifies optional paramaters. The following options are supported:<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
 
* '''transparentColor''': specifies which color stands for transparent, for formats that don't supply an alpha channel such as JPEG
Line 24: Line 24:
 
'''Returns''' a [[Texture]] object<br/>
 
'''Returns''' a [[Texture]] object<br/>
  
{{Noise}}
+
{{FastNoise}}

Latest revision as of 23:35, 28 July 2025

Available since: Gideros 2020.5
Class: FastNoise

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