Difference between revisions of "Noise:getTileTexture"

From GiderosMobile
m (Text replacement - "</source>" to "</syntaxhighlight>")
 
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
<languages />
+
'''Available since:''' Gideros 2020.5<br/>
'''<translate>Available since</translate>:''' Gideros 2020.5<br/>
+
'''Class:''' [[FastNoise]]<br/>
'''<translate>Class</translate>:''' [[Special:MyLanguage/Noise|Noise]]<br/>
+
 
=== <translate>Description</translate> ===
+
=== Description ===
<translate><br />
+
Gets the tileable noise texture (on all 4 sides).
Get tileable noise texture (on all 4 sides).<br />
 
<br /></translate>
 
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
 
(texture) = Noise:getTileTexture(width, height, [filtering, options])
 
(texture) = Noise:getTileTexture(width, height, [filtering, options])
 
</syntaxhighlight>
 
</syntaxhighlight>
=== <translate>Parameters</translate> ===
 
'''width''': (number) <translate>texture width</translate> <br/>
 
'''height''': (number) <translate>texture height</translate> <br/>
 
'''filtering''': (boolean, default = false) <translate>Whether or not the texture is filtered.</translate><br/>
 
'''options''': (table, optional) <translate>A table that specifies optional paramaters. The following options are supported:</translate><br/>
 
  
* '''transparentColor''':<translate>Specify which color stands for transparent, for formats that don't supply an alpha channel such as JPEG</translate>
+
=== Parameters ===
* '''wrap''':<translate>How to treat texels outside the texture. Possible values are Texture.CLAMP and Texture.REPEAT.</translate>
+
'''width''': (number) texture width<br/>
* '''format''':<translate>The GPU pixel format for the texture</translate>
+
'''height''': (number) texture height<br/>
* '''extend''':<translate>Wether the texture should be extended to a power of two size. Defaults to true.</translate>
+
'''filtering''': (boolean, default = false) whether or not the texture is filtered<br/>
* '''scale''':<translate>The scale at which this texture was made, if it cannot be determined by a suffix. Defaults to 1.</translate> <br/>
+
'''options''': (table, optional) a table that specifies optional paramaters. The following options are supported:
=== <translate>Return values</translate> ===
+
* '''transparentColor''': specify which color stands for transparent, for formats that don't supply an alpha channel such as JPEG
'''<translate>Returns</translate>''' <translate>[[Special:MyLanguage/Texture|Texture]] object</translate><br/>
+
* '''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. Default = true
 +
* '''scale''': the scale at which this texture was made if it cannot be determined by a suffix. Default = 1<br/>
 +
 
 +
=== Return values ===
 +
'''Returns''' [[Texture]] object<br/>
  
{{Noise}}
+
{{FastNoise}}

Latest revision as of 23:41, 28 July 2025

Available since: Gideros 2020.5
Class: FastNoise

Description

Gets the tileable noise texture (on all 4 sides).

(texture) = Noise:getTileTexture(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: 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 and Texture.REPEAT
  • format: the GPU pixel format for the texture
  • 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

Return values

Returns Texture object