Files
godot-docs/classes/class_material.rst
2017-10-21 14:03:27 +02:00

77 lines
3.1 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:`ParticlesMaterial<class_particlesmaterial>`, :ref:`ShaderMaterial<class_shadermaterial>`, :ref:`SpatialMaterial<class_spatialmaterial>`, :ref:`CanvasItemMaterial<class_canvasitemmaterial>`
**Category:** Core
Brief Description
-----------------
Abstract base :ref:`Resource<class_resource>` for coloring and shading geometry.
Member Functions
----------------
+----------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`Material<class_material>` | :ref:`get_next_pass<class_Material_get_next_pass>` **(** **)** const |
+----------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_render_priority<class_Material_get_render_priority>` **(** **)** const |
+----------------------------------+-----------------------------------------------------------------------------------------------------------+
| void | :ref:`set_next_pass<class_Material_set_next_pass>` **(** :ref:`Material<class_material>` next_pass **)** |
+----------------------------------+-----------------------------------------------------------------------------------------------------------+
| void | :ref:`set_render_priority<class_Material_set_render_priority>` **(** :ref:`int<class_int>` priority **)** |
+----------------------------------+-----------------------------------------------------------------------------------------------------------+
Member Variables
----------------
.. _class_Material_next_pass:
- :ref:`Material<class_material>` **next_pass**
.. _class_Material_render_priority:
- :ref:`int<class_int>` **render_priority**
Numeric Constants
-----------------
- **RENDER_PRIORITY_MAX** = **127**
- **RENDER_PRIORITY_MIN** = **-128**
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.
Member Function Description
---------------------------
.. _class_Material_get_next_pass:
- :ref:`Material<class_material>` **get_next_pass** **(** **)** const
.. _class_Material_get_render_priority:
- :ref:`int<class_int>` **get_render_priority** **(** **)** const
.. _class_Material_set_next_pass:
- void **set_next_pass** **(** :ref:`Material<class_material>` next_pass **)**
.. _class_Material_set_render_priority:
- void **set_render_priority** **(** :ref:`int<class_int>` priority **)**