SDL/include/SDL3
Sam Lantinga 9ff3446f03 Use SDL_bool instead an int return code in the SDL API
Most SDL functions used to indicate success or failure using an int return code. These functions have been changed to return SDL_bool.

Here is a coccinelle patch to change code that previously compared the return value to 0 and changes it to a boolean test:
@ bool_return_type  @
identifier func =~ "^(SDL_AddEventWatch|SDL_AddHintCallback|SDL_AddSurfaceAlternateImage|SDL_AddVulkanRenderSemaphores|SDL_BindAudioStream|SDL_BindAudioStreams|SDL_BlitSurface|SDL_BlitSurface9Grid|SDL_BlitSurfaceScaled|SDL_BlitSurfaceTiled|SDL_BlitSurfaceTiledWithScale|SDL_BlitSurfaceUnchecked|SDL_BlitSurfaceUncheckedScaled|SDL_CaptureMouse|SDL_ClearAudioStream|SDL_ClearClipboardData|SDL_ClearComposition|SDL_ClearError|SDL_ClearProperty|SDL_ClearSurface|SDL_CloseIO|SDL_CloseStorage|SDL_ConvertAudioSamples|SDL_ConvertEventToRenderCoordinates|SDL_ConvertPixels|SDL_ConvertPixelsAndColorspace|SDL_CopyFile|SDL_CopyProperties|SDL_CopyStorageFile|SDL_CreateDirectory|SDL_CreateStorageDirectory|SDL_CreateWindowAndRenderer|SDL_DateTimeToTime|SDL_DestroyWindowSurface|SDL_DetachVirtualJoystick|SDL_DisableScreenSaver|SDL_EnableScreenSaver|SDL_EnumerateDirectory|SDL_EnumerateProperties|SDL_EnumerateStorageDirectory|SDL_FillSurfaceRect|SDL_FillSurfaceRects|SDL_FlashWindow|SDL_FlipSurface|SDL_FlushAudioStream|SDL_FlushRenderer|SDL_GL_DestroyContext|SDL_GL_GetAttribute|SDL_GL_GetSwapInterval|SDL_GL_LoadLibrary|SDL_GL_MakeCurrent|SDL_GL_SetAttribute|SDL_GL_SetSwapInterval|SDL_GL_SwapWindow|SDL_GetAudioDeviceFormat|SDL_GetAudioStreamFormat|SDL_GetCameraFormat|SDL_GetClosestFullscreenDisplayMode|SDL_GetCurrentRenderOutputSize|SDL_GetCurrentTime|SDL_GetDXGIOutputInfo|SDL_GetDateTimeLocalePreferences|SDL_GetDisplayBounds|SDL_GetDisplayUsableBounds|SDL_GetGDKDefaultUser|SDL_GetGDKTaskQueue|SDL_GetGamepadSensorData|SDL_GetGamepadTouchpadFinger|SDL_GetHapticEffectStatus|SDL_GetJoystickBall|SDL_GetMasksForPixelFormat|SDL_GetPathInfo|SDL_GetRectUnion|SDL_GetRectUnionFloat|SDL_GetRenderClipRect|SDL_GetRenderColorScale|SDL_GetRenderDrawBlendMode|SDL_GetRenderDrawColor|SDL_GetRenderDrawColorFloat|SDL_GetRenderLogicalPresentation|SDL_GetRenderLogicalPresentationRect|SDL_GetRenderOutputSize|SDL_GetRenderSafeArea|SDL_GetRenderScale|SDL_GetRenderVSync|SDL_GetRenderViewport|SDL_GetSensorData|SDL_GetStorageFileSize|SDL_GetStoragePathInfo|SDL_GetSurfaceAlphaMod|SDL_GetSurfaceBlendMode|SDL_GetSurfaceClipRect|SDL_GetSurfaceColorKey|SDL_GetSurfaceColorMod|SDL_GetTextInputArea|SDL_GetTextureAlphaMod|SDL_GetTextureAlphaModFloat|SDL_GetTextureBlendMode|SDL_GetTextureColorMod|SDL_GetTextureColorModFloat|SDL_GetTextureScaleMode|SDL_GetTextureSize|SDL_GetWindowAspectRatio|SDL_GetWindowBordersSize|SDL_GetWindowMaximumSize|SDL_GetWindowMinimumSize|SDL_GetWindowPosition|SDL_GetWindowRelativeMouseMode|SDL_GetWindowSafeArea|SDL_GetWindowSize|SDL_GetWindowSizeInPixels|SDL_GetWindowSurfaceVSync|SDL_HideCursor|SDL_HideWindow|SDL_Init|SDL_InitHapticRumble|SDL_InitSubSystem|SDL_LoadWAV|SDL_LoadWAV_IO|SDL_LockAudioStream|SDL_LockProperties|SDL_LockSurface|SDL_LockTexture|SDL_LockTextureToSurface|SDL_MaximizeWindow|SDL_MinimizeWindow|SDL_MixAudio|SDL_OpenURL|SDL_OutOfMemory|SDL_PauseAudioDevice|SDL_PauseAudioStreamDevice|SDL_PauseHaptic|SDL_PlayHapticRumble|SDL_PremultiplyAlpha|SDL_PremultiplySurfaceAlpha|SDL_PushEvent|SDL_PutAudioStreamData|SDL_RaiseWindow|SDL_ReadStorageFile|SDL_ReadSurfacePixel|SDL_ReadSurfacePixelFloat|SDL_RegisterApp|SDL_ReloadGamepadMappings|SDL_RemovePath|SDL_RemoveStoragePath|SDL_RemoveTimer|SDL_RenamePath|SDL_RenameStoragePath|SDL_RenderClear|SDL_RenderCoordinatesFromWindow|SDL_RenderCoordinatesToWindow|SDL_RenderFillRect|SDL_RenderFillRects|SDL_RenderGeometry|SDL_RenderGeometryRaw|SDL_RenderLine|SDL_RenderLines|SDL_RenderPoint|SDL_RenderPoints|SDL_RenderPresent|SDL_RenderRect|SDL_RenderRects|SDL_RenderTexture|SDL_RenderTexture9Grid|SDL_RenderTextureRotated|SDL_RenderTextureTiled|SDL_RequestAndroidPermission|SDL_RestoreWindow|SDL_ResumeAudioDevice|SDL_ResumeAudioStreamDevice|SDL_ResumeHaptic|SDL_RumbleGamepad|SDL_RumbleGamepadTriggers|SDL_RumbleJoystick|SDL_RumbleJoystickTriggers|SDL_RunHapticEffect|SDL_SaveBMP|SDL_SaveBMP_IO|SDL_SendAndroidMessage|SDL_SendGamepadEffect|SDL_SendJoystickEffect|SDL_SendJoystickVirtualSensorData|SDL_SetAppMetadata|SDL_SetAppMetadataProperty|SDL_SetAudioDeviceGain|SDL_SetAudioPostmixCallback|SDL_SetAudioStreamFormat|SDL_SetAudioStreamFrequencyRatio|SDL_SetAudioStreamGain|SDL_SetAudioStreamGetCallback|SDL_SetAudioStreamInputChannelMap|SDL_SetAudioStreamOutputChannelMap|SDL_SetAudioStreamPutCallback|SDL_SetBooleanProperty|SDL_SetClipboardData|SDL_SetClipboardText|SDL_SetCursor|SDL_SetFloatProperty|SDL_SetGamepadLED|SDL_SetGamepadMapping|SDL_SetGamepadPlayerIndex|SDL_SetGamepadSensorEnabled|SDL_SetHapticAutocenter|SDL_SetHapticGain|SDL_SetJoystickLED|SDL_SetJoystickPlayerIndex|SDL_SetJoystickVirtualAxis|SDL_SetJoystickVirtualBall|SDL_SetJoystickVirtualButton|SDL_SetJoystickVirtualHat|SDL_SetJoystickVirtualTouchpad|SDL_SetLinuxThreadPriority|SDL_SetLinuxThreadPriorityAndPolicy|SDL_SetLogPriorityPrefix|SDL_SetMemoryFunctions|SDL_SetNumberProperty|SDL_SetPaletteColors|SDL_SetPointerProperty|SDL_SetPointerPropertyWithCleanup|SDL_SetPrimarySelectionText|SDL_SetRenderClipRect|SDL_SetRenderColorScale|SDL_SetRenderDrawBlendMode|SDL_SetRenderDrawColor|SDL_SetRenderDrawColorFloat|SDL_SetRenderLogicalPresentation|SDL_SetRenderScale|SDL_SetRenderTarget|SDL_SetRenderVSync|SDL_SetRenderViewport|SDL_SetScancodeName|SDL_SetStringProperty|SDL_SetSurfaceAlphaMod|SDL_SetSurfaceBlendMode|SDL_SetSurfaceColorKey|SDL_SetSurfaceColorMod|SDL_SetSurfaceColorspace|SDL_SetSurfacePalette|SDL_SetSurfaceRLE|SDL_SetTLS|SDL_SetTextInputArea|SDL_SetTextureAlphaMod|SDL_SetTextureAlphaModFloat|SDL_SetTextureBlendMode|SDL_SetTextureColorMod|SDL_SetTextureColorModFloat|SDL_SetTextureScaleMode|SDL_SetThreadPriority|SDL_SetWindowAlwaysOnTop|SDL_SetWindowAspectRatio|SDL_SetWindowBordered|SDL_SetWindowFocusable|SDL_SetWindowFullscreen|SDL_SetWindowFullscreenMode|SDL_SetWindowHitTest|SDL_SetWindowIcon|SDL_SetWindowKeyboardGrab|SDL_SetWindowMaximumSize|SDL_SetWindowMinimumSize|SDL_SetWindowModalFor|SDL_SetWindowMouseGrab|SDL_SetWindowMouseRect|SDL_SetWindowOpacity|SDL_SetWindowPosition|SDL_SetWindowRelativeMouseMode|SDL_SetWindowResizable|SDL_SetWindowShape|SDL_SetWindowSize|SDL_SetWindowSurfaceVSync|SDL_SetWindowTitle|SDL_SetiOSAnimationCallback|SDL_ShowAndroidToast|SDL_ShowCursor|SDL_ShowMessageBox|SDL_ShowSimpleMessageBox|SDL_ShowWindow|SDL_ShowWindowSystemMenu|SDL_StartTextInput|SDL_StartTextInputWithProperties|SDL_StopHapticEffect|SDL_StopHapticEffects|SDL_StopHapticRumble|SDL_StopTextInput|SDL_SyncWindow|SDL_TimeToDateTime|SDL_TryLockMutex|SDL_TryLockRWLockForReading|SDL_TryLockRWLockForWriting|SDL_TryWaitSemaphore|SDL_UnlockAudioStream|SDL_UpdateHapticEffect|SDL_UpdateNVTexture|SDL_UpdateTexture|SDL_UpdateWindowSurface|SDL_UpdateWindowSurfaceRects|SDL_UpdateYUVTexture|SDL_Vulkan_CreateSurface|SDL_Vulkan_LoadLibrary|SDL_WaitConditionTimeout|SDL_WaitSemaphoreTimeout|SDL_WarpMouseGlobal|SDL_WriteStorageFile|SDL_WriteSurfacePixel|SDL_WriteSurfacePixelFloat)$";
@@
(
  func(
  ...
  )
- == 0
|
- func(
+ !func(
  ...
  )
- < 0
|
- func(
+ !func(
  ...
  )
- != 0
|
- func(
+ !func(
  ...
  )
- == -1
)
2024-08-27 10:31:46 -07:00
..
SDL.h Moved the SDL version back to SDL_version.h 2024-05-15 14:38:29 -07:00
SDL_assert.h Sync SDL3 wiki -> header 2024-08-19 00:55:27 +00:00
SDL_atomic.h Standardize placement of '*' in function declarations 2024-07-19 12:22:03 -07:00
SDL_audio.h Use SDL_bool instead an int return code in the SDL API 2024-08-27 10:31:46 -07:00
SDL_begin_code.h Finish removing SDL_DECLSPEC_FREE 2024-07-28 08:06:20 -07:00
SDL_bits.h Updated headers with latest wikiheaders tweaks. 2024-06-14 02:09:55 -04:00
SDL_blendmode.h Align SDL_BLENDMODE_INVALID with the other constants 2024-07-15 15:00:09 -07:00
SDL_camera.h Use SDL_bool instead an int return code in the SDL API 2024-08-27 10:31:46 -07:00
SDL_clipboard.h Use SDL_bool instead an int return code in the SDL API 2024-08-27 10:31:46 -07:00
SDL_close_code.h wikiheaders: bridge wiki Category docs to the headers! 2024-05-16 11:48:23 -04:00
SDL_copying.h wikiheaders: bridge wiki Category docs to the headers! 2024-05-16 11:48:23 -04:00
SDL_cpuinfo.h Renamed DECLSPEC to SDL_DECLSPEC 2024-05-17 17:09:09 -07:00
SDL_dialog.h Standardize placement of '*' in function declarations 2024-07-19 12:22:03 -07:00
SDL_egl.h wikiheaders: bridge wiki Category docs to the headers! 2024-05-16 11:48:23 -04:00
SDL_endian.h SDL_endian.h: Fix byte order detection on Solaris (and some SPARC compilers). 2024-06-28 00:14:26 -04:00
SDL_error.h Use SDL_bool instead an int return code in the SDL API 2024-08-27 10:31:46 -07:00
SDL_events.h Use SDL_bool instead an int return code in the SDL API 2024-08-27 10:31:46 -07:00
SDL_filesystem.h Use SDL_bool instead an int return code in the SDL API 2024-08-27 10:31:46 -07:00
SDL_gamepad.h Use SDL_bool instead an int return code in the SDL API 2024-08-27 10:31:46 -07:00
SDL_guid.h Removed temporary memory from the API 2024-07-26 20:59:14 -07:00
SDL_haptic.h Use SDL_bool instead an int return code in the SDL API 2024-08-27 10:31:46 -07:00
SDL_hidapi.h Sync SDL3 wiki -> header 2024-07-19 19:23:24 +00:00
SDL_hints.h Use SDL_bool instead an int return code in the SDL API 2024-08-27 10:31:46 -07:00
SDL_init.h Use SDL_bool instead an int return code in the SDL API 2024-08-27 10:31:46 -07:00
SDL_intrin.h intrinsics: avx, avx2 and avx512f are (currently) unsupported on arm64ec 2024-07-20 00:59:58 +02:00
SDL_iostream.h Use SDL_bool instead an int return code in the SDL API 2024-08-27 10:31:46 -07:00
SDL_joystick.h Use SDL_bool instead an int return code in the SDL API 2024-08-27 10:31:46 -07:00
SDL_keyboard.h Use SDL_bool instead an int return code in the SDL API 2024-08-27 10:31:46 -07:00
SDL_keycode.h Update SDL_keycode.h 2024-07-25 14:12:04 -07:00
SDL_loadso.h Sync SDL3 wiki -> header 2024-07-19 19:23:24 +00:00
SDL_locale.h Removed SDL_DECLSPEC_FREE 2024-07-28 07:24:21 -07:00
SDL_log.h Use SDL_bool instead an int return code in the SDL API 2024-08-27 10:31:46 -07:00
SDL_main.h Use SDL_bool instead an int return code in the SDL API 2024-08-27 10:31:46 -07:00
SDL_main_impl.h Standardize placement of '*' in function declarations 2024-07-19 12:22:03 -07:00
SDL_messagebox.h Use SDL_bool instead an int return code in the SDL API 2024-08-27 10:31:46 -07:00
SDL_metal.h Standardize placement of '*' in function declarations 2024-07-19 12:22:03 -07:00
SDL_misc.h Use SDL_bool instead an int return code in the SDL API 2024-08-27 10:31:46 -07:00
SDL_mouse.h Use SDL_bool instead an int return code in the SDL API 2024-08-27 10:31:46 -07:00
SDL_mutex.h Use SDL_bool instead an int return code in the SDL API 2024-08-27 10:31:46 -07:00
SDL_oldnames.h Renamed SDL_PostSemaphore() to SDL_SignalSemphore() 2024-07-24 13:37:40 -07:00
SDL_opengl.h wikiheaders: bridge wiki Category docs to the headers! 2024-05-16 11:48:23 -04:00
SDL_opengl_glext.h
SDL_opengles.h wikiheaders: bridge wiki Category docs to the headers! 2024-05-16 11:48:23 -04:00
SDL_opengles2.h wikiheaders: bridge wiki Category docs to the headers! 2024-05-16 11:48:23 -04:00
SDL_opengles2_gl2.h
SDL_opengles2_gl2ext.h
SDL_opengles2_gl2platform.h
SDL_opengles2_khrplatform.h
SDL_pen.h pen: Add support for tangential pressure axis. 2024-08-11 18:00:13 -04:00
SDL_pixels.h Use SDL_bool instead an int return code in the SDL API 2024-08-27 10:31:46 -07:00
SDL_platform.h Ensure that all functions that follow the SDL_GetStringRule return temporary memory 2024-07-19 12:22:03 -07:00
SDL_platform_defines.h Fixed compiling SDL_platform_defines.h on macOS with older compilers (thanks @sezero!) 2024-05-27 14:34:21 -07:00
SDL_power.h Renamed DECLSPEC to SDL_DECLSPEC 2024-05-17 17:09:09 -07:00
SDL_properties.h Use SDL_bool instead an int return code in the SDL API 2024-08-27 10:31:46 -07:00
SDL_rect.h Use SDL_bool instead an int return code in the SDL API 2024-08-27 10:31:46 -07:00
SDL_render.h Use SDL_bool instead an int return code in the SDL API 2024-08-27 10:31:46 -07:00
SDL_revision.h wikiheaders: bridge wiki Category docs to the headers! 2024-05-16 11:48:23 -04:00
SDL_scancode.h The keycode in key events is the base, unmodified, keycode for the current keyboard layout 2024-07-01 13:56:49 -07:00
SDL_sensor.h Use SDL_bool instead an int return code in the SDL API 2024-08-27 10:31:46 -07:00
SDL_stdinc.h Use SDL_bool instead an int return code in the SDL API 2024-08-27 10:31:46 -07:00
SDL_storage.h Use SDL_bool instead an int return code in the SDL API 2024-08-27 10:31:46 -07:00
SDL_surface.h Use SDL_bool instead an int return code in the SDL API 2024-08-27 10:31:46 -07:00
SDL_system.h Use SDL_bool instead an int return code in the SDL API 2024-08-27 10:31:46 -07:00
SDL_test.h Replaced test framework random code with SDL random functions 2024-06-24 11:49:15 -07:00
SDL_test_assert.h wikiheaders: bridge wiki Category docs to the headers! 2024-05-16 11:48:23 -04:00
SDL_test_common.h Changed main callback return values to an enumeration 2024-08-16 11:16:05 -07:00
SDL_test_compare.h Add SDLTest_CompareMemory function to compare memory ranges 2024-04-15 03:05:05 -10:00
SDL_test_crc32.h wikiheaders: bridge wiki Category docs to the headers! 2024-05-16 11:48:23 -04:00
SDL_test_font.h Use SDL_bool instead an int return code in the SDL API 2024-08-27 10:31:46 -07:00
SDL_test_fuzzer.h wikiheaders: bridge wiki Category docs to the headers! 2024-05-16 11:48:23 -04:00
SDL_test_harness.h Run test suites and test cases in non-linear order (see libsdl-org#9303) 2024-08-07 10:25:30 +02:00
SDL_test_log.h
SDL_test_md5.h Named typedef-ed structs Gave name to structs that were defined like anonymous struct with name given by typedef. Example 'typedef struct {...} Foo;' -> 'typedef struct Foo {...} Foo;' 2024-03-10 09:04:18 -07:00
SDL_test_memory.h
SDL_thread.h Use SDL_bool instead an int return code in the SDL API 2024-08-27 10:31:46 -07:00
SDL_time.h Use SDL_bool instead an int return code in the SDL API 2024-08-27 10:31:46 -07:00
SDL_timer.h Use SDL_bool instead an int return code in the SDL API 2024-08-27 10:31:46 -07:00
SDL_touch.h Removed SDL_DECLSPEC_FREE 2024-07-28 07:24:21 -07:00
SDL_version.h Ensure that all functions that follow the SDL_GetStringRule return temporary memory 2024-07-19 12:22:03 -07:00
SDL_video.h Use SDL_bool instead an int return code in the SDL API 2024-08-27 10:31:46 -07:00
SDL_vulkan.h Use SDL_bool instead an int return code in the SDL API 2024-08-27 10:31:46 -07:00