summaryrefslogtreecommitdiff
path: root/doc/classes/VisualShaderNodeParameter.xml
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2022-09-02 13:49:53 +0200
committerRémi Verschelde <rverschelde@gmail.com>2022-09-02 13:49:53 +0200
commitc82bbc38a51c3b3a66519babd26135abf2ce7d47 (patch)
tree5d86f9962ebf8ca146234b4f6aed7823ec75c94a /doc/classes/VisualShaderNodeParameter.xml
parent9142904c248cb4c9de8776f9abe995fc22335c2c (diff)
parent8191b3c110260f086de390ff38ccc980474ef755 (diff)
Merge pull request #64952 from Chaosus/vs_rename_uniform_to_param
Diffstat (limited to 'doc/classes/VisualShaderNodeParameter.xml')
-rw-r--r--doc/classes/VisualShaderNodeParameter.xml29
1 files changed, 29 insertions, 0 deletions
diff --git a/doc/classes/VisualShaderNodeParameter.xml b/doc/classes/VisualShaderNodeParameter.xml
new file mode 100644
index 0000000000..c66022f77d
--- /dev/null
+++ b/doc/classes/VisualShaderNodeParameter.xml
@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<class name="VisualShaderNodeParameter" inherits="VisualShaderNode" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
+ <brief_description>
+ A base type for the parameters within the visual shader graph.
+ </brief_description>
+ <description>
+ A parameter represents a variable in the shader which is set externally, i.e. from the [ShaderMaterial]. Parameters are exposed as properties in the [ShaderMaterial] and can be assigned from the inspector or from a script.
+ </description>
+ <tutorials>
+ </tutorials>
+ <members>
+ <member name="parameter_name" type="String" setter="set_parameter_name" getter="get_parameter_name" default="&quot;&quot;">
+ Name of the parameter, by which it can be accessed through the [ShaderMaterial] properties.
+ </member>
+ <member name="qualifier" type="int" setter="set_qualifier" getter="get_qualifier" enum="VisualShaderNodeParameter.Qualifier" default="0">
+ </member>
+ </members>
+ <constants>
+ <constant name="QUAL_NONE" value="0" enum="Qualifier">
+ </constant>
+ <constant name="QUAL_GLOBAL" value="1" enum="Qualifier">
+ </constant>
+ <constant name="QUAL_INSTANCE" value="2" enum="Qualifier">
+ </constant>
+ <constant name="QUAL_MAX" value="3" enum="Qualifier">
+ Represents the size of the [enum Qualifier] enum.
+ </constant>
+ </constants>
+</class>