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
ritalat 0bc370dfba Android doc cleanup 6 months ago
..
README-android.md Android doc cleanup 6 months ago
README-cmake.md Add version info when building CI/CD for apple platforms 8 months ago
README-contributing.md Document the SDL-specific custom ci commands 10 months ago
README-documentation-rules.md README-documentation-rules.md: Mention not listing types in param/returns docs. 8 months ago
README-dynapi.md Removed SDL_bool in favor of plain bool 10 months ago
README-emscripten.md docs: Updated README-emscripten.md. 9 months ago
README-gdk.md Rename functions in SDL_system.h to match SDL 3.0 naming convention 12 months ago
README-git.md docs: document copying shared SDL3 a bit more + document sanitizer/libc incompatibility 9 months ago
README-highdpi.md Sync SDL3 wiki -> header 9 months ago
README-ios.md Sync SDL3 wiki -> header 6 months ago
README-kmsbsd.md docs: Convert everything to Unix-style endlines. 2 years ago
README-linux.md asyncio: Added Linux io_uring support. 7 months ago
README-macos.md Add version info when building CI/CD for apple platforms 8 months ago
README-main-functions.md docs/README-main-functions.md: reformatted Best Practices section. 7 months ago
README-migration.md README-migration.md: Note the GL/EGL library environment variable removals. 6 months ago
README-n3ds.md docs: Convert everything to Unix-style endlines. 2 years ago
README-ngage.md ngage: Remove Nokia N-Gage support. 7 months ago
README-platforms.md docs: Convert everything to Unix-style endlines. 2 years ago
README-porting.md winrt: Removed WinRT/Windows Phone/UWP support. 10 months ago
README-ps2.md JANITORIAL: Fix typos in comments in various files (#10058) 1 year ago
README-psp.md docs: Convert everything to Unix-style endlines. 2 years ago
README-raspberrypi.md docs/README-raspberrypi.md: Corrected NEON information (thanks, @cmitu!). 8 months ago
README-riscos.md docs: Convert everything to Unix-style endlines. 2 years ago
README-strings.md Removed temporary memory from the API 12 months ago
README-touch.md Sync SDL3 wiki -> header 7 months ago
README-versions.md docs: Convert everything to Unix-style endlines. 2 years ago
README-visualc.md Sync SDL3 wiki -> header 6 months ago
README-vita.md Added thread-safe environment functions 10 months ago
README-wayland.md examples now using SDL_ALPHA_OPAQUE(_FLOAT) for opaque alpha value 9 months ago
README-windows.md Add detailed documentation on building with MinGW64 (#11780) 6 months ago
README.md winrt: Removed WinRT/Windows Phone/UWP support. 10 months ago
doxyfile Don't automatically free temporary memory, let the application call SDL_FreeTemporaryMemory() when it's ready. 12 months ago
release_checklist.md Added a reminder to sign the source archives when creating a release 7 months 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 "test" 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