From 6843ccf462b501f11b78b438c4b28d49a4ab8076 Mon Sep 17 00:00:00 2001 From: Bastiaan Olij Date: Sat, 26 May 2018 12:08:34 +1000 Subject: [PATCH] Added some quick info on shaders to the docs (cherry picked from commit b7ae2ca128307f4926a9b380f271469030c06e2a) --- doc/classes/Shader.xml | 5 +++-- 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 7a5236515dc..3b7bd1e93f8 100644 --- a/doc/classes/Shader.xml +++ b/doc/classes/Shader.xml @@ -1,10 +1,10 @@ - To be changed, ignore. + A custom shader program. - To be changed, ignore. + This class allows you to define a custom shader program that can be used for various materials to render objects. http://docs.godotengine.org/en/3.0/tutorials/shading/index.html @@ -24,6 +24,7 @@ + Returns the shader mode for the shader, eiter [code]MODE_CANVAS_ITEM[/code], [code]MODE_SPATIAL[/code] or [code]MODE_PARTICLES[/code] diff --git a/doc/classes/ShaderMaterial.xml b/doc/classes/ShaderMaterial.xml index 6d93f43c4b0..31f194e64bc 100644 --- a/doc/classes/ShaderMaterial.xml +++ b/doc/classes/ShaderMaterial.xml @@ -1,8 +1,10 @@ + A material that uses a custom [Shader] program + 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. @@ -15,6 +17,7 @@ + Returns the current value set for this material of a uniform in the shader @@ -25,11 +28,13 @@ + Changes the value set for this material of a uniform in the shader + The [Shader] program used to render this material