.. 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/docs/gdscript/doc/classes/VisualShaderNode.xml. .. _class_VisualShaderNode: VisualShaderNode ================ **Inherits:** :ref:`Resource` **<** :ref:`RefCounted` **<** :ref:`Object` **Inherited By:** :ref:`VisualShaderNodeBillboard`, :ref:`VisualShaderNodeClamp`, :ref:`VisualShaderNodeColorFunc`, :ref:`VisualShaderNodeColorOp`, :ref:`VisualShaderNodeCompare`, :ref:`VisualShaderNodeConstant`, :ref:`VisualShaderNodeCubemap`, :ref:`VisualShaderNodeCustom`, :ref:`VisualShaderNodeDerivativeFunc`, :ref:`VisualShaderNodeDeterminant`, :ref:`VisualShaderNodeDistanceFade`, :ref:`VisualShaderNodeDotProduct`, :ref:`VisualShaderNodeFloatFunc`, :ref:`VisualShaderNodeFloatOp`, :ref:`VisualShaderNodeFresnel`, :ref:`VisualShaderNodeIf`, :ref:`VisualShaderNodeInput`, :ref:`VisualShaderNodeIntFunc`, :ref:`VisualShaderNodeIntOp`, :ref:`VisualShaderNodeIs`, :ref:`VisualShaderNodeLinearSceneDepth`, :ref:`VisualShaderNodeMix`, :ref:`VisualShaderNodeMultiplyAdd`, :ref:`VisualShaderNodeOuterProduct`, :ref:`VisualShaderNodeOutput`, :ref:`VisualShaderNodeParameter`, :ref:`VisualShaderNodeParameterRef`, :ref:`VisualShaderNodeParticleAccelerator`, :ref:`VisualShaderNodeParticleConeVelocity`, :ref:`VisualShaderNodeParticleEmit`, :ref:`VisualShaderNodeParticleEmitter`, :ref:`VisualShaderNodeParticleMultiplyByAxisAngle`, :ref:`VisualShaderNodeParticleRandomness`, :ref:`VisualShaderNodeProximityFade`, :ref:`VisualShaderNodeRandomRange`, :ref:`VisualShaderNodeRemap`, :ref:`VisualShaderNodeReroute`, :ref:`VisualShaderNodeResizableBase`, :ref:`VisualShaderNodeRotationByAxis`, :ref:`VisualShaderNodeSample3D`, :ref:`VisualShaderNodeScreenNormalWorldSpace`, :ref:`VisualShaderNodeScreenUVToSDF`, :ref:`VisualShaderNodeSDFRaymarch`, :ref:`VisualShaderNodeSDFToScreenUV`, :ref:`VisualShaderNodeSmoothStep`, :ref:`VisualShaderNodeStep`, :ref:`VisualShaderNodeSwitch`, :ref:`VisualShaderNodeTexture`, :ref:`VisualShaderNodeTextureSDF`, :ref:`VisualShaderNodeTextureSDFNormal`, :ref:`VisualShaderNodeTransformCompose`, :ref:`VisualShaderNodeTransformDecompose`, :ref:`VisualShaderNodeTransformFunc`, :ref:`VisualShaderNodeTransformOp`, :ref:`VisualShaderNodeTransformVecMult`, :ref:`VisualShaderNodeUIntFunc`, :ref:`VisualShaderNodeUIntOp`, :ref:`VisualShaderNodeUVFunc`, :ref:`VisualShaderNodeUVPolarCoord`, :ref:`VisualShaderNodeVarying`, :ref:`VisualShaderNodeVectorBase`, :ref:`VisualShaderNodeWorldPositionFromDepth` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------+---------------------------------------------------------------------------------------------+--------+ | :ref:`int` | :ref:`linked_parent_graph_frame` | ``-1`` | +-----------------------+---------------------------------------------------------------------------------------------+--------+ | :ref:`int` | :ref:`output_port_for_preview` | ``-1`` | +-----------------------+---------------------------------------------------------------------------------------------+--------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear_default_input_values` **(** **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_default_input_port` **(** :ref:`PortType` type **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array` | :ref:`get_default_input_values` **(** **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant` | :ref:`get_input_port_default_value` **(** :ref:`int` port **)** |const| | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`remove_input_port_default_value` **(** :ref:`int` port **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_default_input_values` **(** :ref:`Array` values **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_input_port_default_value` **(** :ref:`int` port, :ref:`Variant` value, :ref:`Variant` prev_value=null **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_VisualShaderNode_PortType: .. rst-class:: classref-enumeration enum **PortType**: .. _class_VisualShaderNode_constant_PORT_TYPE_SCALAR: .. rst-class:: classref-enumeration-constant :ref:`PortType` **PORT_TYPE_SCALAR** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_VisualShaderNode_constant_PORT_TYPE_SCALAR_INT: .. rst-class:: classref-enumeration-constant :ref:`PortType` **PORT_TYPE_SCALAR_INT** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_VisualShaderNode_constant_PORT_TYPE_SCALAR_UINT: .. rst-class:: classref-enumeration-constant :ref:`PortType` **PORT_TYPE_SCALAR_UINT** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_VisualShaderNode_constant_PORT_TYPE_VECTOR_2D: .. rst-class:: classref-enumeration-constant :ref:`PortType` **PORT_TYPE_VECTOR_2D** = ``3`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_VisualShaderNode_constant_PORT_TYPE_VECTOR_3D: .. rst-class:: classref-enumeration-constant :ref:`PortType` **PORT_TYPE_VECTOR_3D** = ``4`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_VisualShaderNode_constant_PORT_TYPE_VECTOR_4D: .. rst-class:: classref-enumeration-constant :ref:`PortType` **PORT_TYPE_VECTOR_4D** = ``5`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_VisualShaderNode_constant_PORT_TYPE_BOOLEAN: .. rst-class:: classref-enumeration-constant :ref:`PortType` **PORT_TYPE_BOOLEAN** = ``6`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_VisualShaderNode_constant_PORT_TYPE_TRANSFORM: .. rst-class:: classref-enumeration-constant :ref:`PortType` **PORT_TYPE_TRANSFORM** = ``7`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_VisualShaderNode_constant_PORT_TYPE_SAMPLER: .. rst-class:: classref-enumeration-constant :ref:`PortType` **PORT_TYPE_SAMPLER** = ``8`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_VisualShaderNode_constant_PORT_TYPE_MAX: .. rst-class:: classref-enumeration-constant :ref:`PortType` **PORT_TYPE_MAX** = ``9`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_VisualShaderNode_property_linked_parent_graph_frame: .. rst-class:: classref-property :ref:`int` **linked_parent_graph_frame** = ``-1`` .. rst-class:: classref-property-setget - void **set_frame** **(** :ref:`int` value **)** - :ref:`int` **get_frame** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_VisualShaderNode_property_output_port_for_preview: .. rst-class:: classref-property :ref:`int` **output_port_for_preview** = ``-1`` .. rst-class:: classref-property-setget - void **set_output_port_for_preview** **(** :ref:`int` value **)** - :ref:`int` **get_output_port_for_preview** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_VisualShaderNode_method_clear_default_input_values: .. rst-class:: classref-method void **clear_default_input_values** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_VisualShaderNode_method_get_default_input_port: .. rst-class:: classref-method :ref:`int` **get_default_input_port** **(** :ref:`PortType` type **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_VisualShaderNode_method_get_default_input_values: .. rst-class:: classref-method :ref:`Array` **get_default_input_values** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_VisualShaderNode_method_get_input_port_default_value: .. rst-class:: classref-method :ref:`Variant` **get_input_port_default_value** **(** :ref:`int` port **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_VisualShaderNode_method_remove_input_port_default_value: .. rst-class:: classref-method void **remove_input_port_default_value** **(** :ref:`int` port **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_VisualShaderNode_method_set_default_input_values: .. rst-class:: classref-method void **set_default_input_values** **(** :ref:`Array` values **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_VisualShaderNode_method_set_input_port_default_value: .. rst-class:: classref-method void **set_input_port_default_value** **(** :ref:`int` port, :ref:`Variant` value, :ref:`Variant` prev_value=null **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |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.)`