eden-emu/SDL
14
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-05-14 16:58:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
SDL/docs
History
Exact
GamesTrap 3f2226a917 Add progress bar support for Linux
2025-05-10 07:53:36 -07:00
..
doxyfile Don't automatically free temporary memory, let the application call SDL_FreeTemporaryMemory() when it's ready. 2024-07-26 10:05:03 -07:00
hello.c Remove newlines from log messages 2025-01-22 20:25:04 -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 Tweaked emscripten introduction 2025-01-22 13:05:44 -08:00
INTRO-mingw.md Fixup the mingw readme cmakelists 2025-03-11 19:42:28 -07: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 Added INTRO-xcode.md 2025-01-13 16:42:50 -08:00
README-android.md Sync SDL3 wiki -> header 2025-04-10 17:25:30 +00:00
README-bsd.md Updated README-platforms.md 2025-01-16 16:21:18 -08:00
README-cmake.md docs: Tweak some minor things to keep wikiheaders happy. 2025-05-05 23:34:20 -04:00
README-contributing.md Minor readability improvement for README-contributing.md 2025-01-13 16:42:50 -08:00
README-documentation-rules.md Sync SDL3 wiki -> header 2025-05-06 17:21:29 +00:00
README-dynapi.md Removed SDL_bool in favor of plain bool 2024-09-18 08:32:30 -07:00
README-emscripten.md Sync SDL3 wiki -> header 2025-05-07 05:54:39 +00:00
README-gdk.md Rename functions in SDL_system.h to match SDL 3.0 naming convention 2024-07-15 16:27:48 -07: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 Updates SDL_SetEventFilter code snippet to SDL3 2025-03-20 16:42:34 -07:00
README-kmsbsd.md docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05:00
README-linux.md Added support for using XTest to warp the mouse 2025-03-05 13:23:02 -08:00
README-macos.md Bumped deployment requirements for Apple platforms 2025-01-14 12:03:07 -08:00
README-main-functions.md docs/README-main-functions.md: reformatted Best Practices section. 2024-11-28 00:19:55 -05:00
README-migration.md android: reduce visiblity as much as possible 2025-03-19 23:36:08 +01:00
README-n3ds.md docs: Convert everything to Unix-style endlines. 2023-11-29 11:29:57 -05:00
README-ngage.md ngage: Remove Nokia N-Gage support. 2024-12-11 13:29:43 -05:00
README-platforms.md Updated README-platforms.md 2025-01-16 16:21:18 -08:00
README-porting.md winrt: Removed WinRT/Windows Phone/UWP support. 2024-09-06 13:28:39 -04:00
README-ps2.md JANITORIAL: Fix typos in comments in various files (#10058) 2024-06-19 07:13:46 -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-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 Updated README-platforms.md 2025-01-16 16:21:18 -08: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 Add progress bar support for Linux 2025-05-10 07:53:36 -07:00
README-windows.md minor update to mingw-w64 build instructions. 2025-01-14 05:04:24 +03: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

README.md

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