godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/VisualShaderNodeGroupBase.xml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

161 lines
5.7 KiB
XML
Raw Normal View History

doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Bump version to 4.1-dev Can't stop, won't stop, they said, huh?
2023-03-01 00:44:37 +00:00
<class name="VisualShaderNodeGroupBase" inherits="VisualShaderNodeResizableBase" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
<brief_description>
[doc] Fix grammar in class docs: amount vs. number Number is used for things that can be counted (discrete items - think "integer" in this context). Also fixes a couple of awkward phrases.
2022-08-17 22:08:09 +00:00
Base class for a family of nodes with variable number of input and output ports within the visual shader graph.
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
</brief_description>
<description>
Docs for some nodes in visual shader(part 2)
2020-01-27 15:14:10 +00:00
Currently, has no direct usage, use the derived classes instead.
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
</description>
<tutorials>
</tutorials>
<methods>
<method name="add_input_port">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="id" type="int" />
<param index="1" name="type" type="int" />
<param index="2" name="name" type="String" />
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters Co-authored-by: Yuri Sizov <11782833+YuriSizov@users.noreply.github.com>
2022-08-08 23:41:07 +00:00
Adds an input port with the specified [param type] (see [enum VisualShaderNode.PortType]) and [param name].
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
</description>
</method>
<method name="add_output_port">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="id" type="int" />
<param index="1" name="type" type="int" />
<param index="2" name="name" type="String" />
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters Co-authored-by: Yuri Sizov <11782833+YuriSizov@users.noreply.github.com>
2022-08-08 23:41:07 +00:00
Adds an output port with the specified [param type] (see [enum VisualShaderNode.PortType]) and [param name].
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
</description>
</method>
<method name="clear_input_ports">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
<description>
Docs for some nodes in visual shader(part 2)
2020-01-27 15:14:10 +00:00
Removes all previously specified input ports.
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
</description>
</method>
<method name="clear_output_ports">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
<description>
Docs for some nodes in visual shader(part 2)
2020-01-27 15:14:10 +00:00
Removes all previously specified output ports.
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
</description>
</method>
<method name="get_free_input_port_id" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
<description>
Docs for some nodes in visual shader(part 2)
2020-01-27 15:14:10 +00:00
Returns a free input port ID which can be used in [method add_input_port].
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
</description>
</method>
<method name="get_free_output_port_id" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
<description>
Docs for some nodes in visual shader(part 2)
2020-01-27 15:14:10 +00:00
Returns a free output port ID which can be used in [method add_output_port].
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
</description>
</method>
<method name="get_input_port_count" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
<description>
Docs for some nodes in visual shader(part 2)
2020-01-27 15:14:10 +00:00
Returns the number of input ports in use. Alternative for [method get_free_input_port_id].
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
</description>
</method>
<method name="get_inputs" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="String" />
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
<description>
class reference proofreading
2021-03-18 11:04:28 +00:00
Returns a [String] description of the input ports as a colon-separated list using the format [code]id,type,name;[/code] (see [method add_input_port]).
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
</description>
</method>
<method name="get_output_port_count" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
<description>
Docs for some nodes in visual shader(part 2)
2020-01-27 15:14:10 +00:00
Returns the number of output ports in use. Alternative for [method get_free_output_port_id].
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
</description>
</method>
<method name="get_outputs" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="String" />
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
<description>
class reference proofreading
2021-03-18 11:04:28 +00:00
Returns a [String] description of the output ports as a colon-separated list using the format [code]id,type,name;[/code] (see [method add_output_port]).
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
</description>
</method>
<method name="has_input_port" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="id" type="int" />
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
<description>
Docs for some nodes in visual shader(part 2)
2020-01-27 15:14:10 +00:00
Returns [code]true[/code] if the specified input port exists.
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
</description>
</method>
<method name="has_output_port" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="id" type="int" />
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
<description>
Docs for some nodes in visual shader(part 2)
2020-01-27 15:14:10 +00:00
Returns [code]true[/code] if the specified output port exists.
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
</description>
</method>
doc: Sync classref with current source
2019-06-24 08:39:59 +00:00
<method name="is_valid_port_name" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="name" type="String" />
doc: Sync classref with current source
2019-06-24 08:39:59 +00:00
<description>
Docs for some nodes in visual shader(part 2)
2020-01-27 15:14:10 +00:00
Returns [code]true[/code] if the specified port name does not override an existed port name and is valid within the shader.
doc: Sync classref with current source
2019-06-24 08:39:59 +00:00
</description>
</method>
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
<method name="remove_input_port">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="id" type="int" />
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
<description>
Docs for some nodes in visual shader(part 2)
2020-01-27 15:14:10 +00:00
Removes the specified input port.
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
</description>
</method>
<method name="remove_output_port">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="id" type="int" />
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
<description>
Docs for some nodes in visual shader(part 2)
2020-01-27 15:14:10 +00:00
Removes the specified output port.
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
</description>
</method>
<method name="set_input_port_name">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="id" type="int" />
<param index="1" name="name" type="String" />
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
<description>
Docs for some nodes in visual shader(part 2)
2020-01-27 15:14:10 +00:00
Renames the specified input port.
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
</description>
</method>
<method name="set_input_port_type">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="id" type="int" />
<param index="1" name="type" type="int" />
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
<description>
Docs for some nodes in visual shader(part 2)
2020-01-27 15:14:10 +00:00
Sets the specified input port's type (see [enum VisualShaderNode.PortType]).
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
</description>
</method>
<method name="set_inputs">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="inputs" type="String" />
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
<description>
Docs for some nodes in visual shader(part 2)
2020-01-27 15:14:10 +00:00
Defines all input ports using a [String] formatted as a colon-separated list: [code]id,type,name;[/code] (see [method add_input_port]).
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
</description>
</method>
<method name="set_output_port_name">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="id" type="int" />
<param index="1" name="name" type="String" />
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
<description>
Docs for some nodes in visual shader(part 2)
2020-01-27 15:14:10 +00:00
Renames the specified output port.
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
</description>
</method>
<method name="set_output_port_type">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="id" type="int" />
<param index="1" name="type" type="int" />
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
<description>
Docs for some nodes in visual shader(part 2)
2020-01-27 15:14:10 +00:00
Sets the specified output port's type (see [enum VisualShaderNode.PortType]).
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
</description>
</method>
<method name="set_outputs">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="outputs" type="String" />
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
<description>
Docs for some nodes in visual shader(part 2)
2020-01-27 15:14:10 +00:00
Defines all output ports using a [String] formatted as a colon-separated list: [code]id,type,name;[/code] (see [method add_output_port]).
doc: Sync classref with current source
2019-05-28 16:08:13 +00:00
</description>
</method>
</methods>
</class>