mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
148 lines
5.0 KiB
ReStructuredText
148 lines
5.0 KiB
ReStructuredText
: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/VisualShaderNodeStep.xml.
|
|
|
|
.. _class_VisualShaderNodeStep:
|
|
|
|
VisualShaderNodeStep
|
|
====================
|
|
|
|
**Inherits:** :ref:`VisualShaderNode<class_VisualShaderNode>` **<** :ref:`Resource<class_Resource>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
|
|
|
|
Calculates a Step function within the visual shader graph.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Description
|
|
-----------
|
|
|
|
Translates to ``step(edge, x)`` in the shader language.
|
|
|
|
Returns ``0.0`` if ``x`` is smaller than ``edge`` and ``1.0`` otherwise.
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Properties
|
|
----------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+-------------------------------------------------+-------------------------------------------------------------+-------+
|
|
| :ref:`OpType<enum_VisualShaderNodeStep_OpType>` | :ref:`op_type<class_VisualShaderNodeStep_property_op_type>` | ``0`` |
|
|
+-------------------------------------------------+-------------------------------------------------------------+-------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Enumerations
|
|
------------
|
|
|
|
.. _enum_VisualShaderNodeStep_OpType:
|
|
|
|
.. rst-class:: classref-enumeration
|
|
|
|
enum **OpType**: :ref:`🔗<enum_VisualShaderNodeStep_OpType>`
|
|
|
|
.. _class_VisualShaderNodeStep_constant_OP_TYPE_SCALAR:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`OpType<enum_VisualShaderNodeStep_OpType>` **OP_TYPE_SCALAR** = ``0``
|
|
|
|
A floating-point scalar type.
|
|
|
|
.. _class_VisualShaderNodeStep_constant_OP_TYPE_VECTOR_2D:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`OpType<enum_VisualShaderNodeStep_OpType>` **OP_TYPE_VECTOR_2D** = ``1``
|
|
|
|
A 2D vector type.
|
|
|
|
.. _class_VisualShaderNodeStep_constant_OP_TYPE_VECTOR_2D_SCALAR:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`OpType<enum_VisualShaderNodeStep_OpType>` **OP_TYPE_VECTOR_2D_SCALAR** = ``2``
|
|
|
|
The ``x`` port uses a 2D vector type, while the ``edge`` port uses a floating-point scalar type.
|
|
|
|
.. _class_VisualShaderNodeStep_constant_OP_TYPE_VECTOR_3D:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`OpType<enum_VisualShaderNodeStep_OpType>` **OP_TYPE_VECTOR_3D** = ``3``
|
|
|
|
A 3D vector type.
|
|
|
|
.. _class_VisualShaderNodeStep_constant_OP_TYPE_VECTOR_3D_SCALAR:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`OpType<enum_VisualShaderNodeStep_OpType>` **OP_TYPE_VECTOR_3D_SCALAR** = ``4``
|
|
|
|
The ``x`` port uses a 3D vector type, while the ``edge`` port uses a floating-point scalar type.
|
|
|
|
.. _class_VisualShaderNodeStep_constant_OP_TYPE_VECTOR_4D:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`OpType<enum_VisualShaderNodeStep_OpType>` **OP_TYPE_VECTOR_4D** = ``5``
|
|
|
|
A 4D vector type.
|
|
|
|
.. _class_VisualShaderNodeStep_constant_OP_TYPE_VECTOR_4D_SCALAR:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`OpType<enum_VisualShaderNodeStep_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_VisualShaderNodeStep_constant_OP_TYPE_MAX:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`OpType<enum_VisualShaderNodeStep_OpType>` **OP_TYPE_MAX** = ``7``
|
|
|
|
Represents the size of the :ref:`OpType<enum_VisualShaderNodeStep_OpType>` enum.
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Property Descriptions
|
|
---------------------
|
|
|
|
.. _class_VisualShaderNodeStep_property_op_type:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`OpType<enum_VisualShaderNodeStep_OpType>` **op_type** = ``0`` :ref:`🔗<class_VisualShaderNodeStep_property_op_type>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_op_type**\ (\ value\: :ref:`OpType<enum_VisualShaderNodeStep_OpType>`\ )
|
|
- :ref:`OpType<enum_VisualShaderNodeStep_OpType>` **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.)`
|
|
.. |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.)`
|