From 59af063636b3e17df488ad0d9e059919aa03fcf1 Mon Sep 17 00:00:00 2001 From: Yuri Roubinsky Date: Tue, 1 Feb 2022 11:32:01 +0300 Subject: Add support for 2D vector type to visual shaders --- doc/classes/VisualShaderNode.xml | 14 ++++++++----- doc/classes/VisualShaderNodeClamp.xml | 9 ++++++--- doc/classes/VisualShaderNodeCompare.xml | 13 ++++++++----- doc/classes/VisualShaderNodeDerivativeFunc.xml | 7 +++++-- doc/classes/VisualShaderNodeFaceForward.xml | 2 +- doc/classes/VisualShaderNodeMix.xml | 18 +++++++++++------ doc/classes/VisualShaderNodeMultiplyAdd.xml | 11 +++++++---- doc/classes/VisualShaderNodeSmoothStep.xml | 18 +++++++++++------ doc/classes/VisualShaderNodeStep.xml | 18 +++++++++++------ doc/classes/VisualShaderNodeSwitch.xml | 13 ++++++++----- doc/classes/VisualShaderNodeVec2Constant.xml | 16 +++++++++++++++ doc/classes/VisualShaderNodeVec2Uniform.xml | 19 ++++++++++++++++++ doc/classes/VisualShaderNodeVectorBase.xml | 26 +++++++++++++++++++++++++ doc/classes/VisualShaderNodeVectorCompose.xml | 2 +- doc/classes/VisualShaderNodeVectorDecompose.xml | 2 +- doc/classes/VisualShaderNodeVectorDistance.xml | 2 +- doc/classes/VisualShaderNodeVectorFunc.xml | 2 +- doc/classes/VisualShaderNodeVectorLen.xml | 2 +- doc/classes/VisualShaderNodeVectorOp.xml | 2 +- 19 files changed, 147 insertions(+), 49 deletions(-) create mode 100644 doc/classes/VisualShaderNodeVec2Constant.xml create mode 100644 doc/classes/VisualShaderNodeVec2Uniform.xml create mode 100644 doc/classes/VisualShaderNodeVectorBase.xml (limited to 'doc/classes') diff --git a/doc/classes/VisualShaderNode.xml b/doc/classes/VisualShaderNode.xml index cebe7f215f..0067240820 100644 --- a/doc/classes/VisualShaderNode.xml +++ b/doc/classes/VisualShaderNode.xml @@ -47,6 +47,7 @@ + Sets the default value for the selected input [code]port[/code]. @@ -71,19 +72,22 @@ Integer scalar. Translated to [code]int[/code] type in shader code. - + + 2D vector of floating-point values. Translated to [code]vec2[/code] type in shader code. + + 3D vector of floating-point values. Translated to [code]vec3[/code] type in shader code. - + Boolean type. Translated to [code]bool[/code] type in shader code. - + Transform type. Translated to [code]mat4[/code] type in shader code. - + Sampler type. Translated to reference of sampler uniform in shader code. Can only be used for input ports in non-uniform nodes. - + Represents the size of the [enum PortType] enum. diff --git a/doc/classes/VisualShaderNodeClamp.xml b/doc/classes/VisualShaderNodeClamp.xml index a68cbbec49..7219ba14b7 100644 --- a/doc/classes/VisualShaderNodeClamp.xml +++ b/doc/classes/VisualShaderNodeClamp.xml @@ -20,10 +20,13 @@ An integer scalar. - - A vector type. + + A 2D vector type. - + + A 3D vector type. + + Represents the size of the [enum OpType] enum. diff --git a/doc/classes/VisualShaderNodeCompare.xml b/doc/classes/VisualShaderNodeCompare.xml index 49bf952b31..ddd7f87cb8 100644 --- a/doc/classes/VisualShaderNodeCompare.xml +++ b/doc/classes/VisualShaderNodeCompare.xml @@ -10,7 +10,7 @@ - Extra condition which is applied if [member type] is set to [constant CTYPE_VECTOR]. + Extra condition which is applied if [member type] is set to [constant CTYPE_VECTOR_3D]. A comparison function. See [enum Function] for options. @@ -26,16 +26,19 @@ An integer scalar. - + + A 2D vector type. + + A 3D vector type. - + A boolean type. - + A transform ([code]mat4[/code]) type. - + Represents the size of the [enum ComparisonType] enum. diff --git a/doc/classes/VisualShaderNodeDerivativeFunc.xml b/doc/classes/VisualShaderNodeDerivativeFunc.xml index f7edac8597..704af44d04 100644 --- a/doc/classes/VisualShaderNodeDerivativeFunc.xml +++ b/doc/classes/VisualShaderNodeDerivativeFunc.xml @@ -20,10 +20,13 @@ A floating-point scalar. - + + A 2D vector type. + + A 3D vector type. - + Represents the size of the [enum OpType] enum. diff --git a/doc/classes/VisualShaderNodeFaceForward.xml b/doc/classes/VisualShaderNodeFaceForward.xml index 80cb8aea4e..cd2b3972b7 100644 --- a/doc/classes/VisualShaderNodeFaceForward.xml +++ b/doc/classes/VisualShaderNodeFaceForward.xml @@ -1,5 +1,5 @@ - + Returns the vector that points in the same direction as a reference vector within the visual shader graph. diff --git a/doc/classes/VisualShaderNodeMix.xml b/doc/classes/VisualShaderNodeMix.xml index 1ef580a983..8a2f289a11 100644 --- a/doc/classes/VisualShaderNodeMix.xml +++ b/doc/classes/VisualShaderNodeMix.xml @@ -15,15 +15,21 @@ - A scalar type. + A floating-point scalar. - - A vector type. + + A 2D vector type. - - A vector type. [code]weight[/code] port is using a scalar type. + + The [code]a[/code] and [code]b[/code] ports use a 2D vector type. The [code]weight[/code] port uses a scalar type. - + + A 3D vector type. + + + The [code]a[/code] and [code]b[/code] ports use a 3D vector type. The [code]weight[/code] port uses a scalar type. + + Represents the size of the [enum OpType] enum. diff --git a/doc/classes/VisualShaderNodeMultiplyAdd.xml b/doc/classes/VisualShaderNodeMultiplyAdd.xml index a0e9aef703..a6168e4df1 100644 --- a/doc/classes/VisualShaderNodeMultiplyAdd.xml +++ b/doc/classes/VisualShaderNodeMultiplyAdd.xml @@ -15,12 +15,15 @@ - A scalar type. + A floating-point scalar type. - - A vector type. + + A 2D vector type. - + + A 3D vector type. + + Represents the size of the [enum OpType] enum. diff --git a/doc/classes/VisualShaderNodeSmoothStep.xml b/doc/classes/VisualShaderNodeSmoothStep.xml index 2f8c7e0f33..714b9d8267 100644 --- a/doc/classes/VisualShaderNodeSmoothStep.xml +++ b/doc/classes/VisualShaderNodeSmoothStep.xml @@ -16,15 +16,21 @@ - A scalar type. + A floating-point scalar type. - - A vector type. + + A 2D vector type. - - A vector type. [code]edge0[/code] and [code]edge1[/code] are using a scalar type. + + The [code]x[/code] port uses a 2D vector type. The first two ports use a floating-point scalar type. - + + A 3D vector type. + + + The [code]x[/code] port uses a 3D vector type. The first two ports use a floating-point scalar type. + + Represents the size of the [enum OpType] enum. diff --git a/doc/classes/VisualShaderNodeStep.xml b/doc/classes/VisualShaderNodeStep.xml index 5d8b464814..f65c95ea9e 100644 --- a/doc/classes/VisualShaderNodeStep.xml +++ b/doc/classes/VisualShaderNodeStep.xml @@ -16,15 +16,21 @@ - A scalar type. + A floating-point scalar type. - - A vector type. + + A 2D vector type. - - A vector type. [code]edge[/code] port is using a scalar type. + + The [code]x[/code] port uses a 2D vector type, while the [code]edge[/code] port uses a floating-point scalar type. - + + A 3D vector type. + + + The [code]x[/code] port uses a 3D vector type, while the [code]edge[/code] port uses a floating-point scalar type. + + Represents the size of the [enum OpType] enum. diff --git a/doc/classes/VisualShaderNodeSwitch.xml b/doc/classes/VisualShaderNodeSwitch.xml index 921092cd07..71888ec2c3 100644 --- a/doc/classes/VisualShaderNodeSwitch.xml +++ b/doc/classes/VisualShaderNodeSwitch.xml @@ -20,16 +20,19 @@ An integer scalar. - - A vector type. + + A 2D vector type. - + + A 3D vector type. + + A boolean type. - + A transform type. - + Represents the size of the [enum OpType] enum. diff --git a/doc/classes/VisualShaderNodeVec2Constant.xml b/doc/classes/VisualShaderNodeVec2Constant.xml new file mode 100644 index 0000000000..f897ab4091 --- /dev/null +++ b/doc/classes/VisualShaderNodeVec2Constant.xml @@ -0,0 +1,16 @@ + + + + A [Vector2] constant to be used within the visual shader graph. + + + A constant [Vector2], which can be used as an input node. + + + + + + A [Vector2] constant which represents the state of this node. + + + diff --git a/doc/classes/VisualShaderNodeVec2Uniform.xml b/doc/classes/VisualShaderNodeVec2Uniform.xml new file mode 100644 index 0000000000..d5cf7e57c8 --- /dev/null +++ b/doc/classes/VisualShaderNodeVec2Uniform.xml @@ -0,0 +1,19 @@ + + + + A [Vector2] uniform to be used within the visual shader graph. + + + Translated to [code]uniform vec2[/code] in the shader language. + + + + + + A default value to be assigned within the shader. + + + Enables usage of the [member default_value]. + + + diff --git a/doc/classes/VisualShaderNodeVectorBase.xml b/doc/classes/VisualShaderNodeVectorBase.xml new file mode 100644 index 0000000000..8a560c1951 --- /dev/null +++ b/doc/classes/VisualShaderNodeVectorBase.xml @@ -0,0 +1,26 @@ + + + + A base type for the nodes using different vector types within the visual shader graph. + + + + + + + + A base type. + + + + + A 2D vector type. + + + A 3D vector type. + + + Represents the size of the [enum OpType] enum. + + + diff --git a/doc/classes/VisualShaderNodeVectorCompose.xml b/doc/classes/VisualShaderNodeVectorCompose.xml index ebc30d03f4..b8caf154f9 100644 --- a/doc/classes/VisualShaderNodeVectorCompose.xml +++ b/doc/classes/VisualShaderNodeVectorCompose.xml @@ -1,5 +1,5 @@ - + Composes a [Vector3] from three scalars within the visual shader graph. diff --git a/doc/classes/VisualShaderNodeVectorDecompose.xml b/doc/classes/VisualShaderNodeVectorDecompose.xml index 09986bf969..9ef9db0cfb 100644 --- a/doc/classes/VisualShaderNodeVectorDecompose.xml +++ b/doc/classes/VisualShaderNodeVectorDecompose.xml @@ -1,5 +1,5 @@ - + Decomposes a [Vector3] into three scalars within the visual shader graph. diff --git a/doc/classes/VisualShaderNodeVectorDistance.xml b/doc/classes/VisualShaderNodeVectorDistance.xml index 098787e583..c0d8ffe943 100644 --- a/doc/classes/VisualShaderNodeVectorDistance.xml +++ b/doc/classes/VisualShaderNodeVectorDistance.xml @@ -1,5 +1,5 @@ - + Returns the distance between two points. To be used within the visual shader graph. diff --git a/doc/classes/VisualShaderNodeVectorFunc.xml b/doc/classes/VisualShaderNodeVectorFunc.xml index 27ae82e11b..17a6418b94 100644 --- a/doc/classes/VisualShaderNodeVectorFunc.xml +++ b/doc/classes/VisualShaderNodeVectorFunc.xml @@ -1,5 +1,5 @@ - + A vector function to be used within the visual shader graph. diff --git a/doc/classes/VisualShaderNodeVectorLen.xml b/doc/classes/VisualShaderNodeVectorLen.xml index 165455e622..f1b6919bdc 100644 --- a/doc/classes/VisualShaderNodeVectorLen.xml +++ b/doc/classes/VisualShaderNodeVectorLen.xml @@ -1,5 +1,5 @@ - + Returns the length of a [Vector3] within the visual shader graph. diff --git a/doc/classes/VisualShaderNodeVectorOp.xml b/doc/classes/VisualShaderNodeVectorOp.xml index 5e8f0abda3..6a579abb9a 100644 --- a/doc/classes/VisualShaderNodeVectorOp.xml +++ b/doc/classes/VisualShaderNodeVectorOp.xml @@ -1,5 +1,5 @@ - + A vector operator to be used within the visual shader graph. -- cgit v1.2.3