SDL/docs
2026-04-27 18:04:02 +03:00
..
doxyfile CodeSpell 2026-02-07 18:14:00 +03:00
hello.c Updated copyright for 2026 2026-01-01 09:40:08 -08:00
INTRO-androidstudio.md Added https://github.com/Ravbug/sdl3-sample as a more complete Android example 2025-01-14 12:22:00 -08:00
INTRO-cmake.md Added MinGW Intro readme, touched up CMake and Visual Studio readmes. (#12485) 2025-03-06 16:24:16 -08:00
INTRO-emscripten.md Sync SDL3 wiki -> header 2025-11-21 14:41:25 +00:00
INTRO-mingw.md Sync SDL3 wiki -> header 2025-11-21 14:41:25 +00:00
INTRO-visualstudio.md Added MinGW Intro readme, touched up CMake and Visual Studio readmes. (#12485) 2025-03-06 16:24:16 -08:00
INTRO-xcode.md CodeSpell 2026-02-07 18:14:00 +03:00
README-android.md Updated documentation on customizing your Android app name 2026-03-21 16:03:40 -07:00
README-bsd.md Document SDL's policy on setuid/setgid executables 2025-12-28 10:14:57 -08:00
README-cmake.md Fix a broken link inside README-cmake.md that's meant to send to README-linux.md 2025-06-10 18:46:35 -04:00
README-contributing.md ci: add option to set ctest arguments 2026-04-11 04:12:15 +02:00
README-documentation-rules.md Sync SDL3 wiki -> header 2025-09-13 00:23:10 +00:00
README-dos.md Add DOS platform support (DJGPP) (#15377) 2026-04-23 19:54:49 -04:00
README-dynapi.md Removed SDL_bool in favor of plain bool 2024-09-18 08:32:30 -07:00
README-emscripten.md emscripten: Add support for automounting persistent storage before SDL_main. 2026-03-25 14:16:07 -04:00
README-gdk.md Sync SDL3 wiki -> header 2026-02-24 15:05:20 +00:00
README-haiku.md Updated README-platforms.md 2025-01-16 16:21:18 -08:00
README-highdpi.md More clarification for high DPI support 2025-03-31 18:53:40 -07:00
README-ios.md Added documentation for getting the full resolution in iOS 2026-03-27 08:43:30 -07:00
README-kmsbsd.md docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05:00
README-linux.md Document SDL's policy on setuid/setgid executables 2025-12-28 10:14:57 -08:00
README-macos.md Added documentation to fix building on macOS with Xcode 12.2 (thanks @buhman!) 2026-04-01 16:37:14 -07:00
README-main-functions.md Documentation tweak 2025-12-05 11:14:38 -08:00
README-migration.md CodeSpell 2026-02-07 18:14:00 +03:00
README-n3ds.md docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05:00
README-ngage.md [N-Gage] Remove optimisations except for native texture handling prior to some rework of the rendering back-end 2026-04-18 19:54:30 +02:00
README-platforms.md docs/README-platforms.md: Add DOS. 2026-04-27 18:04:02 +03:00
README-porting.md winrt: Removed WinRT/Windows Phone/UWP support. 2024-09-06 13:28:39 -04:00
README-ps2.md Documented environment setup for PS2 development 2025-10-12 09:20:00 -07:00
README-ps4.md Updated README-platforms.md 2025-01-16 16:21:18 -08:00
README-ps5.md Updated README-platforms.md 2025-01-16 16:21:18 -08:00
README-psp.md Sync SDL3 wiki -> header 2025-04-10 17:52:25 +00:00
README-qnx.md Up-to-date QNX support (#14806) 2026-01-30 15:32:43 -08:00
README-riscos.md docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05:00
README-steamos.md Updated README-platforms.md 2025-01-16 16:21:18 -08:00
README-strings.md Removed temporary memory from the API 2024-07-26 20:59:14 -07:00
README-switch.md README-switch.md: Updated to mention Switch 2. 2025-10-14 14:18:35 -04:00
README-touch.md Sync SDL3 wiki -> header 2024-12-17 07:29:13 +00:00
README-versions.md Updated version documentation to match SDL 3.x practice 2025-04-07 10:22:42 -07:00
README-vita.md Sync SDL3 wiki -> header 2025-01-09 20:15:17 +00:00
README-wayland.md CodeSpell 2026-02-07 18:14:00 +03:00
README-windows.md minor update to mingw-w64 build instructions. 2025-01-14 05:04:24 +03:00
README-xr.md Sync SDL3 wiki -> header 2026-02-23 16:15:38 +00:00
README.md Updated README-platforms.md 2025-01-16 16:21:18 -08:00
release_checklist.md Added a note to tag the wiki when doing feature releases 2025-03-24 11:45:20 -07:00

Simple DirectMedia Layer

https://www.libsdl.org/

Simple DirectMedia Layer is a cross-platform development library designed to provide low level access to audio, keyboard, mouse, joystick, and graphics hardware. It is used by video playback software, emulators, and popular games including Valve's award winning catalog and many Humble Bundle games.

SDL officially supports Windows, macOS, Linux, iOS, Android, Xbox, PlayStation 4/5, Nintendo Switch, and many other platforms.

SDL is written in C, works natively with C++, and there are bindings available for several other languages, including C# and Python.

This library is distributed under the zlib license, which can be found in the file "LICENSE.txt".

Information on building SDL with CMake is available in README-cmake.md

The best way to learn how to use SDL is to check out the header files in the "include" subdirectory and the programs in the "examples" subdirectory. The header files and test programs are well commented and always up to date.

Information on reporting bugs and contributing is available in README-contributing.md

More documentation and FAQs are available online at the wiki

If you need help with the library, or just want to discuss SDL related issues, you can join the SDL Discourse, which can be used as a web forum or a mailing list, at your preference.

If you want to report bugs or contribute patches, please submit them to our bug tracker

Enjoy!

Sam Lantinga mailto:slouken@libsdl.org