move indicator flags to SDL_WindowData
[platform/upstream/SDL.git] / WhatsNew.txt
1
2 This is a list of major changes in SDL's version history.
3
4 ---------------------------------------------------------------------------
5 2.0.4:
6 ---------------------------------------------------------------------------
7
8 General:
9 * Added support for web applications using Emscripten, see docs/README-emscripten.md for more information
10 * Added support for web applications using Native Client (NaCl), see docs/README-nacl.md for more information
11 * Added an API to queue audio instead of using the audio callback:
12     SDL_QueueAudio(), SDL_GetQueuedAudioSize(), SDL_ClearQueuedAudio()
13 * Added events for audio device hot plug support:
14     SDL_AUDIODEVICEADDED, SDL_AUDIODEVICEREMOVED
15 * Added SDL_PointInRect()
16 * Added SDL_HasAVX2() to detect CPUs with AVX2 support
17 * Added SDL_SetWindowHitTest() to let apps treat parts of their SDL window like traditional window decorations (drag areas, resize areas)
18 * Added SDL_GetGrabbedWindow() to get the window that currently has input grab, if any
19 * Added SDL_RenderIsClipEnabled() to tell whether clipping is currently enabled in a renderer
20 * Added SDL_CaptureMouse() to capture the mouse to get events while the mouse is not in your window
21 * Added SDL_WarpMouseGlobal() to warp the mouse cursor in global screen space
22 * Added SDL_GetGlobalMouseState() to get the current mouse state outside of an SDL window
23 * Added a direction field to mouse wheel events to tell whether they are flipped (natural) or not
24 * Added GL_CONTEXT_RELEASE_BEHAVIOR GL attribute (maps to [WGL|GLX]_ARB_context_flush_control extension)
25 * Added EGL_KHR_create_context support to allow OpenGL ES version selection on some platforms
26 * Added NV12 and NV21 YUV texture support for OpenGL and OpenGL ES 2.0 renderers
27 * Added a Vivante video driver that is used on various SoC platforms
28 * Added an event SDL_RENDER_DEVICE_RESET that is sent from the D3D renderers when the D3D device is lost, and from Android's event loop when the GLES context had to be recreated
29 * Added a hint SDL_HINT_NO_SIGNAL_HANDLERS to disable SDL's built in signal handling
30 * Added a hint SDL_HINT_THREAD_STACK_SIZE to set the stack size of SDL's threads
31 * Added SDL_sqrtf(), SDL_tan(), and SDL_tanf() to the stdlib routines
32 * Improved support for WAV and BMP files with unusual chunks in them
33 * Renamed SDL_assert_data to SDL_AssertData and SDL_assert_state to SDL_AssertState
34 * Added a hint SDL_HINT_WINDOW_FRAME_USABLE_WHILE_CURSOR_HIDDEN to prevent window interaction while cursor is hidden
35 * Added SDL_GetDisplayDPI() to get the DPI information for a display
36 * Added SDL_JoystickCurrentPowerLevel() to get the battery level of a joystick
37 * Added SDL_JoystickFromInstanceID(), as a helper function, to get the SDL_Joystick* that an event is referring to.
38 * Added SDL_GameControllerFromInstanceID(), as a helper function, to get the SDL_GameController* that an event is referring to.
39
40 Windows:
41 * Added support for Windows Phone 8.1 and Windows 10/UWP (Universal Windows Platform)
42 * Timer resolution is now 1 ms by default, adjustable with the SDL_HINT_TIMER_RESOLUTION hint
43 * SDLmain no longer depends on the C runtime, so you can use the same .lib in both Debug and Release builds
44 * Added SDL_SetWindowsMessageHook() to set a function to be called for every windows message before TranslateMessage()
45 * Added a hint SDL_HINT_WINDOWS_ENABLE_MESSAGELOOP to control whether SDL_PumpEvents() processes the Windows message loop
46 * You can distinguish between real mouse and touch events by looking for SDL_TOUCH_MOUSEID in the mouse event "which" field
47 * SDL_SysWMinfo now contains the window HDC
48 * Added support for Unicode command line options
49 * Prevent beeping when Alt-key combos are pressed
50 * SDL_SetTextInputRect() re-positions the OS-rendered IME
51 * Added a hint SDL_HINT_WINDOWS_NO_CLOSE_ON_ALT_F4 to prevent generating SDL_WINDOWEVENT_CLOSE events when Alt-F4 is pressed
52 * Added a hint SDL_HINT_XINPUT_USE_OLD_JOYSTICK_MAPPING to use the old axis and button mapping for XInput devices (deprecated)
53
54 Mac OS X:
55 * Implemented drag-and-drop support
56 * Improved joystick hot-plug detection
57 * The SDL_WINDOWEVENT_EXPOSED window event is triggered in the appropriate situations
58 * Fixed relative mouse mode when the application loses/regains focus
59 * Fixed bugs related to transitioning to and from Spaces-aware fullscreen-desktop mode
60 * Fixed the refresh rate of display modes
61 * SDL_SysWMInfo is now ARC-compatible
62 * Added a hint SDL_HINT_MAC_BACKGROUND_APP to prevent forcing the application to become a foreground process
63
64 Linux:
65 * Enabled building with Mir and Wayland support by default.
66 * Added IBus IME support
67 * Added a hint SDL_HINT_IME_INTERNAL_EDITING to control whether IBus should handle text editing internally instead of sending SDL_TEXTEDITING events
68 * Added a hint SDL_HINT_VIDEO_X11_NET_WM_PING to allow disabling _NET_WM_PING protocol handling in SDL_CreateWindow()
69 * Added support for multiple audio devices when using Pulseaudio
70 * Fixed duplicate mouse events when using relative mouse motion
71
72 iOS:
73 * Added support for iOS 8
74 * The SDL_WINDOW_ALLOW_HIGHDPI window flag now enables high-dpi support, and SDL_GL_GetDrawableSize() or SDL_GetRendererOutputSize() gets the window resolution in pixels
75 * SDL_GetWindowSize() and display mode sizes are in the "DPI-independent points" / "screen coordinates" coordinate space rather than pixels (matches OS X behavior)
76 * Added native resolution support for the iPhone 6 Plus
77 * Added support for MFi game controllers
78 * Added support for the hint SDL_HINT_ACCELEROMETER_AS_JOYSTICK
79 * Added sRGB OpenGL ES context support on iOS 7+
80 * Added support for SDL_DisableScreenSaver(), SDL_EnableScreenSaver() and the hint SDL_HINT_VIDEO_ALLOW_SCREENSAVER
81 * SDL_SysWMinfo now contains the OpenGL ES framebuffer and color renderbuffer objects used by the window's active GLES view
82 * Fixed various rotation and orientation issues
83 * Fixed memory leaks
84
85 Android:
86 * Added a hint SDL_HINT_ANDROID_SEPARATE_MOUSE_AND_TOUCH to prevent mouse events from being registered as touch events
87 * Added hints SDL_HINT_ANDROID_APK_EXPANSION_MAIN_FILE_VERSION and SDL_HINT_ANDROID_APK_EXPANSION_PATCH_FILE_VERSION
88 * Added support for SDL_DisableScreenSaver(), SDL_EnableScreenSaver() and the hint SDL_HINT_VIDEO_ALLOW_SCREENSAVER
89 * Added support for SDL_ShowMessageBox() and SDL_ShowSimpleMessageBox()
90
91 Raspberry Pi:
92 * Added support for the Raspberry Pi 2
93
94
95 ---------------------------------------------------------------------------
96 2.0.3:
97 ---------------------------------------------------------------------------
98
99 Mac OS X:
100 * Fixed creating an OpenGL context by default on Mac OS X 10.6
101
102
103 ---------------------------------------------------------------------------
104 2.0.2:
105 ---------------------------------------------------------------------------
106 General:
107 * Added SDL_GL_ResetAttributes() to reset OpenGL attributes to default values
108 * Added an API to load a database of game controller mappings from a file:
109     SDL_GameControllerAddMappingsFromFile(), SDL_GameControllerAddMappingsFromRW()
110 * Added game controller mappings for the PS4 and OUYA controllers
111 * Added SDL_GetDefaultAssertionHandler() and SDL_GetAssertionHandler()
112 * Added SDL_DetachThread()
113 * Added SDL_HasAVX() to determine if the CPU has AVX features
114 * Added SDL_vsscanf(), SDL_acos(), and SDL_asin() to the stdlib routines
115 * EGL can now create/manage OpenGL and OpenGL ES 1.x/2.x contexts, and share
116   them using SDL_GL_SHARE_WITH_CURRENT_CONTEXT
117 * Added a field "clicks" to the mouse button event which records whether the event is a single click, double click, etc.
118 * The screensaver is now disabled by default, and there is a hint SDL_HINT_VIDEO_ALLOW_SCREENSAVER that can change that behavior.
119 * Added a hint SDL_HINT_MOUSE_RELATIVE_MODE_WARP to specify whether mouse relative mode should be emulated using mouse warping.
120 * testgl2 does not need to link with libGL anymore
121 * Added testgles2 test program to demonstrate working with OpenGL ES 2.0
122 * Added controllermap test program to visually map a game controller
123
124 Windows:
125 * Support for OpenGL ES 2.x contexts using either WGL or EGL (natively via
126   the driver or emulated through ANGLE)
127 * Added a hint SDL_HINT_VIDEO_WIN_D3DCOMPILER to specify which D3D shader compiler to use for OpenGL ES 2 support through ANGLE
128 * Added a hint SDL_HINT_VIDEO_WINDOW_SHARE_PIXEL_FORMAT that is useful when creating multiple windows that should share the same OpenGL context.
129 * Added an event SDL_RENDER_TARGETS_RESET that is sent when D3D9 render targets are reset after the device has been restored.
130
131 Mac OS X:
132 * 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.
133
134 Linux:
135 * Fixed fullscreen and focused behavior when receiving NotifyGrab events
136 * Added experimental Wayland and Mir support, disabled by default
137
138 Android:
139 * Joystick support (minimum SDK version required to build SDL is now 12, 
140   the required runtime version remains at 10, but on such devices joystick 
141   support won't be available).
142 * Hotplugging support for joysticks
143 * 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.
144
145
146 ---------------------------------------------------------------------------
147 2.0.1:
148 ---------------------------------------------------------------------------
149
150 General:
151 * Added an API to get common filesystem paths in SDL_filesystem.h:
152     SDL_GetBasePath(), SDL_GetPrefPath()
153 * Added an API to do optimized YV12 and IYUV texture updates:
154     SDL_UpdateYUVTexture()
155 * Added an API to get the amount of RAM on the system:
156     SDL_GetSystemRAM()
157 * Added a macro to perform timestamp comparisons with SDL_GetTicks():
158     SDL_TICKS_PASSED()
159 * Dramatically improved OpenGL ES 2.0 rendering performance
160 * Added OpenGL attribute SDL_GL_FRAMEBUFFER_SRGB_CAPABLE
161
162 Windows:
163 * Created a static library configuration for the Visual Studio 2010 project
164 * Added a hint to create the Direct3D device with support for multi-threading:
165     SDL_HINT_RENDER_DIRECT3D_THREADSAFE
166 * Added a function to get the D3D9 adapter index for a display:
167     SDL_Direct3D9GetAdapterIndex()
168 * Added a function to get the D3D9 device for a D3D9 renderer:
169     SDL_RenderGetD3D9Device()
170 * Fixed building SDL with the mingw32 toolchain (mingw-w64 is preferred)
171 * Fixed crash when using two XInput controllers at the same time
172 * Fixed detecting a mixture of XInput and DirectInput controllers
173 * Fixed clearing a D3D render target larger than the window
174 * Improved support for format specifiers in SDL_snprintf()
175
176 Mac OS X:
177 * Added support for retina displays:
178   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.
179 * Fixed mouse warping in fullscreen mode
180 * Right mouse click is emulated by holding the Ctrl key while left clicking
181
182 Linux:
183 * Fixed float audio support with the PulseAudio driver
184 * Fixed missing line endpoints in the OpenGL renderer on some drivers
185 * X11 symbols are no longer defined to avoid collisions when linking statically
186
187 iOS:
188 * Fixed status bar visibility on iOS 7
189 * Flipped the accelerometer Y axis to match expected values
190
191 Android:
192 IMPORTANT: You MUST get the updated SDLActivity.java to match C code
193 * Moved EGL initialization to native code 
194 * Fixed the accelerometer axis rotation relative to the device rotation
195 * Fixed race conditions when handling the EGL context on pause/resume
196 * Touch devices are available for enumeration immediately after init
197
198 Raspberry Pi:
199 * Added support for the Raspberry Pi, see README-raspberrypi.txt for details