annotate SDL3/SDL.h @ 1:20d02a178406 default tip

*: check in everything else yay
author Paper <paper@tflc.us>
date Mon, 05 Jan 2026 02:15:46 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
1 /*
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
2 Simple DirectMedia Layer
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
3 Copyright (C) 1997-2025 Sam Lantinga <slouken@libsdl.org>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
4
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
5 This software is provided 'as-is', without any express or implied
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
6 warranty. In no event will the authors be held liable for any damages
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
7 arising from the use of this software.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
8
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
9 Permission is granted to anyone to use this software for any purpose,
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
10 including commercial applications, and to alter it and redistribute it
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
11 freely, subject to the following restrictions:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
12
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
13 1. The origin of this software must not be misrepresented; you must not
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
14 claim that you wrote the original software. If you use this software
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
15 in a product, an acknowledgment in the product documentation would be
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
16 appreciated but is not required.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
17 2. Altered source versions must be plainly marked as such, and must not be
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
18 misrepresented as being the original software.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
19 3. This notice may not be removed or altered from any source distribution.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
20 */
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
21
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
22 /**
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
23 * Main include header for the SDL library, version 3.4.0
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
24 *
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
25 * It is almost always best to include just this one header instead of
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
26 * picking out individual headers included here. There are exceptions to
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
27 * this rule--SDL_main.h is special and not included here--but usually
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
28 * letting SDL.h include the kitchen sink for you is the correct approach.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
29 */
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
30
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
31 #ifndef SDL_h_
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
32 #define SDL_h_
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
33
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
34 #include <SDL3/SDL_stdinc.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
35 #include <SDL3/SDL_assert.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
36 #include <SDL3/SDL_asyncio.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
37 #include <SDL3/SDL_atomic.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
38 #include <SDL3/SDL_audio.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
39 #include <SDL3/SDL_bits.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
40 #include <SDL3/SDL_blendmode.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
41 #include <SDL3/SDL_camera.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
42 #include <SDL3/SDL_clipboard.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
43 #include <SDL3/SDL_cpuinfo.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
44 #include <SDL3/SDL_dialog.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
45 #include <SDL3/SDL_dlopennote.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
46 #include <SDL3/SDL_endian.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
47 #include <SDL3/SDL_error.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
48 #include <SDL3/SDL_events.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
49 #include <SDL3/SDL_filesystem.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
50 #include <SDL3/SDL_gamepad.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
51 #include <SDL3/SDL_gpu.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
52 #include <SDL3/SDL_guid.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
53 #include <SDL3/SDL_haptic.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
54 #include <SDL3/SDL_hidapi.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
55 #include <SDL3/SDL_hints.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
56 #include <SDL3/SDL_init.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
57 #include <SDL3/SDL_iostream.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
58 #include <SDL3/SDL_joystick.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
59 #include <SDL3/SDL_keyboard.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
60 #include <SDL3/SDL_keycode.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
61 #include <SDL3/SDL_loadso.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
62 #include <SDL3/SDL_locale.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
63 #include <SDL3/SDL_log.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
64 #include <SDL3/SDL_messagebox.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
65 #include <SDL3/SDL_metal.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
66 #include <SDL3/SDL_misc.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
67 #include <SDL3/SDL_mouse.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
68 #include <SDL3/SDL_mutex.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
69 #include <SDL3/SDL_pen.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
70 #include <SDL3/SDL_pixels.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
71 #include <SDL3/SDL_platform.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
72 #include <SDL3/SDL_power.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
73 #include <SDL3/SDL_process.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
74 #include <SDL3/SDL_properties.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
75 #include <SDL3/SDL_rect.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
76 #include <SDL3/SDL_render.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
77 #include <SDL3/SDL_scancode.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
78 #include <SDL3/SDL_sensor.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
79 #include <SDL3/SDL_storage.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
80 #include <SDL3/SDL_surface.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
81 #include <SDL3/SDL_system.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
82 #include <SDL3/SDL_thread.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
83 #include <SDL3/SDL_time.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
84 #include <SDL3/SDL_timer.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
85 #include <SDL3/SDL_tray.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
86 #include <SDL3/SDL_touch.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
87 #include <SDL3/SDL_version.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
88 #include <SDL3/SDL_video.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
89 #include <SDL3/SDL_oldnames.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
90
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
91 #endif /* SDL_h_ */