class_shader.rst 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the Shader.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_Shader:
  5. Shader
  6. ======
  7. **Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. To be changed, ignore.
  12. Member Functions
  13. ----------------
  14. +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
  15. | :ref:`String<class_string>` | :ref:`get_code<class_Shader_get_code>` **(** **)** const |
  16. +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
  17. | :ref:`Texture<class_texture>` | :ref:`get_default_texture_param<class_Shader_get_default_texture_param>` **(** :ref:`String<class_string>` param **)** const |
  18. +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
  19. | :ref:`int<class_int>` | :ref:`get_mode<class_Shader_get_mode>` **(** **)** const |
  20. +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
  21. | :ref:`bool<class_bool>` | :ref:`has_param<class_Shader_has_param>` **(** :ref:`String<class_string>` name **)** const |
  22. +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
  23. | void | :ref:`set_code<class_Shader_set_code>` **(** :ref:`String<class_string>` code **)** |
  24. +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
  25. | void | :ref:`set_default_texture_param<class_Shader_set_default_texture_param>` **(** :ref:`String<class_string>` param, :ref:`Texture<class_texture>` texture **)** |
  26. +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
  27. Numeric Constants
  28. -----------------
  29. - **MODE_SPATIAL** = **0**
  30. - **MODE_CANVAS_ITEM** = **1**
  31. - **MODE_PARTICLES** = **2**
  32. Description
  33. -----------
  34. To be changed, ignore.
  35. Member Function Description
  36. ---------------------------
  37. .. _class_Shader_get_code:
  38. - :ref:`String<class_string>` **get_code** **(** **)** const
  39. .. _class_Shader_get_default_texture_param:
  40. - :ref:`Texture<class_texture>` **get_default_texture_param** **(** :ref:`String<class_string>` param **)** const
  41. .. _class_Shader_get_mode:
  42. - :ref:`int<class_int>` **get_mode** **(** **)** const
  43. .. _class_Shader_has_param:
  44. - :ref:`bool<class_bool>` **has_param** **(** :ref:`String<class_string>` name **)** const
  45. .. _class_Shader_set_code:
  46. - void **set_code** **(** :ref:`String<class_string>` code **)**
  47. .. _class_Shader_set_default_texture_param:
  48. - void **set_default_texture_param** **(** :ref:`String<class_string>` param, :ref:`Texture<class_texture>` texture **)**