access_kit_winit Adapter::on_event is confusingly named and undocumented
alice-i-cecile opened this issue · comments
This call seems to propagate winit events into access_kit in order to be handled correctly.
The boolean returned seems to reflect whether or not the event should be filtered and absorbed, per bevyengine/bevy#10239 (comment), but currently always returns true across platforms. This is particularly confusing because the wrapping struct (of the same name)'s method is marked #[must_use]
.
I'm new to accesskit's codebase, but a few requests to ease integration:
- Rename
on_event
to something that clearly indicates that there will be side-effects, likeprocess_winit_event
- Add documentation for these methods.
- Change the returned
bool
to a more meaningful enum, either a Result or a customShouldFilter
enum to better communicate intended use.