docs/README-winrt.md
changeset 9242 f4d353bd5d16
parent 9224 bc074eca6597
child 9247 eddb899239fe
     1.1 --- a/docs/README-winrt.md	Thu Nov 27 08:50:11 2014 -0500
     1.2 +++ b/docs/README-winrt.md	Thu Nov 27 09:55:34 2014 -0500
     1.3 @@ -116,6 +116,32 @@
     1.4  
     1.5  
     1.6  
     1.7 +Caveats
     1.8 +-------
     1.9 +
    1.10 +#### SDL_GetPrefPath() usage
    1.11 +
    1.12 +SDL_GetPrefPath() is available for use in WinRT apps, however the following
    1.13 +should be noted:
    1.14 +
    1.15 +1. It will return different path types, by default, depending on the WinRT
    1.16 +   platform.  Windows Phone apps will default to using the app's "local" path,
    1.17 +   whereas Windows Store (i.e. non-Phone) apps will default to using the app's
    1.18 +   "roaming" path.  This behavior can be changed by calling SDL_SetHint() with
    1.19 +   the key, SDL_HINT_WINRT_PREF_PATH_ROOT, and a value of either "local" or
    1.20 +   "roaming".
    1.21 +
    1.22 +2. Windows Phone 8.0 does not provide apps access to a "roaming" folder.
    1.23 +   Attempts to make SDL_GetPrefPath() return a roaming folder on Windows
    1.24 +   Phone 8.0 will be ignored (and a path inside the "local" folder will be
    1.25 +   used instead).
    1.26 +
    1.27 +Further details on this can be found in the documentation for
    1.28 +SDL_HINT_WINRT_PREF_PATH_ROOT, in SDL_hints.h, as well as the docs for
    1.29 +SDL_WinRT_Path, SDL_WinRTGetFSPathUNICODE, and SDL_WinRTGetFSPathUTF8,
    1.30 +in SDL_system.h.
    1.31 +
    1.32 +
    1.33  
    1.34  Setup, High-Level Steps
    1.35  -----------------------