From 15e757ec602e940613295629dd3fc8c0f4ea0f50 Mon Sep 17 00:00:00 2001 From: Yuri Roubinsky Date: Wed, 26 Feb 2020 14:27:56 +0300 Subject: [PATCH] Docs for some nodes in visual shader(part 3) --- doc/classes/VisualShaderNodeCompare.xml | 2 +- doc/classes/VisualShaderNodeFloatConstant.xml | 3 ++ doc/classes/VisualShaderNodeFloatFunc.xml | 35 +++++++++++++++++++ doc/classes/VisualShaderNodeFloatOp.xml | 13 +++++++ doc/classes/VisualShaderNodeIf.xml | 2 ++ doc/classes/VisualShaderNodeInput.xml | 4 +++ doc/classes/VisualShaderNodeIntConstant.xml | 3 ++ doc/classes/VisualShaderNodeIntFunc.xml | 7 ++++ doc/classes/VisualShaderNodeIntOp.xml | 10 ++++++ 9 files changed, 78 insertions(+), 1 deletion(-) diff --git a/doc/classes/VisualShaderNodeCompare.xml b/doc/classes/VisualShaderNodeCompare.xml index f207cba0a5a..32f7be3ec30 100644 --- a/doc/classes/VisualShaderNodeCompare.xml +++ b/doc/classes/VisualShaderNodeCompare.xml @@ -50,7 +50,7 @@ Comparison for less than ([code]a < b[/code]). Cannot be used if [member type] set to [constant CTYPE_BOOLEAN] or [constant CTYPE_TRANSFORM]. - Comparison for less than or equal ([code]a < b[/code]). Cannot be used if [member type] set to [constant CTYPE_BOOLEAN] or [constant CTYPE_TRANSFORM]. + Comparison for less than or equal ([code]a <= b[/code]). Cannot be used if [member type] set to [constant CTYPE_BOOLEAN] or [constant CTYPE_TRANSFORM]. The result will be true if all of component in vector satisfy the comparison condition. diff --git a/doc/classes/VisualShaderNodeFloatConstant.xml b/doc/classes/VisualShaderNodeFloatConstant.xml index 267570121d4..3ba9ff07d37 100644 --- a/doc/classes/VisualShaderNodeFloatConstant.xml +++ b/doc/classes/VisualShaderNodeFloatConstant.xml @@ -1,8 +1,10 @@ + A scalar floating-point constant to be used within the visual shader graph. + Translated to [code]float[/code] in the shader language. @@ -10,6 +12,7 @@ + A floating-point constant which represents a state of this node. diff --git a/doc/classes/VisualShaderNodeFloatFunc.xml b/doc/classes/VisualShaderNodeFloatFunc.xml index de1f902f2c5..bb7486e8cf0 100644 --- a/doc/classes/VisualShaderNodeFloatFunc.xml +++ b/doc/classes/VisualShaderNodeFloatFunc.xml @@ -1,8 +1,10 @@ + A scalar floating-point function to be used within the visual shader graph. + Accept a floating-point scalar ([code]x[/code]) to the input port and transform it according to [member function]. @@ -10,72 +12,105 @@ + A function to be applied to the scalar. See [enum Function] for options. + Returns the sine of the parameter. Translates to [code]sin(x)[/code] in the Godot Shader Language. + Returns the cosine of the parameter. Translates to [code]cos(x)[/code] in the Godot Shader Language. + Returns the tangent of the parameter. Translates to [code]tan(x)[/code] in the Godot Shader Language. + Returns the arc-sine of the parameter. Translates to [code]asin(x)[/code] in the Godot Shader Language. + Returns the arc-cosine of the parameter. Translates to [code]acos(x)[/code] in the Godot Shader Language. + Returns the arc-tangent of the parameter. Translates to [code]atan(x)[/code] in the Godot Shader Language. + Returns the hyperbolic sine of the parameter. Translates to [code]sinh(x)[/code] in the Godot Shader Language. + Returns the hyperbolic cosine of the parameter. Translates to [code]cosh(x)[/code] in the Godot Shader Language. + Returns the hyperbolic tangent of the parameter. Translates to [code]tanh(x)[/code] in the Godot Shader Language. + Returns the natural logarithm of the parameter. Translates to [code]log(x)[/code] in the Godot Shader Language. + Returns the natural exponentiation of the parameter. Translates to [code]exp(x)[/code] in the Godot Shader Language. + Returns the square root of the parameter. Translates to [code]sqrt(x)[/code] in the Godot Shader Language. + Returns the absolute value of the parameter. Translates to [code]abs(x)[/code] in the Godot Shader Language. + Extracts the sign of the parameter. Translates to [code]sign(x)[/code] in the Godot Shader Language. + Finds the nearest integer less than or equal to the parameter. Translates to [code]floor(x)[/code] in the Godot Shader Language. + Finds the nearest integer to the parameter. Translates to [code]round(x)[/code] in the Godot Shader Language. + Finds the nearest integer that is greater than or equal to the parameter. Translates to [code]ceil(x)[/code] in the Godot Shader Language. + Computes the fractional part of the argument. Translates to [code]fract(x)[/code] in the Godot Shader Language. + Clamps the value between [code]0.0[/code] and [code]1.0[/code] using [code]min(max(x, 0.0), 1.0)[/code]. + Negates the [code]x[/code] using [code]-(x)[/code]. + Returns the arc-hyperbolic-cosine of the parameter. Translates to [code]acosh(x)[/code] in the Godot Shader Language. + Returns the arc-hyperbolic-sine of the parameter. Translates to [code]asinh(x)[/code] in the Godot Shader Language. + Returns the arc-hyperbolic-tangent of the parameter. Translates to [code]atanh(x)[/code] in the Godot Shader Language. + Convert a quantity in radians to degrees. Translates to [code]degrees(x)[/code] in the Godot Shader Language. + Returns 2 raised by the power of the parameter. Translates to [code]exp2(x)[/code] in the Godot Shader Language. + Returns the inverse of the square root of the parameter. Translates to [code]inversesqrt(x)[/code] in the Godot Shader Language. + Returns the base 2 logarithm of the parameter. Translates to [code]log2(x)[/code] in the Godot Shader Language. + Convert a quantity in degrees to radians. Translates to [code]radians(x)[/code] in the Godot Shader Language. + Finds reciprocal value of dividing 1 by [code]x[/code] (i.e. [code]1 / x[/code]). + Finds the nearest even integer to the parameter. Translates to [code]roundEven(x)[/code] in the Godot Shader Language. + Returns a value equal to the nearest integer to [code]x[/code] whose absolute value is not larger than the absolute value of [code]x[/code]. Translates to [code]trunc(x)[/code] in the Godot Shader Language. + Subtracts scalar [code]x[/code] from 1 (i.e. [code]1 - x[/code]). diff --git a/doc/classes/VisualShaderNodeFloatOp.xml b/doc/classes/VisualShaderNodeFloatOp.xml index 50ba08701cf..2c9ebabb890 100644 --- a/doc/classes/VisualShaderNodeFloatOp.xml +++ b/doc/classes/VisualShaderNodeFloatOp.xml @@ -1,8 +1,10 @@ + A floating-point scalar operator to be used within the visual shader graph. + Applies [member operator] to two floating-point inputs: [code]a[/code] and [code]b[/code]. @@ -10,28 +12,39 @@ + An operator to be applied to the inputs. See [enum Operator] for options. + Sums two numbers using [code]a + b[/code]. + Subtracts two numbers using [code]a - b[/code]. + Multiplies two numbers using [code]a * b[/code]. + Divides two numbers using [code]a / b[/code]. + Calculates the remainder of two numbers. Translates to [code]mod(a, b)[/code] in the Godot Shader Language. + Raises the [code]a[/code] to the power of [code]b[/code]. Translates to [code]pow(a, b)[/code] in the Godot Shader Language. + Returns the greater of two numbers. Translates to [code]max(a, b)[/code] in the Godot Shader Language. + Returns the lesser of two numbers. Translates to [code]min(a, b)[/code] in the Godot Shader Language. + Returns the arc-tangent of the parameters. Translates to [code]atan(a, b)[/code] in the Godot Shader Language. + Generates a step function by comparing [code]b[/code](x) to [code]a[/code](edge). Returns 0.0 if [code]x[/code] is smaller than [code]edge[/code] and otherwise 1.0. Translates to [code]step(a, b)[/code] in the Godot Shader Language. diff --git a/doc/classes/VisualShaderNodeIf.xml b/doc/classes/VisualShaderNodeIf.xml index 0a8fdcfd4d4..1ebd945d427 100644 --- a/doc/classes/VisualShaderNodeIf.xml +++ b/doc/classes/VisualShaderNodeIf.xml @@ -1,8 +1,10 @@ + Compares two floating-point numbers in order to return a required vector within the visual shader graph. + First two ports are scalar floatin-point numbers to compare, third is tolerance comparsion amount and last three ports represents a vectors returned if [code]a == b[/code], [code]a > b[/code] and [code]a < b[/code] respectivly. diff --git a/doc/classes/VisualShaderNodeInput.xml b/doc/classes/VisualShaderNodeInput.xml index 1c8d8d84c4e..ed629508d0c 100644 --- a/doc/classes/VisualShaderNodeInput.xml +++ b/doc/classes/VisualShaderNodeInput.xml @@ -1,6 +1,7 @@ + Represents the input shader parameter within the visual shader graph. @@ -11,16 +12,19 @@ + Returns a translated name of the current constant in the Godot Shader Language. eg. [code]"ALBEDO"[/code] if the [member input_name] equal to [code]"albedo"[/code]. + One of the several input constants in lower-case style like: "vertex"([/code]VERTEX[code]) or "point_size"([code]POINT_SIZE[/code]). + Emitted when input is changed via [member input_name]. diff --git a/doc/classes/VisualShaderNodeIntConstant.xml b/doc/classes/VisualShaderNodeIntConstant.xml index cb05d589d29..1c407b21ca4 100644 --- a/doc/classes/VisualShaderNodeIntConstant.xml +++ b/doc/classes/VisualShaderNodeIntConstant.xml @@ -1,8 +1,10 @@ + A scalar integer constant to be used within the visual shader graph. + Translated to [code]int[/code] in the shader language. @@ -10,6 +12,7 @@ + An integer constant which represents a state of this node. diff --git a/doc/classes/VisualShaderNodeIntFunc.xml b/doc/classes/VisualShaderNodeIntFunc.xml index 9196250e381..4b5d4ca8d28 100644 --- a/doc/classes/VisualShaderNodeIntFunc.xml +++ b/doc/classes/VisualShaderNodeIntFunc.xml @@ -1,8 +1,10 @@ + A scalar integer function to be used within the visual shader graph. + Accept an integer scalar ([code]x[/code]) to the input port and transform it according to [member function]. @@ -10,16 +12,21 @@ + A function to be applied to the scalar. See [enum Function] for options. + Returns the absolute value of the parameter. Translates to [code]abs(x)[/code] in the Godot Shader Language. + Constrains a parameter between [code]min[/code] and [code]max[/code]. Translates to [code]clamp(x, min, max)[/code] in the Godot Shader Language. + Negates the [code]x[/code] using [code]-(x)[/code]. + Extracts the sign of the parameter. Translates to [code]sign(x)[/code] in the Godot Shader Language. diff --git a/doc/classes/VisualShaderNodeIntOp.xml b/doc/classes/VisualShaderNodeIntOp.xml index 5e7020c75c9..fc9a0a9a0a9 100644 --- a/doc/classes/VisualShaderNodeIntOp.xml +++ b/doc/classes/VisualShaderNodeIntOp.xml @@ -1,8 +1,10 @@ + An integer scalar operator to be used within the visual shader graph. + Applies [member operator] to two integer inputs: [code]a[/code] and [code]b[/code]. @@ -10,22 +12,30 @@ + An operator to be applied to the inputs. See [enum Operator] for options. + Sums two numbers using [code]a + b[/code]. + Subtracts two numbers using [code]a - b[/code]. + Multiplies two numbers using [code]a * b[/code]. + Divides two numbers using [code]a / b[/code]. + Calculates the remainder of two numbers using [code]a % b[/code]. + Returns the greater of two numbers. Translates to [code]max(a, b)[/code] in the Godot Shader Language. + Returns the lesser of two numbers. Translates to [code]max(a, b)[/code] in the Godot Shader Language.