:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/VisualShaderNodeParameter.xml. .. _class_VisualShaderNodeParameter: VisualShaderNodeParameter ========================= **Inherits:** :ref:`VisualShaderNode` **<** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` **Inherited By:** :ref:`VisualShaderNodeBooleanParameter`, :ref:`VisualShaderNodeColorParameter`, :ref:`VisualShaderNodeFloatParameter`, :ref:`VisualShaderNodeIntParameter`, :ref:`VisualShaderNodeTextureParameter`, :ref:`VisualShaderNodeTransformParameter`, :ref:`VisualShaderNodeUIntParameter`, :ref:`VisualShaderNodeVec2Parameter`, :ref:`VisualShaderNodeVec3Parameter`, :ref:`VisualShaderNodeVec4Parameter` A base type for the parameters within the visual shader graph. .. rst-class:: classref-introduction-group Description ----------- A parameter represents a variable in the shader which is set externally, i.e. from the :ref:`ShaderMaterial`. Parameters are exposed as properties in the :ref:`ShaderMaterial` and can be assigned from the Inspector or from a script. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +------------------------------------------------------------+--------------------------------------------------------------------------------+--------+ | :ref:`String` | :ref:`parameter_name` | ``""`` | +------------------------------------------------------------+--------------------------------------------------------------------------------+--------+ | :ref:`Qualifier` | :ref:`qualifier` | ``0`` | +------------------------------------------------------------+--------------------------------------------------------------------------------+--------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_VisualShaderNodeParameter_Qualifier: .. rst-class:: classref-enumeration enum **Qualifier**: :ref:`🔗` .. _class_VisualShaderNodeParameter_constant_QUAL_NONE: .. rst-class:: classref-enumeration-constant :ref:`Qualifier` **QUAL_NONE** = ``0`` The parameter will be tied to the :ref:`ShaderMaterial` using this shader. .. _class_VisualShaderNodeParameter_constant_QUAL_GLOBAL: .. rst-class:: classref-enumeration-constant :ref:`Qualifier` **QUAL_GLOBAL** = ``1`` The parameter will use a global value, defined in Project Settings. .. _class_VisualShaderNodeParameter_constant_QUAL_INSTANCE: .. rst-class:: classref-enumeration-constant :ref:`Qualifier` **QUAL_INSTANCE** = ``2`` The parameter will be tied to the node with attached :ref:`ShaderMaterial` using this shader. .. _class_VisualShaderNodeParameter_constant_QUAL_MAX: .. rst-class:: classref-enumeration-constant :ref:`Qualifier` **QUAL_MAX** = ``3`` Represents the size of the :ref:`Qualifier` enum. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_VisualShaderNodeParameter_property_parameter_name: .. rst-class:: classref-property :ref:`String` **parameter_name** = ``""`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_parameter_name**\ (\ value\: :ref:`String`\ ) - :ref:`String` **get_parameter_name**\ (\ ) Name of the parameter, by which it can be accessed through the :ref:`ShaderMaterial` properties. .. rst-class:: classref-item-separator ---- .. _class_VisualShaderNodeParameter_property_qualifier: .. rst-class:: classref-property :ref:`Qualifier` **qualifier** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_qualifier**\ (\ value\: :ref:`Qualifier`\ ) - :ref:`Qualifier` **get_qualifier**\ (\ ) Defines the scope of the parameter. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`