doc: unwinding state before stop_emulating is the caller's responsibility

Part-of: <https://gitlab.freedesktop.org/libinput/libei/-/merge_requests/308>
This commit is contained in:
Peter Hutterer 2024-12-06 10:56:07 +10:00
parent cdec01dacd
commit 561cfd009e

View file

@ -1474,6 +1474,10 @@ ei_device_start_emulating(struct ei_device *device, uint32_t sequence);
* Notify the EIS implementation that the given device is no longer sending
* events. See ei_device_start_emulating() for details.
*
* If the device is not logically in a neutral state, that state is left
* as-is. It is the caller's responsibility to release any buttons, keys, touch
* sequences, etc. when stopping emulation to avoid adverse side effects.
*
* This method is only available on an ei sender context.
*/
void