summaryrefslogtreecommitdiffstats
path: root/doc/classes/VisualShaderNodeIs.xml
diff options
context:
space:
mode:
authorTomasz Chabora <kobewi4e@gmail.com>2020-05-07 11:19:23 +0200
committerTomasz Chabora <kobewi4e@gmail.com>2020-05-08 00:36:01 +0200
commitfecf79f2870508697b3e45d4d93312d16fe161c5 (patch)
tree8be2da8dd346aebce3c44ad55b2b2efe8a6d6156 /doc/classes/VisualShaderNodeIs.xml
parent2df844d5b311fc8d8b18040020df82c73d4365dd (diff)
downloadredot-engine-fecf79f2870508697b3e45d4d93312d16fe161c5.tar.gz
Add documentation for the VisualShader nodes
Diffstat (limited to 'doc/classes/VisualShaderNodeIs.xml')
-rw-r--r--doc/classes/VisualShaderNodeIs.xml5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/classes/VisualShaderNodeIs.xml b/doc/classes/VisualShaderNodeIs.xml
index 184c9e099f..b767a9638e 100644
--- a/doc/classes/VisualShaderNodeIs.xml
+++ b/doc/classes/VisualShaderNodeIs.xml
@@ -1,8 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualShaderNodeIs" inherits="VisualShaderNode" version="4.0">
<brief_description>
+ A boolean comparison operator to be used within the visual shader graph.
</brief_description>
<description>
+ Returns the boolean result of the comparison between [code]INF[/code] or [code]NaN[/code] and a scalar parameter.
</description>
<tutorials>
</tutorials>
@@ -10,12 +12,15 @@
</methods>
<members>
<member name="function" type="int" setter="set_function" getter="get_function" enum="VisualShaderNodeIs.Function" default="0">
+ The comparison function. See [enum Function] for options.
</member>
</members>
<constants>
<constant name="FUNC_IS_INF" value="0" enum="Function">
+ Comparison with [code]INF[/code] (Infinity).
</constant>
<constant name="FUNC_IS_NAN" value="1" enum="Function">
+ Comparison with [code]NaN[/code] (Not a Number; denotes invalid numeric results, e.g. division by zero).
</constant>
</constants>
</class>