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
Pierre Wendling dcfa127fd4 N3DS: Document the SDL_GetBasePath behaviour. 3 years ago
..
CONTRIBUTING.md Add contributing guidelines. 3 years ago
README-android.md Update minimal required Android SDK version 3 years ago
README-cmake.md Expand CMake documentation a bit (#5961) 3 years ago
README-directfb.md Clean up formatting in README-directfb.md 4 years ago
README-dynapi.md README-dynapi.md: Google+ link is gone, remove it. 4 years ago
README-emscripten.md docs: Add notes about Emscripten audio quirks. 3 years ago
README-gdk.md Xbox GDKX support (#5869) 3 years ago
README-gesture.md Fixed crash if initialization of EGL failed but was tried again later. 10 years ago
README-git.md Revert "Update wiki.libsdl.org urls to libsdl-org/SDL/wiki (#4069)" 5 years ago
README-hg.md Deprecate SDL_GetRevisionNumber and update things for git instead of hg. 5 years ago
README-ios.md iOS: remove dead pre-iOS 8 codepaths. 3 years ago
README-kmsbsd.md KMSDRM on Dragonfly BSD doesn't work without being root 4 years ago
README-linux.md Update the list of required Ubuntu packages, and add Ubuntu 22.04 workflows 3 years ago
README-macos.md Updated minimum OS targets on Apple platforms to match supported platforms using Xcode 13 3 years ago
README-n3ds.md N3DS: Document the SDL_GetBasePath behaviour. 3 years ago
README-nacl.md Converted README documentation to DOS text format 9 years ago
README-ngage.md N-Gage port: add changes from code reviews, overall cleanup (#5618) 3 years ago
README-os2.md fixed typo: ervironment to environment 4 years ago
README-pandora.md Converted README documentation to DOS text format 9 years ago
README-platforms.md Revert "Update wiki.libsdl.org urls to libsdl-org/SDL/wiki (#4069)" 5 years ago
README-porting.md docs: Replace references to configure.in with configure.ac 7 years ago
README-ps2.md Adding specific SDL_Hint for the dynamic VSYNC 3 years ago
README-psp.md Updating Readme-psp info 4 years ago
README-raspberrypi.md x11: Remove XVidMode and Xinerama support. 3 years ago
README-riscos.md docs: Add README-riscos.md 4 years ago
README-touch.md Converted README documentation to DOS text format 9 years ago
README-versions.md docs: Document new versioning scheme 3 years ago
README-visualc.md Remove URLs from markdown headers in README-visualc.md 4 years ago
README-vita.md Vita: fix readme 4 years ago
README-wince.md Converted README documentation to DOS text format 9 years ago
README-windows.md README-windows: Notes on building with Visual Studio/LLVM. 4 years ago
README-winrt.md README-winrt.md: Updates for newer build details. 3 years ago
README.md Update README.md 3 years ago
doxyfile docs/release_checklist.md: Document how/where to bump version numbers 3 years ago
release_checklist.md Added a note to update the website after a stable release 3 years 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 via OpenGL and Direct3D. 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".

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.

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