Walnut icon indicating copy to clipboard operation
Walnut copied to clipboard

Add Support for custom Key Callbacks in Input class

Open jchionh opened this issue 1 year ago • 3 comments

Existing Input class only checks for IsKeyDown, which checks the key state via glfwGetKey. This doesn't support keyboard's keypress delay and repeat events ASAP.

This PR adds support for custom key press callbacks, so that we can have a callback for every event emitted for a key press, and repeats follows the user's keyboard settings.

Reference for callbacks https://www.glfw.org/docs/3.3/input_guide.html#input_key

Summary by CodeRabbit

  • New Features
    • Introduced functionality for setting up and handling key callbacks, enhancing user interaction with keyboard events.

jchionh avatar Jul 23 '23 09:07 jchionh

@TheCherno Is there anything holding this PR back?

learn-more avatar Dec 14 '23 19:12 learn-more

@coderabbitai review

TheCherno avatar Apr 03 '24 04:04 TheCherno

Walkthrough

The update introduces a new system for handling key events within the Walnut project. It establishes a method to set up key callbacks, allowing specific functions to be assigned to key events. This is achieved through the introduction of a key callback map, initialization and setting mechanisms for key callbacks, enhancing the project's interactivity and responsiveness to user input.

Changes

Files Summary
Walnut/src/Walnut/Input/Input.cpp
Walnut/src/Walnut/Input/Input.h
Introduced s_KeyCallbackMap for storing key callbacks, added functionalities for setting and initializing key callbacks.

🎉 A Celebration of Keys and Callbacks 🎉

In the realm of code, where the walnut trees grow,
A new update has come, with a bright, gleaming glow.
Keys now have a voice, callbacks their song,
Together in harmony, they dance along.
So here's to the changes, may they make our code leap,
As the rabbit watches over, never falling asleep.
🐰💻🌟

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar Apr 03 '24 04:04 coderabbitai[bot]