WhatsNew.txt
author Sam Lantinga <slouken@libsdl.org>
Sun, 19 Nov 2017 23:36:54 -0800
changeset 11706 d5d95b296cb0
parent 11687 e968d755a760
child 11757 72855e49c8cc
permissions -rw-r--r--
Added support for aarch64 memory barrier instruction
     1 
     2 This is a list of major changes in SDL's version history.
     3 
     4 ---------------------------------------------------------------------------
     5 2.0.8:
     6 ---------------------------------------------------------------------------
     7 
     8 General:
     9 * Added SDL_fmod()
    10 * Each of the SDL math functions now has the corresponding float version
    11 
    12 
    13 ---------------------------------------------------------------------------
    14 2.0.7:
    15 ---------------------------------------------------------------------------
    16 
    17 General:
    18 * Added audio stream conversion functions:
    19 	SDL_NewAudioStream
    20 	SDL_AudioStreamPut
    21 	SDL_AudioStreamGet
    22 	SDL_AudioStreamAvailable
    23 	SDL_AudioStreamFlush
    24 	SDL_AudioStreamClear
    25 	SDL_FreeAudioStream
    26 * Added functions to query and set the SDL memory allocation functions:
    27 	SDL_GetMemoryFunctions()
    28 	SDL_SetMemoryFunctions()
    29 	SDL_GetNumAllocations()
    30 * Added locking functions for multi-threaded access to the joystick and game controller APIs:
    31 	SDL_LockJoysticks()
    32 	SDL_UnlockJoysticks()
    33 * The following functions are now thread-safe:
    34 	SDL_SetEventFilter()
    35 	SDL_GetEventFilter()
    36 	SDL_AddEventWatch()
    37 	SDL_DelEventWatch()
    38 
    39 
    40 General:
    41 ---------------------------------------------------------------------------
    42 2.0.6:
    43 ---------------------------------------------------------------------------
    44 
    45 General:
    46 * Added cross-platform Vulkan graphics support in SDL_vulkan.h
    47 	SDL_Vulkan_LoadLibrary()
    48 	SDL_Vulkan_GetVkGetInstanceProcAddr()
    49 	SDL_Vulkan_GetInstanceExtensions()
    50 	SDL_Vulkan_CreateSurface()
    51 	SDL_Vulkan_GetDrawableSize()
    52 	SDL_Vulkan_UnloadLibrary()
    53   This is all the platform-specific code you need to bring up Vulkan on all SDL platforms. You can look at an example in test/testvulkan.c
    54 * Added SDL_ComposeCustomBlendMode() to create custom blend modes for 2D rendering
    55 * Added SDL_HasNEON() which returns whether the CPU has NEON instruction support
    56 * Added support for many game controllers, including the Nintendo Switch Pro Controller
    57 * Added support for inverted axes and separate axis directions in game controller mappings
    58 * Added functions to return information about a joystick before it's opened:
    59 	SDL_JoystickGetDeviceVendor()
    60 	SDL_JoystickGetDeviceProduct()
    61 	SDL_JoystickGetDeviceProductVersion()
    62 	SDL_JoystickGetDeviceType()
    63 	SDL_JoystickGetDeviceInstanceID()
    64 * Added functions to return information about an open joystick:
    65 	SDL_JoystickGetVendor()
    66 	SDL_JoystickGetProduct()
    67 	SDL_JoystickGetProductVersion()
    68 	SDL_JoystickGetType()
    69 	SDL_JoystickGetAxisInitialState()
    70 * Added functions to return information about an open game controller:
    71 	SDL_GameControllerGetVendor()
    72 	SDL_GameControllerGetProduct()
    73 	SDL_GameControllerGetProductVersion()
    74 * Added SDL_GameControllerNumMappings() and SDL_GameControllerMappingForIndex() to be able to enumerate the built-in game controller mappings
    75 * Added SDL_LoadFile() and SDL_LoadFile_RW() to load a file into memory
    76 * Added SDL_DuplicateSurface() to make a copy of a surface
    77 * Added an experimental JACK audio driver
    78 * Implemented non-power-of-two audio resampling, optionally using libsamplerate to perform the resampling
    79 * Added the hint SDL_HINT_AUDIO_RESAMPLING_MODE to control the quality of resampling
    80 * Added the hint SDL_HINT_RENDER_LOGICAL_SIZE_MODE to control the scaling policy for SDL_RenderSetLogicalSize():
    81 	"0" or "letterbox" - Uses letterbox/sidebars to fit the entire rendering on screen (the default)
    82 	"1" or "overscan"  - Will zoom the rendering so it fills the entire screen, allowing edges to be drawn offscreen
    83 * Added the hints SDL_HINT_MOUSE_NORMAL_SPEED_SCALE and SDL_HINT_MOUSE_RELATIVE_SPEED_SCALE to scale the mouse speed when being read from raw mouse input
    84 * Added the hint SDL_HINT_TOUCH_MOUSE_EVENTS to control whether SDL will synthesize mouse events from touch events
    85 
    86 Windows:
    87 * The new default audio driver on Windows is WASAPI and supports hot-plugging devices and changing the default audio device
    88 * The old XAudio2 audio driver is deprecated and will be removed in the next release
    89 * Added hints SDL_HINT_WINDOWS_INTRESOURCE_ICON and SDL_HINT_WINDOWS_INTRESOURCE_ICON_SMALL to specify a custom icon resource ID for SDL windows
    90 * The hint SDL_HINT_WINDOWS_DISABLE_THREAD_NAMING is now on by default for compatibility with .NET languages and various Windows debuggers
    91 * Updated the GUID format for game controller mappings, older mappings will be automatically converted on load
    92 * Implemented the SDL_WINDOW_ALWAYS_ON_TOP flag on Windows
    93 
    94 Linux:
    95 * Added an experimental KMS/DRM video driver for embedded development
    96 
    97 iOS:
    98 * Added a hint SDL_HINT_AUDIO_CATEGORY to control the audio category, determining whether the phone mute switch affects the audio
    99 
   100 ---------------------------------------------------------------------------
   101 2.0.5:
   102 ---------------------------------------------------------------------------
   103 
   104 General:
   105 * Implemented audio capture support for some platforms
   106 * Added SDL_DequeueAudio() to retrieve audio when buffer queuing is turned on for audio capture
   107 * Added events for dragging and dropping text
   108 * Added events for dragging and dropping multiple items
   109 * By default the click raising a window will not be delivered to the SDL application. You can set the hint SDL_HINT_MOUSE_FOCUS_CLICKTHROUGH to "1" to allow that click through to the window.
   110 * Saving a surface with an alpha channel as a BMP will use a newer BMP format that supports alpha information. You can set the hint SDL_HINT_BMP_SAVE_LEGACY_FORMAT to "1" to use the old format.
   111 * Added SDL_GetHintBoolean() to get the boolean value of a hint
   112 * Added SDL_RenderSetIntegerScale() to set whether to smoothly scale or use integral multiples of the viewport size when scaling the rendering output
   113 * Added SDL_CreateRGBSurfaceWithFormat() and SDL_CreateRGBSurfaceWithFormatFrom() to create an SDL surface with a specific pixel format
   114 * Added SDL_GetDisplayUsableBounds() which returns the area usable for windows. For example, on Mac OS X, this subtracts the area occupied by the menu bar and dock.
   115 * Added SDL_GetWindowBordersSize() which returns the size of the window's borders around the client area
   116 * Added a window event SDL_WINDOWEVENT_HIT_TEST when a window had a hit test that wasn't SDL_HITTEST_NORMAL (e.g. in the title bar or window frame)
   117 * Added SDL_SetWindowResizable() to change whether a window is resizable
   118 * Added SDL_SetWindowOpacity() and SDL_GetWindowOpacity() to affect the window transparency
   119 * Added SDL_SetWindowModalFor() to set a window as modal for another window
   120 * Added support for AUDIO_U16LSB and AUDIO_U16MSB to SDL_MixAudioFormat()
   121 * Fixed flipped images when reading back from target textures when using the OpenGL renderer
   122 * Fixed texture color modulation with SDL_BLENDMODE_NONE when using the OpenGL renderer
   123 * Fixed bug where the alpha value of colorkeys was ignored when blitting in some cases
   124 
   125 Windows:
   126 * Added a hint SDL_HINT_WINDOWS_DISABLE_THREAD_NAMING to prevent SDL from raising a debugger exception to name threads. This exception can cause problems with .NET applications when running under a debugger.
   127 * The hint SDL_HINT_THREAD_STACK_SIZE is now supported on Windows
   128 * Fixed XBox controller triggers automatically being pulled at startup
   129 * The first icon from the executable is used as the default window icon at runtime
   130 * Fixed SDL log messages being printed twice if SDL was built with C library support
   131 * Reset dead keys when the SDL window loses focus, so dead keys pressed in SDL applications don't affect text input into other applications.
   132 
   133 Mac OS X:
   134 * Fixed selecting the dummy video driver
   135 * The caps lock key now generates a pressed event when pressed and a released event when released, instead of a press/release event pair when pressed.
   136 * Fixed mouse wheel events on Mac OS X 10.12
   137 * The audio driver has been updated to use AVFoundation for better compatibility with newer versions of Mac OS X
   138 
   139 Linux:
   140 * Added support for the Fcitx IME
   141 * Added a window event SDL_WINDOWEVENT_TAKE_FOCUS when a window manager asks the SDL window whether it wants to take focus.
   142 * Refresh rates are now rounded instead of truncated, e.g. 59.94 Hz is rounded up to 60 Hz instead of 59.
   143 * Added initial support for touchscreens on Raspberry Pi
   144 
   145 OpenBSD:
   146 * SDL_GetBasePath() is now implemented on OpenBSD
   147 
   148 iOS:
   149 * Added support for dynamically loaded objects on iOS 8 and newer
   150 
   151 tvOS:
   152 * Added support for Apple TV
   153 * Added a hint SDL_HINT_APPLE_TV_REMOTE_ALLOW_ROTATION to control whether he Apple TV remote's joystick axes will automatically match the rotation of the remote.  
   154 
   155 Android:
   156 * Fixed SDL not resizing window when Android screen resolution changes
   157 * Corrected the joystick Z axis reporting for the accelerometer
   158 
   159 Emscripten (running in a web browser):
   160 * Many bug fixes and improvements
   161 
   162 
   163 ---------------------------------------------------------------------------
   164 2.0.4:
   165 ---------------------------------------------------------------------------
   166 
   167 General:
   168 * Added support for web applications using Emscripten, see docs/README-emscripten.md for more information
   169 * Added support for web applications using Native Client (NaCl), see docs/README-nacl.md for more information
   170 * Added an API to queue audio instead of using the audio callback:
   171     SDL_QueueAudio(), SDL_GetQueuedAudioSize(), SDL_ClearQueuedAudio()
   172 * Added events for audio device hot plug support:
   173     SDL_AUDIODEVICEADDED, SDL_AUDIODEVICEREMOVED
   174 * Added SDL_PointInRect()
   175 * Added SDL_HasAVX2() to detect CPUs with AVX2 support
   176 * Added SDL_SetWindowHitTest() to let apps treat parts of their SDL window like traditional window decorations (drag areas, resize areas)
   177 * Added SDL_GetGrabbedWindow() to get the window that currently has input grab, if any
   178 * Added SDL_RenderIsClipEnabled() to tell whether clipping is currently enabled in a renderer
   179 * Added SDL_CaptureMouse() to capture the mouse to get events while the mouse is not in your window
   180 * Added SDL_WarpMouseGlobal() to warp the mouse cursor in global screen space
   181 * Added SDL_GetGlobalMouseState() to get the current mouse state outside of an SDL window
   182 * Added a direction field to mouse wheel events to tell whether they are flipped (natural) or not
   183 * Added GL_CONTEXT_RELEASE_BEHAVIOR GL attribute (maps to [WGL|GLX]_ARB_context_flush_control extension)
   184 * Added EGL_KHR_create_context support to allow OpenGL ES version selection on some platforms
   185 * Added NV12 and NV21 YUV texture support for OpenGL and OpenGL ES 2.0 renderers
   186 * Added a Vivante video driver that is used on various SoC platforms
   187 * 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
   188 * Added a hint SDL_HINT_NO_SIGNAL_HANDLERS to disable SDL's built in signal handling
   189 * Added a hint SDL_HINT_THREAD_STACK_SIZE to set the stack size of SDL's threads
   190 * Added SDL_sqrtf(), SDL_tan(), and SDL_tanf() to the stdlib routines
   191 * Improved support for WAV and BMP files with unusual chunks in them
   192 * Renamed SDL_assert_data to SDL_AssertData and SDL_assert_state to SDL_AssertState
   193 * Added a hint SDL_HINT_WINDOW_FRAME_USABLE_WHILE_CURSOR_HIDDEN to prevent window interaction while cursor is hidden
   194 * Added SDL_GetDisplayDPI() to get the DPI information for a display
   195 * Added SDL_JoystickCurrentPowerLevel() to get the battery level of a joystick
   196 * Added SDL_JoystickFromInstanceID(), as a helper function, to get the SDL_Joystick* that an event is referring to.
   197 * Added SDL_GameControllerFromInstanceID(), as a helper function, to get the SDL_GameController* that an event is referring to.
   198 
   199 Windows:
   200 * Added support for Windows Phone 8.1 and Windows 10/UWP (Universal Windows Platform)
   201 * Timer resolution is now 1 ms by default, adjustable with the SDL_HINT_TIMER_RESOLUTION hint
   202 * SDLmain no longer depends on the C runtime, so you can use the same .lib in both Debug and Release builds
   203 * Added SDL_SetWindowsMessageHook() to set a function to be called for every windows message before TranslateMessage()
   204 * Added a hint SDL_HINT_WINDOWS_ENABLE_MESSAGELOOP to control whether SDL_PumpEvents() processes the Windows message loop
   205 * You can distinguish between real mouse and touch events by looking for SDL_TOUCH_MOUSEID in the mouse event "which" field
   206 * SDL_SysWMinfo now contains the window HDC
   207 * Added support for Unicode command line options
   208 * Prevent beeping when Alt-key combos are pressed
   209 * SDL_SetTextInputRect() re-positions the OS-rendered IME
   210 * Added a hint SDL_HINT_WINDOWS_NO_CLOSE_ON_ALT_F4 to prevent generating SDL_WINDOWEVENT_CLOSE events when Alt-F4 is pressed
   211 * Added a hint SDL_HINT_XINPUT_USE_OLD_JOYSTICK_MAPPING to use the old axis and button mapping for XInput devices (deprecated)
   212 
   213 Mac OS X:
   214 * Implemented drag-and-drop support
   215 * Improved joystick hot-plug detection
   216 * The SDL_WINDOWEVENT_EXPOSED window event is triggered in the appropriate situations
   217 * Fixed relative mouse mode when the application loses/regains focus
   218 * Fixed bugs related to transitioning to and from Spaces-aware fullscreen-desktop mode
   219 * Fixed the refresh rate of display modes
   220 * SDL_SysWMInfo is now ARC-compatible
   221 * Added a hint SDL_HINT_MAC_BACKGROUND_APP to prevent forcing the application to become a foreground process
   222 
   223 Linux:
   224 * Enabled building with Mir and Wayland support by default.
   225 * Added IBus IME support
   226 * Added a hint SDL_HINT_IME_INTERNAL_EDITING to control whether IBus should handle text editing internally instead of sending SDL_TEXTEDITING events
   227 * Added a hint SDL_HINT_VIDEO_X11_NET_WM_PING to allow disabling _NET_WM_PING protocol handling in SDL_CreateWindow()
   228 * Added support for multiple audio devices when using Pulseaudio
   229 * Fixed duplicate mouse events when using relative mouse motion
   230 
   231 iOS:
   232 * Added support for iOS 8
   233 * 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
   234 * SDL_GetWindowSize() and display mode sizes are in the "DPI-independent points" / "screen coordinates" coordinate space rather than pixels (matches OS X behavior)
   235 * Added native resolution support for the iPhone 6 Plus
   236 * Added support for MFi game controllers
   237 * Added support for the hint SDL_HINT_ACCELEROMETER_AS_JOYSTICK
   238 * Added sRGB OpenGL ES context support on iOS 7+
   239 * Added support for SDL_DisableScreenSaver(), SDL_EnableScreenSaver() and the hint SDL_HINT_VIDEO_ALLOW_SCREENSAVER
   240 * SDL_SysWMinfo now contains the OpenGL ES framebuffer and color renderbuffer objects used by the window's active GLES view
   241 * Fixed various rotation and orientation issues
   242 * Fixed memory leaks
   243 
   244 Android:
   245 * Added a hint SDL_HINT_ANDROID_SEPARATE_MOUSE_AND_TOUCH to prevent mouse events from being registered as touch events
   246 * Added hints SDL_HINT_ANDROID_APK_EXPANSION_MAIN_FILE_VERSION and SDL_HINT_ANDROID_APK_EXPANSION_PATCH_FILE_VERSION
   247 * Added support for SDL_DisableScreenSaver(), SDL_EnableScreenSaver() and the hint SDL_HINT_VIDEO_ALLOW_SCREENSAVER
   248 * Added support for SDL_ShowMessageBox() and SDL_ShowSimpleMessageBox()
   249 
   250 Raspberry Pi:
   251 * Added support for the Raspberry Pi 2
   252 
   253 
   254 ---------------------------------------------------------------------------
   255 2.0.3:
   256 ---------------------------------------------------------------------------
   257 
   258 Mac OS X:
   259 * Fixed creating an OpenGL context by default on Mac OS X 10.6
   260 
   261 
   262 ---------------------------------------------------------------------------
   263 2.0.2:
   264 ---------------------------------------------------------------------------
   265 General:
   266 * Added SDL_GL_ResetAttributes() to reset OpenGL attributes to default values
   267 * Added an API to load a database of game controller mappings from a file:
   268     SDL_GameControllerAddMappingsFromFile(), SDL_GameControllerAddMappingsFromRW()
   269 * Added game controller mappings for the PS4 and OUYA controllers
   270 * Added SDL_GetDefaultAssertionHandler() and SDL_GetAssertionHandler()
   271 * Added SDL_DetachThread()
   272 * Added SDL_HasAVX() to determine if the CPU has AVX features
   273 * Added SDL_vsscanf(), SDL_acos(), and SDL_asin() to the stdlib routines
   274 * EGL can now create/manage OpenGL and OpenGL ES 1.x/2.x contexts, and share
   275   them using SDL_GL_SHARE_WITH_CURRENT_CONTEXT
   276 * Added a field "clicks" to the mouse button event which records whether the event is a single click, double click, etc.
   277 * The screensaver is now disabled by default, and there is a hint SDL_HINT_VIDEO_ALLOW_SCREENSAVER that can change that behavior.
   278 * Added a hint SDL_HINT_MOUSE_RELATIVE_MODE_WARP to specify whether mouse relative mode should be emulated using mouse warping.
   279 * testgl2 does not need to link with libGL anymore
   280 * Added testgles2 test program to demonstrate working with OpenGL ES 2.0
   281 * Added controllermap test program to visually map a game controller
   282 
   283 Windows:
   284 * Support for OpenGL ES 2.x contexts using either WGL or EGL (natively via
   285   the driver or emulated through ANGLE)
   286 * Added a hint SDL_HINT_VIDEO_WIN_D3DCOMPILER to specify which D3D shader compiler to use for OpenGL ES 2 support through ANGLE
   287 * Added a hint SDL_HINT_VIDEO_WINDOW_SHARE_PIXEL_FORMAT that is useful when creating multiple windows that should share the same OpenGL context.
   288 * Added an event SDL_RENDER_TARGETS_RESET that is sent when D3D9 render targets are reset after the device has been restored.
   289 
   290 Mac OS X:
   291 * 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.
   292 
   293 Linux:
   294 * Fixed fullscreen and focused behavior when receiving NotifyGrab events
   295 * Added experimental Wayland and Mir support, disabled by default
   296 
   297 Android:
   298 * Joystick support (minimum SDK version required to build SDL is now 12, 
   299   the required runtime version remains at 10, but on such devices joystick 
   300   support won't be available).
   301 * Hotplugging support for joysticks
   302 * 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.
   303 
   304 
   305 ---------------------------------------------------------------------------
   306 2.0.1:
   307 ---------------------------------------------------------------------------
   308 
   309 General:
   310 * Added an API to get common filesystem paths in SDL_filesystem.h:
   311     SDL_GetBasePath(), SDL_GetPrefPath()
   312 * Added an API to do optimized YV12 and IYUV texture updates:
   313     SDL_UpdateYUVTexture()
   314 * Added an API to get the amount of RAM on the system:
   315     SDL_GetSystemRAM()
   316 * Added a macro to perform timestamp comparisons with SDL_GetTicks():
   317     SDL_TICKS_PASSED()
   318 * Dramatically improved OpenGL ES 2.0 rendering performance
   319 * Added OpenGL attribute SDL_GL_FRAMEBUFFER_SRGB_CAPABLE
   320 
   321 Windows:
   322 * Created a static library configuration for the Visual Studio 2010 project
   323 * Added a hint to create the Direct3D device with support for multi-threading:
   324     SDL_HINT_RENDER_DIRECT3D_THREADSAFE
   325 * Added a function to get the D3D9 adapter index for a display:
   326     SDL_Direct3D9GetAdapterIndex()
   327 * Added a function to get the D3D9 device for a D3D9 renderer:
   328     SDL_RenderGetD3D9Device()
   329 * Fixed building SDL with the mingw32 toolchain (mingw-w64 is preferred)
   330 * Fixed crash when using two XInput controllers at the same time
   331 * Fixed detecting a mixture of XInput and DirectInput controllers
   332 * Fixed clearing a D3D render target larger than the window
   333 * Improved support for format specifiers in SDL_snprintf()
   334 
   335 Mac OS X:
   336 * Added support for retina displays:
   337   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.
   338 * Fixed mouse warping in fullscreen mode
   339 * Right mouse click is emulated by holding the Ctrl key while left clicking
   340 
   341 Linux:
   342 * Fixed float audio support with the PulseAudio driver
   343 * Fixed missing line endpoints in the OpenGL renderer on some drivers
   344 * X11 symbols are no longer defined to avoid collisions when linking statically
   345 
   346 iOS:
   347 * Fixed status bar visibility on iOS 7
   348 * Flipped the accelerometer Y axis to match expected values
   349 
   350 Android:
   351 IMPORTANT: You MUST get the updated SDLActivity.java to match C code
   352 * Moved EGL initialization to native code 
   353 * Fixed the accelerometer axis rotation relative to the device rotation
   354 * Fixed race conditions when handling the EGL context on pause/resume
   355 * Touch devices are available for enumeration immediately after init
   356 
   357 Raspberry Pi:
   358 * Added support for the Raspberry Pi, see README-raspberrypi.txt for details