diff options
author | Yuri Rubinsky <chaosus89@gmail.com> | 2022-04-20 08:33:42 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-04-20 08:33:42 +0300 |
commit | f4b0c7a1ea8d86c1dfd96478ca12ad1360903d9d (patch) | |
tree | 16426afe66415722c287a0c087f7cca0771ab8a3 /doc | |
parent | 7f384886ce65fb5deead17a3604a9f0b8917a9ee (diff) | |
parent | cf58d23a727e09a4707ba0c87087aa7fa37827c5 (diff) |
Merge pull request #60175 from Geometror/visual-shader-vector4
Diffstat (limited to 'doc')
-rw-r--r-- | doc/classes/VisualShader.xml | 8 | ||||
-rw-r--r-- | doc/classes/VisualShaderNode.xml | 11 | ||||
-rw-r--r-- | doc/classes/VisualShaderNodeClamp.xml | 5 | ||||
-rw-r--r-- | doc/classes/VisualShaderNodeCompare.xml | 9 | ||||
-rw-r--r-- | doc/classes/VisualShaderNodeDerivativeFunc.xml | 5 | ||||
-rw-r--r-- | doc/classes/VisualShaderNodeMix.xml | 8 | ||||
-rw-r--r-- | doc/classes/VisualShaderNodeMultiplyAdd.xml | 5 | ||||
-rw-r--r-- | doc/classes/VisualShaderNodeSmoothStep.xml | 8 | ||||
-rw-r--r-- | doc/classes/VisualShaderNodeStep.xml | 8 | ||||
-rw-r--r-- | doc/classes/VisualShaderNodeSwitch.xml | 9 | ||||
-rw-r--r-- | doc/classes/VisualShaderNodeVec4Constant.xml | 16 | ||||
-rw-r--r-- | doc/classes/VisualShaderNodeVec4Uniform.xml | 19 | ||||
-rw-r--r-- | doc/classes/VisualShaderNodeVectorBase.xml | 5 | ||||
-rw-r--r-- | doc/classes/VisualShaderNodeVectorCompose.xml | 4 | ||||
-rw-r--r-- | doc/classes/VisualShaderNodeVectorDecompose.xml | 4 |
15 files changed, 100 insertions, 24 deletions
diff --git a/doc/classes/VisualShader.xml b/doc/classes/VisualShader.xml index 138aad8d47..5f13e4e7bc 100644 --- a/doc/classes/VisualShader.xml +++ b/doc/classes/VisualShader.xml @@ -214,11 +214,13 @@ </constant> <constant name="VARYING_TYPE_VECTOR_3D" value="2" enum="VaryingType"> </constant> - <constant name="VARYING_TYPE_COLOR" value="3" enum="VaryingType"> + <constant name="VARYING_TYPE_VECTOR_4D" value="3" enum="VaryingType"> </constant> - <constant name="VARYING_TYPE_TRANSFORM" value="4" enum="VaryingType"> + <constant name="VARYING_TYPE_COLOR" value="4" enum="VaryingType"> </constant> - <constant name="VARYING_TYPE_MAX" value="5" enum="VaryingType"> + <constant name="VARYING_TYPE_TRANSFORM" value="5" enum="VaryingType"> + </constant> + <constant name="VARYING_TYPE_MAX" value="6" enum="VaryingType"> </constant> <constant name="NODE_ID_INVALID" value="-1"> </constant> diff --git a/doc/classes/VisualShaderNode.xml b/doc/classes/VisualShaderNode.xml index b4a9c85625..7220731a8a 100644 --- a/doc/classes/VisualShaderNode.xml +++ b/doc/classes/VisualShaderNode.xml @@ -78,16 +78,19 @@ <constant name="PORT_TYPE_VECTOR_3D" value="3" enum="PortType"> 3D vector of floating-point values. Translated to [code]vec3[/code] type in shader code. </constant> - <constant name="PORT_TYPE_BOOLEAN" value="4" enum="PortType"> + <constant name="PORT_TYPE_VECTOR_4D" value="4" enum="PortType"> + 4D vector of floating-point values. Translated to [code]vec4[/code] type in shader code. + </constant> + <constant name="PORT_TYPE_BOOLEAN" value="5" enum="PortType"> Boolean type. Translated to [code]bool[/code] type in shader code. </constant> - <constant name="PORT_TYPE_TRANSFORM" value="5" enum="PortType"> + <constant name="PORT_TYPE_TRANSFORM" value="6" enum="PortType"> Transform type. Translated to [code]mat4[/code] type in shader code. </constant> - <constant name="PORT_TYPE_SAMPLER" value="6" enum="PortType"> + <constant name="PORT_TYPE_SAMPLER" value="7" enum="PortType"> Sampler type. Translated to reference of sampler uniform in shader code. Can only be used for input ports in non-uniform nodes. </constant> - <constant name="PORT_TYPE_MAX" value="7" enum="PortType"> + <constant name="PORT_TYPE_MAX" value="8" enum="PortType"> Represents the size of the [enum PortType] enum. </constant> </constants> diff --git a/doc/classes/VisualShaderNodeClamp.xml b/doc/classes/VisualShaderNodeClamp.xml index fd24b9cfc2..35f50a37c3 100644 --- a/doc/classes/VisualShaderNodeClamp.xml +++ b/doc/classes/VisualShaderNodeClamp.xml @@ -26,7 +26,10 @@ <constant name="OP_TYPE_VECTOR_3D" value="3" enum="OpType"> A 3D vector type. </constant> - <constant name="OP_TYPE_MAX" value="4" enum="OpType"> + <constant name="OP_TYPE_VECTOR_4D" value="4" enum="OpType"> + A 4D vector type. + </constant> + <constant name="OP_TYPE_MAX" value="5" enum="OpType"> Represents the size of the [enum OpType] enum. </constant> </constants> diff --git a/doc/classes/VisualShaderNodeCompare.xml b/doc/classes/VisualShaderNodeCompare.xml index d703181e2d..942ced2ebd 100644 --- a/doc/classes/VisualShaderNodeCompare.xml +++ b/doc/classes/VisualShaderNodeCompare.xml @@ -32,13 +32,16 @@ <constant name="CTYPE_VECTOR_3D" value="3" enum="ComparisonType"> A 3D vector type. </constant> - <constant name="CTYPE_BOOLEAN" value="4" enum="ComparisonType"> + <constant name="CTYPE_VECTOR_4D" value="4" enum="ComparisonType"> + A 4D vector type. + </constant> + <constant name="CTYPE_BOOLEAN" value="5" enum="ComparisonType"> A boolean type. </constant> - <constant name="CTYPE_TRANSFORM" value="5" enum="ComparisonType"> + <constant name="CTYPE_TRANSFORM" value="6" enum="ComparisonType"> A transform ([code]mat4[/code]) type. </constant> - <constant name="CTYPE_MAX" value="6" enum="ComparisonType"> + <constant name="CTYPE_MAX" value="7" enum="ComparisonType"> Represents the size of the [enum ComparisonType] enum. </constant> <constant name="FUNC_EQUAL" value="0" enum="Function"> diff --git a/doc/classes/VisualShaderNodeDerivativeFunc.xml b/doc/classes/VisualShaderNodeDerivativeFunc.xml index ea1153ca25..9a1ad53394 100644 --- a/doc/classes/VisualShaderNodeDerivativeFunc.xml +++ b/doc/classes/VisualShaderNodeDerivativeFunc.xml @@ -26,7 +26,10 @@ <constant name="OP_TYPE_VECTOR_3D" value="2" enum="OpType"> A 3D vector type. </constant> - <constant name="OP_TYPE_MAX" value="3" enum="OpType"> + <constant name="OP_TYPE_VECTOR_4D" value="3" enum="OpType"> + A 4D vector type. + </constant> + <constant name="OP_TYPE_MAX" value="4" enum="OpType"> Represents the size of the [enum OpType] enum. </constant> <constant name="FUNC_SUM" value="0" enum="Function"> diff --git a/doc/classes/VisualShaderNodeMix.xml b/doc/classes/VisualShaderNodeMix.xml index c8ca545183..3470e47726 100644 --- a/doc/classes/VisualShaderNodeMix.xml +++ b/doc/classes/VisualShaderNodeMix.xml @@ -29,7 +29,13 @@ <constant name="OP_TYPE_VECTOR_3D_SCALAR" value="4" enum="OpType"> The [code]a[/code] and [code]b[/code] ports use a 3D vector type. The [code]weight[/code] port uses a scalar type. </constant> - <constant name="OP_TYPE_MAX" value="5" enum="OpType"> + <constant name="OP_TYPE_VECTOR_4D" value="5" enum="OpType"> + A 4D vector type. + </constant> + <constant name="OP_TYPE_VECTOR_4D_SCALAR" value="6" enum="OpType"> + The [code]a[/code] and [code]b[/code] ports use a 4D vector type. The [code]weight[/code] port uses a scalar type. + </constant> + <constant name="OP_TYPE_MAX" value="7" enum="OpType"> Represents the size of the [enum OpType] enum. </constant> </constants> diff --git a/doc/classes/VisualShaderNodeMultiplyAdd.xml b/doc/classes/VisualShaderNodeMultiplyAdd.xml index 811f01fc28..15d0d113e9 100644 --- a/doc/classes/VisualShaderNodeMultiplyAdd.xml +++ b/doc/classes/VisualShaderNodeMultiplyAdd.xml @@ -23,7 +23,10 @@ <constant name="OP_TYPE_VECTOR_3D" value="2" enum="OpType"> A 3D vector type. </constant> - <constant name="OP_TYPE_MAX" value="3" enum="OpType"> + <constant name="OP_TYPE_VECTOR_4D" value="3" enum="OpType"> + A 4D vector type. + </constant> + <constant name="OP_TYPE_MAX" value="4" enum="OpType"> Represents the size of the [enum OpType] enum. </constant> </constants> diff --git a/doc/classes/VisualShaderNodeSmoothStep.xml b/doc/classes/VisualShaderNodeSmoothStep.xml index b10e8b4433..e25fb72921 100644 --- a/doc/classes/VisualShaderNodeSmoothStep.xml +++ b/doc/classes/VisualShaderNodeSmoothStep.xml @@ -30,7 +30,13 @@ <constant name="OP_TYPE_VECTOR_3D_SCALAR" value="4" enum="OpType"> The [code]x[/code] port uses a 3D vector type. The first two ports use a floating-point scalar type. </constant> - <constant name="OP_TYPE_MAX" value="5" enum="OpType"> + <constant name="OP_TYPE_VECTOR_4D" value="5" enum="OpType"> + A 4D vector type. + </constant> + <constant name="OP_TYPE_VECTOR_4D_SCALAR" value="6" enum="OpType"> + The [code]a[/code] and [code]b[/code] ports use a 4D vector type. The [code]weight[/code] port uses a scalar type. + </constant> + <constant name="OP_TYPE_MAX" value="7" enum="OpType"> Represents the size of the [enum OpType] enum. </constant> </constants> diff --git a/doc/classes/VisualShaderNodeStep.xml b/doc/classes/VisualShaderNodeStep.xml index 2d9e87e56c..497b86c85f 100644 --- a/doc/classes/VisualShaderNodeStep.xml +++ b/doc/classes/VisualShaderNodeStep.xml @@ -30,7 +30,13 @@ <constant name="OP_TYPE_VECTOR_3D_SCALAR" value="4" enum="OpType"> The [code]x[/code] port uses a 3D vector type, while the [code]edge[/code] port uses a floating-point scalar type. </constant> - <constant name="OP_TYPE_MAX" value="5" enum="OpType"> + <constant name="OP_TYPE_VECTOR_4D" value="5" enum="OpType"> + A 4D vector type. + </constant> + <constant name="OP_TYPE_VECTOR_4D_SCALAR" value="6" enum="OpType"> + The [code]a[/code] and [code]b[/code] ports use a 4D vector type. The [code]weight[/code] port uses a scalar type. + </constant> + <constant name="OP_TYPE_MAX" value="7" enum="OpType"> Represents the size of the [enum OpType] enum. </constant> </constants> diff --git a/doc/classes/VisualShaderNodeSwitch.xml b/doc/classes/VisualShaderNodeSwitch.xml index 4cadf79b8e..e74ff6e162 100644 --- a/doc/classes/VisualShaderNodeSwitch.xml +++ b/doc/classes/VisualShaderNodeSwitch.xml @@ -26,13 +26,16 @@ <constant name="OP_TYPE_VECTOR_3D" value="3" enum="OpType"> A 3D vector type. </constant> - <constant name="OP_TYPE_BOOLEAN" value="4" enum="OpType"> + <constant name="OP_TYPE_VECTOR_4D" value="4" enum="OpType"> + A 4D vector type. + </constant> + <constant name="OP_TYPE_BOOLEAN" value="5" enum="OpType"> A boolean type. </constant> - <constant name="OP_TYPE_TRANSFORM" value="5" enum="OpType"> + <constant name="OP_TYPE_TRANSFORM" value="6" enum="OpType"> A transform type. </constant> - <constant name="OP_TYPE_MAX" value="6" enum="OpType"> + <constant name="OP_TYPE_MAX" value="7" enum="OpType"> Represents the size of the [enum OpType] enum. </constant> </constants> diff --git a/doc/classes/VisualShaderNodeVec4Constant.xml b/doc/classes/VisualShaderNodeVec4Constant.xml new file mode 100644 index 0000000000..ed3d8a673d --- /dev/null +++ b/doc/classes/VisualShaderNodeVec4Constant.xml @@ -0,0 +1,16 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeVec4Constant" inherits="VisualShaderNodeConstant" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> + <brief_description> + A 4D vector (represented as a [Quaternion]) constant to be used within the visual shader graph. + </brief_description> + <description> + A constant 4D vector (represented as a [Quaternion]), which can be used as an input node. + </description> + <tutorials> + </tutorials> + <members> + <member name="constant" type="Quaternion" setter="set_constant" getter="get_constant" default="Quaternion(0, 0, 0, 1)"> + A 4D vector (represented as a [Quaternion]) constant which represents the state of this node. + </member> + </members> +</class> diff --git a/doc/classes/VisualShaderNodeVec4Uniform.xml b/doc/classes/VisualShaderNodeVec4Uniform.xml new file mode 100644 index 0000000000..5bd13a440b --- /dev/null +++ b/doc/classes/VisualShaderNodeVec4Uniform.xml @@ -0,0 +1,19 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="VisualShaderNodeVec4Uniform" inherits="VisualShaderNodeUniform" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> + <brief_description> + A 4D vector (represented as a [Quaternion]) uniform to be used within the visual shader graph. + </brief_description> + <description> + Translated to [code]uniform vec4[/code] in the shader language. + </description> + <tutorials> + </tutorials> + <members> + <member name="default_value" type="Quaternion" setter="set_default_value" getter="get_default_value" default="Quaternion(0, 0, 0, 1)"> + A default value to be assigned within the shader. + </member> + <member name="default_value_enabled" type="bool" setter="set_default_value_enabled" getter="is_default_value_enabled" default="false"> + Enables usage of the [member default_value]. + </member> + </members> +</class> diff --git a/doc/classes/VisualShaderNodeVectorBase.xml b/doc/classes/VisualShaderNodeVectorBase.xml index 21f70960ab..d9c9f2d79c 100644 --- a/doc/classes/VisualShaderNodeVectorBase.xml +++ b/doc/classes/VisualShaderNodeVectorBase.xml @@ -19,7 +19,10 @@ <constant name="OP_TYPE_VECTOR_3D" value="1" enum="OpType"> A 3D vector type. </constant> - <constant name="OP_TYPE_MAX" value="2" enum="OpType"> + <constant name="OP_TYPE_VECTOR_4D" value="2" enum="OpType"> + A 4D vector type. + </constant> + <constant name="OP_TYPE_MAX" value="3" enum="OpType"> Represents the size of the [enum OpType] enum. </constant> </constants> diff --git a/doc/classes/VisualShaderNodeVectorCompose.xml b/doc/classes/VisualShaderNodeVectorCompose.xml index 87947c088e..b7447894b7 100644 --- a/doc/classes/VisualShaderNodeVectorCompose.xml +++ b/doc/classes/VisualShaderNodeVectorCompose.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="VisualShaderNodeVectorCompose" inherits="VisualShaderNodeVectorBase" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> - Composes a [Vector3] from three scalars within the visual shader graph. + Composes a [Vector2], [Vector3] or 4D vector (represented as a [Quaternion]) from scalars within the visual shader graph. </brief_description> <description> - Creates a [code]vec3[/code] using three scalar values that can be provided from separate inputs. + Creates a [code]vec2[/code], [code]vec3[/code] or [code]vec4[/code] using scalar values that can be provided from separate inputs. </description> <tutorials> </tutorials> diff --git a/doc/classes/VisualShaderNodeVectorDecompose.xml b/doc/classes/VisualShaderNodeVectorDecompose.xml index f5cff2a9f7..fa18e6b0b9 100644 --- a/doc/classes/VisualShaderNodeVectorDecompose.xml +++ b/doc/classes/VisualShaderNodeVectorDecompose.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="VisualShaderNodeVectorDecompose" inherits="VisualShaderNodeVectorBase" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> - Decomposes a [Vector3] into three scalars within the visual shader graph. + Decomposes a [Vector2], [Vector3] or 4D vector (represented as a [Quaternion]) into scalars within the visual shader graph. </brief_description> <description> - Takes a [code]vec3[/code] and decomposes it into three scalar values that can be used as separate inputs. + Takes a [code]vec2[/code], [code]vec3[/code] or [code]vec4[/code] and decomposes it into scalar values that can be used as separate outputs. </description> <tutorials> </tutorials> |