author David Ludwig <>
Sat, 29 Nov 2014 10:09:30 -0500
changeset 9247 eddb899239fe
parent 7635 c57071e3d636
permissions -rw-r--r--
WinRT: bug and data-integrity fixes for SDL_GetPrefPath()

This change does a few things, all with regards to the WinRT implementation of

1. it fixes a bug whereby SDL_GetPrefPath() did not create the directory it
returned. On other SDL platforms, SDL_GetPrefPath() will create separate
directories for its 'org' and 'app' folders. Without this, attempts to create
files in the pref-path would fail, unless those directories were first created
by the app, or by some other library the app used. This change makes sure
that these directories get created, before SDL_GetPrefPath() returns to its

2. it defaults to having SDL_GetPrefPath() return a WinRT 'Local' folder
on all platforms. Previously, for Windows Store apps, it would have used a
different, 'Roaming' folder. Files in Roaming folders can be automatically,
and synchronized across multiple devices by Windows. This synchronization can
happen while the app runs, with new files being copied into a running app's
pref-path. Unless an app is specifically designed to handle this scenario,
there is a chance that save-data could be overwritten in unwanted or
unexpected ways.

The default is now to use a Local folder, which does not get synchronized, and
which is arguably a bit safer to use. Apps that wish to use Roaming folders
can do so by setting SDL_HINT_WINRT_PREF_PATH_ROOT to "roaming", however it
is recommended that one first read Microsoft's documentation for Roaming
files, a link to which is provided in

To preserve older pref-path selection behavior (found in SDL 2.0.3, as well as
many pre-2.0.4 versions of SDL from, which uses a Roaming path
in Windows Store apps, and a Local path in Windows Phone, set

Please note that Roaming paths are not supported on Windows Phone 8.0, due to
limitations in the OS itself. Attempts to use this will fail.
(Windows Phone 8.1 does not have this limitation, however.)

3. It makes SDL_GetPrefPath(), when on Windows Phone 8.0, and when
SDL_HINT_WINRT_PREF_PATH_ROOT is set to "roaming", return NULL, rather than
silently defaulting to a Local path (then switching to a Roaming path if and
when the user upgraded to Windows Phone 8.1).
     2 Simple DirectMedia Layer CREDITS
     3 Thanks to everyone who made this possible, including:
     5 * Cliff Matthews, for giving me a reason to start this project. :)
     6  -- Executor rocks!  *grin*
     8 * Ryan Gordon for helping everybody out and keeping the dream alive. :)
    10 * Gabriel Jacobo for his work on the Android port and generally helping out all around.
    12 * Philipp Wiesemann for his attention to detail reviewing the entire SDL code base and proposes patches.
    14 * Andreas Schiffler for his dedication to unit tests, Visual Studio projects, and managing the Google Summer of Code.
    16 * Mike Sartain for incorporating SDL into Team Fortress 2 and cheering me on at Valve.
    18 * Alfred Reynolds for the game controller API and general (in)sanity
    20 * Jørgen Tjernø for numerous magical Mac OS X fixes.
    22 * Pierre-Loup Griffais for his deep knowledge of OpenGL drivers.
    24 * Julian Winter for the SDL 2.0 website.
    26 * Sheena Smith for many months of great work on the SDL wiki creating the API documentation and style guides.
    28 * Paul Hunkin for his port of SDL to Android during the Google Summer of Code 2010.
    30 * Eli Gottlieb for his work on shaped windows during the Google Summer of Code 2010.
    32 * Jim Grandpre for his work on multi-touch and gesture recognition during
    33   the Google Summer of Code 2010.
    35 * Edgar "bobbens" Simo for his force feedback API development during the
    36   Google Summer of Code 2008.
    38 * Aaron Wishnick for his work on audio resampling and pitch shifting during
    39   the Google Summer of Code 2008.
    41 * Holmes Futrell for his port of SDL to the iPhone and iPod Touch during the
    42   Google Summer of Code 2008.
    44 * Jon Atkins for SDL_image, SDL_mixer and SDL_net documentation.
    46 * Everybody at Loki Software, Inc. for their great contributions!
    48  And a big hand to everyone else who has contributed over the years.
    50 THANKS! :)
    52   -- Sam Lantinga			<>