:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/3.6/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/3.6/doc/classes/InputEventMouseMotion.xml. .. _class_InputEventMouseMotion: InputEventMouseMotion ===================== **Inherits:** :ref:`InputEventMouse` **<** :ref:`InputEventWithModifiers` **<** :ref:`InputEvent` **<** :ref:`Resource` **<** :ref:`Reference` **<** :ref:`Object` Input event type for mouse motion events. .. rst-class:: classref-introduction-group Description ----------- Contains mouse and pen motion information. Supports relative, absolute positions and speed. See :ref:`Node._input`. \ **Note:** The behavior of this event is affected by the value of :ref:`Input.use_accumulated_input`. When set to ``true`` (default), mouse/pen motion events received from the OS will be merged to emit an accumulated event only once per frame rendered at most. When set to ``false``, the events will be emitted as received, which means that they can be emitted multiple times per frame rendered, allowing for precise input reporting at the expense of CPU usage. \ **Note:** If you use InputEventMouseMotion to draw lines, consider implementing `Bresenham's line algorithm `__ as well to avoid visible gaps in lines if the user is moving the mouse quickly. .. rst-class:: classref-introduction-group Tutorials --------- - :doc:`Mouse and input coordinates <../tutorials/inputs/mouse_and_input_coordinates>` - `3D Voxel Demo `__ .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-------------------------------+------------------------------------------------------------------------+---------------------+ | :ref:`bool` | :ref:`pen_inverted` | ``false`` | +-------------------------------+------------------------------------------------------------------------+---------------------+ | :ref:`float` | :ref:`pressure` | ``0.0`` | +-------------------------------+------------------------------------------------------------------------+---------------------+ | :ref:`Vector2` | :ref:`relative` | ``Vector2( 0, 0 )`` | +-------------------------------+------------------------------------------------------------------------+---------------------+ | :ref:`Vector2` | :ref:`speed` | ``Vector2( 0, 0 )`` | +-------------------------------+------------------------------------------------------------------------+---------------------+ | :ref:`Vector2` | :ref:`tilt` | ``Vector2( 0, 0 )`` | +-------------------------------+------------------------------------------------------------------------+---------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_InputEventMouseMotion_property_pen_inverted: .. rst-class:: classref-property :ref:`bool` **pen_inverted** = ``false`` .. rst-class:: classref-property-setget - void **set_pen_inverted** **(** :ref:`bool` value **)** - :ref:`bool` **get_pen_inverted** **(** **)** Returns ``true`` when using the eraser end of a stylus pen. \ **Note:** This property is implemented on Linux, macOS and Windows. .. rst-class:: classref-item-separator ---- .. _class_InputEventMouseMotion_property_pressure: .. rst-class:: classref-property :ref:`float` **pressure** = ``0.0`` .. rst-class:: classref-property-setget - void **set_pressure** **(** :ref:`float` value **)** - :ref:`float` **get_pressure** **(** **)** Represents the pressure the user puts on the pen. Ranges from ``0.0`` to ``1.0``. .. rst-class:: classref-item-separator ---- .. _class_InputEventMouseMotion_property_relative: .. rst-class:: classref-property :ref:`Vector2` **relative** = ``Vector2( 0, 0 )`` .. rst-class:: classref-property-setget - void **set_relative** **(** :ref:`Vector2` value **)** - :ref:`Vector2` **get_relative** **(** **)** The mouse position relative to the previous position (position at the last frame). \ **Note:** Since **InputEventMouseMotion** is only emitted when the mouse moves, the last event won't have a relative position of ``Vector2(0, 0)`` when the user stops moving the mouse. .. rst-class:: classref-item-separator ---- .. _class_InputEventMouseMotion_property_speed: .. rst-class:: classref-property :ref:`Vector2` **speed** = ``Vector2( 0, 0 )`` .. rst-class:: classref-property-setget - void **set_speed** **(** :ref:`Vector2` value **)** - :ref:`Vector2` **get_speed** **(** **)** The mouse speed in pixels per second. .. rst-class:: classref-item-separator ---- .. _class_InputEventMouseMotion_property_tilt: .. rst-class:: classref-property :ref:`Vector2` **tilt** = ``Vector2( 0, 0 )`` .. rst-class:: classref-property-setget - void **set_tilt** **(** :ref:`Vector2` value **)** - :ref:`Vector2` **get_tilt** **(** **)** Represents the angles of tilt of the pen. Positive X-coordinate value indicates a tilt to the right. Positive Y-coordinate value indicates a tilt toward the user. Ranges from ``-1.0`` to ``1.0`` for both axes. .. |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.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`