class_colorramp.rst 5.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
  3. .. _class_ColorRamp:
  4. ColorRamp
  5. =========
  6. **Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  7. **Category:** Core
  8. Brief Description
  9. -----------------
  10. Member Functions
  11. ----------------
  12. +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
  13. | void | :ref:`add_point<class_ColorRamp_add_point>` **(** :ref:`float<class_float>` offset, :ref:`Color<class_color>` color **)** |
  14. +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
  15. | void | :ref:`remove_point<class_ColorRamp_remove_point>` **(** :ref:`int<class_int>` offset **)** |
  16. +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
  17. | void | :ref:`set_offset<class_ColorRamp_set_offset>` **(** :ref:`int<class_int>` point, :ref:`float<class_float>` offset **)** |
  18. +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
  19. | :ref:`float<class_float>` | :ref:`get_offset<class_ColorRamp_get_offset>` **(** :ref:`int<class_int>` point **)** const |
  20. +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
  21. | void | :ref:`set_color<class_ColorRamp_set_color>` **(** :ref:`int<class_int>` point, :ref:`Color<class_color>` color **)** |
  22. +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
  23. | :ref:`Color<class_color>` | :ref:`get_color<class_ColorRamp_get_color>` **(** :ref:`int<class_int>` point **)** const |
  24. +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
  25. | :ref:`Color<class_color>` | :ref:`interpolate<class_ColorRamp_interpolate>` **(** :ref:`float<class_float>` offset **)** |
  26. +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
  27. | :ref:`int<class_int>` | :ref:`get_point_count<class_ColorRamp_get_point_count>` **(** **)** const |
  28. +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
  29. | void | :ref:`set_offsets<class_ColorRamp_set_offsets>` **(** :ref:`RealArray<class_realarray>` offsets **)** |
  30. +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
  31. | :ref:`RealArray<class_realarray>` | :ref:`get_offsets<class_ColorRamp_get_offsets>` **(** **)** const |
  32. +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
  33. | void | :ref:`set_colors<class_ColorRamp_set_colors>` **(** :ref:`ColorArray<class_colorarray>` colors **)** |
  34. +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
  35. | :ref:`ColorArray<class_colorarray>` | :ref:`get_colors<class_ColorRamp_get_colors>` **(** **)** const |
  36. +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
  37. Member Function Description
  38. ---------------------------
  39. .. _class_ColorRamp_add_point:
  40. - void **add_point** **(** :ref:`float<class_float>` offset, :ref:`Color<class_color>` color **)**
  41. .. _class_ColorRamp_remove_point:
  42. - void **remove_point** **(** :ref:`int<class_int>` offset **)**
  43. .. _class_ColorRamp_set_offset:
  44. - void **set_offset** **(** :ref:`int<class_int>` point, :ref:`float<class_float>` offset **)**
  45. .. _class_ColorRamp_get_offset:
  46. - :ref:`float<class_float>` **get_offset** **(** :ref:`int<class_int>` point **)** const
  47. .. _class_ColorRamp_set_color:
  48. - void **set_color** **(** :ref:`int<class_int>` point, :ref:`Color<class_color>` color **)**
  49. .. _class_ColorRamp_get_color:
  50. - :ref:`Color<class_color>` **get_color** **(** :ref:`int<class_int>` point **)** const
  51. .. _class_ColorRamp_interpolate:
  52. - :ref:`Color<class_color>` **interpolate** **(** :ref:`float<class_float>` offset **)**
  53. .. _class_ColorRamp_get_point_count:
  54. - :ref:`int<class_int>` **get_point_count** **(** **)** const
  55. .. _class_ColorRamp_set_offsets:
  56. - void **set_offsets** **(** :ref:`RealArray<class_realarray>` offsets **)**
  57. .. _class_ColorRamp_get_offsets:
  58. - :ref:`RealArray<class_realarray>` **get_offsets** **(** **)** const
  59. .. _class_ColorRamp_set_colors:
  60. - void **set_colors** **(** :ref:`ColorArray<class_colorarray>` colors **)**
  61. .. _class_ColorRamp_get_colors:
  62. - :ref:`ColorArray<class_colorarray>` **get_colors** **(** **)** const