summaryrefslogtreecommitdiff
path: root/doc/classes/ShaderMaterial.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/ShaderMaterial.xml')
-rw-r--r--doc/classes/ShaderMaterial.xml25
1 files changed, 10 insertions, 15 deletions
diff --git a/doc/classes/ShaderMaterial.xml b/doc/classes/ShaderMaterial.xml
index 096d6d4332..058e00e46c 100644
--- a/doc/classes/ShaderMaterial.xml
+++ b/doc/classes/ShaderMaterial.xml
@@ -1,34 +1,23 @@
<?xml version="1.0" encoding="UTF-8" ?>
-<class name="ShaderMaterial" inherits="Material" category="Core" version="3.0-beta">
+<class name="ShaderMaterial" inherits="Material" category="Core" version="3.1">
<brief_description>
+ A material that uses a custom [Shader] program
</brief_description>
<description>
+ A material that uses a custom [Shader] program to render either items to screen or process particles. You can create multiple materials for the same shader but configure different values for the uniforms defined in the shader.
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
- <method name="get_shader" qualifiers="const">
- <return type="Shader">
- </return>
- <description>
- </description>
- </method>
<method name="get_shader_param" qualifiers="const">
<return type="Variant">
</return>
<argument index="0" name="param" type="String">
</argument>
<description>
- </description>
- </method>
- <method name="set_shader">
- <return type="void">
- </return>
- <argument index="0" name="shader" type="Shader">
- </argument>
- <description>
+ Returns the current value set for this material of a uniform in the shader
</description>
</method>
<method name="set_shader_param">
@@ -39,9 +28,15 @@
<argument index="1" name="value" type="Variant">
</argument>
<description>
+ Changes the value set for this material of a uniform in the shader
</description>
</method>
</methods>
+ <members>
+ <member name="shader" type="Shader" setter="set_shader" getter="get_shader">
+ The [Shader] program used to render this material
+ </member>
+ </members>
<constants>
</constants>
</class>