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