Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Fork of
mbed-os
by 
erkin yucel
USBHostMouse Class Reference
A class to communicate a USB mouse. More...
#include <USBHostMouse.h>
Inherits IUSBEnumerator.
Public Member Functions | |
| USBHostMouse () | |
| Constructor. | |
| bool | connect () |
| Try to connect a mouse device. | |
| bool | connected () |
| Check if a mouse is connected. | |
| void | attachEvent (void(*ptr)(uint8_t buttons, int8_t x, int8_t y, int8_t z)) |
| Attach a callback called when a mouse event is received. | |
| void | attachButtonEvent (void(*ptr)(uint8_t buttons)) |
| Attach a callback called when the button state changes. | |
| void | attachXEvent (void(*ptr)(int8_t x)) |
| Attach a callback called when the X axis value changes. | |
| void | attachYEvent (void(*ptr)(int8_t y)) |
| Attach a callback called when the Y axis value changes. | |
| void | attachZEvent (void(*ptr)(int8_t z)) |
| Attach a callback called when the Z axis value changes (scrolling) | |
Detailed Description
A class to communicate a USB mouse.
Definition at line 29 of file USBHostMouse.h.
Constructor & Destructor Documentation
| USBHostMouse | ( | ) |
Constructor.
Definition at line 21 of file USBHostMouse.cpp.
Member Function Documentation
| void attachButtonEvent | ( | void(*)(uint8_t buttons) | ptr ) |
Attach a callback called when the button state changes.
- Parameters:
-
ptr function pointer
Definition at line 67 of file USBHostMouse.h.
| void attachEvent | ( | void(*)(uint8_t buttons, int8_t x, int8_t y, int8_t z) | ptr ) |
Attach a callback called when a mouse event is received.
- Parameters:
-
ptr function pointer
Definition at line 56 of file USBHostMouse.h.
| void attachXEvent | ( | void(*)(int8_t x) | ptr ) |
Attach a callback called when the X axis value changes.
- Parameters:
-
ptr function pointer
Definition at line 78 of file USBHostMouse.h.
| void attachYEvent | ( | void(*)(int8_t y) | ptr ) |
Attach a callback called when the Y axis value changes.
- Parameters:
-
ptr function pointer
Definition at line 89 of file USBHostMouse.h.
| void attachZEvent | ( | void(*)(int8_t z) | ptr ) |
Attach a callback called when the Z axis value changes (scrolling)
- Parameters:
-
ptr function pointer
Definition at line 100 of file USBHostMouse.h.
| bool connect | ( | void | ) |
Try to connect a mouse device.
- Returns:
- true if connection was successful
Definition at line 49 of file USBHostMouse.cpp.
| bool connected | ( | ) |
Check if a mouse is connected.
- Returns:
- true if a mouse is connected
Definition at line 45 of file USBHostMouse.cpp.
Generated on Tue Jul 12 2022 13:17:02 by
1.7.2