class_shader.rst 3.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  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:`Texture<class_texture>` | :ref:`get_default_texture_param<class_Shader_get_default_texture_param>` **(** :ref:`String<class_string>` param **)** const |
  16. +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
  17. | :ref:`int<class_int>` | :ref:`get_mode<class_Shader_get_mode>` **(** **)** const |
  18. +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
  19. | :ref:`bool<class_bool>` | :ref:`has_param<class_Shader_has_param>` **(** :ref:`String<class_string>` name **)** const |
  20. +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
  21. | void | :ref:`set_default_texture_param<class_Shader_set_default_texture_param>` **(** :ref:`String<class_string>` param, :ref:`Texture<class_texture>` texture **)** |
  22. +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
  23. Member Variables
  24. ----------------
  25. .. _class_Shader_code:
  26. - :ref:`String<class_string>` **code**
  27. Enums
  28. -----
  29. .. _enum_Shader_Mode:
  30. enum **Mode**
  31. - **MODE_SPATIAL** = **0**
  32. - **MODE_CANVAS_ITEM** = **1**
  33. - **MODE_PARTICLES** = **2**
  34. Description
  35. -----------
  36. To be changed, ignore.
  37. Member Function Description
  38. ---------------------------
  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_default_texture_param:
  46. - void **set_default_texture_param** **(** :ref:`String<class_string>` param, :ref:`Texture<class_texture>` texture **)**