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

Clarify Key Callback GLFW_REPEAT events in documentation #1596

Open
dougbinks opened this issue Nov 13, 2019 · 0 comments
Open

Clarify Key Callback GLFW_REPEAT events in documentation #1596

dougbinks opened this issue Nov 13, 2019 · 0 comments
Assignees

Comments

@dougbinks
Copy link
Contributor

@dougbinks dougbinks commented Nov 13, 2019

The documentation for glfwSetKeyCallback at https://www.glfw.org/docs/latest/input_guide.html#input_key offers little guidance on what will cause a GLFW_REPEAT action, which can cause confusion such as in the forum post Key Callback Not Registering Every Key Press
.

I think we should consider modifying the documentation, however I do not know enough about the behaviour on all systems.

The following line change might be sufficient:

OLD: The action is one of GLFW_PRESS, GLFW_REPEAT or GLFW_RELEASE.

NEW: The action is one of GLFW_PRESS, GLFW_REPEAT or GLFW_RELEASE. The action GLFW_REPEAT should not be relied upon to indicate which keys are being held down, as it may only be generated by the OS for one key at a time, so developers should store their own state if needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.