diff options
author | RĂ©mi Verschelde <rverschelde@gmail.com> | 2020-01-23 22:58:24 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-01-23 22:58:24 +0100 |
commit | 2e27e746499888b1a9d2dd37ddd5e29f36b2831d (patch) | |
tree | 2a41c6a462f9976990d210a69c80eafcc6598d2d /doc/classes/VisualShaderNodeColorFunc.xml | |
parent | c66144738b1567c9623b4e0738546d2dc1e02aa2 (diff) | |
parent | ce43c922083341aff6eb8bc017b36f61ec01f42f (diff) |
Merge pull request #35470 from Chaosus/vs_docs
Docs for some nodes in visual shader
Diffstat (limited to 'doc/classes/VisualShaderNodeColorFunc.xml')
-rw-r--r-- | doc/classes/VisualShaderNodeColorFunc.xml | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/classes/VisualShaderNodeColorFunc.xml b/doc/classes/VisualShaderNodeColorFunc.xml index b37a669ee9..9e8e13245b 100644 --- a/doc/classes/VisualShaderNodeColorFunc.xml +++ b/doc/classes/VisualShaderNodeColorFunc.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="VisualShaderNodeColorFunc" inherits="VisualShaderNode" category="Core" version="3.2"> <brief_description> + A [Color] function to be used within the visual shader graph. </brief_description> <description> + Accept a [Color] to the input port and transform it according to [member function]. </description> <tutorials> </tutorials> @@ -10,12 +12,29 @@ </methods> <members> <member name="function" type="int" setter="set_function" getter="get_function" enum="VisualShaderNodeColorFunc.Function" default="0"> + A function to be applied to the input color. See [enum Function] for options. </member> </members> <constants> <constant name="FUNC_GRAYSCALE" value="0" enum="Function"> + Converts the color to grayscale using the following formula: + [codeblock] + vec3 c = input; + float max1 = max(c.r, c.g); + float max2 = max(max1, c.b); + float max3 = max(max1, max2); + return vec3(max3, max3, max3); + [/codeblock] </constant> <constant name="FUNC_SEPIA" value="1" enum="Function"> + Applies sepia tone effect using the following formula: + [codeblock] + vec3 c = input; + float r = (c.r * 0.393) + (c.g * 0.769) + (c.b * 0.189); + float g = (c.r * 0.349) + (c.g * 0.686) + (c.b * 0.168); + float b = (c.r * 0.272) + (c.g * 0.534) + (c.b * 0.131); + return vec3(r, g, b); + [/codeblock] </constant> </constants> </class> |