summaryrefslogtreecommitdiff
path: root/doc/classes/VisualShaderNode.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/VisualShaderNode.xml')
-rw-r--r--doc/classes/VisualShaderNode.xml44
1 files changed, 22 insertions, 22 deletions
diff --git a/doc/classes/VisualShaderNode.xml b/doc/classes/VisualShaderNode.xml
index 3bb527f3d4..2cff70b4f1 100644
--- a/doc/classes/VisualShaderNode.xml
+++ b/doc/classes/VisualShaderNode.xml
@@ -4,43 +4,49 @@
Base class for nodes in a visual shader graph.
</brief_description>
<description>
+ Visual shader graphs consist of various nodes. Each node in the graph is a separate object and they are represented as a rectangular boxes with title and a set of properties. Each node has also connection ports that allow to connect it to another nodes and control the flow of the shader.
</description>
<tutorials>
<link title="VisualShaders">https://docs.godotengine.org/en/latest/tutorials/shading/visual_shaders.html</link>
</tutorials>
<methods>
+ <method name="clear_default_input_values">
+ <return type="void" />
+ <description>
+ Clears the default input ports value.
+ </description>
+ </method>
<method name="get_default_input_values" qualifiers="const">
- <return type="Array">
- </return>
+ <return type="Array" />
<description>
Returns an [Array] containing default values for all of the input ports of the node in the form [code][index0, value0, index1, value1, ...][/code].
</description>
</method>
<method name="get_input_port_default_value" qualifiers="const">
- <return type="Variant">
- </return>
- <argument index="0" name="port" type="int">
- </argument>
+ <return type="Variant" />
+ <argument index="0" name="port" type="int" />
<description>
Returns the default value of the input [code]port[/code].
</description>
</method>
+ <method name="remove_input_port_default_value">
+ <return type="void" />
+ <argument index="0" name="port" type="int" />
+ <description>
+ Removes the default value of the input [code]port[/code].
+ </description>
+ </method>
<method name="set_default_input_values">
- <return type="void">
- </return>
- <argument index="0" name="values" type="Array">
- </argument>
+ <return type="void" />
+ <argument index="0" name="values" type="Array" />
<description>
Sets the default input ports values using an [Array] of the form [code][index0, value0, index1, value1, ...][/code]. For example: [code][0, Vector3(0, 0, 0), 1, Vector3(0, 0, 0)][/code].
</description>
</method>
<method name="set_input_port_default_value">
- <return type="void">
- </return>
- <argument index="0" name="port" type="int">
- </argument>
- <argument index="1" name="value" type="Variant">
- </argument>
+ <return type="void" />
+ <argument index="0" name="port" type="int" />
+ <argument index="1" name="value" type="Variant" />
<description>
Sets the default value for the selected input [code]port[/code].
</description>
@@ -57,12 +63,6 @@
Emitted when the node requests an editor refresh. Currently called only in setter of [member VisualShaderNodeTexture.source], [VisualShaderNodeTexture], and [VisualShaderNodeCubemap] (and their derivatives).
</description>
</signal>
- <signal name="show_port_preview">
- <argument index="0" name="port_id" type="int">
- </argument>
- <description>
- </description>
- </signal>
</signals>
<constants>
<constant name="PORT_TYPE_SCALAR" value="0" enum="PortType">