summaryrefslogtreecommitdiff
path: root/doc/classes/CanvasItemMaterial.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/CanvasItemMaterial.xml')
-rw-r--r--doc/classes/CanvasItemMaterial.xml58
1 files changed, 21 insertions, 37 deletions
diff --git a/doc/classes/CanvasItemMaterial.xml b/doc/classes/CanvasItemMaterial.xml
index b9d2653a2f..81709227ad 100644
--- a/doc/classes/CanvasItemMaterial.xml
+++ b/doc/classes/CanvasItemMaterial.xml
@@ -1,65 +1,49 @@
<?xml version="1.0" encoding="UTF-8" ?>
-<class name="CanvasItemMaterial" inherits="Material" category="Core" version="3.0-alpha">
+<class name="CanvasItemMaterial" inherits="Material" category="Core" version="3.0-beta">
<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>
- <method name="get_blend_mode" qualifiers="const">
- <return type="int" enum="CanvasItemMaterial.BlendMode">
- </return>
- <description>
- </description>
- </method>
- <method name="get_light_mode" qualifiers="const">
- <return type="int" enum="CanvasItemMaterial.LightMode">
- </return>
- <description>
- </description>
- </method>
- <method name="set_blend_mode">
- <return type="void">
- </return>
- <argument index="0" name="blend_mode" type="int" enum="CanvasItemMaterial.BlendMode">
- </argument>
- <description>
- </description>
- </method>
- <method name="set_light_mode">
- <return type="void">
- </return>
- <argument index="0" name="light_mode" type="int" enum="CanvasItemMaterial.LightMode">
- </argument>
- <description>
- </description>
- </method>
</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">
+ <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">
+ <constant name="BLEND_MODE_ADD" value="1" enum="BlendMode">
+ Additive blending mode.
</constant>
- <constant name="BLEND_MODE_SUB" value="2">
+ <constant name="BLEND_MODE_SUB" value="2" enum="BlendMode">
+ Subtractive blending mode.
</constant>
- <constant name="BLEND_MODE_MUL" value="3">
+ <constant name="BLEND_MODE_MUL" value="3" enum="BlendMode">
+ Multiplicative blending mode.
</constant>
- <constant name="BLEND_MODE_PREMULT_ALPHA" value="4">
+ <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">
+ <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">
+ <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">
+ <constant name="LIGHT_MODE_LIGHT_ONLY" value="2" enum="LightMode">
+ Render the material as if there were only light.
</constant>
</constants>
</class>