| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980 |
- .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the CanvasItemMaterial.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_CanvasItemMaterial:
- CanvasItemMaterial
- ==================
- **Inherits:** :ref:`Material<class_Material>` **<** :ref:`Resource<class_Resource>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
- **Category:** Core
- Brief Description
- -----------------
- A material for :ref:`CanvasItem<class_CanvasItem>`\ s.
- Properties
- ----------
- +-----------------------------------------------------+--------------------------------------------------------+
- | :ref:`BlendMode<enum_CanvasItemMaterial_BlendMode>` | :ref:`blend_mode<class_CanvasItemMaterial_blend_mode>` |
- +-----------------------------------------------------+--------------------------------------------------------+
- | :ref:`LightMode<enum_CanvasItemMaterial_LightMode>` | :ref:`light_mode<class_CanvasItemMaterial_light_mode>` |
- +-----------------------------------------------------+--------------------------------------------------------+
- Enumerations
- ------------
- .. _enum_CanvasItemMaterial_LightMode:
- enum **LightMode**:
- - **LIGHT_MODE_NORMAL** = **0** --- Render the material using both light and non-light sensitive material properties.
- - **LIGHT_MODE_UNSHADED** = **1** --- Render the material as if there were no light.
- - **LIGHT_MODE_LIGHT_ONLY** = **2** --- Render the material as if there were only light.
- .. _enum_CanvasItemMaterial_BlendMode:
- enum **BlendMode**:
- - **BLEND_MODE_MIX** = **0** --- Mix blending mode. Colors are assumed to be independent of the alpha (opacity) value.
- - **BLEND_MODE_ADD** = **1** --- Additive blending mode.
- - **BLEND_MODE_SUB** = **2** --- Subtractive blending mode.
- - **BLEND_MODE_MUL** = **3** --- Multiplicative blending mode.
- - **BLEND_MODE_PREMULT_ALPHA** = **4** --- Mix blending mode. Colors are assumed to be premultiplied by the alpha (opacity) value.
- Description
- -----------
- ``CanvasItemMaterial``\ s provide a means of modifying the textures associated with a CanvasItem. They specialize in describing blend and lighting behaviors for textures. Use a :ref:`ShaderMaterial<class_ShaderMaterial>` to more fully customize a material's interactions with a :ref:`CanvasItem<class_CanvasItem>`.
- Property Descriptions
- ---------------------
- .. _class_CanvasItemMaterial_blend_mode:
- - :ref:`BlendMode<enum_CanvasItemMaterial_BlendMode>` **blend_mode**
- +----------+-----------------------+
- | *Setter* | set_blend_mode(value) |
- +----------+-----------------------+
- | *Getter* | get_blend_mode() |
- +----------+-----------------------+
- The manner in which a material's rendering is applied to underlying textures.
- .. _class_CanvasItemMaterial_light_mode:
- - :ref:`LightMode<enum_CanvasItemMaterial_LightMode>` **light_mode**
- +----------+-----------------------+
- | *Setter* | set_light_mode(value) |
- +----------+-----------------------+
- | *Getter* | get_light_mode() |
- +----------+-----------------------+
- The manner in which material reacts to lighting.
|
