classref: Sync with latest 4.0-dev

classes/class_visualshadernodesmoothstep.rst

@@ -0,0 +1,75 @@
+:github_url: hide
+
+.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
+.. DO NOT EDIT THIS FILE, but the VisualShaderNodeSmoothStep.xml source instead.
+.. The source is found in doc/classes or modules/<name>/doc_classes.
+
+.. _class_VisualShaderNodeSmoothStep:
+
+VisualShaderNodeSmoothStep
+==========================
+
+**Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
+
+Calculates a SmoothStep function within the visual shader graph.
+
+Description
+-----------
+
+Translates to ``smoothstep(edge0, edge1, x)`` in the shader language.
+
+Returns ``0.0`` if ``x`` is smaller than ``edge0`` and ``1.0`` if ``x`` is larger than ``edge1``. Otherwise, the return value is interpolated between ``0.0`` and ``1.0`` using Hermite polynomials.
+
+Properties
+----------
+
++-------------------------------------------------------+-------------------------------------------------------------------+-------+
+| :ref:`OpType<enum_VisualShaderNodeSmoothStep_OpType>` | :ref:`op_type<class_VisualShaderNodeSmoothStep_property_op_type>` | ``0`` |
++-------------------------------------------------------+-------------------------------------------------------------------+-------+
+
+Enumerations
+------------
+
+.. _enum_VisualShaderNodeSmoothStep_OpType:
+
+.. _class_VisualShaderNodeSmoothStep_constant_OP_TYPE_SCALAR:
+
+.. _class_VisualShaderNodeSmoothStep_constant_OP_TYPE_VECTOR:
+
+.. _class_VisualShaderNodeSmoothStep_constant_OP_TYPE_VECTOR_SCALAR:
+
+.. _class_VisualShaderNodeSmoothStep_constant_OP_TYPE_MAX:
+
+enum **OpType**:
+
+- **OP_TYPE_SCALAR** = **0** --- A scalar type.
+
+- **OP_TYPE_VECTOR** = **1** --- A vector type.
+
+- **OP_TYPE_VECTOR_SCALAR** = **2** --- A vector type. ``edge0`` and ``edge1`` are using a scalar type.
+
+- **OP_TYPE_MAX** = **3** --- Represents the size of the :ref:`OpType<enum_VisualShaderNodeSmoothStep_OpType>` enum.
+
+Property Descriptions
+---------------------
+
+.. _class_VisualShaderNodeSmoothStep_property_op_type:
+
+- :ref:`OpType<enum_VisualShaderNodeSmoothStep_OpType>` **op_type**
+
++-----------+--------------------+
+| *Default* | ``0``              |
++-----------+--------------------+
+| *Setter*  | set_op_type(value) |
++-----------+--------------------+
+| *Getter*  | get_op_type()      |
++-----------+--------------------+
+
+A type of operands and returned value.
+
+.. |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.)`