CanvasItemMaterial

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.

@GodotBaseClass

struct CanvasItemMaterial {

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

package @nogc nothrow __gshared

bool _classBindingInitialized;

struct GDNativeClassBinding;

bool opEquals(CanvasItemMaterial other);

typeof(null) opAssign(typeof(null) n);

bool opEquals(typeof(null) n);

size_t toHash();

mixin baseCasts ;

static CanvasItemMaterial _new();

enum LightMode;

enum BlendMode;

enum Constants;

CanvasItemMaterial.BlendMode getBlendMode();

CanvasItemMaterial.LightMode getLightMode();

long getParticlesAnimHFrames();

bool getParticlesAnimLoop();

long getParticlesAnimVFrames();

bool getParticlesAnimation();

void setBlendMode(long blend_mode);

void setLightMode(long light_mode);

void setParticlesAnimHFrames(long frames);

void setParticlesAnimLoop(bool loop);

void setParticlesAnimVFrames(long frames);

void setParticlesAnimation(bool particles_anim);

CanvasItemMaterial.BlendMode blendMode [@property getter];

long blendMode [@property setter];

CanvasItemMaterial.LightMode lightMode [@property getter];

long lightMode [@property setter];

long particlesAnimHFrames [@property getter];

long particlesAnimHFrames [@property setter];

bool particlesAnimLoop [@property getter];

bool particlesAnimLoop [@property setter];

long particlesAnimVFrames [@property getter];

long particlesAnimVFrames [@property setter];

bool particlesAnimation [@property getter];

bool particlesAnimation [@property setter];

}

Members

Aliases

BaseClasses alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses): Undocumented in source.

Enums

BlendMode enum BlendMode
Constants enum Constants
LightMode enum LightMode

Functions

getBlendMode CanvasItemMaterial.BlendMode getBlendMode()
getLightMode CanvasItemMaterial.LightMode getLightMode()
getParticlesAnimHFrames long getParticlesAnimHFrames()
getParticlesAnimLoop bool getParticlesAnimLoop()
getParticlesAnimVFrames long getParticlesAnimVFrames()
getParticlesAnimation bool getParticlesAnimation()
opAssign typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(CanvasItemMaterial other)
opEquals bool opEquals(typeof(null) n)
setBlendMode void setBlendMode(long blend_mode)
setLightMode void setLightMode(long light_mode)
setParticlesAnimHFrames void setParticlesAnimHFrames(long frames)
setParticlesAnimLoop void setParticlesAnimLoop(bool loop)
setParticlesAnimVFrames void setParticlesAnimVFrames(long frames)
setParticlesAnimation void setParticlesAnimation(bool particles_anim)
toHash size_t toHash()

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

blendMode CanvasItemMaterial.BlendMode blendMode [@property getter]
long blendMode [@property setter]: The manner in which a material's rendering is applied to underlying textures.
lightMode CanvasItemMaterial.LightMode lightMode [@property getter]
long lightMode [@property setter]: The manner in which material reacts to lighting.
particlesAnimHFrames long particlesAnimHFrames [@property getter]
long particlesAnimHFrames [@property setter]: The number of columns in the spritesheet assigned as Texture for a Particles2D or CPUParticles2D. Note: This property is only used and visible in the editor if particlesAnimation is true.
particlesAnimLoop bool particlesAnimLoop [@property getter]
bool particlesAnimLoop [@property setter]: If true, the particles animation will loop. Note: This property is only used and visible in the editor if particlesAnimation is true.
particlesAnimVFrames long particlesAnimVFrames [@property getter]
long particlesAnimVFrames [@property setter]: The number of rows in the spritesheet assigned as Texture for a Particles2D or CPUParticles2D. Note: This property is only used and visible in the editor if particlesAnimation is true.
particlesAnimation bool particlesAnimation [@property getter]
bool particlesAnimation [@property setter]: If true, enable spritesheet-based animation features when assigned to Particles2D and CPUParticles2D nodes. The ParticlesMaterial.animSpeed or CPUParticles2D.animSpeed 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.

Static functions

_new CanvasItemMaterial _new(): Construct a new instance of CanvasItemMaterial. Note: use memnew!CanvasItemMaterial instead.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

GDNativeClassBinding struct GDNativeClassBinding: Undocumented in source.

Unions

__anonymous union __anonymous: Undocumented in source.

Variables

_GODOT_internal_name enum string _GODOT_internal_name;: Undocumented in source.

Mixed In Members

From `mixin baseCasts`

as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(ToRef) as(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast template opCast(To): Undocumented in source.
opCast template opCast(To): Undocumented in source.
opCast template opCast(ToRef): Undocumented in source.
opCast void* opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast godot_object opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast bool opCast(): Undocumented in source. Be warned that the author may not have intended to support it.

Meta

Source

See Implementation

godot canvasitemmaterial structs

CanvasItemMaterial