BLE_HOGPS_SetMouseButtonInputReport

C

uint16_t BLE_HOGPS_SetMouseButtonInputReport(uint8_t buttons, int8_t wheel, int8_t acPan);

Description

Sets the HID mouse button input report.

Note

This function prepares the input report for mouse button states, wheel movement, and AC pan in the HID profile. It indicates which mouse buttons are pressed, the vertical scroll wheel movement, and the horizontal scroll (AC Pan).

Parameters

ParameterDescription
[in] buttonsA bitmask representing the state of mouse buttons. Each bit corresponds to a button: - Bit 0 to Bit 4: Indicate whether each button is pressed (1) or not (0)
[in] wheelThe vertical scroll amount with a valid range from -127 to 127.
[in] acPanThe horizontal scroll (AC Pan) amount with a valid range from -127 to 127.

Return values

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