summaryrefslogtreecommitdiff
path: root/doc/classes/CanvasItemMaterial.xml
blob: 5ec32bc63da17eedd48516163a5c64116c10fde4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
<?xml version="1.0" encoding="UTF-8" ?>
<class name="CanvasItemMaterial" inherits="Material" category="Core" version="3.0-stable">
	<brief_description>
		A material for [CanvasItem]s.
	</brief_description>
	<description>
		[code]CanvasItemMaterial[/code]s 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].
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
	</methods>
	<members>
		<member name="blend_mode" type="int" setter="set_blend_mode" getter="get_blend_mode" enum="CanvasItemMaterial.BlendMode">
			The manner in which a material's rendering is applied to underlying textures.
		</member>
		<member name="light_mode" type="int" setter="set_light_mode" getter="get_light_mode" enum="CanvasItemMaterial.LightMode">
			The manner in which material reacts to lighting.
		</member>
	</members>
	<constants>
		<constant name="BLEND_MODE_MIX" value="0" enum="BlendMode">
			Mix blending mode. Colors are assumed to be independent of the alpha (opacity) value.
		</constant>
		<constant name="BLEND_MODE_ADD" value="1" enum="BlendMode">
			Additive blending mode.
		</constant>
		<constant name="BLEND_MODE_SUB" value="2" enum="BlendMode">
			Subtractive blending mode.
		</constant>
		<constant name="BLEND_MODE_MUL" value="3" enum="BlendMode">
			Multiplicative blending mode.
		</constant>
		<constant name="BLEND_MODE_PREMULT_ALPHA" value="4" enum="BlendMode">
			Mix blending mode. Colors are assumed to be premultiplied by the alpha (opacity) value.
		</constant>
		<constant name="LIGHT_MODE_NORMAL" value="0" enum="LightMode">
			Render the material using both light and non-light sensitive material properties.
		</constant>
		<constant name="LIGHT_MODE_UNSHADED" value="1" enum="LightMode">
			Render the material as if there were no light.
		</constant>
		<constant name="LIGHT_MODE_LIGHT_ONLY" value="2" enum="LightMode">
			Render the material as if there were only light.
		</constant>
	</constants>
</class>