processing / processing/processing-website

MouseEvent and KeyEvent references are missing

Open
#631 5 comments 0 reactions 1 assignee View on GitHub

@yashodipmore is already working on this.

Since Jun 16, 2025.

Dominant language
MDX
Stars
90
Forks
122
Avg merge
1h 43m
Merged PRs (30d)
3

Description

Select the type of content error.

Other content error (please specify)

Section

Reference

Location of the error

https://processing.org/reference/mouseWheel_.html

Describe the error

There are no reference sections for MouseEvent and KeyEvent.
All mouse*() key*() methods accept such an object, but most reference pages for these methods have no examples for it (one exception: https://processing.org/reference/mouseWheel_.html).

Suggested correction

Suggestion 1:

  • Add reference pages for these classes.

  • Add a few examples of their use.

Suggestion 2:

  • describe that for all practical end-user scenarios the global variables (like mouseX, mousePressed, key, keyCode, etc.) contain all necessary information; in that case, I would suggest to even remove the methods taking an event from the documentation.

  • mouseWheel() could be exception: the getCount() method is not backed by a global.

Language

EN

Screenshots or references

No response

Additional context

No response

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.