include/SDL_hints.h
changeset 9247 eddb899239fe
parent 9242 f4d353bd5d16
child 9255 c2ef0d8d6da0
child 9531 b7ad394978b1
     1.1 --- a/include/SDL_hints.h	Fri Nov 28 04:51:33 2014 -0800
     1.2 +++ b/include/SDL_hints.h	Sat Nov 29 10:09:30 2014 -0500
     1.3 @@ -495,16 +495,25 @@
     1.4   *  \brief  A variable that dictates what SDL_GetPrefPath() returns in WinRT apps.
     1.5   *
     1.6   *  The variable can be set to the following values:
     1.7 - *    "local"   - Use the app's 'local' folder to store data; default for
     1.8 - *                Windows Phone apps.
     1.9 - *    "roaming" - Use the app's 'roaming' folder to store data; default for
    1.10 - *                Windows Store (non-Phone) apps.  On Windows Phone 8.0, this
    1.11 - *                setting will be ignored (and the 'local' folder will be used
    1.12 - *                instead), as the OS does not support roaming folders.
    1.13 + *   * "local"   - Use the app's 'local' folder to store data.
    1.14 + *   * "roaming" - Use the app's 'roaming' folder to store data.
    1.15 + *                 On Windows Phone 8.0, this setting is not supported due to
    1.16 + *                 limitations in the OS itself.  Attempts to use this (via
    1.17 + *                 SDL_GetPrefPath()) on Windows Phone 8.0 will fail, with
    1.18 + *                 SDL_GetPrefPath() returning NULL.  (Windows Phone 8.1 does,
    1.19 + *                 however, support roaming folders.)
    1.20 + *   * "old"     - Use the app's 'local' folder on Windows Phone, and 'roaming'
    1.21 + *                 on non-Phone versions of WinRT.  This mimics behavior found
    1.22 + *                 in SDL 2.0.3's implementation of SDL_GetPrefPath() for WinRT
    1.23 + *                 (and was changed for SDL 2.0.4, further details of which are
    1.24 + *                 in the "Caveats" section of SDL's
    1.25 + *                 [WinRT README file](README-winrt.md).
    1.26   *
    1.27 - *  Details on 'local' verses 'roaming' folders can be found on MSDN, in the
    1.28 - *  documentation for WinRT's Windows.Storage.ApplicationData class, which is
    1.29 - *  available at http://msdn.microsoft.com/en-us/library/windows/apps/windows.storage.applicationdata
    1.30 + *  The default is to use the app's "local" folder.
    1.31 + *
    1.32 + *  Details on 'local' verses 'roaming' folders can be found on MSDN, in
    1.33 + *  the documentation for WinRT's Windows.Storage.ApplicationData class,
    1.34 + *  (available at http://msdn.microsoft.com/en-us/library/windows/apps/windows.storage.applicationdata ).
    1.35   *
    1.36   *  The application's local and roaming paths may, alternatively, be retrieved
    1.37   *  via the SDL_WinRTGetFSPathUTF8() and SDL_WinRTGetFSPathUNICODE() functions,