diff --git a/include/SDL3/SDL_audio.h b/include/SDL3/SDL_audio.h index f74374105d..8b3e61bbba 100644 --- a/include/SDL3/SDL_audio.h +++ b/include/SDL3/SDL_audio.h @@ -532,8 +532,8 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetAudioDeviceName(SDL_AudioDeviceI * \param spec on return, will be filled with device details. * \param sample_frames pointer to store device buffer size, in sample frames. * Can be NULL. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread. * @@ -659,8 +659,8 @@ extern SDL_DECLSPEC SDL_AudioDeviceID SDLCALL SDL_OpenAudioDevice(SDL_AudioDevic * created through SDL_OpenAudioDevice() can be. * * \param dev a device opened by SDL_OpenAudioDevice(). - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread. * @@ -687,8 +687,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_PauseAudioDevice(SDL_AudioDeviceID dev) * created through SDL_OpenAudioDevice() can be. * * \param dev a device opened by SDL_OpenAudioDevice(). - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread. * @@ -767,8 +767,8 @@ extern SDL_DECLSPEC float SDLCALL SDL_GetAudioDeviceGain(SDL_AudioDeviceID devid * * \param devid the audio device on which to change gain. * \param gain the gain. 1.0f is no change, 0.0f is silence. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread, as it holds * a stream-specific mutex while running. @@ -824,8 +824,8 @@ extern SDL_DECLSPEC void SDLCALL SDL_CloseAudioDevice(SDL_AudioDeviceID devid); * \param devid an audio device to bind a stream to. * \param streams an array of audio streams to bind. * \param num_streams number streams listed in the `streams` array. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread. * @@ -845,8 +845,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_BindAudioStreams(SDL_AudioDeviceID devi * * \param devid an audio device to bind a stream to. * \param stream an audio stream to bind to a device. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread. * @@ -953,8 +953,8 @@ extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetAudioStreamProperties(SDL_Au * \param stream the SDL_AudioStream to query. * \param src_spec where to store the input audio format; ignored if NULL. * \param dst_spec where to store the output audio format; ignored if NULL. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread, as it holds * a stream-specific mutex while running. @@ -983,8 +983,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetAudioStreamFormat(SDL_AudioStream *s * changed. * \param dst_spec the new format of the audio output; if NULL, it is not * changed. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread, as it holds * a stream-specific mutex while running. @@ -1027,8 +1027,8 @@ extern SDL_DECLSPEC float SDLCALL SDL_GetAudioStreamFrequencyRatio(SDL_AudioStre * \param stream the stream the frequency ratio is being changed. * \param ratio the frequency ratio. 1.0 is normal speed. Must be between 0.01 * and 100. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread, as it holds * a stream-specific mutex while running. @@ -1074,8 +1074,8 @@ extern SDL_DECLSPEC float SDLCALL SDL_GetAudioStreamGain(SDL_AudioStream *stream * * \param stream the stream on which the gain is being changed. * \param gain the gain. 1.0f is no change, 0.0f is silence. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread, as it holds * a stream-specific mutex while running. @@ -1171,8 +1171,8 @@ extern SDL_DECLSPEC int * SDLCALL SDL_GetAudioStreamOutputChannelMap(SDL_AudioSt * \param stream the SDL_AudioStream to change. * \param chmap the new channel map, NULL to reset to default. * \param count The number of channels in the map. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread, as it holds * a stream-specific mutex while running. Don't change the @@ -1218,8 +1218,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetAudioStreamInputChannelMap(SDL_Audio * \param stream the SDL_AudioStream to change. * \param chmap the new channel map, NULL to reset to default. * \param count The number of channels in the map. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread, as it holds * a stream-specific mutex while running. Don't change the @@ -1246,8 +1246,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetAudioStreamOutputChannelMap(SDL_Audi * \param stream the stream the audio data is being added to. * \param buf a pointer to the audio data to add. * \param len the number of bytes to write to the stream. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread, but if the * stream has a callback set, the caller might need to manage @@ -1277,8 +1277,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_PutAudioStreamData(SDL_AudioStream *str * \param stream the stream the audio is being requested from. * \param buf a buffer to fill with audio data. * \param len the maximum number of bytes to fill. - * \returns the number of bytes read from the stream or -1 - * on failure; call SDL_GetError() for more information. + * \returns the number of bytes read from the stream or -1 on failure; call + * SDL_GetError() for more information. * * \threadsafety It is safe to call this function from any thread, but if the * stream has a callback set, the caller might need to manage @@ -1306,7 +1306,8 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetAudioStreamData(SDL_AudioStream *stream, * clamped. * * \param stream the audio stream to query. - * \returns the number of converted/resampled bytes available or -1 on failure; call SDL_GetError() for more information. + * \returns the number of converted/resampled bytes available or -1 on + * failure; call SDL_GetError() for more information. * * \threadsafety It is safe to call this function from any thread. * @@ -1338,8 +1339,8 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetAudioStreamAvailable(SDL_AudioStream *str * clamped. * * \param stream the audio stream to query. - * \returns the number of bytes queued or -1 on failure; - * call SDL_GetError() for more information. + * \returns the number of bytes queued or -1 on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread. * @@ -1360,8 +1361,8 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetAudioStreamQueued(SDL_AudioStream *stream * input, so the complete output becomes available. * * \param stream the audio stream to flush. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread. * @@ -1378,8 +1379,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_FlushAudioStream(SDL_AudioStream *strea * stream until more is added. * * \param stream the audio stream to clear. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread. * @@ -1405,8 +1406,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_ClearAudioStream(SDL_AudioStream *strea * loading, etc. * * \param stream the audio stream associated with the audio device to pause. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread. * @@ -1425,8 +1426,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_PauseAudioStreamDevice(SDL_AudioStream * to progress again, and audio can be generated. * * \param stream the audio stream associated with the audio device to resume. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread. * @@ -1453,8 +1454,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_ResumeAudioStreamDevice(SDL_AudioStream * all the same attributes (recursive locks are allowed, etc). * * \param stream the audio stream to lock. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread. * @@ -1471,8 +1472,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_LockAudioStream(SDL_AudioStream *stream * This unlocks an audio stream after a call to SDL_LockAudioStream. * * \param stream the audio stream to unlock. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety You should only call this from the same thread that * previously called SDL_LockAudioStream. @@ -1560,9 +1561,8 @@ typedef void (SDLCALL *SDL_AudioStreamCallback)(void *userdata, SDL_AudioStream * stream. * \param userdata an opaque pointer provided to the callback for its own * personal use. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. This only fails if `stream` - * is NULL. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. This only fails if `stream` is NULL. * * \threadsafety It is safe to call this function from any thread. * @@ -1610,9 +1610,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetAudioStreamGetCallback(SDL_AudioStre * stream. * \param userdata an opaque pointer provided to the callback for its own * personal use. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. This only fails if `stream` - * is NULL. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. This only fails if `stream` is NULL. * * \threadsafety It is safe to call this function from any thread. * @@ -1789,8 +1788,8 @@ typedef void (SDLCALL *SDL_AudioPostmixCallback)(void *userdata, const SDL_Audio * \param devid the ID of an opened audio device. * \param callback a callback function to be called. Can be NULL. * \param userdata app-controlled pointer passed to callback. Can be NULL. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread. * @@ -1859,13 +1858,13 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetAudioPostmixCallback(SDL_AudioDevice * function. * \param audio_len a pointer filled with the length of the audio data buffer * in bytes. - * \returns SDL_TRUE on success. `audio_buf` will be filled with a pointer to an - * allocated buffer containing the audio data, and `audio_len` is + * \returns SDL_TRUE on success. `audio_buf` will be filled with a pointer to + * an allocated buffer containing the audio data, and `audio_len` is * filled with the length of that audio buffer in bytes. * - * This function returns SDL_FALSE if the .WAV file cannot be opened, uses - * an unknown data format, or is corrupt; call SDL_GetError() for - * more information. + * This function returns SDL_FALSE if the .WAV file cannot be opened, + * uses an unknown data format, or is corrupt; call SDL_GetError() + * for more information. * * When the application is done with the data returned in * `audio_buf`, it should call SDL_free() to dispose of it. @@ -1895,13 +1894,13 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_LoadWAV_IO(SDL_IOStream *src, SDL_bool * function. * \param audio_len a pointer filled with the length of the audio data buffer * in bytes. - * \returns SDL_TRUE on success. `audio_buf` will be filled with a pointer to an - * allocated buffer containing the audio data, and `audio_len` is + * \returns SDL_TRUE on success. `audio_buf` will be filled with a pointer to + * an allocated buffer containing the audio data, and `audio_len` is * filled with the length of that audio buffer in bytes. * - * This function returns SDL_FALSE if the .WAV file cannot be opened, uses - * an unknown data format, or is corrupt; call SDL_GetError() for - * more information. + * This function returns SDL_FALSE if the .WAV file cannot be opened, + * uses an unknown data format, or is corrupt; call SDL_GetError() + * for more information. * * When the application is done with the data returned in * `audio_buf`, it should call SDL_free() to dispose of it. @@ -1942,8 +1941,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_LoadWAV(const char *path, SDL_AudioSpec * \param len the length of the audio buffer in bytes. * \param volume ranges from 0.0 - 1.0, and should be set to 1.0 for full * audio volume. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread. * @@ -1972,8 +1971,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_MixAudio(Uint8 *dst, const Uint8 *src, * which should be freed with SDL_free(). On error, it will be * NULL. * \param dst_len will be filled with the len of dst_data. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread. * diff --git a/include/SDL3/SDL_camera.h b/include/SDL3/SDL_camera.h index 7282e7f82d..3d4c57e9b8 100644 --- a/include/SDL3/SDL_camera.h +++ b/include/SDL3/SDL_camera.h @@ -366,15 +366,15 @@ extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetCameraProperties(SDL_Camera * be converting to this format behind the scenes. * * If the system is waiting for the user to approve access to the camera, as - * some platforms require, this will return SDL_FALSE, but this isn't necessarily a - * fatal error; you should either wait for an SDL_EVENT_CAMERA_DEVICE_APPROVED - * (or SDL_EVENT_CAMERA_DEVICE_DENIED) event, or poll SDL_IsCameraApproved() - * occasionally until it returns non-zero. + * some platforms require, this will return SDL_FALSE, but this isn't + * necessarily a fatal error; you should either wait for an + * SDL_EVENT_CAMERA_DEVICE_APPROVED (or SDL_EVENT_CAMERA_DEVICE_DENIED) event, + * or poll SDL_IsCameraApproved() occasionally until it returns non-zero. * * \param camera opened camera device. * \param spec the SDL_CameraSpec to be initialized by this function. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread. * diff --git a/include/SDL3/SDL_clipboard.h b/include/SDL3/SDL_clipboard.h index 0e5230e677..4d4ae3220b 100644 --- a/include/SDL3/SDL_clipboard.h +++ b/include/SDL3/SDL_clipboard.h @@ -46,8 +46,8 @@ extern "C" { * Put UTF-8 text into the clipboard. * * \param text the text to store in the clipboard. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -89,8 +89,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_HasClipboardText(void); * Put UTF-8 text into the primary selection. * * \param text the text to store in the primary selection. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -185,8 +185,8 @@ typedef void (SDLCALL *SDL_ClipboardCleanupCallback)(void *userdata); * \param userdata an opaque pointer that will be forwarded to the callbacks. * \param mime_types a list of mime-types that are being offered. * \param num_mime_types the number of mime-types in the mime_types list. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -199,8 +199,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetClipboardData(SDL_ClipboardDataCallb /** * Clear the clipboard data. * - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * diff --git a/include/SDL3/SDL_events.h b/include/SDL3/SDL_events.h index 6d845fb83f..1d94fc7d32 100644 --- a/include/SDL3/SDL_events.h +++ b/include/SDL3/SDL_events.h @@ -1039,8 +1039,8 @@ typedef enum SDL_EventAction * SDL_EVENT_FIRST is a safe choice. * \param maxType maximum value of the event type to be considered; * SDL_EVENT_LAST is a safe choice. - * \returns the number of events actually stored or -1 on - * failure; call SDL_GetError() for more information. + * \returns the number of events actually stored or -1 on failure; call + * SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. * @@ -1254,8 +1254,9 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_WaitEventTimeout(SDL_Event *event, Sint * its own custom event types. * * \param event the SDL_Event to be added to the queue. - * \returns SDL_TRUE on success, SDL_FALSE if the event was filtered or on failure; call SDL_GetError() for more information. A - * common reason for error is the event queue being full. + * \returns SDL_TRUE on success, SDL_FALSE if the event was filtered or on + * failure; call SDL_GetError() for more information. A common reason + * for error is the event queue being full. * * \since This function is available since SDL 3.0.0. * @@ -1371,8 +1372,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetEventFilter(SDL_EventFilter *filter, * * \param filter an SDL_EventFilter function to call when an event happens. * \param userdata a pointer that is passed to `filter`. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread. * diff --git a/include/SDL3/SDL_filesystem.h b/include/SDL3/SDL_filesystem.h index abf9875bb3..5faa244b89 100644 --- a/include/SDL3/SDL_filesystem.h +++ b/include/SDL3/SDL_filesystem.h @@ -266,8 +266,8 @@ typedef Uint32 SDL_GlobFlags; * Create a directory. * * \param path the path of the directory to create. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -289,8 +289,8 @@ typedef int (SDLCALL *SDL_EnumerateDirectoryCallback)(void *userdata, const char * \param path the path of the directory to enumerate. * \param callback a function that is called for each entry in the directory. * \param userdata a pointer that is passed to `callback`. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -300,8 +300,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_EnumerateDirectory(const char *path, SD * Remove a file or an empty directory. * * \param path the path of the directory to enumerate. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -312,8 +312,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_RemovePath(const char *path); * * \param oldpath the old path. * \param newpath the new path. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -324,8 +324,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_RenamePath(const char *oldpath, const c * * \param oldpath the old path. * \param newpath the new path. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -337,8 +337,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_CopyFile(const char *oldpath, const cha * \param path the path to query. * \param info a pointer filled in with information about the path, or NULL to * check for the existence of a file. - * \returns SDL_TRUE on success or SDL_FALSE if the file doesn't exist, - * or another failure; call SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE if the file doesn't exist, or + * another failure; call SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. */ diff --git a/include/SDL3/SDL_gamepad.h b/include/SDL3/SDL_gamepad.h index 22e315fbe9..3d2d726d77 100644 --- a/include/SDL3/SDL_gamepad.h +++ b/include/SDL3/SDL_gamepad.h @@ -379,8 +379,8 @@ extern SDL_DECLSPEC int SDLCALL SDL_AddGamepadMappingsFromFile(const char *file) * * This will generate gamepad events as needed if device mappings change. * - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -442,8 +442,8 @@ extern SDL_DECLSPEC char * SDLCALL SDL_GetGamepadMapping(SDL_Gamepad *gamepad); * \param instance_id the joystick instance ID. * \param mapping the mapping to use for this device, or NULL to clear the * mapping. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -813,8 +813,8 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetGamepadPlayerIndex(SDL_Gamepad *gamepad); * \param gamepad the gamepad object to adjust. * \param player_index player index to assign to this gamepad, or -1 to clear * the player index and turn off player LEDs. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1257,8 +1257,8 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetNumGamepadTouchpadFingers(SDL_Gamepad *ga * \param y filled with y position, normalized 0 to 1, with the origin in the * upper left. * \param pressure filled with pressure value. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1287,8 +1287,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GamepadHasSensor(SDL_Gamepad *gamepad, * \param gamepad the gamepad to update. * \param type the type of sensor to enable/disable. * \param enabled whether data reporting should be enabled. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1331,8 +1331,8 @@ extern SDL_DECLSPEC float SDLCALL SDL_GetGamepadSensorDataRate(SDL_Gamepad *game * \param type the type of sensor to query. * \param data a pointer filled with the current sensor state. * \param num_values the number of values to write to data. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -1353,8 +1353,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetGamepadSensorData(SDL_Gamepad *gamep * \param high_frequency_rumble the intensity of the high frequency (right) * rumble motor, from 0 to 0xFFFF. * \param duration_ms the duration of the rumble effect, in milliseconds. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -1379,8 +1379,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_RumbleGamepad(SDL_Gamepad *gamepad, Uin * \param right_rumble the intensity of the right trigger rumble motor, from 0 * to 0xFFFF. * \param duration_ms the duration of the rumble effect, in milliseconds. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1401,8 +1401,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_RumbleGamepadTriggers(SDL_Gamepad *game * \param red the intensity of the red LED. * \param green the intensity of the green LED. * \param blue the intensity of the blue LED. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -1414,8 +1414,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetGamepadLED(SDL_Gamepad *gamepad, Uin * \param gamepad the gamepad to affect. * \param data the data to send to the gamepad. * \param size the size of the data to send to the gamepad. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ diff --git a/include/SDL3/SDL_haptic.h b/include/SDL3/SDL_haptic.h index 04f72fb703..95446fe2b7 100644 --- a/include/SDL3/SDL_haptic.h +++ b/include/SDL3/SDL_haptic.h @@ -1116,8 +1116,7 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetMaxHapticEffects(SDL_Haptic *haptic); * * \param haptic the SDL_Haptic device to query maximum playing effects. * \returns the number of effects the haptic device can play at the same time - * or -1 on failure; call SDL_GetError() for more - * information. + * or -1 on failure; call SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. * @@ -1147,8 +1146,8 @@ extern SDL_DECLSPEC Uint32 SDLCALL SDL_GetHapticFeatures(SDL_Haptic *haptic); * SDL_HapticDirection effect. * * \param haptic the SDL_Haptic device to query. - * \returns the number of axes on success or -1 on failure; - * call SDL_GetError() for more information. + * \returns the number of axes on success or -1 on failure; call + * SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. */ @@ -1174,8 +1173,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_HapticEffectSupported(SDL_Haptic *hapti * \param haptic an SDL_Haptic device to create the effect on. * \param effect an SDL_HapticEffect structure containing the properties of * the effect to create. - * \returns the ID of the effect on success or -1 on - * failure; call SDL_GetError() for more information. + * \returns the ID of the effect on success or -1 on failure; call + * SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. * @@ -1197,8 +1196,8 @@ extern SDL_DECLSPEC int SDLCALL SDL_CreateHapticEffect(SDL_Haptic *haptic, const * \param effect the identifier of the effect to update. * \param data an SDL_HapticEffect structure containing the new effect * properties to use. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1220,8 +1219,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_UpdateHapticEffect(SDL_Haptic *haptic, * \param effect the ID of the haptic effect to run. * \param iterations the number of iterations to run the effect; use * `SDL_HAPTIC_INFINITY` to repeat forever. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1236,8 +1235,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_RunHapticEffect(SDL_Haptic *haptic, int * * \param haptic the SDL_Haptic device to stop the effect on. * \param effect the ID of the haptic effect to stop. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1268,7 +1267,8 @@ extern SDL_DECLSPEC void SDLCALL SDL_DestroyHapticEffect(SDL_Haptic *haptic, int * * \param haptic the SDL_Haptic device to query for the effect status on. * \param effect the ID of the haptic effect to query its status. - * \returns SDL_TRUE if it is playing, SDL_FALSE if it isn't playing or haptic status isn't supported. + * \returns SDL_TRUE if it is playing, SDL_FALSE if it isn't playing or haptic + * status isn't supported. * * \since This function is available since SDL 3.0.0. * @@ -1289,8 +1289,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetHapticEffectStatus(SDL_Haptic *hapti * \param haptic the SDL_Haptic device to set the gain on. * \param gain value to set the gain to, should be between 0 and 100 (0 - * 100). - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1308,8 +1308,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetHapticGain(SDL_Haptic *haptic, int g * * \param haptic the SDL_Haptic device to set autocentering on. * \param autocenter value to set autocenter to (0-100). - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1327,8 +1327,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetHapticAutocenter(SDL_Haptic *haptic, * can cause all sorts of weird errors. * * \param haptic the SDL_Haptic device to pause. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1342,8 +1342,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_PauseHaptic(SDL_Haptic *haptic); * Call to unpause after SDL_PauseHaptic(). * * \param haptic the SDL_Haptic device to unpause. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1355,8 +1355,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_ResumeHaptic(SDL_Haptic *haptic); * Stop all the currently playing effects on a haptic device. * * \param haptic the SDL_Haptic device to stop. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1381,8 +1381,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_HapticRumbleSupported(SDL_Haptic *hapti * Initialize a haptic device for simple rumble playback. * * \param haptic the haptic device to initialize for simple rumble playback. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1398,8 +1398,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_InitHapticRumble(SDL_Haptic *haptic); * \param haptic the haptic device to play the rumble effect on. * \param strength strength of the rumble to play as a 0-1 float value. * \param length length of the rumble to play in milliseconds. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1412,8 +1412,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_PlayHapticRumble(SDL_Haptic *haptic, fl * Stop the simple rumble on a haptic device. * * \param haptic the haptic device to stop the rumble effect on. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * diff --git a/include/SDL3/SDL_hints.h b/include/SDL3/SDL_hints.h index 6bb28c7795..69f73b32a8 100644 --- a/include/SDL3/SDL_hints.h +++ b/include/SDL3/SDL_hints.h @@ -4168,8 +4168,8 @@ typedef enum SDL_HintPriority * \param name the hint to set. * \param value the value of the hint variable. * \param priority the SDL_HintPriority level for the hint. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread. * @@ -4190,8 +4190,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetHintWithPriority(const char *name, c * * \param name the hint to set. * \param value the value of the hint variable. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread. * @@ -4211,8 +4211,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetHint(const char *name, const char *v * change. * * \param name the hint to set. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread. * @@ -4306,8 +4306,8 @@ typedef void (SDLCALL *SDL_HintCallback)(void *userdata, const char *name, const * \param callback An SDL_HintCallback function that will be called when the * hint value changes. * \param userdata a pointer to pass to the callback function. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread. * diff --git a/include/SDL3/SDL_init.h b/include/SDL3/SDL_init.h index 973b5ed2fe..503bdb302c 100644 --- a/include/SDL3/SDL_init.h +++ b/include/SDL3/SDL_init.h @@ -143,8 +143,8 @@ typedef void (SDLCALL *SDL_AppQuit_func)(void *appstate); * SDL_SetAppMetadataProperty(). * * \param flags subsystem initialization flags. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -163,8 +163,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_Init(SDL_InitFlags flags); * This function and SDL_Init() are interchangeable. * * \param flags any of the flags used by SDL_Init(); see SDL_Init for details. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -248,8 +248,8 @@ extern SDL_DECLSPEC void SDLCALL SDL_Quit(void); * hash, or whatever makes sense). * \param appidentifier A unique string in reverse-domain format that * identifies this app ("com.example.mygame2"). - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread. * @@ -310,8 +310,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetAppMetadata(const char *appname, con * * \param name the name of the metadata property to set. * \param value the value of the property, or NULL to remove that property. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread. * diff --git a/include/SDL3/SDL_iostream.h b/include/SDL3/SDL_iostream.h index 88ffa703a6..a306debb3f 100644 --- a/include/SDL3/SDL_iostream.h +++ b/include/SDL3/SDL_iostream.h @@ -372,15 +372,15 @@ extern SDL_DECLSPEC SDL_IOStream * SDLCALL SDL_OpenIO(const SDL_IOStreamInterfac * * SDL_CloseIO() closes and cleans up the SDL_IOStream stream. It releases any * resources used by the stream and frees the SDL_IOStream itself. This - * returns SDL_TRUE on success, or SDL_FALSE if the stream failed to flush to its output - * (e.g. to disk). + * returns SDL_TRUE on success, or SDL_FALSE if the stream failed to flush to + * its output (e.g. to disk). * * Note that if this fails to flush the stream to disk, this function reports * an error, but the SDL_IOStream is still invalid once this function returns. * * \param context SDL_IOStream structure to close. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * diff --git a/include/SDL3/SDL_joystick.h b/include/SDL3/SDL_joystick.h index 2e39b509c9..43bc1e98f7 100644 --- a/include/SDL3/SDL_joystick.h +++ b/include/SDL3/SDL_joystick.h @@ -472,8 +472,8 @@ extern SDL_DECLSPEC SDL_JoystickID SDLCALL SDL_AttachVirtualJoystick(const SDL_V * * \param instance_id the joystick instance ID, previously returned from * SDL_AttachVirtualJoystick(). - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -507,8 +507,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_IsJoystickVirtual(SDL_JoystickID instan * \param joystick the virtual joystick on which to set state. * \param axis the index of the axis on the virtual joystick to update. * \param value the new value for the specified axis. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -527,8 +527,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetJoystickVirtualAxis(SDL_Joystick *jo * \param ball the index of the ball on the virtual joystick to update. * \param xrel the relative motion on the X axis. * \param yrel the relative motion on the Y axis. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -546,8 +546,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetJoystickVirtualBall(SDL_Joystick *jo * \param joystick the virtual joystick on which to set state. * \param button the index of the button on the virtual joystick to update. * \param value the new value for the specified button. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -565,8 +565,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetJoystickVirtualButton(SDL_Joystick * * \param joystick the virtual joystick on which to set state. * \param hat the index of the hat on the virtual joystick to update. * \param value the new value for the specified hat. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -592,8 +592,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetJoystickVirtualHat(SDL_Joystick *joy * \param y the y coordinate of the finger on the touchpad, normalized 0 to 1, * with the origin in the upper left. * \param pressure the pressure of the finger. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -614,8 +614,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetJoystickVirtualTouchpad(SDL_Joystick * the sensor reading. * \param data the data associated with the sensor reading. * \param num_values the number of values pointed to by `data`. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -698,8 +698,8 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetJoystickPlayerIndex(SDL_Joystick *joystic * \param joystick the SDL_Joystick obtained from SDL_OpenJoystick(). * \param player_index player index to assign to this joystick, or -1 to clear * the player index and turn off player LEDs. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -853,9 +853,8 @@ extern SDL_DECLSPEC SDL_JoystickID SDLCALL SDL_GetJoystickID(SDL_Joystick *joyst * device and platform. * * \param joystick an SDL_Joystick structure containing joystick information. - * \returns the number of axis controls/number of axes on success or -1 - * on failure; call SDL_GetError() for more - * information. + * \returns the number of axis controls/number of axes on success or -1 on + * failure; call SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. * @@ -875,8 +874,8 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetNumJoystickAxes(SDL_Joystick *joystick); * Most joysticks do not have trackballs. * * \param joystick an SDL_Joystick structure containing joystick information. - * \returns the number of trackballs on success or -1 on - * failure; call SDL_GetError() for more information. + * \returns the number of trackballs on success or -1 on failure; call + * SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. * @@ -891,8 +890,8 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetNumJoystickBalls(SDL_Joystick *joystick); * Get the number of POV hats on a joystick. * * \param joystick an SDL_Joystick structure containing joystick information. - * \returns the number of POV hats on success or -1 on - * failure; call SDL_GetError() for more information. + * \returns the number of POV hats on success or -1 on failure; call + * SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. * @@ -907,8 +906,8 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetNumJoystickHats(SDL_Joystick *joystick); * Get the number of buttons on a joystick. * * \param joystick an SDL_Joystick structure containing joystick information. - * \returns the number of buttons on success or -1 on - * failure; call SDL_GetError() for more information. + * \returns the number of buttons on success or -1 on failure; call + * SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. * @@ -1013,8 +1012,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetJoystickAxisInitialState(SDL_Joystic * \param ball the ball index to query; ball indices start at index 0. * \param dx stores the difference in the x axis position since the last poll. * \param dy stores the difference in the y axis position since the last poll. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1102,8 +1101,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_RumbleJoystick(SDL_Joystick *joystick, * \param right_rumble the intensity of the right trigger rumble motor, from 0 * to 0xFFFF. * \param duration_ms the duration of the rumble effect, in milliseconds. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1124,8 +1123,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_RumbleJoystickTriggers(SDL_Joystick *jo * \param red the intensity of the red LED. * \param green the intensity of the green LED. * \param blue the intensity of the blue LED. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -1137,8 +1136,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetJoystickLED(SDL_Joystick *joystick, * \param joystick the joystick to affect. * \param data the data to send to the joystick. * \param size the size of the data to send to the joystick. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ diff --git a/include/SDL3/SDL_keyboard.h b/include/SDL3/SDL_keyboard.h index daa925971f..ec6c3f23be 100644 --- a/include/SDL3/SDL_keyboard.h +++ b/include/SDL3/SDL_keyboard.h @@ -231,8 +231,8 @@ extern SDL_DECLSPEC SDL_Scancode SDLCALL SDL_GetScancodeFromKey(SDL_Keycode key, * \param name the name to use for the scancode, encoded as UTF-8. The string * is not copied, so the pointer given to this function must stay * valid while SDL is being used. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -322,8 +322,8 @@ extern SDL_DECLSPEC SDL_Keycode SDLCALL SDL_GetKeyFromName(const char *name); * On some platforms using this function shows the screen keyboard. * * \param window the window to enable text input. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -414,8 +414,8 @@ typedef enum SDL_Capitalization * * \param window the window to enable text input. * \param props the properties to use. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -451,8 +451,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_TextInputActive(SDL_Window *window); * it. * * \param window the window to disable text input. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -464,8 +464,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_StopTextInput(SDL_Window *window); * Dismiss the composition window/IME without disabling the subsystem. * * \param window the window to affect. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -485,8 +485,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_ClearComposition(SDL_Window *window); * coordinates, or NULL to clear it. * \param cursor the offset of the current cursor location relative to * `rect->x`, in window coordinates. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -505,8 +505,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetTextInputArea(SDL_Window *window, co * may be NULL. * \param cursor a pointer to the offset of the current cursor location * relative to `rect->x`, may be NULL. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * diff --git a/include/SDL3/SDL_log.h b/include/SDL3/SDL_log.h index 1ee8b3a002..3c0e80f38c 100644 --- a/include/SDL3/SDL_log.h +++ b/include/SDL3/SDL_log.h @@ -191,8 +191,8 @@ extern SDL_DECLSPEC void SDLCALL SDL_ResetLogPriorities(void); * \param priority the SDL_LogPriority to modify. * \param prefix the prefix to use for that log priority, or NULL to use no * prefix. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * diff --git a/include/SDL3/SDL_main.h b/include/SDL3/SDL_main.h index 7c21885516..de3c18771d 100644 --- a/include/SDL3/SDL_main.h +++ b/include/SDL3/SDL_main.h @@ -478,8 +478,9 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetMainReady(void); * literally have to be `main`. * \param reserved should be NULL (reserved for future use, will probably be * platform-specific then). - * \returns the return value from mainFunction: 0 on success, otherwise failure; - * SDL_GetError() might have more information on the failure. + * \returns the return value from mainFunction: 0 on success, otherwise + * failure; SDL_GetError() might have more information on the + * failure. * * \threadsafety Generally this is called once, near startup, from the * process's initial thread. @@ -537,8 +538,8 @@ extern SDL_DECLSPEC int SDLCALL SDL_EnterAppMainCallbacks(int argc, char *argv[] * what is specified here. * \param hInst the HINSTANCE to use in WNDCLASSEX::hInstance. If zero, SDL * will use `GetModuleHandle(NULL)` instead. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ diff --git a/include/SDL3/SDL_messagebox.h b/include/SDL3/SDL_messagebox.h index 4aba3d470d..c626b22835 100644 --- a/include/SDL3/SDL_messagebox.h +++ b/include/SDL3/SDL_messagebox.h @@ -154,8 +154,8 @@ typedef struct SDL_MessageBoxData * other options. * \param buttonid the pointer to which user id of hit button should be * copied. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -196,8 +196,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_ShowMessageBox(const SDL_MessageBoxData * \param title uTF-8 title text. * \param message uTF-8 message text. * \param window the parent window, or NULL for no parent. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * diff --git a/include/SDL3/SDL_misc.h b/include/SDL3/SDL_misc.h index a7e202cbfa..23317e0147 100644 --- a/include/SDL3/SDL_misc.h +++ b/include/SDL3/SDL_misc.h @@ -62,8 +62,8 @@ extern "C" { * * \param url a valid URL/URI to open. Use `file:///full/path/to/file` for * local files, if supported. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ diff --git a/include/SDL3/SDL_mouse.h b/include/SDL3/SDL_mouse.h index 368df14fea..90c856009c 100644 --- a/include/SDL3/SDL_mouse.h +++ b/include/SDL3/SDL_mouse.h @@ -295,8 +295,8 @@ extern SDL_DECLSPEC void SDLCALL SDL_WarpMouseInWindow(SDL_Window * window, * * \param x the x coordinate. * \param y the y coordinate. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -316,8 +316,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_WarpMouseGlobal(float x, float y); * * \param window the window to change. * \param enabled SDL_TRUE to enable relative mode, SDL_FALSE to disable. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -375,8 +375,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetWindowRelativeMouseMode(SDL_Window * * `SDL_HINT_MOUSE_AUTO_CAPTURE` hint to zero. * * \param enabled SDL_TRUE to enable capturing, SDL_FALSE to disable. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -483,8 +483,8 @@ extern SDL_DECLSPEC SDL_Cursor * SDLCALL SDL_CreateSystemCursor(SDL_SystemCursor * this is desired for any reason. * * \param cursor a cursor to make active. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -538,8 +538,8 @@ extern SDL_DECLSPEC void SDLCALL SDL_DestroyCursor(SDL_Cursor *cursor); /** * Show the cursor. * - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -551,8 +551,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_ShowCursor(void); /** * Hide the cursor. * - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * diff --git a/include/SDL3/SDL_mutex.h b/include/SDL3/SDL_mutex.h index 2bbbc6bf89..3a7ce5655c 100644 --- a/include/SDL3/SDL_mutex.h +++ b/include/SDL3/SDL_mutex.h @@ -190,7 +190,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_LockMutex(SDL_Mutex *mutex) SDL_ACQUIRE(mut * don't want to wait for it, and will return to it to try again later. * * This function returns SDL_TRUE if passed a NULL mutex. - * + * * \param mutex the mutex to try to lock. * \returns SDL_TRUE on success, SDL_FALSE if the mutex would block. * @@ -388,7 +388,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_LockRWLockForWriting(SDL_RWLock *rwlock) SD * holding read-only locks, as this won't prevent access. * * This function returns SDL_TRUE if passed a NULL rwlock. - * + * * \param rwlock the rwlock to try to lock. * \returns SDL_TRUE on success, SDL_FALSE if the lock would block. * @@ -418,7 +418,7 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_TryLockRWLockForReading(SDL_RWLock *rwl * read-only lock before requesting a write lock. * * This function returns SDL_TRUE if passed a NULL rwlock. - * + * * \param rwlock the rwlock to try to lock. * \returns SDL_TRUE on success, SDL_FALSE if the lock would block. * @@ -537,8 +537,9 @@ extern SDL_DECLSPEC void SDLCALL SDL_DestroySemaphore(SDL_Semaphore *sem); /** * Wait until a semaphore has a positive value and then decrements it. * - * This function suspends the calling thread until the semaphore - * pointed to by `sem` has a positive value, and then atomically decrement the semaphore value. + * This function suspends the calling thread until the semaphore pointed to by + * `sem` has a positive value, and then atomically decrement the semaphore + * value. * * This function is the equivalent of calling SDL_WaitSemaphoreTimeout() with * a time length of -1. @@ -562,8 +563,7 @@ extern SDL_DECLSPEC void SDLCALL SDL_WaitSemaphore(SDL_Semaphore *sem); * returns SDL_FALSE. * * \param sem the semaphore to wait on. - * \returns SDL_TRUE if the wait succeeds, SDL_FALSE if the wait would - * block. + * \returns SDL_TRUE if the wait succeeds, SDL_FALSE if the wait would block. * * \since This function is available since SDL 3.0.0. * @@ -577,11 +577,12 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_TryWaitSemaphore(SDL_Semaphore *sem); * Wait until a semaphore has a positive value and then decrements it. * * This function suspends the calling thread until either the semaphore - * pointed to by `sem` has a positive value or the specified time has elapsed. If the call is - * successful it will atomically decrement the semaphore value. + * pointed to by `sem` has a positive value or the specified time has elapsed. + * If the call is successful it will atomically decrement the semaphore value. * * \param sem the semaphore to wait on. - * \param timeoutMS the length of the timeout, in milliseconds, or -1 to wait indefinitely. + * \param timeoutMS the length of the timeout, in milliseconds, or -1 to wait + * indefinitely. * \returns SDL_TRUE if the wait succeeds or SDL_FALSE if the wait times out. * * \since This function is available since SDL 3.0.0. @@ -740,8 +741,8 @@ extern SDL_DECLSPEC void SDLCALL SDL_WaitCondition(SDL_Condition *cond, SDL_Mute * \param mutex the mutex used to coordinate thread access. * \param timeoutMS the maximum time to wait, in milliseconds, or -1 to wait * indefinitely. - * \returns SDL_TRUE if the condition variable is signaled, SDL_FALSE if - * the condition is not signaled in the allotted time. + * \returns SDL_TRUE if the condition variable is signaled, SDL_FALSE if the + * condition is not signaled in the allotted time. * * \threadsafety It is safe to call this function from any thread. * diff --git a/include/SDL3/SDL_pixels.h b/include/SDL3/SDL_pixels.h index baf683c03d..3825dd5850 100644 --- a/include/SDL3/SDL_pixels.h +++ b/include/SDL3/SDL_pixels.h @@ -742,8 +742,8 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetPixelFormatName(SDL_PixelFormat * \param Gmask a pointer filled in with the green mask for the format. * \param Bmask a pointer filled in with the blue mask for the format. * \param Amask a pointer filled in with the alpha mask for the format. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread. * @@ -819,8 +819,8 @@ extern SDL_DECLSPEC SDL_Palette * SDLCALL SDL_CreatePalette(int ncolors); * \param colors an array of SDL_Color structures to copy into the palette. * \param firstcolor the index of the first palette entry to modify. * \param ncolors the number of entries to modify. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread, as long as * the palette is not modified or destroyed in another thread. diff --git a/include/SDL3/SDL_properties.h b/include/SDL3/SDL_properties.h index 231b2f3c4f..c3a2c82abf 100644 --- a/include/SDL3/SDL_properties.h +++ b/include/SDL3/SDL_properties.h @@ -116,8 +116,8 @@ extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_CreateProperties(void); * * \param src the properties to copy. * \param dst the destination properties. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread. * @@ -138,8 +138,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_CopyProperties(SDL_PropertiesID src, SD * thread. * * \param props the properties to lock. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread. * @@ -204,8 +204,8 @@ typedef void (SDLCALL *SDL_CleanupPropertyCallback)(void *userdata, void *value) * \param cleanup the function to call when this property is deleted, or NULL * if no cleanup is necessary. * \param userdata a pointer that is passed to the cleanup function. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread. * @@ -223,8 +223,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetPointerPropertyWithCleanup(SDL_Prope * \param props the properties to modify. * \param name the name of the property to modify. * \param value the new value of the property, or NULL to delete the property. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread. * @@ -249,8 +249,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetPointerProperty(SDL_PropertiesID pro * \param props the properties to modify. * \param name the name of the property to modify. * \param value the new value of the property, or NULL to delete the property. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread. * @@ -266,8 +266,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetStringProperty(SDL_PropertiesID prop * \param props the properties to modify. * \param name the name of the property to modify. * \param value the new value of the property. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread. * @@ -283,8 +283,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetNumberProperty(SDL_PropertiesID prop * \param props the properties to modify. * \param name the name of the property to modify. * \param value the new value of the property. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread. * @@ -300,8 +300,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetFloatProperty(SDL_PropertiesID props * \param props the properties to modify. * \param name the name of the property to modify. * \param value the new value of the property. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread. * @@ -470,8 +470,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetBooleanProperty(SDL_PropertiesID pro * * \param props the properties to modify. * \param name the name of the property to clear. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread. * @@ -507,8 +507,8 @@ typedef void (SDLCALL *SDL_EnumeratePropertiesCallback)(void *userdata, SDL_Prop * \param props the properties to query. * \param callback the function to call for each property. * \param userdata a pointer that is passed to `callback`. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread. * diff --git a/include/SDL3/SDL_rect.h b/include/SDL3/SDL_rect.h index 7d7a8a39ae..ea97df9c51 100644 --- a/include/SDL3/SDL_rect.h +++ b/include/SDL3/SDL_rect.h @@ -247,8 +247,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetRectIntersection(const SDL_Rect *A, * \param B an SDL_Rect structure representing the second rectangle. * \param result an SDL_Rect structure filled in with the union of rectangles * `A` and `B`. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -450,8 +450,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetRectIntersectionFloat(const SDL_FRec * \param B an SDL_FRect structure representing the second rectangle. * \param result an SDL_FRect structure filled in with the union of rectangles * `A` and `B`. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ diff --git a/include/SDL3/SDL_render.h b/include/SDL3/SDL_render.h index eb5de99643..706308cf66 100644 --- a/include/SDL3/SDL_render.h +++ b/include/SDL3/SDL_render.h @@ -174,8 +174,8 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetRenderDriver(int index); * SDL_CreateWindow()). * \param window a pointer filled with the window, or NULL on error. * \param renderer a pointer filled with the renderer, or NULL on error. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -444,8 +444,8 @@ extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetRendererProperties(SDL_Rende * \param renderer the rendering context. * \param w a pointer filled in with the width in pixels. * \param h a pointer filled in with the height in pixels. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -464,8 +464,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetRenderOutputSize(SDL_Renderer *rende * \param renderer the rendering context. * \param w a pointer filled in with the current width. * \param h a pointer filled in with the current height. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -801,8 +801,8 @@ extern SDL_DECLSPEC SDL_Renderer * SDLCALL SDL_GetRendererFromTexture(SDL_Textur * argument can be NULL if you don't need this information. * \param h a pointer filled in with the height of the texture in pixels. This * argument can be NULL if you don't need this information. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -817,15 +817,15 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetTextureSize(SDL_Texture *texture, fl * * `srcC = srcC * (color / 255)` * - * Color modulation is not always supported by the renderer; it will return SDL_FALSE - * if color modulation is not supported. + * Color modulation is not always supported by the renderer; it will return + * SDL_FALSE if color modulation is not supported. * * \param texture the texture to update. * \param r the red color value multiplied into copy operations. * \param g the green color value multiplied into copy operations. * \param b the blue color value multiplied into copy operations. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -845,15 +845,15 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetTextureColorMod(SDL_Texture *texture * * `srcC = srcC * color` * - * Color modulation is not always supported by the renderer; it will return SDL_FALSE - * if color modulation is not supported. + * Color modulation is not always supported by the renderer; it will return + * SDL_FALSE if color modulation is not supported. * * \param texture the texture to update. * \param r the red color value multiplied into copy operations. * \param g the green color value multiplied into copy operations. * \param b the blue color value multiplied into copy operations. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -871,8 +871,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetTextureColorModFloat(SDL_Texture *te * \param r a pointer filled in with the current red color value. * \param g a pointer filled in with the current green color value. * \param b a pointer filled in with the current blue color value. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -889,8 +889,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetTextureColorMod(SDL_Texture *texture * \param r a pointer filled in with the current red color value. * \param g a pointer filled in with the current green color value. * \param b a pointer filled in with the current blue color value. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -908,13 +908,13 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetTextureColorModFloat(SDL_Texture *te * * `srcA = srcA * (alpha / 255)` * - * Alpha modulation is not always supported by the renderer; it will return SDL_FALSE - * if alpha modulation is not supported. + * Alpha modulation is not always supported by the renderer; it will return + * SDL_FALSE if alpha modulation is not supported. * * \param texture the texture to update. * \param alpha the source alpha value multiplied into copy operations. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -932,13 +932,13 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetTextureAlphaMod(SDL_Texture *texture * * `srcA = srcA * alpha` * - * Alpha modulation is not always supported by the renderer; it will return SDL_FALSE - * if alpha modulation is not supported. + * Alpha modulation is not always supported by the renderer; it will return + * SDL_FALSE if alpha modulation is not supported. * * \param texture the texture to update. * \param alpha the source alpha value multiplied into copy operations. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -953,8 +953,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetTextureAlphaModFloat(SDL_Texture *te * * \param texture the texture to query. * \param alpha a pointer filled in with the current alpha value. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -969,8 +969,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetTextureAlphaMod(SDL_Texture *texture * * \param texture the texture to query. * \param alpha a pointer filled in with the current alpha value. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -988,8 +988,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetTextureAlphaModFloat(SDL_Texture *te * * \param texture the texture to update. * \param blendMode the SDL_BlendMode to use for texture blending. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1002,8 +1002,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetTextureBlendMode(SDL_Texture *textur * * \param texture the texture to query. * \param blendMode a pointer filled in with the current SDL_BlendMode. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1020,8 +1020,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetTextureBlendMode(SDL_Texture *textur * * \param texture the texture to update. * \param scaleMode the SDL_ScaleMode to use for texture scaling. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1034,8 +1034,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetTextureScaleMode(SDL_Texture *textur * * \param texture the texture to query. * \param scaleMode a pointer filled in with the current scale mode. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1063,8 +1063,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetTextureScaleMode(SDL_Texture *textur * \param pixels the raw pixel data in the format of the texture. * \param pitch the number of bytes in a row of pixel data, including padding * between lines. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1095,8 +1095,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_UpdateTexture(SDL_Texture *texture, con * \param Vplane the raw pixel data for the V plane. * \param Vpitch the number of bytes between rows of pixel data for the V * plane. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1125,8 +1125,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_UpdateYUVTexture(SDL_Texture *texture, * \param UVplane the raw pixel data for the UV plane. * \param UVpitch the number of bytes between rows of pixel data for the UV * plane. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1157,8 +1157,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_UpdateNVTexture(SDL_Texture *texture, * appropriately offset by the locked area. * \param pitch this is filled in with the pitch of the locked pixels; the * pitch is the length of one row in bytes. - * \returns SDL_TRUE on success or SDL_FALSE if the texture is not valid - * or was not created with `SDL_TEXTUREACCESS_STREAMING`; call + * \returns SDL_TRUE on success or SDL_FALSE if the texture is not valid or + * was not created with `SDL_TEXTUREACCESS_STREAMING`; call * SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. @@ -1194,8 +1194,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_LockTexture(SDL_Texture *texture, * NULL, the entire texture will be locked. * \param surface this is filled in with an SDL surface representing the * locked area. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1234,8 +1234,8 @@ extern SDL_DECLSPEC void SDLCALL SDL_UnlockTexture(SDL_Texture *texture); * \param texture the targeted texture, which must be created with the * `SDL_TEXTUREACCESS_TARGET` flag, or NULL to render to the * window instead of a texture. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1277,8 +1277,8 @@ extern SDL_DECLSPEC SDL_Texture * SDLCALL SDL_GetRenderTarget(SDL_Renderer *rend * \param h the height of the logical resolution. * \param mode the presentation mode used. * \param scale_mode the scale mode used. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1299,8 +1299,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetRenderLogicalPresentation(SDL_Render * \param h an int to be filled with the height. * \param mode a pointer filled in with the presentation mode. * \param scale_mode a pointer filled in with the scale mode. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1319,8 +1319,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetRenderLogicalPresentation(SDL_Render * \param renderer the rendering context. * \param rect a pointer filled in with the final presentation rectangle, may * be NULL. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1336,8 +1336,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetRenderLogicalPresentationRect(SDL_Re * \param window_y the y coordinate in window coordinates. * \param x a pointer filled with the x coordinate in render coordinates. * \param y a pointer filled with the y coordinate in render coordinates. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1356,8 +1356,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_RenderCoordinatesFromWindow(SDL_Rendere * coordinates. * \param window_y a pointer filled with the y coordinate in window * coordinates. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1376,8 +1376,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_RenderCoordinatesToWindow(SDL_Renderer * * \param renderer the rendering context. * \param event the event to modify. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1391,8 +1391,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_ConvertEventToRenderCoordinates(SDL_Ren * \param renderer the rendering context. * \param rect the SDL_Rect structure representing the drawing area, or NULL * to set the viewport to the entire target. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1406,8 +1406,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetRenderViewport(SDL_Renderer *rendere * * \param renderer the rendering context. * \param rect an SDL_Rect structure filled in with the current drawing area. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1447,8 +1447,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_RenderViewportSet(SDL_Renderer *rendere * \param renderer the rendering context. * \param rect a pointer filled in with the area that is safe for interactive * content. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -1460,8 +1460,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetRenderSafeArea(SDL_Renderer *rendere * \param renderer the rendering context. * \param rect an SDL_Rect structure representing the clip area, relative to * the viewport, or NULL to disable clipping. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1476,8 +1476,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetRenderClipRect(SDL_Renderer *rendere * \param renderer the rendering context. * \param rect an SDL_Rect structure filled in with the current clipping area * or an empty rectangle if clipping is disabled. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1514,8 +1514,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_RenderClipEnabled(SDL_Renderer *rendere * \param renderer the rendering context. * \param scaleX the horizontal scaling factor. * \param scaleY the vertical scaling factor. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1529,8 +1529,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetRenderScale(SDL_Renderer *renderer, * \param renderer the rendering context. * \param scaleX a pointer filled in with the horizontal scaling factor. * \param scaleY a pointer filled in with the vertical scaling factor. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1551,8 +1551,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetRenderScale(SDL_Renderer *renderer, * \param a the alpha value used to draw on the rendering target; usually * `SDL_ALPHA_OPAQUE` (255). Use SDL_SetRenderDrawBlendMode to * specify how the alpha channel is used. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1574,8 +1574,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetRenderDrawColor(SDL_Renderer *render * \param a the alpha value used to draw on the rendering target. Use * SDL_SetRenderDrawBlendMode to specify how the alpha channel is * used. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1596,8 +1596,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetRenderDrawColorFloat(SDL_Renderer *r * rendering target. * \param a a pointer filled in with the alpha value used to draw on the * rendering target; usually `SDL_ALPHA_OPAQUE` (255). - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1618,8 +1618,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetRenderDrawColor(SDL_Renderer *render * rendering target. * \param a a pointer filled in with the alpha value used to draw on the * rendering target. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1641,8 +1641,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetRenderDrawColorFloat(SDL_Renderer *r * * \param renderer the rendering context. * \param scale the color scale value. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1655,8 +1655,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetRenderColorScale(SDL_Renderer *rende * * \param renderer the rendering context. * \param scale a pointer filled in with the current color scale value. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1671,8 +1671,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetRenderColorScale(SDL_Renderer *rende * * \param renderer the rendering context. * \param blendMode the SDL_BlendMode to use for blending. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1685,8 +1685,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetRenderDrawBlendMode(SDL_Renderer *re * * \param renderer the rendering context. * \param blendMode a pointer filled in with the current SDL_BlendMode. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1703,8 +1703,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetRenderDrawBlendMode(SDL_Renderer *re * SDL_SetRenderDrawColor() when needed. * * \param renderer the rendering context. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1718,8 +1718,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_RenderClear(SDL_Renderer *renderer); * \param renderer the renderer which should draw a point. * \param x the x coordinate of the point. * \param y the y coordinate of the point. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1733,8 +1733,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_RenderPoint(SDL_Renderer *renderer, flo * \param renderer the renderer which should draw multiple points. * \param points the points to draw. * \param count the number of points to draw. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1750,8 +1750,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_RenderPoints(SDL_Renderer *renderer, co * \param y1 the y coordinate of the start point. * \param x2 the x coordinate of the end point. * \param y2 the y coordinate of the end point. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1766,8 +1766,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_RenderLine(SDL_Renderer *renderer, floa * \param renderer the renderer which should draw multiple lines. * \param points the points along the lines. * \param count the number of points, drawing count-1 lines. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1781,8 +1781,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_RenderLines(SDL_Renderer *renderer, con * \param renderer the renderer which should draw a rectangle. * \param rect a pointer to the destination rectangle, or NULL to outline the * entire rendering target. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1797,8 +1797,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_RenderRect(SDL_Renderer *renderer, cons * \param renderer the renderer which should draw multiple rectangles. * \param rects a pointer to an array of destination rectangles. * \param count the number of rectangles. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1813,8 +1813,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_RenderRects(SDL_Renderer *renderer, con * \param renderer the renderer which should fill a rectangle. * \param rect a pointer to the destination rectangle, or NULL for the entire * rendering target. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1829,8 +1829,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_RenderFillRect(SDL_Renderer *renderer, * \param renderer the renderer which should fill multiple rectangles. * \param rects a pointer to an array of destination rectangles. * \param count the number of rectangles. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1848,8 +1848,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_RenderFillRects(SDL_Renderer *renderer, * texture. * \param dstrect a pointer to the destination rectangle, or NULL for the * entire rendering target. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1875,8 +1875,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_RenderTexture(SDL_Renderer *renderer, S * around dstrect.w/2, dstrect.h/2). * \param flip an SDL_FlipMode value stating which flipping actions should be * performed on the texture. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1903,8 +1903,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_RenderTextureRotated(SDL_Renderer *rend * 64x64 tiles. * \param dstrect a pointer to the destination rectangle, or NULL for the * entire rendering target. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1935,8 +1935,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_RenderTextureTiled(SDL_Renderer *render * corner of `dstrect`, or 0.0f for an unscaled copy. * \param dstrect a pointer to the destination rectangle, or NULL for the * entire rendering target. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1957,8 +1957,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_RenderTexture9Grid(SDL_Renderer *render * array, if NULL all vertices will be rendered in sequential * order. * \param num_indices number of indices. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1987,8 +1987,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_RenderGeometry(SDL_Renderer *renderer, * if NULL all vertices will be rendered in sequential order. * \param num_indices number of indices. * \param size_indices index size: 1 (byte), 2 (short), 4 (int). - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -2047,8 +2047,8 @@ extern SDL_DECLSPEC SDL_Surface * SDLCALL SDL_RenderReadPixels(SDL_Renderer *ren * do not have a concept of backbuffers. * * \param renderer the rendering context. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety You may only call this function on the main thread. * @@ -2122,8 +2122,8 @@ extern SDL_DECLSPEC void SDLCALL SDL_DestroyRenderer(SDL_Renderer *renderer); * be prepared to make changes if specific state needs to be protected. * * \param renderer the rendering context. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -2187,8 +2187,8 @@ extern SDL_DECLSPEC void * SDLCALL SDL_GetRenderMetalCommandEncoder(SDL_Renderer * \param signal_semaphore a VkSempahore that SDL will signal when rendering * for the current frame is complete, or 0 if not * needed. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is **NOT** safe to call this function from two threads at * once. @@ -2211,8 +2211,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_AddVulkanRenderSemaphores(SDL_Renderer * * \param renderer the renderer to toggle. * \param vsync the vertical refresh sync interval. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -2229,8 +2229,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetRenderVSync(SDL_Renderer *renderer, * \param renderer the renderer to toggle. * \param vsync an int filled with the current vertical refresh sync interval. * See SDL_SetRenderVSync() for the meaning of the value. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * diff --git a/include/SDL3/SDL_sensor.h b/include/SDL3/SDL_sensor.h index 3d2c67440e..3ae48566f0 100644 --- a/include/SDL3/SDL_sensor.h +++ b/include/SDL3/SDL_sensor.h @@ -277,8 +277,8 @@ extern SDL_DECLSPEC SDL_SensorID SDLCALL SDL_GetSensorID(SDL_Sensor *sensor); * \param sensor the SDL_Sensor object to query. * \param data a pointer filled with the current sensor state. * \param num_values the number of values to write to data. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ diff --git a/include/SDL3/SDL_stdinc.h b/include/SDL3/SDL_stdinc.h index ec09766081..5539f2a815 100644 --- a/include/SDL3/SDL_stdinc.h +++ b/include/SDL3/SDL_stdinc.h @@ -599,8 +599,8 @@ extern SDL_DECLSPEC void SDLCALL SDL_GetMemoryFunctions(SDL_malloc_func *malloc_ * \param calloc_func custom calloc function. * \param realloc_func custom realloc function. * \param free_func custom free function. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread, but one * should not replace the memory functions once any allocations diff --git a/include/SDL3/SDL_storage.h b/include/SDL3/SDL_storage.h index 718577ce20..91a90bc4ee 100644 --- a/include/SDL3/SDL_storage.h +++ b/include/SDL3/SDL_storage.h @@ -230,8 +230,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_StorageReady(SDL_Storage *storage); * \param storage a storage container to query. * \param path the relative path of the file to query. * \param length a pointer to be filled with the file's length. - * \returns SDL_TRUE if the file could be queried or SDL_FALSE on - * failure; call SDL_GetError() for more information. + * \returns SDL_TRUE if the file could be queried or SDL_FALSE on failure; + * call SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. * @@ -266,8 +266,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_ReadStorageFile(SDL_Storage *storage, c * \param path the relative path of the file to write. * \param source a client-provided buffer to write from. * \param length the length of the source buffer. - * \returns SDL_TRUE if the file was written or SDL_FALSE on failure; - * call SDL_GetError() for more information. + * \returns SDL_TRUE if the file was written or SDL_FALSE on failure; call + * SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. * @@ -282,8 +282,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_WriteStorageFile(SDL_Storage *storage, * * \param storage a storage container. * \param path the path of the directory to create. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -302,8 +302,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_CreateStorageDirectory(SDL_Storage *sto * \param path the path of the directory to enumerate. * \param callback a function that is called for each entry in the directory. * \param userdata a pointer that is passed to `callback`. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -316,8 +316,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_EnumerateStorageDirectory(SDL_Storage * * * \param storage a storage container. * \param path the path of the directory to enumerate. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -331,8 +331,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_RemoveStoragePath(SDL_Storage *storage, * \param storage a storage container. * \param oldpath the old path. * \param newpath the new path. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -346,8 +346,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_RenameStoragePath(SDL_Storage *storage, * \param storage a storage container. * \param oldpath the old path. * \param newpath the new path. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -362,8 +362,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_CopyStorageFile(SDL_Storage *storage, c * \param path the path to query. * \param info a pointer filled in with information about the path, or NULL to * check for the existence of a file. - * \returns SDL_TRUE on success or SDL_FALSE if the file doesn't exist, - * or another failure; call SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE if the file doesn't exist, or + * another failure; call SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. * diff --git a/include/SDL3/SDL_surface.h b/include/SDL3/SDL_surface.h index 31c0a2624f..8c1d3577e4 100644 --- a/include/SDL3/SDL_surface.h +++ b/include/SDL3/SDL_surface.h @@ -224,8 +224,8 @@ extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetSurfaceProperties(SDL_Surfac * \param surface the SDL_Surface structure to update. * \param colorspace an SDL_ColorSpace value describing the surface * colorspace. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -285,8 +285,8 @@ extern SDL_DECLSPEC SDL_Palette * SDLCALL SDL_CreateSurfacePalette(SDL_Surface * * * \param surface the SDL_Surface structure to update. * \param palette the SDL_Palette structure to use. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -322,8 +322,8 @@ extern SDL_DECLSPEC SDL_Palette * SDLCALL SDL_GetSurfacePalette(SDL_Surface *sur * \param surface the SDL_Surface structure to update. * \param image a pointer to an alternate SDL_Surface to associate with this * surface. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -402,8 +402,8 @@ extern SDL_DECLSPEC void SDLCALL SDL_RemoveSurfaceAlternateImages(SDL_Surface *s * format of the surface will not change. * * \param surface the SDL_Surface structure to be locked. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -474,8 +474,8 @@ extern SDL_DECLSPEC SDL_Surface * SDLCALL SDL_LoadBMP(const char *file); * \param dst a data stream to save to. * \param closeio if SDL_TRUE, calls SDL_CloseIO() on `dst` before returning, * even in the case of an error. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -495,8 +495,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SaveBMP_IO(SDL_Surface *surface, SDL_IO * * \param surface the SDL_Surface structure containing the image to be saved. * \param file a file to save to. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -514,8 +514,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SaveBMP(SDL_Surface *surface, const cha * \param surface the SDL_Surface structure to optimize. * \param enabled SDL_TRUE to enable RLE acceleration, SDL_FALSE to disable * it. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -553,8 +553,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SurfaceHasRLE(SDL_Surface *surface); * \param enabled SDL_TRUE to enable color key, SDL_FALSE to disable color * key. * \param key the transparent pixel. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -589,8 +589,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SurfaceHasColorKey(SDL_Surface *surface * * \param surface the SDL_Surface structure to query. * \param key a pointer filled in with the transparent pixel. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -612,8 +612,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetSurfaceColorKey(SDL_Surface *surface * \param r the red color value multiplied into blit operations. * \param g the green color value multiplied into blit operations. * \param b the blue color value multiplied into blit operations. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -630,8 +630,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetSurfaceColorMod(SDL_Surface *surface * \param r a pointer filled in with the current red color value. * \param g a pointer filled in with the current green color value. * \param b a pointer filled in with the current blue color value. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -650,8 +650,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetSurfaceColorMod(SDL_Surface *surface * * \param surface the SDL_Surface structure to update. * \param alpha the alpha value multiplied into blit operations. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -665,8 +665,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetSurfaceAlphaMod(SDL_Surface *surface * * \param surface the SDL_Surface structure to query. * \param alpha a pointer filled in with the current alpha value. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -684,8 +684,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetSurfaceAlphaMod(SDL_Surface *surface * * \param surface the SDL_Surface structure to update. * \param blendMode the SDL_BlendMode to use for blit blending. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -698,8 +698,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetSurfaceBlendMode(SDL_Surface *surfac * * \param surface the SDL_Surface structure to query. * \param blendMode a pointer filled in with the current SDL_BlendMode. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -738,8 +738,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetSurfaceClipRect(SDL_Surface *surface * clipped. * \param rect an SDL_Rect structure filled in with the clipping rectangle for * the surface. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -752,8 +752,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetSurfaceClipRect(SDL_Surface *surface * * \param surface the surface to flip. * \param flip the direction to flip. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -860,8 +860,8 @@ extern SDL_DECLSPEC SDL_Surface * SDLCALL SDL_ConvertSurfaceAndColorspace(SDL_Su * \param dst_format an SDL_PixelFormat value of the `dst` pixels format. * \param dst a pointer to be filled in with new pixel data. * \param dst_pitch the pitch of the destination pixels, in bytes. - * \returns SDL_FALSE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_FALSE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -889,8 +889,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_ConvertPixels(int width, int height, SD * properties, or 0. * \param dst a pointer to be filled in with new pixel data. * \param dst_pitch the pitch of the destination pixels, in bytes. - * \returns SDL_FALSE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_FALSE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -913,8 +913,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_ConvertPixelsAndColorspace(int width, i * \param dst_pitch the pitch of the destination pixels, in bytes. * \param linear SDL_TRUE to convert from sRGB to linear space for the alpha * multiplication, SDL_FALSE to do multiplication in sRGB space. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -928,8 +928,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_PremultiplyAlpha(int width, int height, * \param surface the surface to modify. * \param linear SDL_TRUE to convert from sRGB to linear space for the alpha * multiplication, SDL_FALSE to do multiplication in sRGB space. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -948,8 +948,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_PremultiplySurfaceAlpha(SDL_Surface *su * \param g the green component of the pixel, normally in the range 0-1. * \param b the blue component of the pixel, normally in the range 0-1. * \param a the alpha component of the pixel, normally in the range 0-1. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -971,8 +971,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_ClearSurface(SDL_Surface *surface, floa * \param rect the SDL_Rect structure representing the rectangle to fill, or * NULL to fill the entire surface. * \param color the color to fill with. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -996,8 +996,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_FillSurfaceRect(SDL_Surface *dst, const * \param rects an array of SDL_Rects representing the rectangles to fill. * \param count the number of rectangles in the array. * \param color the color to fill with. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1067,8 +1067,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_FillSurfaceRects(SDL_Surface *dst, cons * height are ignored, and are copied from `srcrect`. If you * want a specific width and height, you should use * SDL_BlitSurfaceScaled(). - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety The same destination surface should not be used from two * threads at once. It is safe to use the same source surface @@ -1092,8 +1092,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_BlitSurface(SDL_Surface *src, const SDL * \param dst the SDL_Surface structure that is the blit target. * \param dstrect the SDL_Rect structure representing the target rectangle in * the destination surface, may not be NULL. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety The same destination surface should not be used from two * threads at once. It is safe to use the same source surface @@ -1117,8 +1117,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_BlitSurfaceUnchecked(SDL_Surface *src, * the destination surface, or NULL to fill the entire * destination surface. * \param scaleMode the SDL_ScaleMode to be used. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety The same destination surface should not be used from two * threads at once. It is safe to use the same source surface @@ -1143,8 +1143,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_BlitSurfaceScaled(SDL_Surface *src, con * \param dstrect the SDL_Rect structure representing the target rectangle in * the destination surface, may not be NULL. * \param scaleMode the SDL_ScaleMode to be used. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety The same destination surface should not be used from two * threads at once. It is safe to use the same source surface @@ -1169,8 +1169,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_BlitSurfaceUncheckedScaled(SDL_Surface * \param dst the SDL_Surface structure that is the blit target. * \param dstrect the SDL_Rect structure representing the target rectangle in * the destination surface, or NULL to fill the entire surface. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety The same destination surface should not be used from two * threads at once. It is safe to use the same source surface @@ -1199,8 +1199,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_BlitSurfaceTiled(SDL_Surface *src, cons * \param dst the SDL_Surface structure that is the blit target. * \param dstrect the SDL_Rect structure representing the target rectangle in * the destination surface, or NULL to fill the entire surface. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety The same destination surface should not be used from two * threads at once. It is safe to use the same source surface @@ -1236,8 +1236,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_BlitSurfaceTiledWithScale(SDL_Surface * * \param dst the SDL_Surface structure that is the blit target. * \param dstrect the SDL_Rect structure representing the target rectangle in * the destination surface, or NULL to fill the entire surface. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety The same destination surface should not be used from two * threads at once. It is safe to use the same source surface @@ -1330,8 +1330,8 @@ extern SDL_DECLSPEC Uint32 SDLCALL SDL_MapSurfaceRGBA(SDL_Surface *surface, Uint * ignore this channel. * \param a a pointer filled in with the alpha channel, 0-255, or NULL to * ignore this channel. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -1354,8 +1354,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_ReadSurfacePixel(SDL_Surface *surface, * 0-1, or NULL to ignore this channel. * \param a a pointer filled in with the alpha channel, normally in the range * 0-1, or NULL to ignore this channel. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -1377,8 +1377,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_ReadSurfacePixelFloat(SDL_Surface *surf * \param g the green channel value, 0-255. * \param b the blue channel value, 0-255. * \param a the alpha channel value, 0-255. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -1397,8 +1397,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_WriteSurfacePixel(SDL_Surface *surface, * \param g the green channel value, normally in the range 0-1. * \param b the blue channel value, normally in the range 0-1. * \param a the alpha channel value, normally in the range 0-1. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ diff --git a/include/SDL3/SDL_system.h b/include/SDL3/SDL_system.h index 0f2da28147..17ac0a1056 100644 --- a/include/SDL3/SDL_system.h +++ b/include/SDL3/SDL_system.h @@ -101,8 +101,8 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetWindowsMessageHook(SDL_WindowsMessageHoo * controls on which monitor a full screen application will appear. * * \param displayID the instance of the display to query. - * \returns the D3D9 adapter index on success or -1 on - * failure; call SDL_GetError() for more information. + * \returns the D3D9 adapter index on success or -1 on failure; call + * SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. */ @@ -122,8 +122,8 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetDirect3D9AdapterIndex(SDL_DisplayID displ * \param displayID the instance of the display to query. * \param adapterIndex a pointer to be filled in with the adapter index. * \param outputIndex a pointer to be filled in with the output index. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -162,8 +162,8 @@ extern SDL_DECLSPEC void SDLCALL SDL_SetX11EventHook(SDL_X11EventHook callback, * * \param threadID the Unix thread ID to change priority of. * \param priority the new, Unix-specific, priority value. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -178,8 +178,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetLinuxThreadPriority(Sint64 threadID, * \param sdlPriority the new SDL_ThreadPriority value. * \param schedPolicy the new scheduling policy (SCHED_FIFO, SCHED_RR, * SCHED_OTHER, etc...). - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -240,8 +240,8 @@ typedef void (SDLCALL *SDL_iOSAnimationCallback)(void *userdata); * called. * \param callback the function to call for every frame. * \param callbackParam a pointer that is passed to `callback`. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -503,8 +503,8 @@ typedef void (SDLCALL *SDL_RequestAndroidPermissionCallback)(void *userdata, con * \param permission the permission to request. * \param cb the callback to trigger when the request has a response. * \param userdata an app-controlled pointer that is passed to the callback. - * \returns SDL_TRUE if the request was submitted, SDL_FALSE if there was an error - * submitting. The result of the request is only ever reported + * \returns SDL_TRUE if the request was submitted, SDL_FALSE if there was an + * error submitting. The result of the request is only ever reported * through the callback, not this return value. * * \threadsafety It is safe to call this function from any thread. @@ -532,8 +532,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_RequestAndroidPermission(const char *pe * \param gravity where the notification should appear on the screen. * \param xoffset set this parameter only when gravity >=0. * \param yoffset set this parameter only when gravity >=0. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread. * @@ -548,8 +548,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_ShowAndroidToast(const char *message, i * * \param command user command that must be greater or equal to 0x8000. * \param param user parameter. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread. * @@ -794,8 +794,8 @@ typedef struct XUser *XUserHandle; * leak. * * \param outTaskQueue a pointer to be filled in with task queue handle. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -809,8 +809,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetGDKTaskQueue(XTaskQueueHandle *outTa * * \param outUserHandle a pointer to be filled in with the default user * handle. - * \returns SDL_TRUE if success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE if success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ diff --git a/include/SDL3/SDL_thread.h b/include/SDL3/SDL_thread.h index ee79e000a2..0fdc8a0278 100644 --- a/include/SDL3/SDL_thread.h +++ b/include/SDL3/SDL_thread.h @@ -381,8 +381,8 @@ extern SDL_DECLSPEC SDL_ThreadID SDLCALL SDL_GetThreadID(SDL_Thread *thread); * an administrator account. Be prepared for this to fail. * * \param priority the SDL_ThreadPriority to set. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -504,8 +504,8 @@ typedef void (SDLCALL *SDL_TLSDestructorCallback)(void *value); * \param value the value to associate with the ID for the current thread. * \param destructor a function called when the thread exits, to free the * value, may be NULL. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \threadsafety It is safe to call this function from any thread. * diff --git a/include/SDL3/SDL_time.h b/include/SDL3/SDL_time.h index e26f6f9c49..86c1fad01b 100644 --- a/include/SDL3/SDL_time.h +++ b/include/SDL3/SDL_time.h @@ -95,8 +95,8 @@ typedef enum SDL_TimeFormat * format, may be NULL. * \param timeFormat a pointer to the SDL_TimeFormat to hold the returned time * format, may be NULL. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -107,8 +107,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetDateTimeLocalePreferences(SDL_DateFo * Jan 1, 1970 in Universal Coordinated Time (UTC). * * \param ticks the SDL_Time to hold the returned tick count. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -123,8 +123,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetCurrentTime(SDL_Time *ticks); * \param localTime the resulting SDL_DateTime will be expressed in local time * if true, otherwise it will be in Universal Coordinated * Time (UTC). - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -138,8 +138,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_TimeToDateTime(SDL_Time ticks, SDL_Date * * \param dt the source SDL_DateTime. * \param ticks the resulting SDL_Time. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -181,8 +181,8 @@ extern SDL_DECLSPEC SDL_Time SDLCALL SDL_TimeFromWindows(Uint32 dwLowDateTime, U * * \param year the year. * \param month the month [1-12]. - * \returns the number of days in the requested month or -1 - * on failure; call SDL_GetError() for more information. + * \returns the number of days in the requested month or -1 on failure; call + * SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. */ @@ -194,8 +194,8 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetDaysInMonth(int year, int month); * \param year the year component of the date. * \param month the month component of the date. * \param day the day component of the date. - * \returns the day of year [0-365] if the date is valid or -1 - * on failure; call SDL_GetError() for more information. + * \returns the day of year [0-365] if the date is valid or -1 on failure; + * call SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. */ @@ -207,9 +207,8 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetDayOfYear(int year, int month, int day); * \param year the year component of the date. * \param month the month component of the date. * \param day the day component of the date. - * \returns a value between 0 and 6 (0 being Sunday) if the date is valid or -1 - * on failure; call SDL_GetError() for more - * information. + * \returns a value between 0 and 6 (0 being Sunday) if the date is valid or + * -1 on failure; call SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. */ diff --git a/include/SDL3/SDL_timer.h b/include/SDL3/SDL_timer.h index b2f58b2fca..9d05161b40 100644 --- a/include/SDL3/SDL_timer.h +++ b/include/SDL3/SDL_timer.h @@ -263,8 +263,8 @@ extern SDL_DECLSPEC SDL_TimerID SDLCALL SDL_AddTimerNS(Uint64 interval, SDL_NSTi * Remove a timer created with SDL_AddTimer(). * * \param id the ID of the timer to remove. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * diff --git a/include/SDL3/SDL_video.h b/include/SDL3/SDL_video.h index 3539148b40..7cce828aa7 100644 --- a/include/SDL3/SDL_video.h +++ b/include/SDL3/SDL_video.h @@ -475,8 +475,8 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetDisplayName(SDL_DisplayID displa * * \param displayID the instance ID of the display to query. * \param rect the SDL_Rect structure filled in with the display bounds. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -499,8 +499,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetDisplayBounds(SDL_DisplayID displayI * * \param displayID the instance ID of the display to query. * \param rect the SDL_Rect structure filled in with the display bounds. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -598,8 +598,8 @@ extern SDL_DECLSPEC SDL_DisplayMode ** SDLCALL SDL_GetFullscreenDisplayModes(SDL * the search. * \param mode a pointer filled in with the closest display mode equal to or * larger than the desired mode. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -751,8 +751,8 @@ extern SDL_DECLSPEC float SDLCALL SDL_GetWindowDisplayScale(SDL_Window *window); * borderless fullscreen desktop mode, or one of the fullscreen * modes returned by SDL_GetFullscreenDisplayModes() to set an * exclusive fullscreen mode. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1327,8 +1327,8 @@ extern SDL_DECLSPEC SDL_WindowFlags SDLCALL SDL_GetWindowFlags(SDL_Window *windo * * \param window the window to change. * \param title the desired window title in UTF-8 format. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1364,8 +1364,8 @@ extern SDL_DECLSPEC const char * SDLCALL SDL_GetWindowTitle(SDL_Window *window); * * \param window the window to change. * \param icon an SDL_Surface structure containing the icon for the window. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -1401,8 +1401,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetWindowIcon(SDL_Window *window, SDL_S * `SDL_WINDOWPOS_UNDEFINED`. * \param y the y coordinate of the window, or `SDL_WINDOWPOS_CENTERED` or * `SDL_WINDOWPOS_UNDEFINED`. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1425,8 +1425,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetWindowPosition(SDL_Window *window, i * NULL. * \param y a pointer filled in with the y position of the window, may be * NULL. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1459,8 +1459,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetWindowPosition(SDL_Window *window, i * \param window the window to change. * \param w the width of the window, must be > 0. * \param h the height of the window, must be > 0. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1480,8 +1480,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetWindowSize(SDL_Window *window, int w * \param window the window to query the width and height from. * \param w a pointer filled in with the width of the window, may be NULL. * \param h a pointer filled in with the height of the window, may be NULL. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1504,8 +1504,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetWindowSize(SDL_Window *window, int * * \param window the window to query. * \param rect a pointer filled in with the client area that is safe for * interactive content. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -1540,8 +1540,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetWindowSafeArea(SDL_Window *window, S * limit. * \param max_aspect the maximum aspect ratio of the window, or 0.0f for no * limit. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1558,8 +1558,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetWindowAspectRatio(SDL_Window *window * window, may be NULL. * \param max_aspect a pointer filled in with the maximum aspect ratio of the * window, may be NULL. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1592,8 +1592,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetWindowAspectRatio(SDL_Window *window * border; NULL is permitted. * \param right pointer to variable for storing the size of the right border; * NULL is permitted. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1609,8 +1609,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetWindowBordersSize(SDL_Window *window * NULL. * \param h a pointer to variable for storing the height in pixels, may be * NULL. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1625,8 +1625,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetWindowSizeInPixels(SDL_Window *windo * \param window the window to change. * \param min_w the minimum width of the window, or 0 for no limit. * \param min_h the minimum height of the window, or 0 for no limit. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1643,8 +1643,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetWindowMinimumSize(SDL_Window *window * NULL. * \param h a pointer filled in with the minimum height of the window, may be * NULL. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1659,8 +1659,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetWindowMinimumSize(SDL_Window *window * \param window the window to change. * \param max_w the maximum width of the window, or 0 for no limit. * \param max_h the maximum height of the window, or 0 for no limit. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1677,8 +1677,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetWindowMaximumSize(SDL_Window *window * NULL. * \param h a pointer filled in with the maximum height of the window, may be * NULL. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1698,8 +1698,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetWindowMaximumSize(SDL_Window *window * * \param window the window of which to change the border state. * \param bordered SDL_FALSE to remove border, SDL_TRUE to add border. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1718,8 +1718,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetWindowBordered(SDL_Window *window, S * * \param window the window of which to change the resizable state. * \param resizable SDL_TRUE to allow resizing, SDL_FALSE to disallow. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1736,8 +1736,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetWindowResizable(SDL_Window *window, * \param window the window of which to change the always on top state. * \param on_top SDL_TRUE to set the window always on top, SDL_FALSE to * disable. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1749,8 +1749,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetWindowAlwaysOnTop(SDL_Window *window * Show a window. * * \param window the window to show. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1763,8 +1763,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_ShowWindow(SDL_Window *window); * Hide a window. * * \param window the window to hide. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1783,8 +1783,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_HideWindow(SDL_Window *window); * the window will have the SDL_WINDOW_INPUT_FOCUS flag set. * * \param window the window to raise. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -1811,8 +1811,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_RaiseWindow(SDL_Window *window); * and Wayland window managers may vary. * * \param window the window to maximize. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1835,8 +1835,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_MaximizeWindow(SDL_Window *window); * deny the state change. * * \param window the window to minimize. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1860,8 +1860,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_MinimizeWindow(SDL_Window *window); * deny the state change. * * \param window the window to restore. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1890,8 +1890,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_RestoreWindow(SDL_Window *window); * \param window the window to change. * \param fullscreen SDL_TRUE for fullscreen mode, SDL_FALSE for windowed * mode. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -1985,8 +1985,8 @@ extern SDL_DECLSPEC SDL_Surface * SDLCALL SDL_GetWindowSurface(SDL_Window *windo * * \param window the window. * \param vsync the vertical refresh sync interval. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -2003,8 +2003,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetWindowSurfaceVSync(SDL_Window *windo * \param window the window to query. * \param vsync an int filled with the current vertical refresh sync interval. * See SDL_SetWindowSurfaceVSync() for the meaning of the value. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -2021,8 +2021,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GetWindowSurfaceVSync(SDL_Window *windo * This function is equivalent to the SDL 1.2 API SDL_Flip(). * * \param window the window to update. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -2048,8 +2048,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_UpdateWindowSurface(SDL_Window *window) * \param rects an array of SDL_Rect structures representing areas of the * surface to copy, in pixels. * \param numrects the number of rectangles. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -2062,8 +2062,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_UpdateWindowSurfaceRects(SDL_Window *wi * Destroy the surface associated with the window. * * \param window the window to update. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -2093,8 +2093,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_DestroyWindowSurface(SDL_Window *window * * \param window the window for which the keyboard grab mode should be set. * \param grabbed this is SDL_TRUE to grab keyboard, and SDL_FALSE to release. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -2110,8 +2110,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetWindowKeyboardGrab(SDL_Window *windo * * \param window the window for which the mouse grab mode should be set. * \param grabbed this is SDL_TRUE to grab mouse, and SDL_FALSE to release. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -2165,8 +2165,8 @@ extern SDL_DECLSPEC SDL_Window * SDLCALL SDL_GetGrabbedWindow(void); * \param window the window that will be associated with the barrier. * \param rect a rectangle area in window-relative coordinates. If NULL the * barrier for the specified window will be destroyed. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -2198,8 +2198,8 @@ extern SDL_DECLSPEC const SDL_Rect * SDLCALL SDL_GetWindowMouseRect(SDL_Window * * * \param window the window which will be made transparent or opaque. * \param opacity the opacity value (0.0f - transparent, 1.0f - opaque). - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -2214,7 +2214,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetWindowOpacity(SDL_Window *window, fl * as 1.0f without error. * * \param window the window to get the current opacity value from. - * \returns the opacity, (0.0f - transparent, 1.0f - opaque), or -1.0f on failure; call SDL_GetError() for more information. + * \returns the opacity, (0.0f - transparent, 1.0f - opaque), or -1.0f on + * failure; call SDL_GetError() for more information. * * \since This function is available since SDL 3.0.0. * @@ -2234,8 +2235,8 @@ extern SDL_DECLSPEC float SDLCALL SDL_GetWindowOpacity(SDL_Window *window); * * \param modal_window the window that should be set modal. * \param parent_window the parent window for the modal window. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -2247,8 +2248,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetWindowModalFor(SDL_Window *modal_win * \param window the window to set focusable state. * \param focusable SDL_TRUE to allow input focus, SDL_FALSE to not allow * input focus. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -2271,8 +2272,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetWindowFocusable(SDL_Window *window, * the client area. * \param y the y coordinate of the menu, relative to the origin (top-left) of * the client area. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -2348,8 +2349,8 @@ typedef SDL_HitTestResult (SDLCALL *SDL_HitTest)(SDL_Window *win, * \param window the window to set hit-testing on. * \param callback the function to call when doing a hit-test. * \param callback_data an app-defined void pointer passed to **callback**. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -2372,8 +2373,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetWindowHitTest(SDL_Window *window, SD * \param window the window. * \param shape the surface representing the shape of the window, or NULL to * remove any current shape. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -2384,8 +2385,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_SetWindowShape(SDL_Window *window, SDL_ * * \param window the window to be flashed. * \param operation the operation to perform. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -2428,8 +2429,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_ScreenSaverEnabled(void); /** * Allow the screen to be blanked by a screen saver. * - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -2447,8 +2448,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_EnableScreenSaver(void); * The screensaver is disabled by default, but this may by changed by * SDL_HINT_VIDEO_ALLOW_SCREENSAVER. * - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -2475,8 +2476,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_DisableScreenSaver(void); * * \param path the platform dependent OpenGL library name, or NULL to open the * default OpenGL library. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -2606,8 +2607,8 @@ extern SDL_DECLSPEC void SDLCALL SDL_GL_ResetAttributes(void); * \param attr an SDL_GLattr enum value specifying the OpenGL attribute to * set. * \param value the desired value for the attribute. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -2622,8 +2623,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GL_SetAttribute(SDL_GLattr attr, int va * \param attr an SDL_GLattr enum value specifying the OpenGL attribute to * get. * \param value a pointer filled in with the current value of `attr`. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -2661,8 +2662,8 @@ extern SDL_DECLSPEC SDL_GLContext SDLCALL SDL_GL_CreateContext(SDL_Window *windo * * \param window the window to associate with the context. * \param context the OpenGL context to associate with the window. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -2757,8 +2758,8 @@ extern SDL_DECLSPEC void SDLCALL SDL_EGL_SetAttributeCallbacks(SDL_EGLAttribArra * the vertical retrace for a given frame, it swaps buffers immediately, which * might be less jarring for the user during occasional framerate drops. If an * application requests adaptive vsync and the system does not support it, - * this function will fail and return SDL_FALSE. In such a case, you should probably - * retry the call with 1 for the interval. + * this function will fail and return SDL_FALSE. In such a case, you should + * probably retry the call with 1 for the interval. * * Adaptive vsync is implemented for some glX drivers with * GLX_EXT_swap_control_tear, and for some Windows drivers with @@ -2769,8 +2770,8 @@ extern SDL_DECLSPEC void SDLCALL SDL_EGL_SetAttributeCallbacks(SDL_EGLAttribArra * * \param interval 0 for immediate updates, 1 for updates synchronized with * the vertical retrace, -1 for adaptive vsync. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -2788,8 +2789,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GL_SetSwapInterval(int interval); * synchronization, 1 if the buffer swap is synchronized with * the vertical retrace, and -1 if late swaps happen * immediately instead of waiting for the next retrace. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -2808,8 +2809,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GL_GetSwapInterval(int *interval); * extra. * * \param window the window to change. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. */ @@ -2819,8 +2820,8 @@ extern SDL_DECLSPEC SDL_bool SDLCALL SDL_GL_SwapWindow(SDL_Window *window); * Delete an OpenGL context. * * \param context the OpenGL context to be deleted. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * diff --git a/include/SDL3/SDL_vulkan.h b/include/SDL3/SDL_vulkan.h index d724e19a6d..c31d33c1a5 100644 --- a/include/SDL3/SDL_vulkan.h +++ b/include/SDL3/SDL_vulkan.h @@ -95,8 +95,8 @@ struct VkAllocationCallbacks; * library version. * * \param path the platform dependent Vulkan loader library name or NULL. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. * @@ -175,8 +175,8 @@ extern SDL_DECLSPEC char const * const * SDLCALL SDL_Vulkan_GetInstanceExtension * allocator that creates the surface. Can be NULL. * \param surface a pointer to a VkSurfaceKHR handle to output the newly * created surface. - * \returns SDL_TRUE on success or SDL_FALSE on failure; call - * SDL_GetError() for more information. + * \returns SDL_TRUE on success or SDL_FALSE on failure; call SDL_GetError() + * for more information. * * \since This function is available since SDL 3.0.0. *