encounter
/
SDL
mirror of https://github.com/encounter/SDL.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
SDL/docs
History
David Ludwig ce64b4ad3a WinRT: bug and data-integrity fixes for SDL_GetPrefPath() 
This change does a few things, all with regards to the WinRT implementation of
SDL_GetPrefPath():

1. it fixes a bug whereby SDL_GetPrefPath() did not create the directory it
returned.  On other SDL platforms, SDL_GetPrefPath() will create separate
directories for its 'org' and 'app' folders.  Without this, attempts to create
files in the pref-path would fail, unless those directories were first created
by the app, or by some other library the app used.  This change makes sure
that these directories get created, before SDL_GetPrefPath() returns to its
caller(s).


2. it defaults to having SDL_GetPrefPath() return a WinRT 'Local' folder
on all platforms.  Previously, for Windows Store apps, it would have used a
different, 'Roaming' folder.  Files in Roaming folders can be automatically,
and synchronized across multiple devices by Windows.  This synchronization can
happen while the app runs, with new files being copied into a running app's
pref-path.  Unless an app is specifically designed to handle this scenario,
there is a chance that save-data could be overwritten in unwanted or
unexpected ways.

The default is now to use a Local folder, which does not get synchronized, and
which is arguably a bit safer to use.  Apps that wish to use Roaming folders
can do so by setting SDL_HINT_WINRT_PREF_PATH_ROOT to "roaming", however it
is recommended that one first read Microsoft's documentation for Roaming
files, a link to which is provided in README-winrt.md.

To preserve older pref-path selection behavior (found in SDL 2.0.3, as well as
many pre-2.0.4 versions of SDL from hg.libsdl.org), which uses a Roaming path
in Windows Store apps, and a Local path in Windows Phone, set
SDL_HINT_WINRT_PREF_PATH_ROOT to "old".

Please note that Roaming paths are not supported on Windows Phone 8.0, due to
limitations in the OS itself.  Attempts to use this will fail.
(Windows Phone 8.1 does not have this limitation, however.)


3. It makes SDL_GetPrefPath(), when on Windows Phone 8.0, and when
SDL_HINT_WINRT_PREF_PATH_ROOT is set to "roaming", return NULL, rather than
silently defaulting to a Local path (then switching to a Roaming path if and
when the user upgraded to Windows Phone 8.1).
 		2014-11-29 10:09:30 -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: bug and data-integrity fixes for SDL_GetPrefPath() 2014-11-29 10:09:30 -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