Difference between revisions of "Unit HIDMOUSE"

From Ultibo.org
Jump to: navigation, search
(Created page with "Return to Unit Reference === Description === ---- ''To be documented'' === Constants === ---- ''To be documented'' === Type definitions === ---- ''To...")
 
Line 5: Line 5:
 
----
 
----
  
''To be documented''
+
'''Ultibo HID Mouse Consumer unit'''
 +
 
 +
This is a consumer for any generic HID mouse device, it accepts HID application collections in the generic desktop page (HID_PAGE_GENERIC_DESKTOP) with the usage set to mouse (HID_DESKTOP_MOUSE).
 +
 +
The consumer will bind to any mouse collection that implements at a minimum the X and Y axis and the primary button. However the data reported can include X, Y and wheel as well as up to 5 buttons including left, right and middle.
 +
 +
A mouse can report either absolute or relative positioning, an absolute position for X, Y or wheel will be reported in the buttons field of the mouse data packet using the MOUSE_ABSOLUTE_* flags.
  
 
=== Constants ===
 
=== Constants ===

Revision as of 05:16, 14 October 2022

Return to Unit Reference


Description


Ultibo HID Mouse Consumer unit

This is a consumer for any generic HID mouse device, it accepts HID application collections in the generic desktop page (HID_PAGE_GENERIC_DESKTOP) with the usage set to mouse (HID_DESKTOP_MOUSE).

The consumer will bind to any mouse collection that implements at a minimum the X and Y axis and the primary button. However the data reported can include X, Y and wheel as well as up to 5 buttons including left, right and middle.

A mouse can report either absolute or relative positioning, an absolute position for X, Y or wheel will be reported in the buttons field of the mouse data packet using the MOUSE_ABSOLUTE_* flags.

Constants


To be documented

Type definitions


To be documented

Public variables


None defined

Function declarations


To be documented


Return to Unit Reference