Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

access_kit_winit Adapter::on_event is confusingly named and undocumented #300

Closed
alice-i-cecile opened this issue Oct 24, 2023 · 0 comments · Fixed by #307
Closed

access_kit_winit Adapter::on_event is confusingly named and undocumented #300

alice-i-cecile opened this issue Oct 24, 2023 · 0 comments · Fixed by #307
Assignees

Comments

@alice-i-cecile
Copy link

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:

  1. Rename on_event to something that clearly indicates that there will be side-effects, like process_winit_event
  2. Add documentation for these methods.
  3. Change the returned bool to a more meaningful enum, either a Result or a custom ShouldFilter enum to better communicate intended use.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants