:github_url: hide

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the NoiseTexture.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_NoiseTexture:

NoiseTexture
============

**Inherits:** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`

**Category:** Core

Brief Description
-----------------

:ref:`OpenSimplexNoise<class_OpenSimplexNoise>` filled texture.

Properties
----------

+-------------------------------------------------+-----------------------------------------------------------------+-------+
| :ref:`bool<class_bool>`                         | :ref:`as_normalmap<class_NoiseTexture_property_as_normalmap>`   | false |
+-------------------------------------------------+-----------------------------------------------------------------+-------+
| :ref:`float<class_float>`                       | :ref:`bump_strength<class_NoiseTexture_property_bump_strength>` | 8.0   |
+-------------------------------------------------+-----------------------------------------------------------------+-------+
| :ref:`int<class_int>`                           | :ref:`height<class_NoiseTexture_property_height>`               | 512   |
+-------------------------------------------------+-----------------------------------------------------------------+-------+
| :ref:`OpenSimplexNoise<class_OpenSimplexNoise>` | :ref:`noise<class_NoiseTexture_property_noise>`                 |       |
+-------------------------------------------------+-----------------------------------------------------------------+-------+
| :ref:`bool<class_bool>`                         | :ref:`seamless<class_NoiseTexture_property_seamless>`           | false |
+-------------------------------------------------+-----------------------------------------------------------------+-------+
| :ref:`int<class_int>`                           | :ref:`width<class_NoiseTexture_property_width>`                 | 512   |
+-------------------------------------------------+-----------------------------------------------------------------+-------+

Description
-----------

Uses an :ref:`OpenSimplexNoise<class_OpenSimplexNoise>` to fill the texture data. You can specify the texture size but keep in mind that larger textures will take longer to generate and seamless noise only works with square sized textures.

NoiseTexture can also generate normalmap textures.

Property Descriptions
---------------------

.. _class_NoiseTexture_property_as_normalmap:

- :ref:`bool<class_bool>` **as_normalmap**

+-----------+-------------------------+
| *Default* | false                   |
+-----------+-------------------------+
| *Setter*  | set_as_normalmap(value) |
+-----------+-------------------------+
| *Getter*  | is_normalmap()          |
+-----------+-------------------------+

If ``true``, the resulting texture contains a normal map created from the original noise interpreted as a bump map.

.. _class_NoiseTexture_property_bump_strength:

- :ref:`float<class_float>` **bump_strength**

+-----------+--------------------------+
| *Default* | 8.0                      |
+-----------+--------------------------+
| *Setter*  | set_bump_strength(value) |
+-----------+--------------------------+
| *Getter*  | get_bump_strength()      |
+-----------+--------------------------+

.. _class_NoiseTexture_property_height:

- :ref:`int<class_int>` **height**

+-----------+-------------------+
| *Default* | 512               |
+-----------+-------------------+
| *Setter*  | set_height(value) |
+-----------+-------------------+
| *Getter*  | get_height()      |
+-----------+-------------------+

Height of the generated texture.

.. _class_NoiseTexture_property_noise:

- :ref:`OpenSimplexNoise<class_OpenSimplexNoise>` **noise**

+----------+------------------+
| *Setter* | set_noise(value) |
+----------+------------------+
| *Getter* | get_noise()      |
+----------+------------------+

The :ref:`OpenSimplexNoise<class_OpenSimplexNoise>` instance used to generate the noise.

.. _class_NoiseTexture_property_seamless:

- :ref:`bool<class_bool>` **seamless**

+-----------+---------------------+
| *Default* | false               |
+-----------+---------------------+
| *Setter*  | set_seamless(value) |
+-----------+---------------------+
| *Getter*  | get_seamless()      |
+-----------+---------------------+

Whether the texture can be tiled without visible seams or not. Seamless textures take longer to generate.

.. _class_NoiseTexture_property_width:

- :ref:`int<class_int>` **width**

+-----------+------------------+
| *Default* | 512              |
+-----------+------------------+
| *Setter*  | set_width(value) |
+-----------+------------------+
| *Getter*  | get_width()      |
+-----------+------------------+

Width of the generated texture.