Inheritance #

CanvasItemMaterial #

is_refcounted, is_instantiable, resource, core, not_builtin_classes

A material for CanvasItems.

CanvasItemMaterials provide a means of modifying the textures associated with a CanvasItem. They specialize in describing blend and lighting behaviors for textures. Use a ShaderMaterial to more fully customize a material's interactions with a CanvasItem.

Members #

var blend_mode = BLEND_MODE_MIX#

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

var light_mode = LIGHT_MODE_NORMAL#

The manner in which material reacts to lighting.

var particles_anim_h_frames: int#

The number of columns in the spritesheet assigned as Texture2D for a GPUParticles2D or CPUParticles2D.

Note: This property is only used and visible in the editor if particles_animation is true.

var particles_anim_loop: bool#

If true, the particles animation will loop.

Note: This property is only used and visible in the editor if particles_animation is true.

var particles_anim_v_frames: int#

The number of rows in the spritesheet assigned as Texture2D for a GPUParticles2D or CPUParticles2D.

Note: This property is only used and visible in the editor if particles_animation is true.

var particles_animation: bool = false#

If true, enable spritesheet-based animation features when assigned to GPUParticles2D and CPUParticles2D nodes. The ParticleProcessMaterial.anim_speed_max or CPUParticles2D.anim_speed_max 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.

Methods #

Annotations #

Constants #

const BLEND_MODE_MIX = 0 enum BlendMode#

Mix blending mode. Colors are assumed to be independent of the alpha (opacity) value.

const BLEND_MODE_ADD = 1 enum BlendMode#

Additive blending mode.

const BLEND_MODE_SUB = 2 enum BlendMode#

Subtractive blending mode.

const BLEND_MODE_MUL = 3 enum BlendMode#

Multiplicative blending mode.

const BLEND_MODE_PREMULT_ALPHA = 4 enum BlendMode#

Mix blending mode. Colors are assumed to be premultiplied by the alpha (opacity) value.

const LIGHT_MODE_NORMAL = 0 enum LightMode#

Render the material using both light and non-light sensitive material properties.

const LIGHT_MODE_UNSHADED = 1 enum LightMode#

Render the material as if there were no light.

const LIGHT_MODE_LIGHT_ONLY = 2 enum LightMode#

Render the material as if there were only light.

Constructors #

Enums #

BlendMode#

LightMode#

Operators #

Signals #

Theme Items #

Tutorials #