godot-docs/classes/class_canvasitemmaterial.rst

:github_url: hide

.. Generated automatically by doc/tools/make_rst.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>`

A material for :ref:`CanvasItem<class_CanvasItem>`\ s.

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>`.

Properties
----------

+-----------------------------------------------------+-------------------------------------------------------------------------------------------+-----------+
| :ref:`BlendMode<enum_CanvasItemMaterial_BlendMode>` | :ref:`blend_mode<class_CanvasItemMaterial_property_blend_mode>`                           | ``0``     |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------+-----------+
| :ref:`LightMode<enum_CanvasItemMaterial_LightMode>` | :ref:`light_mode<class_CanvasItemMaterial_property_light_mode>`                           | ``0``     |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------+-----------+
| :ref:`int<class_int>`                               | :ref:`particles_anim_h_frames<class_CanvasItemMaterial_property_particles_anim_h_frames>` |           |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>`                             | :ref:`particles_anim_loop<class_CanvasItemMaterial_property_particles_anim_loop>`         |           |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------+-----------+
| :ref:`int<class_int>`                               | :ref:`particles_anim_v_frames<class_CanvasItemMaterial_property_particles_anim_v_frames>` |           |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------+-----------+
| :ref:`bool<class_bool>`                             | :ref:`particles_animation<class_CanvasItemMaterial_property_particles_animation>`         | ``false`` |
+-----------------------------------------------------+-------------------------------------------------------------------------------------------+-----------+

Enumerations
------------

.. _enum_CanvasItemMaterial_BlendMode:

.. _class_CanvasItemMaterial_constant_BLEND_MODE_MIX:

.. _class_CanvasItemMaterial_constant_BLEND_MODE_ADD:

.. _class_CanvasItemMaterial_constant_BLEND_MODE_SUB:

.. _class_CanvasItemMaterial_constant_BLEND_MODE_MUL:

.. _class_CanvasItemMaterial_constant_BLEND_MODE_PREMULT_ALPHA:

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.

----

.. _enum_CanvasItemMaterial_LightMode:

.. _class_CanvasItemMaterial_constant_LIGHT_MODE_NORMAL:

.. _class_CanvasItemMaterial_constant_LIGHT_MODE_UNSHADED:

.. _class_CanvasItemMaterial_constant_LIGHT_MODE_LIGHT_ONLY:

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.

Property Descriptions
---------------------

.. _class_CanvasItemMaterial_property_blend_mode:

- :ref:`BlendMode<enum_CanvasItemMaterial_BlendMode>` **blend_mode**

+-----------+-----------------------+
| *Default* | ``0``                 |
+-----------+-----------------------+
| *Setter*  | set_blend_mode(value) |
+-----------+-----------------------+
| *Getter*  | get_blend_mode()      |
+-----------+-----------------------+

The manner in which a material's rendering is applied to underlying textures.

----

.. _class_CanvasItemMaterial_property_light_mode:

- :ref:`LightMode<enum_CanvasItemMaterial_LightMode>` **light_mode**

+-----------+-----------------------+
| *Default* | ``0``                 |
+-----------+-----------------------+
| *Setter*  | set_light_mode(value) |
+-----------+-----------------------+
| *Getter*  | get_light_mode()      |
+-----------+-----------------------+

The manner in which material reacts to lighting.

----

.. _class_CanvasItemMaterial_property_particles_anim_h_frames:

- :ref:`int<class_int>` **particles_anim_h_frames**

+----------+------------------------------------+
| *Setter* | set_particles_anim_h_frames(value) |
+----------+------------------------------------+
| *Getter* | get_particles_anim_h_frames()      |
+----------+------------------------------------+

The number of columns in the spritesheet assigned as :ref:`Texture<class_Texture>` for a :ref:`Particles2D<class_Particles2D>` or :ref:`CPUParticles2D<class_CPUParticles2D>`.

**Note:** This property is only used and visible in the editor if :ref:`particles_animation<class_CanvasItemMaterial_property_particles_animation>` is ``true``.

----

.. _class_CanvasItemMaterial_property_particles_anim_loop:

- :ref:`bool<class_bool>` **particles_anim_loop**

+----------+--------------------------------+
| *Setter* | set_particles_anim_loop(value) |
+----------+--------------------------------+
| *Getter* | get_particles_anim_loop()      |
+----------+--------------------------------+

If ``true``, the particles animation will loop.

**Note:** This property is only used and visible in the editor if :ref:`particles_animation<class_CanvasItemMaterial_property_particles_animation>` is ``true``.

----

.. _class_CanvasItemMaterial_property_particles_anim_v_frames:

- :ref:`int<class_int>` **particles_anim_v_frames**

+----------+------------------------------------+
| *Setter* | set_particles_anim_v_frames(value) |
+----------+------------------------------------+
| *Getter* | get_particles_anim_v_frames()      |
+----------+------------------------------------+

The number of rows in the spritesheet assigned as :ref:`Texture<class_Texture>` for a :ref:`Particles2D<class_Particles2D>` or :ref:`CPUParticles2D<class_CPUParticles2D>`.

**Note:** This property is only used and visible in the editor if :ref:`particles_animation<class_CanvasItemMaterial_property_particles_animation>` is ``true``.

----

.. _class_CanvasItemMaterial_property_particles_animation:

- :ref:`bool<class_bool>` **particles_animation**

+-----------+--------------------------------+
| *Default* | ``false``                      |
+-----------+--------------------------------+
| *Setter*  | set_particles_animation(value) |
+-----------+--------------------------------+
| *Getter*  | get_particles_animation()      |
+-----------+--------------------------------+

If ``true``, enable spritesheet-based animation features when assigned to :ref:`Particles2D<class_Particles2D>` and :ref:`CPUParticles2D<class_CPUParticles2D>` nodes. The :ref:`ParticlesMaterial.anim_speed<class_ParticlesMaterial_property_anim_speed>` or :ref:`CPUParticles2D.anim_speed<class_CPUParticles2D_property_anim_speed>` should also be set to a positive value for the animation to play.

This property (and other ``particles_anim_*`` properties that depend on it) has no effect on other types of nodes.

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`