Files
godot-docs/classes/class_material.rst
2019-07-15 20:48:41 +02:00

71 lines
2.6 KiB
ReStructuredText

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the Material.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_Material:
Material
========
**Inherits:** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Inherited By:** :ref:`CanvasItemMaterial<class_CanvasItemMaterial>`, :ref:`ParticlesMaterial<class_ParticlesMaterial>`, :ref:`ShaderMaterial<class_ShaderMaterial>`, :ref:`SpatialMaterial<class_SpatialMaterial>`
**Category:** Core
Brief Description
-----------------
Abstract base :ref:`Resource<class_Resource>` for coloring and shading geometry.
Properties
----------
+---------------------------------+-----------------------------------------------------------------+---+
| :ref:`Material<class_Material>` | :ref:`next_pass<class_Material_property_next_pass>` | |
+---------------------------------+-----------------------------------------------------------------+---+
| :ref:`int<class_int>` | :ref:`render_priority<class_Material_property_render_priority>` | 0 |
+---------------------------------+-----------------------------------------------------------------+---+
Constants
---------
.. _class_Material_constant_RENDER_PRIORITY_MAX:
.. _class_Material_constant_RENDER_PRIORITY_MIN:
- **RENDER_PRIORITY_MAX** = **127** --- Maximum value for the :ref:`render_priority<class_Material_property_render_priority>` parameter.
- **RENDER_PRIORITY_MIN** = **-128** --- Minimum value for the :ref:`render_priority<class_Material_property_render_priority>` parameter.
Description
-----------
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.
Property Descriptions
---------------------
.. _class_Material_property_next_pass:
- :ref:`Material<class_Material>` **next_pass**
+----------+----------------------+
| *Setter* | set_next_pass(value) |
+----------+----------------------+
| *Getter* | get_next_pass() |
+----------+----------------------+
.. _class_Material_property_render_priority:
- :ref:`int<class_int>` **render_priority**
+-----------+----------------------------+
| *Default* | 0 |
+-----------+----------------------------+
| *Setter* | set_render_priority(value) |
+-----------+----------------------------+
| *Getter* | get_render_priority() |
+-----------+----------------------------+