Jump to main content

##

# 3.5.4 Library Interface

This section describes the Application Programming Interface (API) functions of the USB HID Host Mouse Driver Library.

The USB Mouse driver does not require explicit API call by the application to obtain Mouse data. The data in the appropriate format is sent to the application during an application event handler function call.

## Mouse Access Functions

Name | Description
USB_HOST_HID_MOUSE_EventHandlerSet | This function registers application callback function with the mouse driver.
F_USB_HOST_HID_MOUSE_EventHandler | This is function _USB_HOST_HID_MOUSE_EventHandler.
F_USB_HOST_HID_MOUSE_Task | This is function _USB_HOST_HID_MOUSE_Task.

## Data Types and Constants

Name | Description
USB_HOST_HID_MOUSE_DATA | Defines the USB Host HID mouse data object.
USB_HOST_HID_MOUSE_EVENT | Defines the possible USB HOST HID mouse driver events.
USB_HOST_HID_MOUSE_EVENT_HANDLER | USB HOST mouse driver event handler function pointer type.
USB_HOST_HID_MOUSE_HANDLE | USB HOST HID mouse driver instance handle.
USB_HOST_HID_MOUSE_RESULT | USB Host HID mouse driver results.
USB_HOST_HID_MOUSE_RESULT_MIN | USB Host HID mouse driver result minimum constant.
USB_HOST_HID_MOUSE_HANDLE_INVALID | This is macro USB_HOST_HID_MOUSE_HANDLE_INVALID.