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
This commit is contained in:
David Ludwig 2014-11-27 09:55:34 -05:00
parent 506a1efc22
commit ecc014740a
3 changed files with 63 additions and 2 deletions

View file

@ -116,6 +116,32 @@ Here is a rough list of what works, and what doens't:
Caveats
-------
#### SDL_GetPrefPath() usage
SDL_GetPrefPath() is available for use in WinRT apps, however the following
should be noted:
1. It will return different path types, by default, depending on the WinRT
platform. Windows Phone apps will default to using the app's "local" path,
whereas Windows Store (i.e. non-Phone) apps will default to using the app's
"roaming" path. This behavior can be changed by calling SDL_SetHint() with
the key, SDL_HINT_WINRT_PREF_PATH_ROOT, and a value of either "local" or
"roaming".
2. Windows Phone 8.0 does not provide apps access to a "roaming" folder.
Attempts to make SDL_GetPrefPath() return a roaming folder on Windows
Phone 8.0 will be ignored (and a path inside the "local" folder will be
used instead).
Further details on this can be found in the documentation for
SDL_HINT_WINRT_PREF_PATH_ROOT, in SDL_hints.h, as well as the docs for
SDL_WinRT_Path, SDL_WinRTGetFSPathUNICODE, and SDL_WinRTGetFSPathUTF8,
in SDL_system.h.
Setup, High-Level Steps
-----------------------