stan220/godot-docs
1
0
Fork 0
mirror of https://github.com/stan220/godot-docs.git synced 2026-09-08 17:28:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (f87858a8f)

Browse Source
This commit is contained in:
Yuri Sizov
2022-12-05 20:38:58 +03:00
parent 913ff5e602
commit a7745c4cc4
843 changed files with 158186 additions and 80821 deletions
Download Patch File Download Diff File Expand all files Collapse all files
classes/class_visualshadernodesmoothstep.rst
+86 -34
View File
@@ -14,6 +14,8 @@ VisualShaderNodeSmoothStep
Calculates a SmoothStep function within the visual shader graph.
.. rst-class:: classref-introduction-group
Description
-----------
@@ -21,66 +23,116 @@ 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.
.. rst-class:: classref-reftable-group
Properties
----------
+-------------------------------------------------------+-------------------------------------------------------------------+-------+
| :ref:`OpType<enum_VisualShaderNodeSmoothStep_OpType>` | :ref:`op_type<class_VisualShaderNodeSmoothStep_property_op_type>` | ``0`` |
+-------------------------------------------------------+-------------------------------------------------------------------+-------+
.. table::
:widths: auto
+-------------------------------------------------------+-------------------------------------------------------------------+-------+
| :ref:`OpType<enum_VisualShaderNodeSmoothStep_OpType>` | :ref:`op_type<class_VisualShaderNodeSmoothStep_property_op_type>` | ``0`` |
+-------------------------------------------------------+-------------------------------------------------------------------+-------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Enumerations
------------
.. _enum_VisualShaderNodeSmoothStep_OpType:
.. _class_VisualShaderNodeSmoothStep_constant_OP_TYPE_SCALAR:
.. _class_VisualShaderNodeSmoothStep_constant_OP_TYPE_VECTOR_2D:
.. _class_VisualShaderNodeSmoothStep_constant_OP_TYPE_VECTOR_2D_SCALAR:
.. _class_VisualShaderNodeSmoothStep_constant_OP_TYPE_VECTOR_3D:
.. _class_VisualShaderNodeSmoothStep_constant_OP_TYPE_VECTOR_3D_SCALAR:
.. _class_VisualShaderNodeSmoothStep_constant_OP_TYPE_VECTOR_4D:
.. _class_VisualShaderNodeSmoothStep_constant_OP_TYPE_VECTOR_4D_SCALAR:
.. _class_VisualShaderNodeSmoothStep_constant_OP_TYPE_MAX:
.. rst-class:: classref-enumeration
enum **OpType**:
- **OP_TYPE_SCALAR** = **0** --- A floating-point scalar type.
.. _class_VisualShaderNodeSmoothStep_constant_OP_TYPE_SCALAR:
- **OP_TYPE_VECTOR_2D** = **1** --- A 2D vector type.
.. rst-class:: classref-enumeration-constant
- **OP_TYPE_VECTOR_2D_SCALAR** = **2** --- The ``x`` port uses a 2D vector type. The first two ports use a floating-point scalar type.
:ref:`OpType<enum_VisualShaderNodeSmoothStep_OpType>` **OP_TYPE_SCALAR** = ``0``
- **OP_TYPE_VECTOR_3D** = **3** --- A 3D vector type.
A floating-point scalar type.
- **OP_TYPE_VECTOR_3D_SCALAR** = **4** --- The ``x`` port uses a 3D vector type. The first two ports use a floating-point scalar type.
.. _class_VisualShaderNodeSmoothStep_constant_OP_TYPE_VECTOR_2D:
- **OP_TYPE_VECTOR_4D** = **5** --- A 4D vector type.
.. rst-class:: classref-enumeration-constant
- **OP_TYPE_VECTOR_4D_SCALAR** = **6** --- The ``a`` and ``b`` ports use a 4D vector type. The ``weight`` port uses a scalar type.
:ref:`OpType<enum_VisualShaderNodeSmoothStep_OpType>` **OP_TYPE_VECTOR_2D** = ``1``
- **OP_TYPE_MAX** = **7** --- Represents the size of the :ref:`OpType<enum_VisualShaderNodeSmoothStep_OpType>` enum.
A 2D vector type.
.. _class_VisualShaderNodeSmoothStep_constant_OP_TYPE_VECTOR_2D_SCALAR:
.. rst-class:: classref-enumeration-constant
:ref:`OpType<enum_VisualShaderNodeSmoothStep_OpType>` **OP_TYPE_VECTOR_2D_SCALAR** = ``2``
The ``x`` port uses a 2D vector type. The first two ports use a floating-point scalar type.
.. _class_VisualShaderNodeSmoothStep_constant_OP_TYPE_VECTOR_3D:
.. rst-class:: classref-enumeration-constant
:ref:`OpType<enum_VisualShaderNodeSmoothStep_OpType>` **OP_TYPE_VECTOR_3D** = ``3``
A 3D vector type.
.. _class_VisualShaderNodeSmoothStep_constant_OP_TYPE_VECTOR_3D_SCALAR:
.. rst-class:: classref-enumeration-constant
:ref:`OpType<enum_VisualShaderNodeSmoothStep_OpType>` **OP_TYPE_VECTOR_3D_SCALAR** = ``4``
The ``x`` port uses a 3D vector type. The first two ports use a floating-point scalar type.
.. _class_VisualShaderNodeSmoothStep_constant_OP_TYPE_VECTOR_4D:
.. rst-class:: classref-enumeration-constant
:ref:`OpType<enum_VisualShaderNodeSmoothStep_OpType>` **OP_TYPE_VECTOR_4D** = ``5``
A 4D vector type.
.. _class_VisualShaderNodeSmoothStep_constant_OP_TYPE_VECTOR_4D_SCALAR:
.. rst-class:: classref-enumeration-constant
:ref:`OpType<enum_VisualShaderNodeSmoothStep_OpType>` **OP_TYPE_VECTOR_4D_SCALAR** = ``6``
The ``a`` and ``b`` ports use a 4D vector type. The ``weight`` port uses a scalar type.
.. _class_VisualShaderNodeSmoothStep_constant_OP_TYPE_MAX:
.. rst-class:: classref-enumeration-constant
:ref:`OpType<enum_VisualShaderNodeSmoothStep_OpType>` **OP_TYPE_MAX** = ``7``
Represents the size of the :ref:`OpType<enum_VisualShaderNodeSmoothStep_OpType>` enum.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_VisualShaderNodeSmoothStep_property_op_type:
- :ref:`OpType<enum_VisualShaderNodeSmoothStep_OpType>` **op_type**
.. rst-class:: classref-property
+-----------+--------------------+
| *Default* | ``0`` |
+-----------+--------------------+
| *Setter* | set_op_type(value) |
+-----------+--------------------+
| *Getter* | get_op_type() |
+-----------+--------------------+
:ref:`OpType<enum_VisualShaderNodeSmoothStep_OpType>` **op_type** = ``0``
.. rst-class:: classref-property-setget
- void **set_op_type** **(** :ref:`OpType<enum_VisualShaderNodeSmoothStep_OpType>` value **)**
- :ref:`OpType<enum_VisualShaderNodeSmoothStep_OpType>` **get_op_type** **(** **)**
A type of operands and returned value.