summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <remi@verschelde.fr>2021-08-13 14:44:14 +0200
committerGitHub <noreply@github.com>2021-08-13 14:44:14 +0200
commitf0e420e9815f5336acd7eb12c907b2f6e5d5ef89 (patch)
tree69e750424206a0d9da4ffa2aa3431d5ca1fec7be /doc/classes
parent87b80a84f08256f07eddef543ffef3be444005c6 (diff)
parent9cf158019da555238516d209dd4ab775b90580fc (diff)
Merge pull request #51519 from Chaosus/vs_transform_operator
Changed `TransformMult` node to `TransformOp` in visual shaders
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/VisualShaderNodeTransformMult.xml32
-rw-r--r--doc/classes/VisualShaderNodeTransformOp.xml50
2 files changed, 50 insertions, 32 deletions
diff --git a/doc/classes/VisualShaderNodeTransformMult.xml b/doc/classes/VisualShaderNodeTransformMult.xml
deleted file mode 100644
index f26f60a1f3..0000000000
--- a/doc/classes/VisualShaderNodeTransformMult.xml
+++ /dev/null
@@ -1,32 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" ?>
-<class name="VisualShaderNodeTransformMult" inherits="VisualShaderNode" version="4.0">
- <brief_description>
- Multiplies [Transform3D] by [Transform3D] within the visual shader graph.
- </brief_description>
- <description>
- A multiplication operation on two transforms (4x4 matrices), with support for different multiplication operators.
- </description>
- <tutorials>
- </tutorials>
- <methods>
- </methods>
- <members>
- <member name="operator" type="int" setter="set_operator" getter="get_operator" enum="VisualShaderNodeTransformMult.Operator" default="0">
- The multiplication type to be performed on the transforms. See [enum Operator] for options.
- </member>
- </members>
- <constants>
- <constant name="OP_AxB" value="0" enum="Operator">
- Multiplies transform [code]a[/code] by the transform [code]b[/code].
- </constant>
- <constant name="OP_BxA" value="1" enum="Operator">
- Multiplies transform [code]b[/code] by the transform [code]a[/code].
- </constant>
- <constant name="OP_AxB_COMP" value="2" enum="Operator">
- Performs a component-wise multiplication of transform [code]a[/code] by the transform [code]b[/code].
- </constant>
- <constant name="OP_BxA_COMP" value="3" enum="Operator">
- Performs a component-wise multiplication of transform [code]b[/code] by the transform [code]a[/code].
- </constant>
- </constants>
-</class>
diff --git a/doc/classes/VisualShaderNodeTransformOp.xml b/doc/classes/VisualShaderNodeTransformOp.xml
new file mode 100644
index 0000000000..a628fa3e8d
--- /dev/null
+++ b/doc/classes/VisualShaderNodeTransformOp.xml
@@ -0,0 +1,50 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="VisualShaderNodeTransformOp" inherits="VisualShaderNode" version="4.0">
+ <brief_description>
+ A [Transform3D] operator to be used within the visual shader graph.
+ </brief_description>
+ <description>
+ Applies [member operator] to two transform (4x4 matrices) inputs.
+ </description>
+ <tutorials>
+ </tutorials>
+ <methods>
+ </methods>
+ <members>
+ <member name="operator" type="int" setter="set_operator" getter="get_operator" enum="VisualShaderNodeTransformOp.Operator" default="0">
+ The type of the operation to be performed on the transforms. See [enum Operator] for options.
+ </member>
+ </members>
+ <constants>
+ <constant name="OP_AxB" value="0" enum="Operator">
+ Multiplies transform [code]a[/code] by the transform [code]b[/code].
+ </constant>
+ <constant name="OP_BxA" value="1" enum="Operator">
+ Multiplies transform [code]b[/code] by the transform [code]a[/code].
+ </constant>
+ <constant name="OP_AxB_COMP" value="2" enum="Operator">
+ Performs a component-wise multiplication of transform [code]a[/code] by the transform [code]b[/code].
+ </constant>
+ <constant name="OP_BxA_COMP" value="3" enum="Operator">
+ Performs a component-wise multiplication of transform [code]b[/code] by the transform [code]a[/code].
+ </constant>
+ <constant name="OP_ADD" value="4" enum="Operator">
+ Adds two transforms.
+ </constant>
+ <constant name="OP_A_MINUS_B" value="5" enum="Operator">
+ Subtracts the transform [code]a[/code] from the transform [code]b[/code].
+ </constant>
+ <constant name="OP_B_MINUS_A" value="6" enum="Operator">
+ Subtracts the transform [code]b[/code] from the transform [code]a[/code].
+ </constant>
+ <constant name="OP_A_DIV_B" value="7" enum="Operator">
+ Divides the transform [code]a[/code] by the transform [code]b[/code].
+ </constant>
+ <constant name="OP_B_DIV_A" value="8" enum="Operator">
+ Divides the transform [code]b[/code] by the transform [code]a[/code].
+ </constant>
+ <constant name="OP_LIMITER" value="9" enum="Operator">
+ Represents the size of the [enum Operator] enum.
+ </constant>
+ </constants>
+</class>