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 bca0f114eb
commit fda1375d4e
3 changed files with 63 additions and 2 deletions

View file

@ -491,6 +491,27 @@ extern "C" {
*/
#define SDL_HINT_WINRT_HANDLE_BACK_BUTTON "SDL_WINRT_HANDLE_BACK_BUTTON"
/**
* \brief A variable that dictates what SDL_GetPrefPath() returns in WinRT apps.
*
* The variable can be set to the following values:
* "local" - Use the app's 'local' folder to store data; default for
* Windows Phone apps.
* "roaming" - Use the app's 'roaming' folder to store data; default for
* Windows Store (non-Phone) apps. On Windows Phone 8.0, this
* setting will be ignored (and the 'local' folder will be used
* instead), as the OS does not support roaming folders.
*
* Details on 'local' verses 'roaming' folders can be found on MSDN, in the
* documentation for WinRT's Windows.Storage.ApplicationData class, which is
* available at http://msdn.microsoft.com/en-us/library/windows/apps/windows.storage.applicationdata
*
* The application's local and roaming paths may, alternatively, be retrieved
* via the SDL_WinRTGetFSPathUTF8() and SDL_WinRTGetFSPathUNICODE() functions,
* which are defined in SDL_system.h.
*/
#define SDL_HINT_WINRT_PREF_PATH_ROOT "SDL_WINRT_PREF_PATH_ROOT"
/**
* \brief A variable that dictates policy for fullscreen Spaces on Mac OS X.
*