diff options
| author | Bastiaan Olij <mux213@gmail.com> | 2018-05-26 12:08:34 +1000 |
|---|---|---|
| committer | Bastiaan Olij <mux213@gmail.com> | 2018-05-26 12:08:34 +1000 |
| commit | b7ae2ca128307f4926a9b380f271469030c06e2a (patch) | |
| tree | 4b03e5af2a569a21542267bd5ef723c5f759403a /doc | |
| parent | ca9b7f422f0fcc111b038e5dfa85879dc805e410 (diff) | |
Added some quick info on shaders to the docs
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/Shader.xml | 5 | ||||
| -rw-r--r-- | doc/classes/ShaderMaterial.xml | 5 |
2 files changed, 8 insertions, 2 deletions
diff --git a/doc/classes/Shader.xml b/doc/classes/Shader.xml index 732881c777..7c07778a05 100644 --- a/doc/classes/Shader.xml +++ b/doc/classes/Shader.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Shader" inherits="Resource" category="Core" version="3.1"> <brief_description> - To be changed, ignore. + A custom shader program. </brief_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> <tutorials> http://docs.godotengine.org/en/3.0/tutorials/shading/index.html @@ -24,6 +24,7 @@ <return type="int" enum="Shader.Mode"> </return> <description> + Returns the shader mode for the shader, eiter [code]MODE_CANVAS_ITEM[/code], [code]MODE_SPATIAL[/code] or [code]MODE_PARTICLES[/code] </description> </method> <method name="has_param" qualifiers="const"> diff --git a/doc/classes/ShaderMaterial.xml b/doc/classes/ShaderMaterial.xml index 4767686a8f..058e00e46c 100644 --- a/doc/classes/ShaderMaterial.xml +++ b/doc/classes/ShaderMaterial.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <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> @@ -15,6 +17,7 @@ <argument index="0" name="param" type="String"> </argument> <description> + Returns the current value set for this material of a uniform in the shader </description> </method> <method name="set_shader_param"> @@ -25,11 +28,13 @@ <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> |