BLE_HOGPS_SetBootMouseInputReport

C

uint16_t BLE_HOGPS_SetBootMouseInputReport(uint8_t buttons, int8_t xAxis, int8_t yAxis);

Description

Sets the HID boot mode mouse input report.

Note

This function prepares the input report for a mouse in HID boot mode with the current state of mouse buttons and position.

Parameters

ParameterDescription
[in] buttonsBitmask representing the state of the mouse buttons: - Bit 0: Left button - Bit 1: Right button - Bit 2: Middle button
[in] xAxisThe displacement of the mouse along the X-axis since the last report, in units.
[in] yAxisThe displacement of the mouse along the Y-axis since the last report, in units.

Return values

Return valueDescription
MBA_RES_SUCCESSThe input report was successfully set.
MBA_RES_INVALID_PARAThe parameters provided are invalid.