class_material.rst 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the Material.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_Material:
  6. Material
  7. ========
  8. **Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
  9. **Inherited By:** :ref:`CanvasItemMaterial<class_CanvasItemMaterial>`, :ref:`ParticlesMaterial<class_ParticlesMaterial>`, :ref:`ShaderMaterial<class_ShaderMaterial>`, :ref:`SpatialMaterial<class_SpatialMaterial>`
  10. **Category:** Core
  11. Brief Description
  12. -----------------
  13. Abstract base :ref:`Resource<class_Resource>` for coloring and shading geometry.
  14. Properties
  15. ----------
  16. +---------------------------------+-----------------------------------------------------------------+
  17. | :ref:`Material<class_Material>` | :ref:`next_pass<class_Material_property_next_pass>` |
  18. +---------------------------------+-----------------------------------------------------------------+
  19. | :ref:`int<class_int>` | :ref:`render_priority<class_Material_property_render_priority>` |
  20. +---------------------------------+-----------------------------------------------------------------+
  21. Constants
  22. ---------
  23. .. _class_Material_constant_RENDER_PRIORITY_MAX:
  24. .. _class_Material_constant_RENDER_PRIORITY_MIN:
  25. - **RENDER_PRIORITY_MAX** = **127** --- Maximum value for the :ref:`render_priority<class_Material_property_render_priority>` parameter.
  26. - **RENDER_PRIORITY_MIN** = **-128** --- Minimum value for the :ref:`render_priority<class_Material_property_render_priority>` parameter.
  27. Description
  28. -----------
  29. 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.
  30. Property Descriptions
  31. ---------------------
  32. .. _class_Material_property_next_pass:
  33. - :ref:`Material<class_Material>` **next_pass**
  34. +----------+----------------------+
  35. | *Setter* | set_next_pass(value) |
  36. +----------+----------------------+
  37. | *Getter* | get_next_pass() |
  38. +----------+----------------------+
  39. ----
  40. .. _class_Material_property_render_priority:
  41. - :ref:`int<class_int>` **render_priority**
  42. +----------+----------------------------+
  43. | *Setter* | set_render_priority(value) |
  44. +----------+----------------------------+
  45. | *Getter* | get_render_priority() |
  46. +----------+----------------------------+