class_material.rst 3.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the Material.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_Material:
  5. Material
  6. ========
  7. **Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
  8. **Inherited By:** :ref:`ParticlesMaterial<class_particlesmaterial>`, :ref:`ShaderMaterial<class_shadermaterial>`, :ref:`SpatialMaterial<class_spatialmaterial>`, :ref:`CanvasItemMaterial<class_canvasitemmaterial>`
  9. **Category:** Core
  10. Brief Description
  11. -----------------
  12. Abstract base :ref:`Resource<class_resource>` for coloring and shading geometry.
  13. Member Functions
  14. ----------------
  15. +----------------------------------+-------------------------------------------------------------------------------------------------------------+
  16. | :ref:`Material<class_material>` | :ref:`get_next_pass<class_Material_get_next_pass>` **(** **)** const |
  17. +----------------------------------+-------------------------------------------------------------------------------------------------------------+
  18. | :ref:`int<class_int>` | :ref:`get_render_priority<class_Material_get_render_priority>` **(** **)** const |
  19. +----------------------------------+-------------------------------------------------------------------------------------------------------------+
  20. | void | :ref:`set_next_pass<class_Material_set_next_pass>` **(** :ref:`Material<class_material>` next_pass **)** |
  21. +----------------------------------+-------------------------------------------------------------------------------------------------------------+
  22. | void | :ref:`set_render_priority<class_Material_set_render_priority>` **(** :ref:`int<class_int>` priority **)** |
  23. +----------------------------------+-------------------------------------------------------------------------------------------------------------+
  24. Member Variables
  25. ----------------
  26. - :ref:`Material<class_material>` **next_pass**
  27. - :ref:`int<class_int>` **render_priority**
  28. Numeric Constants
  29. -----------------
  30. - **RENDER_PRIORITY_MAX** = **127**
  31. - **RENDER_PRIORITY_MIN** = **-128**
  32. Description
  33. -----------
  34. Material is a base :ref:`Resource<class_resource>` used for coloring and shading geometry. All materials inherit from it and almost all :ref:`VisualInstance<class_visualinstance>` derived nodes carry a Material. A few flags and parameters are shared between all material types and are configured here.
  35. Member Function Description
  36. ---------------------------
  37. .. _class_Material_get_next_pass:
  38. - :ref:`Material<class_material>` **get_next_pass** **(** **)** const
  39. .. _class_Material_get_render_priority:
  40. - :ref:`int<class_int>` **get_render_priority** **(** **)** const
  41. .. _class_Material_set_next_pass:
  42. - void **set_next_pass** **(** :ref:`Material<class_material>` next_pass **)**
  43. .. _class_Material_set_render_priority:
  44. - void **set_render_priority** **(** :ref:`int<class_int>` priority **)**