Port window.c to SDL3

[ankith26]

Continuing the SDL3 porting work, window.c now compiles in SDL3.

[yunline]

In SDL2, SDL_RaiseWindow returns void.
In SDL3, SDL_RaiseWindow returns a bool to indicate if an error occured.
So an error check is needed here.

[yunline]

SDL3 changed the return values of some functions. In SDL2 they return void. In SDL3 they return bool. We need to add error check for them in SDL3.
Here is a list of this kind of function (may be incomplete):

• SDL_RaiseWindow
• SDL_HideWindow
• SDL_ShowWindow
• SDL_RestoreWindow
• SDL_MaximizeWindow
• SDL_MinimizeWindow
• SDL_SetWindowIcon
• SDL_SetWindowMouseGrab
• SDL_SetWindowKeyboardGrab
• SDL_SetWindowTitle
• SDL_SetWindowResizable
• SDL_SetWindowBordered
• SDL_SetWindowAlwaysOnTop
• SDL_SetWindowSize
• SDL_GetWindowSize
• SDL_GetWindowMinimumSize
• SDL_SetWindowMinimumSize
• SDL_GetWindowMaximumSize
• SDL_SetWindowMaximumSize
• SDL_SetWindowPosition
• SDL_GetWindowPosition

[ankith26]

Definitely a good catch here, thanks!

But it has gotten me thinking - raising errors is technically a behaviour change and while I think it is definitely a step in the right direction, I wonder if it's gonna be very disruptive.

[damusss]

But it has gotten me thinking - raising errors is technically a behaviour change and while I think it is definitely a step in the right direction, I wonder if it's gonna be very disruptive.

I'm not sure if it's a good idea to throw out so many errors. I wouldn't exactly want my program to crash just because non-critical functionality X didn't work. (for example, not sure how could changing the title fail, but even if it failed, I wouldn't want my program crashing). Otherwise you'd need to try-except basically every window operation and with that you basically lose the flexibility of OOP. If we do want to do something I think warnings are the best strategy.

[yunline]

But it has gotten me thinking - raising errors is technically a behaviour change and while I think it is definitely a step in the right direction, I wonder if it's gonna be very disruptive.

The errors added in SDL3 are more like "sanity check". If users don't write code in a really weirld way in SDL2 (like setting an invalid surface as the window icon), they won't get an error in SDL3. So I think it's OK to raise those errors.

I'm not sure if it's a good idea to throw out so many errors. I wouldn't exactly want my program to crash just because non-critical functionality X didn't work. (for example, not sure how could changing the title fail, but even if it failed, I wouldn't want my program crashing). Otherwise you'd need to try-except basically every window operation and with that you basically lose the flexibility of OOP. If we do want to do something I think warnings are the best strategy.

If SDL raises an error, it's usually because the user is giving a wrong input to the function. To eliminate the error, what user needs to do is not simply adding a "try" statement to ignore the error. They need to fix where the code is wrong, making the code more robust. So I think there is no need to replace errors with warnings to decrease the use of "try". Users can fix those errors without "try" easily.

[ankith26]

Consider SDL_SetWindowPosition for instance. For now on SDL2 it will silently fail on platforms like wayland, for reasons completely out of the users control. Whereas SDL3 will actively raise an error in this case.

[yunline]

One way to solve this is to add a option for users to turn on or turn off these errors.
Like:

pygame.compat_ignore_sdl3_errors(True)

[damusss]

If SDL raises an error, it's usually because the user is giving a wrong input to the function. To eliminate the error, what user needs to do is not simply adding a "try" statement to ignore the error. They need to fix where the code is wrong, making the code more robust. So I think there is no need to replace errors with warnings to decrease the use of "try". Users can fix those errors without "try" easily.

I get what you mean, but I'm not exactly talking about that. Things that fail for user input are already raising errors. I'm talking about nonsensical errors like ankith mentioned (wayland doesn't allow to change window position). or like I said if your title string has no errors the code should not error just because the os failed to update the title for some reason. a warning is enough. I don't want to try excpet window.title = "test"