Common APIs used by high level application to use this USB class.
See Quick start guide for USB device mouse module (UDI mouse).
Modules | |
| Interface with USB Device Core (UDC) | |
| Structures and functions required by UDC. | |
| Implementation of UDI HID Mouse | |
| Class internal implementation. | |
| USB device descriptors for a single interface | |
| The following structures provide the USB device descriptors required for USB Device with a single interface HID mouse. | |
| USB interface descriptors | |
| The following structures provide predefined USB interface descriptors. | |
Interfaces for mouse events | |
| bool | udi_hid_mouse_moveScroll (int8_t pos) |
| Move the scroll wheel. More... | |
| bool | udi_hid_mouse_moveY (int8_t pos_y) |
| Move the mouse pointer on Y axe. More... | |
| bool | udi_hid_mouse_moveX (int8_t pos_x) |
| Move the mouse pointer on X axe. More... | |
Interfaces for buttons events | |
| bool | udi_hid_mouse_btnmiddle (bool b_state) |
| Changes middle button state. More... | |
| bool | udi_hid_mouse_btnright (bool b_state) |
| Changes right button state. More... | |
| bool | udi_hid_mouse_btnleft (bool b_state) |
| Changes left button state. More... | |
| #define | HID_MOUSE_BTN_DOWN true |
| Value to signal a button down (pressed) More... | |
| #define | HID_MOUSE_BTN_UP false |
| Value to signal a button up (released) More... | |
| #define HID_MOUSE_BTN_DOWN true |
Value to signal a button down (pressed)
Referenced by udi_hid_mouse_btn().
| #define HID_MOUSE_BTN_UP false |
Value to signal a button up (released)
Changes left button state.
| b_state | New button state |
1 if function was successfully done, otherwise 0. References udi_hid_mouse_btn().
Changes middle button state.
| b_state | New button state |
1 if function was successfully done, otherwise 0. References udi_hid_mouse_btn().
Changes right button state.
| b_state | New button state |
1 if function was successfully done, otherwise 0. References udi_hid_mouse_btn().
| bool udi_hid_mouse_moveScroll | ( | int8_t | pos | ) |
Move the scroll wheel.
| pos | Signed value to move |
1 if function was successfully done, otherwise 0. References udi_hid_mouse_move().
| bool udi_hid_mouse_moveX | ( | int8_t | pos_x | ) |
Move the mouse pointer on X axe.
| pos_x | Signed value to move |
1 if function was successfully done, otherwise 0. References udi_hid_mouse_move().
Referenced by ui_device_sof_action().
| bool udi_hid_mouse_moveY | ( | int8_t | pos_y | ) |
Move the mouse pointer on Y axe.
| pos_y | Signed value to move |
1 if function was successfully done, otherwise 0. References udi_hid_mouse_move().
Referenced by ui_device_sof_action().
1.8.5