pandemonium_engine_docs/classes/class_curvetexture.rst

65 lines
2.3 KiB
ReStructuredText

:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/CurveTexture.xml.
.. _class_CurveTexture:
CurveTexture
============
**Inherits:** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :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:`int<class_int>` | :ref:`width<class_CurveTexture_property_width>` | ``2048`` |
+---------------------------+-------------------------------------------------+----------+
Property Descriptions
---------------------
.. _class_CurveTexture_property_curve:
- :ref:`Curve<class_Curve>` **curve**
+----------+------------------+
| *Setter* | set_curve(value) |
+----------+------------------+
| *Getter* | get_curve() |
+----------+------------------+
The :ref:`Curve<class_Curve>` that is rendered onto the texture.
----
.. _class_CurveTexture_property_width:
- :ref:`int<class_int>` **width**
+-----------+------------------+
| *Default* | ``2048`` |
+-----------+------------------+
| *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.)`