class_shader.rst 6.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889
  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_Shader:
  4. Shader
  5. ======
  6. **Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  7. **Inherited By:** :ref:`MaterialShader<class_materialshader>`, :ref:`CanvasItemShader<class_canvasitemshader>`, :ref:`ShaderGraph<class_shadergraph>`
  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:`String<class_string>` | :ref:`get_fragment_code<class_Shader_get_fragment_code>` **(** **)** const |
  18. +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  19. | :ref:`String<class_string>` | :ref:`get_light_code<class_Shader_get_light_code>` **(** **)** const |
  20. +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  21. | :ref:`int<class_int>` | :ref:`get_mode<class_Shader_get_mode>` **(** **)** const |
  22. +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  23. | :ref:`String<class_string>` | :ref:`get_vertex_code<class_Shader_get_vertex_code>` **(** **)** const |
  24. +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  25. | :ref:`bool<class_bool>` | :ref:`has_param<class_Shader_has_param>` **(** :ref:`String<class_string>` name **)** const |
  26. +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  27. | void | :ref:`set_code<class_Shader_set_code>` **(** :ref:`String<class_string>` vcode, :ref:`String<class_string>` fcode, :ref:`String<class_string>` lcode, :ref:`int<class_int>` fofs=0, :ref:`int<class_int>` lofs=0 **)** |
  28. +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  29. | void | :ref:`set_default_texture_param<class_Shader_set_default_texture_param>` **(** :ref:`String<class_string>` param, :ref:`Texture<class_texture>` texture **)** |
  30. +--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  31. Numeric Constants
  32. -----------------
  33. - **MODE_MATERIAL** = **0**
  34. - **MODE_CANVAS_ITEM** = **1**
  35. - **MODE_POST_PROCESS** = **2**
  36. Description
  37. -----------
  38. To be changed, ignore.
  39. Member Function Description
  40. ---------------------------
  41. .. _class_Shader_get_default_texture_param:
  42. - :ref:`Texture<class_texture>` **get_default_texture_param** **(** :ref:`String<class_string>` param **)** const
  43. .. _class_Shader_get_fragment_code:
  44. - :ref:`String<class_string>` **get_fragment_code** **(** **)** const
  45. .. _class_Shader_get_light_code:
  46. - :ref:`String<class_string>` **get_light_code** **(** **)** const
  47. .. _class_Shader_get_mode:
  48. - :ref:`int<class_int>` **get_mode** **(** **)** const
  49. .. _class_Shader_get_vertex_code:
  50. - :ref:`String<class_string>` **get_vertex_code** **(** **)** const
  51. .. _class_Shader_has_param:
  52. - :ref:`bool<class_bool>` **has_param** **(** :ref:`String<class_string>` name **)** const
  53. .. _class_Shader_set_code:
  54. - void **set_code** **(** :ref:`String<class_string>` vcode, :ref:`String<class_string>` fcode, :ref:`String<class_string>` lcode, :ref:`int<class_int>` fofs=0, :ref:`int<class_int>` lofs=0 **)**
  55. .. _class_Shader_set_default_texture_param:
  56. - void **set_default_texture_param** **(** :ref:`String<class_string>` param, :ref:`Texture<class_texture>` texture **)**