godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added some quick info on shaders to the docs

This commit is contained in:
Bastiaan Olij 2018-05-26 12:08:34 +10:00
parent ca9b7f422f
commit b7ae2ca128
2 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/classes/Shader.xml
View File

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="Shader" inherits="Resource" category="Core" version="3.1"> <class name="Shader" inherits="Resource" category="Core" version="3.1">
<brief_description> <brief_description>
To be changed, ignore. A custom shader program.
</brief_description> </brief_description>
<description> <description>
To be changed, ignore. This class allows you to define a custom shader program that can be used for various materials to render objects.
</description> </description>
<tutorials> <tutorials>
http://docs.godotengine.org/en/3.0/tutorials/shading/index.html http://docs.godotengine.org/en/3.0/tutorials/shading/index.html
@ -24,6 +24,7 @@
<return type="int" enum="Shader.Mode"> <return type="int" enum="Shader.Mode">
</return> </return>
<description> <description>
Returns the shader mode for the shader, eiter [code]MODE_CANVAS_ITEM[/code], [code]MODE_SPATIAL[/code] or [code]MODE_PARTICLES[/code]
</description> </description>
</method> </method>
<method name="has_param" qualifiers="const"> <method name="has_param" qualifiers="const">

5
doc/classes/ShaderMaterial.xml
View File

@ -1,8 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<class name="ShaderMaterial" inherits="Material" category="Core" version="3.1"> <class name="ShaderMaterial" inherits="Material" category="Core" version="3.1">
<brief_description> <brief_description>
A material that uses a custom [Shader] program
</brief_description> </brief_description>
<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> </description>
<tutorials> <tutorials>
</tutorials> </tutorials>
@ -15,6 +17,7 @@
<argument index="0" name="param" type="String"> <argument index="0" name="param" type="String">
</argument> </argument>
<description> <description>
Returns the current value set for this material of a uniform in the shader
</description> </description>
</method> </method>
<method name="set_shader_param"> <method name="set_shader_param">
@ -25,11 +28,13 @@
<argument index="1" name="value" type="Variant"> <argument index="1" name="value" type="Variant">
</argument> </argument>
<description> <description>
Changes the value set for this material of a uniform in the shader
</description> </description>
</method> </method>
</methods> </methods>
<members> <members>
<member name="shader" type="Shader" setter="set_shader" getter="get_shader"> <member name="shader" type="Shader" setter="set_shader" getter="get_shader">
The [Shader] program used to render this material
</member> </member>
</members> </members>
<constants> <constants>