class_curvetexture.rst 2.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the CurveTexture.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_CurveTexture:
  6. CurveTexture
  7. ============
  8. **Inherits:** :ref:`Texture<class_Texture>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. A texture that shows a curve.
  10. Description
  11. -----------
  12. Renders a given :ref:`Curve<class_Curve>` provided to it. Simplifies the task of drawing curves and/or saving them as image files.
  13. Properties
  14. ----------
  15. +---------------------------+-------------------------------------------------+----------+
  16. | :ref:`Curve<class_Curve>` | :ref:`curve<class_CurveTexture_property_curve>` | |
  17. +---------------------------+-------------------------------------------------+----------+
  18. | :ref:`int<class_int>` | :ref:`width<class_CurveTexture_property_width>` | ``2048`` |
  19. +---------------------------+-------------------------------------------------+----------+
  20. Property Descriptions
  21. ---------------------
  22. .. _class_CurveTexture_property_curve:
  23. - :ref:`Curve<class_Curve>` **curve**
  24. +----------+------------------+
  25. | *Setter* | set_curve(value) |
  26. +----------+------------------+
  27. | *Getter* | get_curve() |
  28. +----------+------------------+
  29. The :ref:`Curve<class_Curve>` that is rendered onto the texture.
  30. ----
  31. .. _class_CurveTexture_property_width:
  32. - :ref:`int<class_int>` **width**
  33. +-----------+------------------+
  34. | *Default* | ``2048`` |
  35. +-----------+------------------+
  36. | *Setter* | set_width(value) |
  37. +-----------+------------------+
  38. | *Getter* | get_width() |
  39. +-----------+------------------+
  40. 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.
  41. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  42. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  43. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`