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