SDL/docs
David Ludwig ecc014740a WinRT: added SDL_HINT_WINRT_PREF_PATH_ROOT
SDL_HINT_WINRT_PREF_PATH_ROOT allows WinRT apps to alter the path that
SDL_GetPrefPath() returns.  Setting it to "local" uses the app's
OS-defined Local folder, setting it to "roaming" uses the app's OS-defined
Roaming folder.

Roaming folder support is not available in Windows Phone 8.0.  Attempts to
make SDL_GetPrefPath() return a Roaming folder on this OS will be ignored.

Various bits of documentation on this were added to SDL_hints.h, and to
README-winrt.md
2014-11-27 09:55:34 -05:00
..
README-android.md Corrected header file documentation comment. 2014-11-22 22:20:40 +01:00
README-cmake.md Corrected header file documentation comment. 2014-11-22 22:20:40 +01:00
README-directfb.md Corrected header file documentation comment. 2014-11-22 22:20:40 +01:00
README-dynapi.md Corrected header file documentation comment. 2014-11-22 22:20:40 +01:00
README-gesture.md Corrected header file documentation comment. 2014-11-22 22:20:40 +01:00
README-hg.md Corrected header file documentation comment. 2014-11-22 22:20:40 +01:00
README-ios.md Corrected header file documentation comment. 2014-11-22 22:20:40 +01:00
README-linux.md Corrected header file documentation comment. 2014-11-22 22:20:40 +01:00
README-macosx.md Corrected header file documentation comment. 2014-11-22 22:20:40 +01:00
README-nacl.md Corrected header file documentation comment. 2014-11-22 22:20:40 +01:00
README-pandora.md Corrected header file documentation comment. 2014-11-22 22:20:40 +01:00
README-platforms.md Corrected header file documentation comment. 2014-11-22 22:20:40 +01:00
README-porting.md Corrected header file documentation comment. 2014-11-22 22:20:40 +01:00
README-psp.md Corrected header file documentation comment. 2014-11-22 22:20:40 +01:00
README-raspberrypi.md Corrected header file documentation comment. 2014-11-22 22:20:40 +01:00
README-touch.md Corrected header file documentation comment. 2014-11-22 22:20:40 +01:00
README-wince.md Corrected header file documentation comment. 2014-11-22 22:20:40 +01:00
README-windows.md Corrected header file documentation comment. 2014-11-22 22:20:40 +01:00
README-winrt.md WinRT: added SDL_HINT_WINRT_PREF_PATH_ROOT 2014-11-27 09:55:34 -05:00
README.md Corrected header file documentation comment. 2014-11-22 22:20:40 +01:00
doxyfile Corrected header file documentation comment. 2014-11-22 22:20:40 +01:00

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