Add IsKeyPressedRepeat (desktop only)

[actondev]

Hi Ray!

Currently IsKeyPressed ignores key repeats. This PR keeps the current behavior the same while adding the additional IsKeyPressedRepeat.
Another approach could be changing the existing IsKeyPressed functionality to take into account key repeats as well, and add IsKeyPressedExt, expecting an extra bool repeat flag for taking into account key repeats or not.

Personally I would be in favor of the second approach (changing existing behavior), but it's up for discussion.

[raysan5]

@actondev I understand this functionality returns true for one frame every certain time (i.e. every 10 frames, depending on the framerate), right?

I'm seeing several PRs requiring key-repeat detection functionality. Personally, I never needed it, it just managed it myself using exposed functions. First of all, that functionality does not seem to be available in all supported platforms, only PLATFORM_DESKTOP (correct me if I'm wrong), second, I got many programs depending on keys input and managing key-repeat myself, not sure how those changes could affect my code (or other users codebases in similar situation).

Why is that feature so important? What are the problems of just managing the key-repeats with already provided functionality?

[actondev]

@raysan5 If I understood your question correctly, yes.

Regarding it's usefulness, in keyboard-driven application where on can navigate/perform actions on the GUI, I feel this feature being necessary. Sure one can implement key repeat themselves but a) it's more work, and b) it doesn't respect the system wide setting.
Another issue is if one enables "waiting for events" (so that the main loop isn't rerun without any user input). Is implementing key-repeat yourself also viable in that case?

As I mentioned in the PR description, existing functionality should stay as it is.

Also, if you agree with the general approach here, the same could be used for fixing the "pressed" logic when both the down & up events arrive at the same frame. (see #2827 (comment) ). So similarly as done in this PR, we'd have a keyPressInFrame. I also noted this issue in macbook touchpad: when quickly tapping (for clicking) I rarely get mouse presses, since in the same frame while processing the events, a mousedown and a mouseup.

[actondev]

Btw I find it funny that 2 PRs for this issue got opened back to back. Personally I'm building a custom GUI & was adding some keyboard navigation, so not having key repeat was such a bummer heh

[raysan5]

@actondev thanks for your answer, here my comments:

Another issue is if one enables "waiting for events" (so that the main loop isn't rerun without any user input). Is implementing key-repeat yourself also viable in that case?

Yes, it works because keeping a key down is an event, so loop keeps executing.

As I mentioned in the PR description, existing functionality should stay as it is.

Agree, that's my main concern with all the related PRs/Issues.

I have to review all the other related PRs more carefully but this one seems to me the most feasible option to support this feature.

[rmn20]

It's not a big deal, but maybe IsKeyPressedRepeat could be renamed to IsKeyRepeated for convenience?

[nickyMcDonald]

It's not a big deal, but maybe IsKeyPressedRepeat could be renamed to IsKeyRepeated for convenience?

@actondev, I also think IsKeyPressedRepeat should be renamed. Could you rename it to perhaps IsKeyRepeated or something else in case you can think of something better?

If you do rename it I can close my pr and reopen it to add my additional changes if @raysan5 merges your pr.

Also a side request I have is could you make your IsKey... repeat body consistent with the other IsKey...'s?

bool IsKey...(int key)
{
    if (CORE.Input.Keyboard.keyRepeatInFrame[key] == 1) return true;
    else return false;
}

[raysan5]

@rmn20 @n77y About renaming, I also though about that but actually IsKeyPressedRepeat() is the most accurate naming for the provided functionality. It returns IsKeyPressed() events that are repeated every certain time.

Probably for an advance programmer IsKeyRepeat() is clear enough but for a person that starts on programming it can be confusing.

[nickyMcDonald]

@raysan5, I agree and change my mind. IsKeyPressedRepeat() Is the most accurate even if it’s more verbose.
It looks as if it’s an addition to the IsKeyPressed... functionality:

if (IsKeyPressed(KEY_BACKSPACE) ||
    IsKeyPressedRepeat(KEY_BACKSPACE))

if (IsKeyPressed(KEY_BACKSPACE) || IsKeyPressedRepeat(KEY_BACKSPACE))

if (IsKeyPressed(KEY_BACKSPACE) ||
    IsKeyRepeated(KEY_BACKSPACE))

if (IsKeyPressed(KEY_BACKSPACE) || IsKeyRepeated(KEY_BACKSPACE))

[actondev]

forced pushed formatting changes

[raysan5]

@actondev Thank you very much for this new feature and the required reviews.

@n77y thank you for the review and related improvements.