virtualx-engine/doc/classes/VisualShaderNodeUniform.xml
Rémi Verschelde a95e2ec5ac
Merge pull request #38505 from KoBeWi/ms_visual_docs
Add documentation for the VisualShader nodes
2020-05-10 13:07:56 +02:00

28 lines
1.2 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="VisualShaderNodeUniform" inherits="VisualShaderNode" version="4.0">
<brief_description>
A base type for the uniforms within the visual shader graph.
</brief_description>
<description>
A uniform represents a variable in the shader which is set externally, i.e. from the [ShaderMaterial]. Uniforms are exposed as properties in the [ShaderMaterial] and can be assigned from the inspector or from a script.
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="qualifier" type="int" setter="set_qualifier" getter="get_qualifier" enum="VisualShaderNodeUniform.Qualifier" default="0">
</member>
<member name="uniform_name" type="String" setter="set_uniform_name" getter="get_uniform_name" default="&quot;&quot;">
Name of the uniform, by which it can be accessed through the [ShaderMaterial] properties.
</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>
</constants>
</class>