Files
godot-docs/classes/class_curvetexture.rst
2021-11-15 12:28:38 +01:00

98 lines
3.6 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the CurveTexture.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_CurveTexture:
CurveTexture
============
**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 a curve.
Description
-----------
Renders a given :ref:`Curve<class_Curve>` provided to it. Simplifies the task of drawing curves and/or saving them as image files.
Properties
----------
+---------------------------------------------------+---------------------------------------------------------------+----------+
| :ref:`Curve<class_Curve>` | :ref:`curve<class_CurveTexture_property_curve>` | |
+---------------------------------------------------+---------------------------------------------------------------+----------+
| :ref:`TextureMode<enum_CurveTexture_TextureMode>` | :ref:`texture_mode<class_CurveTexture_property_texture_mode>` | ``0`` |
+---------------------------------------------------+---------------------------------------------------------------+----------+
| :ref:`int<class_int>` | :ref:`width<class_CurveTexture_property_width>` | ``2048`` |
+---------------------------------------------------+---------------------------------------------------------------+----------+
Enumerations
------------
.. _enum_CurveTexture_TextureMode:
.. _class_CurveTexture_constant_TEXTURE_MODE_RGB:
.. _class_CurveTexture_constant_TEXTURE_MODE_RED:
enum **TextureMode**:
- **TEXTURE_MODE_RGB** = **0**
- **TEXTURE_MODE_RED** = **1**
Property Descriptions
---------------------
.. _class_CurveTexture_property_curve:
- :ref:`Curve<class_Curve>` **curve**
+----------+------------------+
| *Setter* | set_curve(value) |
+----------+------------------+
| *Getter* | get_curve() |
+----------+------------------+
The ``curve`` rendered onto the texture.
----
.. _class_CurveTexture_property_texture_mode:
- :ref:`TextureMode<enum_CurveTexture_TextureMode>` **texture_mode**
+-----------+-------------------------+
| *Default* | ``0`` |
+-----------+-------------------------+
| *Setter* | set_texture_mode(value) |
+-----------+-------------------------+
| *Getter* | get_texture_mode() |
+-----------+-------------------------+
----
.. _class_CurveTexture_property_width:
- :ref:`int<class_int>` **width**
+-----------+------------------+
| *Default* | ``2048`` |
+-----------+------------------+
| *Setter* | set_width(value) |
+-----------+------------------+
| *Getter* | get_width() |
+-----------+------------------+
The width of the texture.
.. |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.)`