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
Ethan Lee 225ae6909e Add notes for SDL_WinRTRunApp and SDL2-WinRTResources for non-C++ projects 7 years ago
..
README-android.md Android: add hint SDL_HINT_ANDROID_BLOCK_ON_PAUSE 7 years ago
README-cmake.md Converted README documentation to DOS text format 9 years ago
README-directfb.md Converted README documentation to DOS text format 9 years ago
README-dynapi.md Fixed typos (thanks Martin!) 8 years ago
README-emscripten.md Emscripten: Simplified option name in build script and README. 9 years ago
README-gesture.md Fixed crash if initialization of EGL failed but was tried again later. 11 years ago
README-hg.md README-hg.md: Updated main Mercurial website. 9 years ago
README-ios.md Backed out changeset 2944045e695b, SDL_JOYSTICK_HIDAPI is only used on iOS for Steam Controller support, which is not publicly available. 7 years ago
README-linux.md mir: Removed mir client support. 7 years ago
README-macosx.md docs: Replace references to configure.in with configure.ac 7 years ago
README-nacl.md Converted README documentation to DOS text format 9 years ago
README-pandora.md Converted README documentation to DOS text format 9 years ago
README-platforms.md Converted README documentation to DOS text format 9 years ago
README-porting.md docs: Replace references to configure.in with configure.ac 7 years ago
README-psp.md Converted README documentation to DOS text format 9 years ago
README-raspberrypi.md audio: Added ARM NEON versions of audio converters. 8 years ago
README-touch.md Converted README documentation to DOS text format 9 years ago
README-wince.md Converted README documentation to DOS text format 9 years ago
README-windows.md Be clear that disabling Vulkan surface support disables the entire SDL Vulkan integration 8 years ago
README-winrt.md Add notes for SDL_WinRTRunApp and SDL2-WinRTResources for non-C++ projects 7 years ago
README.md Changed Bugzilla link in README.md to HTTPS like in BUGS.txt. 9 years ago
doxyfile Fixed crash if initialization of EGL failed but was tried again later. 11 years ago

README.md

Simple DirectMedia Layer

                              (SDL)

                            Version 2.0

http://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, Mac OS X, 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 "COPYING.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 developers mailing list

If you want to report bugs or contribute patches, please submit them to bugzilla

Enjoy!

Sam Lantinga mailto:slouken@libsdl.org