WhatsNew.txt
author David Ludwig <dludwig@pobox.com>
Sat, 29 Nov 2014 10:09:30 -0500
changeset 9247 eddb899239fe
parent 8833 ae720d61d14d
child 9732 586417de8897
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
SDL_GetPrefPath():

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
caller(s).


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 README-winrt.md.

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 hg.libsdl.org), which uses a Roaming path
in Windows Store apps, and a Local path in Windows Phone, set
SDL_HINT_WINRT_PREF_PATH_ROOT to "old".

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).
slouken@7228
     1
slouken@7878
     2
This is a list of major changes in SDL's version history.
slouken@7228
     3
slouken@7878
     4
---------------------------------------------------------------------------
gabomdq@8676
     5
2.0.4:
gabomdq@8676
     6
---------------------------------------------------------------------------
gabomdq@8676
     7
gabomdq@8676
     8
General:
gabomdq@8676
     9
* Added an event SDL_RENDER_DEVICE_RESET that is sent from the D3D renderers 
gabomdq@8676
    10
  when the D3D device is lost, and from Android's event loop when the GLES
gabomdq@8676
    11
  context had to be re created.
gabomdq@8833
    12
* Native Client backend
gabomdq@8676
    13
gabomdq@8676
    14
---------------------------------------------------------------------------
slouken@8303
    15
2.0.3:
slouken@8303
    16
---------------------------------------------------------------------------
slouken@8303
    17
slouken@8625
    18
Mac OS X:
slouken@8625
    19
* Fixed creating an OpenGL context by default on Mac OS X 10.6
slouken@8625
    20
slouken@8303
    21
slouken@8303
    22
---------------------------------------------------------------------------
gabomdq@7907
    23
2.0.2:
gabomdq@7907
    24
---------------------------------------------------------------------------
gabomdq@8044
    25
General:
slouken@8197
    26
* Added SDL_GL_ResetAttributes() to reset OpenGL attributes to default values
philipp@8220
    27
* Added an API to load a database of game controller mappings from a file:
slouken@8270
    28
    SDL_GameControllerAddMappingsFromFile(), SDL_GameControllerAddMappingsFromRW()
slouken@8197
    29
* Added game controller mappings for the PS4 and OUYA controllers
slouken@8197
    30
* Added SDL_GetDefaultAssertionHandler() and SDL_GetAssertionHandler()
slouken@8197
    31
* Added SDL_DetachThread()
slouken@8197
    32
* Added SDL_HasAVX() to determine if the CPU has AVX features
slouken@8197
    33
* Added SDL_vsscanf(), SDL_acos(), and SDL_asin() to the stdlib routines
gabomdq@8062
    34
* EGL can now create/manage OpenGL and OpenGL ES 1.x/2.x contexts, and share
gabomdq@8062
    35
  them using SDL_GL_SHARE_WITH_CURRENT_CONTEXT
slouken@8270
    36
* Added a field "clicks" to the mouse button event which records whether the event is a single click, double click, etc.
slouken@8270
    37
* The screensaver is now disabled by default, and there is a hint SDL_HINT_VIDEO_ALLOW_SCREENSAVER that can change that behavior.
slouken@8270
    38
* Added a hint SDL_HINT_MOUSE_RELATIVE_MODE_WARP to specify whether mouse relative mode should be emulated using mouse warping.
slouken@8197
    39
* testgl2 does not need to link with libGL anymore
slouken@8197
    40
* Added testgles2 test program to demonstrate working with OpenGL ES 2.0
slouken@8197
    41
* Added controllermap test program to visually map a game controller
philipp@8220
    42
gabomdq@8044
    43
Windows:
gabomdq@8044
    44
* Support for OpenGL ES 2.x contexts using either WGL or EGL (natively via
gabomdq@8044
    45
  the driver or emulated through ANGLE)
slouken@8270
    46
* Added a hint SDL_HINT_VIDEO_WIN_D3DCOMPILER to specify which D3D shader compiler to use for OpenGL ES 2 support through ANGLE
slouken@8270
    47
* Added a hint SDL_HINT_VIDEO_WINDOW_SHARE_PIXEL_FORMAT that is useful when creating multiple windows that should share the same OpenGL context.
slouken@8270
    48
* Added an event SDL_RENDER_TARGETS_RESET that is sent when D3D9 render targets are reset after the device has been restored.
slouken@8270
    49
slouken@8270
    50
Mac OS X:
slouken@8270
    51
* Added a hint SDL_HINT_MAC_CTRL_CLICK_EMULATE_RIGHT_CLICK to control whether Ctrl+click should be treated as a right click on Mac OS X. This is off by default.
slouken@8270
    52
slouken@8270
    53
Linux:
slouken@8270
    54
* Fixed fullscreen and focused behavior when receiving NotifyGrab events
slouken@8270
    55
* Added experimental Wayland and Mir support, disabled by default
gabomdq@7907
    56
gabomdq@7907
    57
Android:
gabomdq@7907
    58
* Joystick support (minimum SDK version required to build SDL is now 12, 
gabomdq@7907
    59
  the required runtime version remains at 10, but on such devices joystick 
gabomdq@7907
    60
  support won't be available).
gabomdq@8057
    61
* Hotplugging support for joysticks
slouken@8274
    62
* Added a hint SDL_HINT_ACCELEROMETER_AS_JOYSTICK to control whether the accelerometer should be listed as a 3 axis joystick, which it will by default.
slouken@8197
    63
gabomdq@7907
    64
gabomdq@7907
    65
---------------------------------------------------------------------------
slouken@7878
    66
2.0.1:
slouken@7878
    67
---------------------------------------------------------------------------
slouken@7878
    68
slouken@7878
    69
General:
slouken@7878
    70
* Added an API to get common filesystem paths in SDL_filesystem.h:
slouken@7878
    71
    SDL_GetBasePath(), SDL_GetPrefPath()
slouken@7878
    72
* Added an API to do optimized YV12 and IYUV texture updates:
slouken@7878
    73
    SDL_UpdateYUVTexture()
slouken@7878
    74
* Added an API to get the amount of RAM on the system:
slouken@7878
    75
    SDL_GetSystemRAM()
slouken@7878
    76
* Added a macro to perform timestamp comparisons with SDL_GetTicks():
slouken@7878
    77
    SDL_TICKS_PASSED()
slouken@7878
    78
* Dramatically improved OpenGL ES 2.0 rendering performance
slouken@7878
    79
* Added OpenGL attribute SDL_GL_FRAMEBUFFER_SRGB_CAPABLE
slouken@7878
    80
slouken@7878
    81
Windows:
slouken@7878
    82
* Created a static library configuration for the Visual Studio 2010 project
slouken@7878
    83
* Added a hint to create the Direct3D device with support for multi-threading:
slouken@7878
    84
    SDL_HINT_RENDER_DIRECT3D_THREADSAFE
slouken@7878
    85
* Added a function to get the D3D9 adapter index for a display:
slouken@7878
    86
    SDL_Direct3D9GetAdapterIndex()
slouken@7878
    87
* Added a function to get the D3D9 device for a D3D9 renderer:
slouken@7878
    88
    SDL_RenderGetD3D9Device()
slouken@7878
    89
* Fixed building SDL with the mingw32 toolchain (mingw-w64 is preferred)
slouken@7878
    90
* Fixed crash when using two XInput controllers at the same time
slouken@7878
    91
* Fixed detecting a mixture of XInput and DirectInput controllers
slouken@7878
    92
* Fixed clearing a D3D render target larger than the window
slouken@7878
    93
* Improved support for format specifiers in SDL_snprintf()
slouken@7878
    94
slouken@7878
    95
Mac OS X:
slouken@7878
    96
* Added support for retina displays:
slouken@7878
    97
  Create your window with the SDL_WINDOW_ALLOW_HIGHDPI flag, and then use SDL_GL_GetDrawableSize() to find the actual drawable size. You are responsible for scaling mouse and drawing coordinates appropriately.
slouken@7878
    98
* Fixed mouse warping in fullscreen mode
slouken@7878
    99
* Right mouse click is emulated by holding the Ctrl key while left clicking
slouken@7878
   100
slouken@7878
   101
Linux:
slouken@7878
   102
* Fixed float audio support with the PulseAudio driver
slouken@7878
   103
* Fixed missing line endpoints in the OpenGL renderer on some drivers
slouken@7878
   104
* X11 symbols are no longer defined to avoid collisions when linking statically
slouken@7878
   105
slouken@7878
   106
iOS:
slouken@7878
   107
* Fixed status bar visibility on iOS 7
slouken@7878
   108
* Flipped the accelerometer Y axis to match expected values
slouken@7878
   109
slouken@7878
   110
Android:
slouken@7878
   111
IMPORTANT: You MUST get the updated SDLActivity.java to match C code
slouken@7878
   112
* Moved EGL initialization to native code 
slouken@7878
   113
* Fixed the accelerometer axis rotation relative to the device rotation
slouken@7878
   114
* Fixed race conditions when handling the EGL context on pause/resume
slouken@7878
   115
* Touch devices are available for enumeration immediately after init
slouken@7878
   116
slouken@7878
   117
Raspberry Pi:
slouken@7878
   118
* Added support for the Raspberry Pi, see README-raspberrypi.txt for details