| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101 |
- :github_url: hide
- .. DO NOT EDIT THIS FILE!!!
- .. Generated automatically from Godot engine sources.
- .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
- .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CurveXYZTexture.xml.
- .. _class_CurveXYZTexture:
- CurveXYZTexture
- ===============
- **Inherits:** :ref:`Texture2D<class_Texture2D>` **<** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
- A texture that shows 3 different curves (stored on the red, green and blue color channels).
- Description
- -----------
- Renders 3 given :ref:`Curve<class_Curve>`\ s provided to it, on the red, green and blue channels respectively. Compared to using separate :ref:`CurveTexture<class_CurveTexture>`\ s, this further simplifies the task of drawing curves and/or saving them as image files.
- If you only need to store one curve within a single texture, use :ref:`CurveTexture<class_CurveTexture>` instead. See also :ref:`GradientTexture1D<class_GradientTexture1D>` and :ref:`GradientTexture2D<class_GradientTexture2D>`.
- Properties
- ----------
- +---------------------------+--------------------------------------------------------+---------+
- | :ref:`Curve<class_Curve>` | :ref:`curve_x<class_CurveXYZTexture_property_curve_x>` | |
- +---------------------------+--------------------------------------------------------+---------+
- | :ref:`Curve<class_Curve>` | :ref:`curve_y<class_CurveXYZTexture_property_curve_y>` | |
- +---------------------------+--------------------------------------------------------+---------+
- | :ref:`Curve<class_Curve>` | :ref:`curve_z<class_CurveXYZTexture_property_curve_z>` | |
- +---------------------------+--------------------------------------------------------+---------+
- | :ref:`int<class_int>` | :ref:`width<class_CurveXYZTexture_property_width>` | ``256`` |
- +---------------------------+--------------------------------------------------------+---------+
- Property Descriptions
- ---------------------
- .. _class_CurveXYZTexture_property_curve_x:
- - :ref:`Curve<class_Curve>` **curve_x**
- +----------+--------------------+
- | *Setter* | set_curve_x(value) |
- +----------+--------------------+
- | *Getter* | get_curve_x() |
- +----------+--------------------+
- The :ref:`Curve<class_Curve>` that is rendered onto the texture's red channel.
- ----
- .. _class_CurveXYZTexture_property_curve_y:
- - :ref:`Curve<class_Curve>` **curve_y**
- +----------+--------------------+
- | *Setter* | set_curve_y(value) |
- +----------+--------------------+
- | *Getter* | get_curve_y() |
- +----------+--------------------+
- The :ref:`Curve<class_Curve>` that is rendered onto the texture's green channel.
- ----
- .. _class_CurveXYZTexture_property_curve_z:
- - :ref:`Curve<class_Curve>` **curve_z**
- +----------+--------------------+
- | *Setter* | set_curve_z(value) |
- +----------+--------------------+
- | *Getter* | get_curve_z() |
- +----------+--------------------+
- The :ref:`Curve<class_Curve>` that is rendered onto the texture's blue channel.
- ----
- .. _class_CurveXYZTexture_property_width:
- - :ref:`int<class_int>` **width**
- +-----------+------------------+
- | *Default* | ``256`` |
- +-----------+------------------+
- | *Setter* | set_width(value) |
- +-----------+------------------+
- | *Getter* | get_width() |
- +-----------+------------------+
- The width of the texture (in pixels). Higher values make it possible to represent high-frequency data better (such as sudden direction changes), at the cost of increased generation time and memory usage.
- .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
- .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
- .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
- .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
- .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
- .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|
