Documentation for sdl2::video
#1487
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Provided documentation for most of the `sdl2::video` functions. Mostly did that to resolve some uncertanties in functions purpose (`grab`/`keyboard_grab`/`mouse_grab`, `minimize`). Looked at `SDL_SetWindowData`/`SDL_GetWindowData` ToDo: think that those functions should be removed.
|
This is indirectly related to #1199 issue which could now be closed ( |
jagprog5
reviewed
Jun 22, 2025
There was a problem hiding this comment.
@Cobrand @antonilol Looks good to me but I want a second opinion - please approve only if ok.
@JktuJQ thanks for adding this
|
@JktuJQ minor feedback: looks like you're adding an extra |
Not a problem for me, will fix that |
Cobrand
approved these changes
Jun 22, 2025
|
I think now it could be merged with the main branch |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Provided documentation for most of the
sdl2::videofunctions.Mostly did that to resolve some uncertanties in functions purposes (
grab/keyboard_grab/mouse_grab,minimize).Apparently,
grabonly grabs the mouse.SDL documentation:
when input is grabbed, the mouse is confined to the window. This function will also grab the keyboard if SDL_HINT_GRAB_KEYBOARD is set. To grab the keyboard without also grabbing the mouse, use SDL_SetWindowKeyboardGrab().
Since we can't set SDL_HINT_GRAB_KEYBOARD and by default it is set to 0,
graboperates exactly asmouse_grab(which makes it kinda pointless).minimizedoes not set the minimal size of window's client area (minimum_size), it minimizes the window to its iconic representation (without docs it would be confusing).Looked at
SDL_SetWindowData/SDL_GetWindowDataToDo.Those functions allow to store pointer to an arbitrary data (
userdata) within the window (similar to hashmap) and to access it through the window.I don't think that it is possible to safely implement using those functions - there is simply no way to tell the exact type of value that is returned by
SDL_GetWindowData.If needed, I could remove that ToDo in further commit and maybe implement that as an unsafe API.
Two more ToDos in
*_load_libraryfunctions tell to useOsStr::to_cstring()once it's stable - seems like it would never be stabilizedbecause, for example, Windows uses WTF-8 encoding which is considered a private implementation detail.
Seems like those ToDos might be removed as well.