Unit HIDMOUSE

From Ultibo.org
Jump to: navigation, search

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



[Expand]
HID mouse specific constants HID_MOUSE_*


Type definitions



HID mouse device

[Expand]

PHIDMouseDevice = ^THIDMouseDevice;

THIDMouseDevice = record


Public variables


None defined

Function declarations



Initialization functions

[Expand]
procedure HIDMouseInit;
Description: Initialize the HID Mouse unit and HID Mouse driver


HID mouse helper functions

[Expand]
function HIDMouseCheckCollection(Collection:PHIDCollection):LongWord;
Description: Check if a HID collection is suitable for use as a mouse device


[Expand]
function HIDMouseCheckDefinition(Definition:PHIDDefinition):LongWord;
Description: Check if a HID definition is suitable for use as a mouse input report


Return to Unit Reference