mirror of
https://github.com/godotengine/godot-docs-l10n.git
synced 2026-01-05 14:10:19 +03:00
235 lines
9.8 KiB
ReStructuredText
235 lines
9.8 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/4.4/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/4.4/modules/noise/doc_classes/NoiseTexture3D.xml.
|
|
|
|
.. _class_NoiseTexture3D:
|
|
|
|
NoiseTexture3D
|
|
==============
|
|
|
|
**继承：** :ref:`Texture3D<class_Texture3D>` **<** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
|
|
|
|
由 :ref:`Noise<class_Noise>` 对象生成的噪声所填充的 3D 纹理。
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
描述
|
|
----
|
|
|
|
使用 :ref:`FastNoiseLite<class_FastNoiseLite>` 库或其他噪声生成器来填充所需大小的纹理数据。
|
|
|
|
该类在内部使用 :ref:`Thread<class_Thread>` 生成纹理数据，因此如果生成过程尚未完成，\ :ref:`Texture3D.get_data()<class_Texture3D_method_get_data>` 可能会返回 ``null``\ 。在这种情况下，需要等待纹理生成后再访问图像：
|
|
|
|
::
|
|
|
|
var texture = NoiseTexture3D.new()
|
|
texture.noise = FastNoiseLite.new()
|
|
await texture.changed
|
|
var data = texture.get_data()
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
属性
|
|
----
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+---------------------------------+---------------------------------------------------------------------------------+-----------+
|
|
| :ref:`Gradient<class_Gradient>` | :ref:`color_ramp<class_NoiseTexture3D_property_color_ramp>` | |
|
|
+---------------------------------+---------------------------------------------------------------------------------+-----------+
|
|
| :ref:`int<class_int>` | :ref:`depth<class_NoiseTexture3D_property_depth>` | ``64`` |
|
|
+---------------------------------+---------------------------------------------------------------------------------+-----------+
|
|
| :ref:`int<class_int>` | :ref:`height<class_NoiseTexture3D_property_height>` | ``64`` |
|
|
+---------------------------------+---------------------------------------------------------------------------------+-----------+
|
|
| :ref:`bool<class_bool>` | :ref:`invert<class_NoiseTexture3D_property_invert>` | ``false`` |
|
|
+---------------------------------+---------------------------------------------------------------------------------+-----------+
|
|
| :ref:`Noise<class_Noise>` | :ref:`noise<class_NoiseTexture3D_property_noise>` | |
|
|
+---------------------------------+---------------------------------------------------------------------------------+-----------+
|
|
| :ref:`bool<class_bool>` | :ref:`normalize<class_NoiseTexture3D_property_normalize>` | ``true`` |
|
|
+---------------------------------+---------------------------------------------------------------------------------+-----------+
|
|
| :ref:`bool<class_bool>` | :ref:`seamless<class_NoiseTexture3D_property_seamless>` | ``false`` |
|
|
+---------------------------------+---------------------------------------------------------------------------------+-----------+
|
|
| :ref:`float<class_float>` | :ref:`seamless_blend_skirt<class_NoiseTexture3D_property_seamless_blend_skirt>` | ``0.1`` |
|
|
+---------------------------------+---------------------------------------------------------------------------------+-----------+
|
|
| :ref:`int<class_int>` | :ref:`width<class_NoiseTexture3D_property_width>` | ``64`` |
|
|
+---------------------------------+---------------------------------------------------------------------------------+-----------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
属性说明
|
|
--------
|
|
|
|
.. _class_NoiseTexture3D_property_color_ramp:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`Gradient<class_Gradient>` **color_ramp** :ref:`🔗<class_NoiseTexture3D_property_color_ramp>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_color_ramp**\ (\ value\: :ref:`Gradient<class_Gradient>`\ )
|
|
- :ref:`Gradient<class_Gradient>` **get_color_ramp**\ (\ )
|
|
|
|
:ref:`Gradient<class_Gradient>`\ ，用于将每个像素的亮度映射到一个颜色值。
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_NoiseTexture3D_property_depth:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **depth** = ``64`` :ref:`🔗<class_NoiseTexture3D_property_depth>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_depth**\ (\ value\: :ref:`int<class_int>`\ )
|
|
- :ref:`int<class_int>` **get_depth**\ (\ )
|
|
|
|
生成的纹理的深度（单位为像素）。
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_NoiseTexture3D_property_height:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **height** = ``64`` :ref:`🔗<class_NoiseTexture3D_property_height>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_height**\ (\ value\: :ref:`int<class_int>`\ )
|
|
- :ref:`int<class_int>` **get_height**\ (\ )
|
|
|
|
生成的纹理的高度（单位为像素）。
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_NoiseTexture3D_property_invert:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`bool<class_bool>` **invert** = ``false`` :ref:`🔗<class_NoiseTexture3D_property_invert>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_invert**\ (\ value\: :ref:`bool<class_bool>`\ )
|
|
- :ref:`bool<class_bool>` **get_invert**\ (\ )
|
|
|
|
如果为 ``true``\ ，则反转该噪声纹理。白变黑，黑变白。
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_NoiseTexture3D_property_noise:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`Noise<class_Noise>` **noise** :ref:`🔗<class_NoiseTexture3D_property_noise>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_noise**\ (\ value\: :ref:`Noise<class_Noise>`\ )
|
|
- :ref:`Noise<class_Noise>` **get_noise**\ (\ )
|
|
|
|
:ref:`Noise<class_Noise>` 对象的实例。
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_NoiseTexture3D_property_normalize:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`bool<class_bool>` **normalize** = ``true`` :ref:`🔗<class_NoiseTexture3D_property_normalize>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_normalize**\ (\ value\: :ref:`bool<class_bool>`\ )
|
|
- :ref:`bool<class_bool>` **is_normalized**\ (\ )
|
|
|
|
如果为 ``true``\ ，来自噪声发生器的噪声图像，将被归一化到范围 ``0.0`` 到 ``1.0``\ 。
|
|
|
|
关闭归一化会影响对比度，并允许生成非重复的可平铺噪声纹理。
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_NoiseTexture3D_property_seamless:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`bool<class_bool>` **seamless** = ``false`` :ref:`🔗<class_NoiseTexture3D_property_seamless>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_seamless**\ (\ value\: :ref:`bool<class_bool>`\ )
|
|
- :ref:`bool<class_bool>` **get_seamless**\ (\ )
|
|
|
|
如果为 ``true``\ ，则从 :ref:`Noise<class_Noise>` 资源请求无缝纹理。
|
|
|
|
\ **注意：**\ 与非无缝噪声相比，无缝噪声纹理可能需要更长的时间来生成，并且/或者可能具有较低的对比度，具体取决于所使用的 :ref:`Noise<class_Noise>` 资源。这是因为一些实现使用更高的维度来生成无缝噪声。
|
|
|
|
\ **注意：**\ 默认的 :ref:`FastNoiseLite<class_FastNoiseLite>` 实现在生成无缝纹理时使用回退路径。如果使用的 :ref:`width<class_NoiseTexture3D_property_width>`\ 、\ :ref:`height<class_NoiseTexture3D_property_height>` 或 :ref:`depth<class_NoiseTexture3D_property_depth>` 小于默认值，你可能需要通过增大 :ref:`seamless_blend_skirt<class_NoiseTexture3D_property_seamless_blend_skirt>` 来让无缝混合更高效。
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_NoiseTexture3D_property_seamless_blend_skirt:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`float<class_float>` **seamless_blend_skirt** = ``0.1`` :ref:`🔗<class_NoiseTexture3D_property_seamless_blend_skirt>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_seamless_blend_skirt**\ (\ value\: :ref:`float<class_float>`\ )
|
|
- :ref:`float<class_float>` **get_seamless_blend_skirt**\ (\ )
|
|
|
|
用于无缝纹理生成的默认/回退实现。它决定接缝混合的距离。较高的值可能会导致较少的细节和对比度。详见 :ref:`Noise<class_Noise>`\ 。
|
|
|
|
\ **注意：**\ 如果使用的 :ref:`width<class_NoiseTexture3D_property_width>`\ 、\ :ref:`height<class_NoiseTexture3D_property_height>` 或 :ref:`depth<class_NoiseTexture3D_property_depth>` 小于默认值，你可能需要通过增大 :ref:`seamless_blend_skirt<class_NoiseTexture3D_property_seamless_blend_skirt>` 来让无缝混合更高效。
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_NoiseTexture3D_property_width:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **width** = ``64`` :ref:`🔗<class_NoiseTexture3D_property_width>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_width**\ (\ value\: :ref:`int<class_int>`\ )
|
|
- :ref:`int<class_int>` **get_width**\ (\ )
|
|
|
|
生成的纹理的宽度（单位为像素）。
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)`
|
|
.. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)`
|
|
.. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)`
|
|
.. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)`
|
|
.. |static| replace:: :abbr:`static (调用本方法无需实例，可直接使用类名进行调用。)`
|
|
.. |operator| replace:: :abbr:`operator (本方法描述的是使用本类型作为左操作数的有效运算符。)`
|
|
.. |bitfield| replace:: :abbr:`BitField (这个值是由下列位标志构成位掩码的整数。)`
|
|
.. |void| replace:: :abbr:`void (无返回值。)`
|