slouken
commented
1 month ago The new convention of functions returning SDL_TRUE on success and SDL_FALSE on failure causes several logic issues. These are some examples:
SDL_WaitEvent(), SDL_WaitEventTimeout(), SDL_PollEvent(): These functions are now returning SDL_TRUE if there is an event and SDL_FALSE if there is none. SDL_FALSE means failure in other functions. But from my understanding having no event is not a failure. Before this function returned just 1 if there is an event or 0 for no event. That reflected the number of events and was in line with SDL_PeepEvents() which also returns the number of events.
It's not just success or failure, it's positive outcome or negative outcome. In this case, a positive outcome means there is an action that can be taken based on the event.
SDL_WaitSemaphoreTimeout(): This function now returns SDL_TRUE if no timeout occured and SDL_FALSE if it times out. This is very misleading because from the name of the function I would expect SDL_TRUE if the wait for the semaphore timed out. Furthermore from my understanding a timeout of this function is not a failure.
In this case it's the action (wait) that succeeded, not the modifier (timeout).
SDL_CursorVisible(): This function returns SDL_TRUE if the cursor is visible and SDL_FALSE if it is not. With the new convention one could suppose that the function has failed if returning SDL_FALSE. This is misleading.
All functions that return state will return that state, not a success/failure result.
There might be more of these logic issues. But those where the ones I have spotted immediately.
I appreciate that your mental model is different from the new API, but we're not going to change that at this point. Thanks for the feedback!
andreasgrabher
The new convention of functions returning SDL_TRUE on success and SDL_FALSE on failure causes several logic issues. These are some examples:
SDL_WaitEvent(), SDL_WaitEventTimeout(), SDL_PollEvent(): These functions are now returning SDL_TRUE if there is an event and SDL_FALSE if there is none. SDL_FALSE means failure in other functions. But from my understanding having no event is not a failure. Before this function returned just 1 if there is an event or 0 for no event. That reflected the number of events and was in line with SDL_PeepEvents() which also returns the number of events.
SDL_WaitSemaphoreTimeout(): This function now returns SDL_TRUE if no timeout occured and SDL_FALSE if it times out. This is very misleading because from the name of the function I would expect SDL_TRUE if the wait for the semaphore timed out. Furthermore from my understanding a timeout of this function is not a failure.
SDL_CursorVisible(): This function returns SDL_TRUE if the cursor is visible and SDL_FALSE if it is not. With the new convention one could suppose that the function has failed if returning SDL_FALSE. This is misleading.
There might be more of these logic issues. But those where the ones I have spotted immediately.