include/SDL_hints.h
changeset 9242 f4d353bd5d16
parent 9154 3331d2f57704
child 9247 eddb899239fe
     1.1 --- a/include/SDL_hints.h	Thu Nov 27 08:50:11 2014 -0500
     1.2 +++ b/include/SDL_hints.h	Thu Nov 27 09:55:34 2014 -0500
     1.3 @@ -492,6 +492,27 @@
     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; default for
    1.11 + *                Windows Phone apps.
    1.12 + *    "roaming" - Use the app's 'roaming' folder to store data; default for
    1.13 + *                Windows Store (non-Phone) apps.  On Windows Phone 8.0, this
    1.14 + *                setting will be ignored (and the 'local' folder will be used
    1.15 + *                instead), as the OS does not support roaming folders.
    1.16 + *
    1.17 + *  Details on 'local' verses 'roaming' folders can be found on MSDN, in the
    1.18 + *  documentation for WinRT's Windows.Storage.ApplicationData class, which is
    1.19 + *  available at http://msdn.microsoft.com/en-us/library/windows/apps/windows.storage.applicationdata
    1.20 + *
    1.21 + *  The application's local and roaming paths may, alternatively, be retrieved
    1.22 + *  via the SDL_WinRTGetFSPathUTF8() and SDL_WinRTGetFSPathUNICODE() functions,
    1.23 + *  which are defined in SDL_system.h.
    1.24 + */
    1.25 +#define SDL_HINT_WINRT_PREF_PATH_ROOT "SDL_WINRT_PREF_PATH_ROOT"
    1.26 +
    1.27 +/**
    1.28   *  \brief  A variable that dictates policy for fullscreen Spaces on Mac OS X.
    1.29   *
    1.30   *  This hint only applies to Mac OS X.