udi_hid_mouse_doc.h File Reference

USB device driver for Human Interface Device (HID) mouse interface.

Copyright (c) 2014-2018 Microchip Technology Inc. and its subsidiaries.

Data Structures
struct	udi_hid_mouse_desc_t
	Interface descriptor structure for HID mouse. More...
struct	udi_hid_mouse_report_desc_t
	Report descriptor for HID mouse. More...

Macros
USB Interface Descriptors
The following structures provide predefined USB interface descriptors. It must be used to define the final USB descriptors.
#define	UDI_HID_MOUSE_STRING_ID   0
	By default no string associated to this interface. More...
#define	UDI_HID_MOUSE_EP_SIZE   8
	HID mouse endpoints size. More...
#define	UDI_HID_MOUSE_DESC
	Content of HID mouse interface descriptor for all speed. More...

Functions
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...

Variables
Interface with USB Device Core (UDC)
Structure required by UDC.
UDC_DESC_STORAGE udi_api_t	udi_api_hid_mouse
	Global structure which contains standard UDI API for UDC. More...

Interfaces for Buttons Events
#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...
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...