You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
sdl/docs
Sam Lantinga b2793a2ce2 Removed obsolete Raspberry Pi documentation 4 days ago
..
INTRO-androidstudio.md Added https://github.com/Ravbug/sdl3-sample as a more complete Android example 4 days ago
INTRO-cmake.md Updated README-cmake.md with build instructions for several platforms 4 days ago
INTRO-emscripten.md Added INTRO-emscripten.md 5 days ago
INTRO-visualstudio.md Added INTRO-visualstudio.md 5 days ago
INTRO-xcode.md Added INTRO-xcode.md 5 days ago
README-android.md Revert "Separate android initialization from Activity (#11891)" 1 week ago
README-cmake.md Removed CMakeLists.txt example that says you shouldn't use it 4 days ago
README-contributing.md Minor readability improvement for README-contributing.md 5 days ago
README-documentation-rules.md README-documentation-rules.md: Mention not listing types in param/returns docs. 2 months ago
README-dynapi.md Removed SDL_bool in favor of plain bool 4 months ago
README-emscripten.md Added INTRO-emscripten.md 5 days ago
README-gdk.md Rename functions in SDL_system.h to match SDL 3.0 naming convention 6 months ago
README-git.md Sync SDL3 wiki -> header 5 days ago
README-highdpi.md Sync SDL3 wiki -> header 3 months ago
README-ios.md Bumped deployment requirements for Apple platforms 4 days ago
README-kmsbsd.md docs: Convert everything to Unix-style endlines. 1 year ago
README-linux.md asyncio: Added Linux io_uring support. 2 months ago
README-macos.md Bumped deployment requirements for Apple platforms 4 days ago
README-main-functions.md docs/README-main-functions.md: reformatted Best Practices section. 2 months ago
README-migration.md README-migration: note SDL2 brightness/gamma ramp APIs that have been removed. 7 days ago
README-n3ds.md docs: Convert everything to Unix-style endlines. 1 year ago
README-ngage.md ngage: Remove Nokia N-Gage support. 1 month ago
README-platforms.md docs: Convert everything to Unix-style endlines. 1 year ago
README-porting.md winrt: Removed WinRT/Windows Phone/UWP support. 4 months ago
README-ps2.md JANITORIAL: Fix typos in comments in various files (#10058) 7 months ago
README-psp.md docs: Convert everything to Unix-style endlines. 1 year ago
README-riscos.md docs: Convert everything to Unix-style endlines. 1 year ago
README-strings.md Removed temporary memory from the API 6 months ago
README-touch.md Sync SDL3 wiki -> header 1 month ago
README-versions.md docs: Convert everything to Unix-style endlines. 1 year ago
README-vita.md Sync SDL3 wiki -> header 1 week ago
README-wayland.md examples now using SDL_ALPHA_OPAQUE(_FLOAT) for opaque alpha value 3 months ago
README-windows.md minor update to mingw-w64 build instructions. 5 days ago
README.md Added INTRO-visualstudio.md 5 days ago
doxyfile Don't automatically free temporary memory, let the application call SDL_FreeTemporaryMemory() when it's ready. 6 months ago
hello.c Added INTRO-emscripten.md 5 days ago
release_checklist.md Added a reminder to sign the source archives when creating a release 1 month ago

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, and Android. Support for other platforms may be found in the source code.

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