Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Branch: 4.0
Branches Tags
godot-docs
/
classes
/
class_noise.rst

class_noise.rst 9.3 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152 
  1. :github_url: hide
    2. 

  2. 

  3. .. DO NOT EDIT THIS FILE!!!
    4. 

  4. .. Generated automatically from Godot engine sources.
    5. 

  5. .. Generator: https://github.com/godotengine/godot/tree/4.0/doc/tools/make_rst.py.
    6. 

  6. .. XML source: https://github.com/godotengine/godot/tree/4.0/modules/noise/doc_classes/Noise.xml.
    7. 

  7. 

  8. .. _class_Noise:
    9. 

  9. 

  10. Noise
    11. 

  11. =====
    12. 

  12. 

  13. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
    14. 

  14. 

  15. **Inherited By:** :ref:`FastNoiseLite<class_FastNoiseLite>`
    16. 

  16. 

  17. Abstract base class for noise generators.
    18. 

  18. 

  19. .. rst-class:: classref-introduction-group
    20. 

  20. 

  21. Description
    22. 

  22. -----------
    23. 

  23. 

  24. This class defines the interface for noise generation libraries to inherit from.
    25. 

  25. 

  26. A default get_seamless_noise() implementation is provided for libraries that do not provide seamless noise. This function requests a larger image from get_image(), reverses the quadrants of the image, then uses the strips of extra width to blend over the seams.
    27. 

  27. 

  28. Inheriting noise classes can optionally override this function to provide a more optimal algorithm.
    29. 

  29. 

  30. .. rst-class:: classref-reftable-group
    31. 

  31. 

  32. Methods
    33. 

  33. -------
    34. 

  34. 

  35. .. table::
    36. 

  36.    :widths: auto
    37. 

  37. 

  38.    +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    39. 

  39.    | :ref:`Image<class_Image>` | :ref:`get_image<class_Noise_method_get_image>` **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`bool<class_bool>` invert=false, :ref:`bool<class_bool>` in_3d_space=false, :ref:`bool<class_bool>` normalize=true **)** |const|                                                        |
    40. 

  40.    +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    41. 

  41.    | :ref:`float<class_float>` | :ref:`get_noise_1d<class_Noise_method_get_noise_1d>` **(** :ref:`float<class_float>` x **)** |const|                                                                                                                                                                                                         |
    42. 

  42.    +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    43. 

  43.    | :ref:`float<class_float>` | :ref:`get_noise_2d<class_Noise_method_get_noise_2d>` **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)** |const|                                                                                                                                                                            |
    44. 

  44.    +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    45. 

  45.    | :ref:`float<class_float>` | :ref:`get_noise_2dv<class_Noise_method_get_noise_2dv>` **(** :ref:`Vector2<class_Vector2>` v **)** |const|                                                                                                                                                                                                   |
    46. 

  46.    +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    47. 

  47.    | :ref:`float<class_float>` | :ref:`get_noise_3d<class_Noise_method_get_noise_3d>` **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y, :ref:`float<class_float>` z **)** |const|                                                                                                                                               |
    48. 

  48.    +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    49. 

  49.    | :ref:`float<class_float>` | :ref:`get_noise_3dv<class_Noise_method_get_noise_3dv>` **(** :ref:`Vector3<class_Vector3>` v **)** |const|                                                                                                                                                                                                   |
    50. 

  50.    +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    51. 

  51.    | :ref:`Image<class_Image>` | :ref:`get_seamless_image<class_Noise_method_get_seamless_image>` **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`bool<class_bool>` invert=false, :ref:`bool<class_bool>` in_3d_space=false, :ref:`float<class_float>` skirt=0.1, :ref:`bool<class_bool>` normalize=true **)** |const| |
    52. 

  52.    +---------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    53. 

  53. 

  54. .. rst-class:: classref-section-separator
    55. 

  55. 

  56. ----
    57. 

  57. 

  58. .. rst-class:: classref-descriptions-group
    59. 

  59. 

  60. Method Descriptions
    61. 

  61. -------------------
    62. 

  62. 

  63. .. _class_Noise_method_get_image:
    64. 

  64. 

  65. .. rst-class:: classref-method
    66. 

  66. 

  67. :ref:`Image<class_Image>` **get_image** **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`bool<class_bool>` invert=false, :ref:`bool<class_bool>` in_3d_space=false, :ref:`bool<class_bool>` normalize=true **)** |const|
    68. 

  68. 

  69. Returns a 2D :ref:`Image<class_Image>` noise image.
    70. 

  70. 

  71. Note: With ``normalize`` set to ``false`` the default implementation expects the noise generator to return values in the range ``-1.0`` to ``1.0``.
    72. 

  72. 

  73. .. rst-class:: classref-item-separator
    74. 

  74. 

  75. ----
    76. 

  76. 

  77. .. _class_Noise_method_get_noise_1d:
    78. 

  78. 

  79. .. rst-class:: classref-method
    80. 

  80. 

  81. :ref:`float<class_float>` **get_noise_1d** **(** :ref:`float<class_float>` x **)** |const|
    82. 

  82. 

  83. Returns the 1D noise value at the given (x) coordinate.
    84. 

  84. 

  85. .. rst-class:: classref-item-separator
    86. 

  86. 

  87. ----
    88. 

  88. 

  89. .. _class_Noise_method_get_noise_2d:
    90. 

  90. 

  91. .. rst-class:: classref-method
    92. 

  92. 

  93. :ref:`float<class_float>` **get_noise_2d** **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y **)** |const|
    94. 

  94. 

  95. Returns the 2D noise value at the given position.
    96. 

  96. 

  97. .. rst-class:: classref-item-separator
    98. 

  98. 

  99. ----
    100. 

  100. 

  101. .. _class_Noise_method_get_noise_2dv:
    102. 

  102. 

  103. .. rst-class:: classref-method
    104. 

  104. 

  105. :ref:`float<class_float>` **get_noise_2dv** **(** :ref:`Vector2<class_Vector2>` v **)** |const|
    106. 

  106. 

  107. Returns the 2D noise value at the given position.
    108. 

  108. 

  109. .. rst-class:: classref-item-separator
    110. 

  110. 

  111. ----
    112. 

  112. 

  113. .. _class_Noise_method_get_noise_3d:
    114. 

  114. 

  115. .. rst-class:: classref-method
    116. 

  116. 

  117. :ref:`float<class_float>` **get_noise_3d** **(** :ref:`float<class_float>` x, :ref:`float<class_float>` y, :ref:`float<class_float>` z **)** |const|
    118. 

  118. 

  119. Returns the 3D noise value at the given position.
    120. 

  120. 

  121. .. rst-class:: classref-item-separator
    122. 

  122. 

  123. ----
    124. 

  124. 

  125. .. _class_Noise_method_get_noise_3dv:
    126. 

  126. 

  127. .. rst-class:: classref-method
    128. 

  128. 

  129. :ref:`float<class_float>` **get_noise_3dv** **(** :ref:`Vector3<class_Vector3>` v **)** |const|
    130. 

  130. 

  131. Returns the 3D noise value at the given position.
    132. 

  132. 

  133. .. rst-class:: classref-item-separator
    134. 

  134. 

  135. ----
    136. 

  136. 

  137. .. _class_Noise_method_get_seamless_image:
    138. 

  138. 

  139. .. rst-class:: classref-method
    140. 

  140. 

  141. :ref:`Image<class_Image>` **get_seamless_image** **(** :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`bool<class_bool>` invert=false, :ref:`bool<class_bool>` in_3d_space=false, :ref:`float<class_float>` skirt=0.1, :ref:`bool<class_bool>` normalize=true **)** |const|
    142. 

  142. 

  143. Returns a seamless 2D :ref:`Image<class_Image>` noise image.
    144. 

  144. 

  145. Note: With ``normalize`` set to ``false`` the default implementation expects the noise generator to return values in the range ``-1.0`` to ``1.0``.
    146. 

  146. 

  147. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    148. 

  148. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    149. 

  149. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    150. 

  150. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    151. 

  151. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    152. 

  152. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    153.