include/SDL_hints.h
branchiOS-improvements
changeset 9531 b7ad394978b1
parent 9521 4c218c80b34d
parent 9247 eddb899239fe
child 9533 e5693e855338
     1.1 --- a/include/SDL_hints.h	Mon Dec 01 07:31:22 2014 -0400
     1.2 +++ b/include/SDL_hints.h	Tue Dec 02 02:52:45 2014 -0400
     1.3 @@ -493,6 +493,36 @@
     1.4  #define SDL_HINT_WINRT_HANDLE_BACK_BUTTON "SDL_WINRT_HANDLE_BACK_BUTTON"
     1.5  
     1.6  /**
     1.7 + *  \brief  A variable that dictates what SDL_GetPrefPath() returns in WinRT apps.
     1.8 + *
     1.9 + *  The variable can be set to the following values:
    1.10 + *   * "local"   - Use the app's 'local' folder to store data.
    1.11 + *   * "roaming" - Use the app's 'roaming' folder to store data.
    1.12 + *                 On Windows Phone 8.0, this setting is not supported due to
    1.13 + *                 limitations in the OS itself.  Attempts to use this (via
    1.14 + *                 SDL_GetPrefPath()) on Windows Phone 8.0 will fail, with
    1.15 + *                 SDL_GetPrefPath() returning NULL.  (Windows Phone 8.1 does,
    1.16 + *                 however, support roaming folders.)
    1.17 + *   * "old"     - Use the app's 'local' folder on Windows Phone, and 'roaming'
    1.18 + *                 on non-Phone versions of WinRT.  This mimics behavior found
    1.19 + *                 in SDL 2.0.3's implementation of SDL_GetPrefPath() for WinRT
    1.20 + *                 (and was changed for SDL 2.0.4, further details of which are
    1.21 + *                 in the "Caveats" section of SDL's
    1.22 + *                 [WinRT README file](README-winrt.md).
    1.23 + *
    1.24 + *  The default is to use the app's "local" folder.
    1.25 + *
    1.26 + *  Details on 'local' verses 'roaming' folders can be found on MSDN, in
    1.27 + *  the documentation for WinRT's Windows.Storage.ApplicationData class,
    1.28 + *  (available at http://msdn.microsoft.com/en-us/library/windows/apps/windows.storage.applicationdata ).
    1.29 + *
    1.30 + *  The application's local and roaming paths may, alternatively, be retrieved
    1.31 + *  via the SDL_WinRTGetFSPathUTF8() and SDL_WinRTGetFSPathUNICODE() functions,
    1.32 + *  which are defined in SDL_system.h.
    1.33 + */
    1.34 +#define SDL_HINT_WINRT_PREF_PATH_ROOT "SDL_WINRT_PREF_PATH_ROOT"
    1.35 +
    1.36 +/**
    1.37   *  \brief  A variable that dictates policy for fullscreen Spaces on Mac OS X.
    1.38   *
    1.39   *  This hint only applies to Mac OS X.