index :: system

system.cursor

Output cursor motion, mousewheel and button clicks

available since version: 0.1

---

methods:

• polltime sets global cursor polling time
  parameters:
  • T polling time
    type: float
    units: ms
    required: True
    

properties:

• @relative Get/set relative output mode: if on output coords relative to the root window, otherwise output screen coordinates
  type: bool
  default: 0
  

• @norm Get/set cursor x/y coordinates normalization by screen (or window) width/height
  type: bool
  default: 0
  

• @clip Get/set clip mode. If true clip a cursor XY values to the [0..1] range in normalized mode, to the window width/height relative mode, otherwise to the screen width/height
  type: bool
  default: 0
  

inlets:

• output cursor position
  type: control

outlets:

• messages: motion X Y, mousewheel DELTA, button IDX STATE
  type: control

keywords:

cursor mouse mousewheel

Authors: Hans-Christoph Steiner, Serge Poltavsky

License: GPL3 or later