Ryan C. Gordon e23257307e Introduce formal policy for APIs that return strings. ...

This declares that any `const char *` returned from SDL is owned by SDL, and
promises to be valid _at least_ until the next time the event queue runs, or
SDL_Quit() is called, even if the thing that owns the string gets destroyed
or changed before then.

This is noted in the headers as "the SDL_GetStringRule", so this will both be
greppable to find a detailed explaination in docs/README-strings.md and
wikiheaders will automatically turn it into a link we can point at the
appropriate documentation.

Fixes #9902.

(and several FIXMEs, both known and yet-undocumented.)

2024-06-03 14:20:49 -04:00

..

SDL_assert.h

SDL_assert: add support for aarch64-w64-mingw32

2024-06-03 10:55:14 -07:00

SDL_atomic.h

Sync SDL3 wiki -> header

2024-05-22 00:41:09 +00:00

SDL_audio.h

Introduce formal policy for APIs that return strings.

2024-06-03 14:20:49 -04:00

SDL_begin_code.h

Renamed DECLSPEC to SDL_DECLSPEC

2024-05-17 17:09:09 -07:00

SDL_bits.h

wikiheaders: bridge wiki Category docs to the headers!

2024-05-16 11:48:23 -04:00

SDL_blendmode.h

Renamed DECLSPEC to SDL_DECLSPEC

2024-05-17 17:09:09 -07:00

SDL_camera.h

Introduce formal policy for APIs that return strings.

2024-06-03 14:20:49 -04:00

SDL_clipboard.h

Renamed DECLSPEC to SDL_DECLSPEC

2024-05-17 17:09:09 -07:00

SDL_close_code.h

wikiheaders: bridge wiki Category docs to the headers!

2024-05-16 11:48:23 -04:00

SDL_copying.h

wikiheaders: bridge wiki Category docs to the headers!

2024-05-16 11:48:23 -04:00

SDL_cpuinfo.h

Renamed DECLSPEC to SDL_DECLSPEC

2024-05-17 17:09:09 -07:00

SDL_dialog.h

dialog: fixed typo in docs.

2024-05-22 14:26:50 -04:00

SDL_egl.h

wikiheaders: bridge wiki Category docs to the headers!

2024-05-16 11:48:23 -04:00

SDL_endian.h

wikiheaders: bridge wiki Category docs to the headers!

2024-05-16 11:48:23 -04:00

SDL_error.h

Introduce formal policy for APIs that return strings.

2024-06-03 14:20:49 -04:00

SDL_events.h

Note that you can redraw in response to SDL_EVENT_WINDOW_EXPOSED from an event watch callback

2024-05-27 08:06:13 -07:00

SDL_filesystem.h

Renamed DECLSPEC to SDL_DECLSPEC

2024-05-17 17:09:09 -07:00

SDL_gamepad.h

Introduce formal policy for APIs that return strings.

2024-06-03 14:20:49 -04:00

SDL_guid.h

Renamed DECLSPEC to SDL_DECLSPEC

2024-05-17 17:09:09 -07:00

SDL_haptic.h

Introduce formal policy for APIs that return strings.

2024-06-03 14:20:49 -04:00

SDL_hidapi.h

Sync SDL3 wiki -> header

2024-05-20 16:46:41 +00:00

SDL_hints.h

Introduce formal policy for APIs that return strings.

2024-06-03 14:20:49 -04:00

SDL_init.h

Renamed DECLSPEC to SDL_DECLSPEC

2024-05-17 17:09:09 -07:00

SDL_intrin.h

wikiheaders: bridge wiki Category docs to the headers!

2024-05-16 11:48:23 -04:00

SDL_iostream.h

Renamed DECLSPEC to SDL_DECLSPEC

2024-05-17 17:09:09 -07:00

SDL_joystick.h

Introduce formal policy for APIs that return strings.

2024-06-03 14:20:49 -04:00

SDL_keyboard.h

Introduce formal policy for APIs that return strings.

2024-06-03 14:20:49 -04:00

SDL_keycode.h

wikiheaders: bridge wiki Category docs to the headers!

2024-05-16 11:48:23 -04:00

SDL_loadso.h

Renamed DECLSPEC to SDL_DECLSPEC

2024-05-17 17:09:09 -07:00

SDL_locale.h

Renamed DECLSPEC to SDL_DECLSPEC

2024-05-17 17:09:09 -07:00

SDL_log.h

Renamed DECLSPEC to SDL_DECLSPEC

2024-05-17 17:09:09 -07:00

SDL_main_impl.h

wikiheaders: Automatically categorize API symbols by subsystem.

2024-05-14 13:30:42 -04:00

SDL_main.h

Sync SDL3 wiki -> header

2024-05-27 20:04:46 +00:00

SDL_messagebox.h

Renamed DECLSPEC to SDL_DECLSPEC

2024-05-17 17:09:09 -07:00

SDL_metal.h

Renamed DECLSPEC to SDL_DECLSPEC

2024-05-17 17:09:09 -07:00

SDL_misc.h

Renamed DECLSPEC to SDL_DECLSPEC

2024-05-17 17:09:09 -07:00

SDL_mouse.h

Introduce formal policy for APIs that return strings.

2024-06-03 14:20:49 -04:00

SDL_mutex.h

Sync SDL3 wiki -> header

2024-05-27 02:00:01 +00:00

SDL_oldnames.h

SDL_SystemCursor: rename enum items to match CSS.

2024-06-01 22:32:43 -04:00

SDL_opengl_glext.h

replaced line comments in public header.

2023-02-04 10:02:10 +03:00

SDL_opengl.h

wikiheaders: bridge wiki Category docs to the headers!

2024-05-16 11:48:23 -04:00

SDL_opengles2_gl2.h

Switch header convention from #include "SDL.h" to #include <SDL3/SDLh>

2022-11-26 22:15:18 -08:00

SDL_opengles2_gl2ext.h

Switch header convention from #include "SDL.h" to #include <SDL3/SDLh>

2022-11-26 22:15:18 -08:00

SDL_opengles2_gl2platform.h

Switch header convention from #include "SDL.h" to #include <SDL3/SDLh>

2022-11-26 22:15:18 -08:00

SDL_opengles2_khrplatform.h

Switch header convention from #include "SDL.h" to #include <SDL3/SDLh>

2022-11-26 22:15:18 -08:00

SDL_opengles2.h

wikiheaders: bridge wiki Category docs to the headers!

2024-05-16 11:48:23 -04:00

SDL_opengles.h

wikiheaders: bridge wiki Category docs to the headers!

2024-05-16 11:48:23 -04:00

SDL_pen.h

Introduce formal policy for APIs that return strings.

2024-06-03 14:20:49 -04:00

SDL_pixels.h

Introduce formal policy for APIs that return strings.

2024-06-03 14:20:49 -04:00

SDL_platform_defines.h

Fixed compiling SDL_platform_defines.h on macOS with older compilers (thanks @sezero!)

2024-05-27 14:34:21 -07:00

SDL_platform.h

Introduce formal policy for APIs that return strings.

2024-06-03 14:20:49 -04:00

SDL_power.h

Renamed DECLSPEC to SDL_DECLSPEC

2024-05-17 17:09:09 -07:00

SDL_properties.h

Introduce formal policy for APIs that return strings.

2024-06-03 14:20:49 -04:00

SDL_rect.h

Renamed DECLSPEC to SDL_DECLSPEC

2024-05-17 17:09:09 -07:00

SDL_render.h

Introduce formal policy for APIs that return strings.

2024-06-03 14:20:49 -04:00

SDL_revision.h

wikiheaders: bridge wiki Category docs to the headers!

2024-05-16 11:48:23 -04:00

SDL_scancode.h

wikiheaders: bridge wiki Category docs to the headers!

2024-05-16 11:48:23 -04:00

SDL_sensor.h

Introduce formal policy for APIs that return strings.

2024-06-03 14:20:49 -04:00

SDL_stdinc.h

always define PRI?64 using 'I64' when targeting windows

2024-06-01 22:35:40 +03:00

SDL_storage.h

Renamed DECLSPEC to SDL_DECLSPEC

2024-05-17 17:09:09 -07:00

SDL_surface.h

Sync SDL3 wiki -> header

2024-05-27 02:00:01 +00:00

SDL_system.h

Introduce formal policy for APIs that return strings.

2024-06-03 14:20:49 -04:00

SDL_test_assert.h

wikiheaders: bridge wiki Category docs to the headers!

2024-05-16 11:48:23 -04:00

SDL_test_common.h

Added SDL_SetWindowAspectRatio() and SDL_GetWindowAspectRatio()

2024-05-28 11:52:31 -07:00

SDL_test_compare.h

Add SDLTest_CompareMemory function to compare memory ranges

2024-04-15 03:05:05 -10:00

SDL_test_crc32.h

wikiheaders: bridge wiki Category docs to the headers!

2024-05-16 11:48:23 -04:00

SDL_test_font.h

include: A ton of little documentation tweaks, fixes, and improvements.

2024-04-09 00:50:02 -04:00

SDL_test_fuzzer.h

wikiheaders: bridge wiki Category docs to the headers!

2024-05-16 11:48:23 -04:00

SDL_test_harness.h

include: A ton of little documentation tweaks, fixes, and improvements.

2024-04-09 00:50:02 -04:00

SDL_test_log.h

Updated copyright for 2024

2024-01-01 13:15:26 -08:00

SDL_test_md5.h

Named typedef-ed structs Gave name to structs that were defined like anonymous struct with name given by typedef. Example 'typedef struct {...} Foo;' -> 'typedef struct Foo {...} Foo;'

2024-03-10 09:04:18 -07:00

SDL_test_memory.h

Updated copyright for 2024

2024-01-01 13:15:26 -08:00

SDL_test_random.h

Named typedef-ed structs Gave name to structs that were defined like anonymous struct with name given by typedef. Example 'typedef struct {...} Foo;' -> 'typedef struct Foo {...} Foo;'

2024-03-10 09:04:18 -07:00

SDL_test.h

Updated copyright for 2024

2024-01-01 13:15:26 -08:00

SDL_thread.h

Introduce formal policy for APIs that return strings.

2024-06-03 14:20:49 -04:00

SDL_time.h

Renamed DECLSPEC to SDL_DECLSPEC

2024-05-17 17:09:09 -07:00

SDL_timer.h

Sync SDL3 wiki -> header

2024-05-27 14:58:03 +00:00

SDL_touch.h

Introduce formal policy for APIs that return strings.

2024-06-03 14:20:49 -04:00

SDL_version.h

Introduce formal policy for APIs that return strings.

2024-06-03 14:20:49 -04:00

SDL_video.h

Introduce formal policy for APIs that return strings.

2024-06-03 14:20:49 -04:00

SDL_vulkan.h

Renamed DECLSPEC to SDL_DECLSPEC

2024-05-17 17:09:09 -07:00

SDL.h

Moved the SDL version back to SDL_version.h

2024-05-15 14:38:29 -07:00