docs/README-winrt.md
changeset 9242 f4d353bd5d16
parent 9224 bc074eca6597
child 9247 eddb899239fe
equal deleted inserted replaced
9241:4900e838abbc 9242:f4d353bd5d16
   114     API.
   114     API.
   115   * probably anything else that's not listed as supported
   115   * probably anything else that's not listed as supported
   116 
   116 
   117 
   117 
   118 
   118 
       
   119 Caveats
       
   120 -------
       
   121 
       
   122 #### SDL_GetPrefPath() usage
       
   123 
       
   124 SDL_GetPrefPath() is available for use in WinRT apps, however the following
       
   125 should be noted:
       
   126 
       
   127 1. It will return different path types, by default, depending on the WinRT
       
   128    platform.  Windows Phone apps will default to using the app's "local" path,
       
   129    whereas Windows Store (i.e. non-Phone) apps will default to using the app's
       
   130    "roaming" path.  This behavior can be changed by calling SDL_SetHint() with
       
   131    the key, SDL_HINT_WINRT_PREF_PATH_ROOT, and a value of either "local" or
       
   132    "roaming".
       
   133 
       
   134 2. Windows Phone 8.0 does not provide apps access to a "roaming" folder.
       
   135    Attempts to make SDL_GetPrefPath() return a roaming folder on Windows
       
   136    Phone 8.0 will be ignored (and a path inside the "local" folder will be
       
   137    used instead).
       
   138 
       
   139 Further details on this can be found in the documentation for
       
   140 SDL_HINT_WINRT_PREF_PATH_ROOT, in SDL_hints.h, as well as the docs for
       
   141 SDL_WinRT_Path, SDL_WinRTGetFSPathUNICODE, and SDL_WinRTGetFSPathUTF8,
       
   142 in SDL_system.h.
       
   143 
       
   144 
   119 
   145 
   120 Setup, High-Level Steps
   146 Setup, High-Level Steps
   121 -----------------------
   147 -----------------------
   122 
   148 
   123 The steps for setting up a project for an SDL/WinRT app looks like the
   149 The steps for setting up a project for an SDL/WinRT app looks like the