author Ozkan Sezer <sezeroz@gmail.com>
Sat, 03 Aug 2019 12:47:10 +0300
changeset 12989 f4dccc2744a2
parent 12986 19f0f7ea5094
child 12993 e7ee29d04712
permissions -rw-r--r--
update documents for 1.2.16 changes so far.
     2 This is a list of API changes in SDL's version history.
     4 Version 1.0:
     6 1.2.16:  This is mostly multiple bug fixes since the previous version.
     7 Changes include:
     8 - Audio, wav loader: security fixes for ADPCM decoding (CVE-2019-7572,
     9   CVE-2019-7573, CVE-2019-7574, CVE-2019-7575, CVE-2019-7576,
    10   CVE-2019-7577, CVE-2019-7578 -- bugs 4490, 4491, 4492, 4493, 4494,
    11   4495, 4496, and 4522.)
    12 - Video, bmp loader:  security fixes for CVE-2019-7635, CVE-2019-7636,
    13   CVE-2019-7637, CVE-2019-7638, CVE-2019-13616 (bugs 4498, 4499, 4500,
    14   4517, and 4538.)
    15 - Video, blit: fix handling of alpha channel in Altivec accelerated
    16   blit functions (bug 1424.)
    17 - Video, blit: use fast path for RGB 565 -> 32-bit XRGB 8888
    18 - Video, blit: fix RGBA<->RGBA blit broken with the optimization from
    19   bug 11 (bug 2976.)
    20 - Mouse: fix SDL_ResetMouse() using a bogus mouse button causing a
    21   negative shift (bug 3593.)
    22 - Cdrom: fix SDL_CDResume() and SDL_CDStop() not returning failure
    23   when they should (bug 4108.)
    24 - Unix, pthread: Fix SDL_SemWaitTimeout() returning -1 instead of
    25   SDL_MUTEX_TIMEDOUT upon timeout (bug 1426.)
    26 - NetBSD: wscons support.
    27 - NetBSD, audio: use AUDIO_GETBUFINFO when available.
    28 - OpenBSD, audio: add sndio support.
    29 - Haiku/BeOS, audio: fix error in buffer size setting (bug 1679.)
    30 - OpenBSD: fix dynamic loading of X libs (bug 1434.)
    31 - X11video: fix missing symbol X11_KeyToUnicode in .so file (bug 1390.
    32   not being an official SDL function, the use of X11_KeyToUnicode() is
    33   discouraged.)
    34 - X11video: fix compilation with libX11 >= (bug 1769.)
    35 - X11video: fix for XChangeProperty() crash (bug 1427.)
    36 - X11video: fix SDL_EnableUNICODE sometimes dropping keyboard events
    37   completely (bug 2325.)
    38 - X11video: fixed no SDL_VIDEORESIZE event being generated when the
    39   window manager sets the window size (bug 1859.)
    40 - X11video: fix X11_SetGammaRamp not checking the return value of
    41   XStoreColors (bugs 1979, 3770.)
    42 - X11video: fix SDL_VIDEORESIZE events not received when resizing
    43   window from the corner (inverted logic in X11 ConfigureNotify, i.e.
    44   resize handling - bug 1430.)
    45 - X11video: unblock SDL_WM_GrabInput() GrabNotViewable case (bug 1155.)
    46 - Mac OS X: fixed crash on any input in Quartz code (bug 2560.)
    47 - Mac OS X: fixed crash in Quartz gamma ramp code.
    48 - Mac OS X: fixed build for 10.9 Mavericks or newer (bug 2085.)
    49 - Mac OS X, joystick: update to support Saitek p2500 gamepad (bug 2025)
    50 - Mac OS X, main: updates for -psn_XXX command line arg for Finder
    51   launches in new macOS versions.
    52 - Mac OS X, main: replace deprecated CPS apis in new OSX versions
    53   (bug 4114.)
    54 - Windows, video: fix other window positions/sizes when exiting
    55   fullscreen (bug 3315.)
    56 - Windows, keyboard: reset deadkeys upon SDL_EnableUNICODE() or upon
    57   quit (bug 3332.)
    58 - Windows: Visual Studio project file updates.
    59 - OS/2: Watcom makefile updates.
    60 - FreeBSD, joystick: compile fixes.
    61 - BSD, joystick: increase the number of uhid devices to scan (bug 1561)
    62 - Linux, evdev: ignore joystick axis events if they aren't in a sane
    63   range.
    64 - Linux, joystick: fix Dualshock 3's motion sensors overwrite analog
    65   stick: protect against any axis that isn't reported by EVIOCGBIT but
    66   still sending EV_ABS events (bug 3193.)
    67 - FreeBSD, cdrom: fix CDROM detection misbehaviour for 7.x and newer
    68   (bug 1529.)
    69 - Solaris, audio: fix pulseaudio dynamic linking.
    70 - Solaris, cpuinfo: fix asm syntax error causing build failures.
    71 - Atari: multiple platform code updates.
    72 - RiscOS: cleanups to platform code.
    73 - RiscOS: fix thread starvation in fullscreen mode.
    74 - RiscOS: fix returning from full-screen to 16M colour modes.
    75 - RiscOS: fix receiving PreQuit messages.
    76 - RiscOS: ensure the window size is consistent at different DPIs.
    77 - RiscOS, video: add support for more pixel formats.
    78 - RiscOS: mouse fixes. restore mouse palette when exiting while mouse
    79   is in focus. don't reset mouse focus when recreating the window.
    80 - RiscOS: support Windows and Menu key input.
    81 - Configuration: fix library detection selecting wrong lib (bug 2795.)
    82 - Configuration: fix detecting dynamic library support on powerpc64le
    83   (bug 3481.)
    84 - SDL error: string formatting fixes to deal with nasty corner cases
    85   (bug 2049.)
    86 - SDL_error: handle %lu, %li and %ld in format string (bug 3739.)
    87 - stdlib: updated SDL_qsort() code.
    88 - stdlib: use _strtoi64() and _strtoui64() when available for windows.
    89 - headers, close_code.h: fix unbalanced #pragma pack(pop) for watcom
    90   builds (bug 3781.)
    91 - headers, begin_code.h, close_code.h: updates to SDLCALL and DECLSPEC
    92   macros for OS/2.
    93 - headers, endian: add Watcom inline asm for SDL_Swap16 and SDL_Swap32
    94 - headers, config: updates to default windows and os2 config files.
    95 - headers, SDL_syswm.h, SDL_stdinc.h: include system headers before
    96   packing alignment changes (bug 4149.)
    99 1.2.15:  This is a minor bug fix release:
   101 General Notes:
   102 - Fixed assembly register clobbering in CPU info routines.
   103 - Fixed memory stomp when using stretch blit on large images.
   104 - Fixed pixel corruption with overlapping blits.
   105 - SDL_JOYSTICK_DEVICE can be a colon separated list of joystick devices.
   106 - Disabled MMX blitters since they don't compile on modern compilers.
   108 Unix Notes:
   109 - Fixed crash in joystick code on newer Linux kernels.
   110 - Fixed channel swizzling for ALSA target with 6-channel output.
   111 - Use the OpenGL GLX_EXT_swap_control extension if available.
   112 - XRandR support is disabled by default because it causes desktop
   113   reconfiguring. It can be enabled with the SDL_VIDEO_X11_XRANDR=1
   114   environment variable.
   116 Windows Notes:
   117 - Fixed SDL_GL_ACCELERATED_VISUAL handling.
   118 - Fixed application state handling with ALT-Tab.
   119 - Fixed occasional crash handling WM_ACTIVATEAPP in Direct X code.
   120 - Fixed UTF-8 decoding of Russian characters.
   122 Mac OS X Notes:
   123 - Fixed building and running on Mac OS X 10.7 (Lion).
   126 1.2.14:
   127 	Added cast macros for correct usage with C++:
   128 		SDL_reinterpret_cast(type, expression)
   129 		SDL_static_cast(type, expression)
   131 	Added SDL_VIDEO_FULLSCREEN_DISPLAY as a preferred synonym for 
   134 	Added SDL_DISABLE_LOCK_KEYS environment variable to enable normal
   135 	up/down events for Caps-Lock and Num-Lock keys.
   137 1.2.13:
   138 	Added SDL_BUTTON_X1 and SDL_BUTTON_X2 constants.
   140 1.2.12:
   141 	Added SDL_VIDEO_ALLOW_SCREENSAVER to override SDL's disabling
   142 	of the screensaver on Mac OS X and X11.
   144 1.2.10:
   145 	If SDL_OpenAudio() is passed zero for the desired format
   146 	fields, the following environment variables will be used
   147 	to fill them in:
   152 	If an environment variable is not specified, it will be set
   153 	to a reasonable default value.
   155 	Added support for the SDL_VIDEO_FULLSCREEN_HEAD environment
   156 	variable, currently supported on X11 Xinerama configurations.
   158 	Added SDL_GL_SWAP_CONTROL to wait for vsync in OpenGL applications.
   160 	Added SDL_GL_ACCELERATED_VISUAL to guarantee hardware acceleration.
   162 	Added current_w and current_h to the SDL_VideoInfo structure,
   163 	which is set to the desktop resolution during video intialization,
   164 	and then set to the current resolution when a video mode is set.
   166 	SDL_SetVideoMode() now accepts 0 for width or height and will use
   167 	the current video mode (or the desktop mode if no mode has been set.)
   169 	Added SDL_GetKeyRepeat()
   171 	Added SDL_config.h, with defaults for various build environments.
   173 1.2.7:
   174 	Added CPU feature detection functions to SDL_cpuinfo.h:
   175 		SDL_HasRDTSC(), SDL_HasMMX(), SDL_Has3DNow(), SDL_HasSSE(),
   176 		SDL_HasAltiVec()
   177 	Added function to create RWops from const memory: SDL_RWFromConstMem()
   179 1.2.6:
   180 	Added SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject()
   184 1.2.5:
   187 	Added SDL_GL_STEREO for stereoscopic OpenGL contexts
   189 1.2.0:
   190 	Added SDL_VIDEOEXPOSE event to signal that the screen needs to
   191 	be redrawn.  This is currently only delivered to OpenGL windows
   192 	on X11, though it may be delivered in the future when the video
   193 	memory is lost under DirectX.
   195 1.1.8:
   196 	You can pass SDL_NOFRAME to SDL_VideoMode() to create a window
   197 	that has no title bar or frame decoration.  Fullscreen video
   198 	modes automatically have this flag set.
   200 	Added a function to query the clipping rectangle for a surface:
   201 		void SDL_GetClipRect(SDL_Surface *surface, SDL_Rect *rect)
   203 	Added a function to query the current event filter:
   204 		SDL_EventFilter SDL_GetEventFilter(void)
   206 	If you pass -1 to SDL_ShowCursor(), it won't change the current
   207 	cursor visibility state, but will still return it.
   209 	SDL_LockSurface() and SDL_UnlockSurface() are recursive, meaning
   210 	you can nest them as deep as you want, as long as each lock call
   211 	has a matching unlock call.  The surface remains locked until the
   212 	last matching unlock call.
   214 	Note that you may not blit to or from a locked surface.
   216 1.1.7:
   217 	The SDL_SetGammaRamp() and SDL_GetGammaRamp() functions now take
   218 	arrays of Uint16 values instead of Uint8 values.  For the most part,
   219 	you can just take your old values and shift them up 8 bits to get
   220 	new correct values for your gamma ramps.
   222 	You can pass SDL_RLEACCEL in flags passed to SDL_ConvertSurface()
   223         and SDL will try to RLE accelerate colorkey and alpha blits in the
   224 	resulting surface.
   226 1.1.6:
   227 	Added a function to return the thread ID of a specific thread:
   228 		Uint32 SDL_GetThreadID(SDL_Thread *thread)
   229 	If 'thread' is NULL, this function returns the id for this thread.
   231 1.1.5:
   232 	The YUV overlay structure has been changed to use an array of
   233 	pitches and pixels representing the planes of a YUV image, to
   234 	better enable hardware acceleration.  The YV12 and IYUV formats
   235 	each have three planes, corresponding to the Y, U, and V portions
   236 	of the image, while packed pixel YUV formats just have one plane.
   238 	For palettized mode (8bpp), the screen colormap is now split in
   239 	a physical and a logical palette. The physical palette determines
   240 	what colours the screen pixels will get when displayed, and the
   241 	logical palette controls the mapping from blits to/from the screen.
   242 	A new function, SDL_SetPalette() has been added to change
   243 	logical and physical palettes separately. SDL_SetColors() works
   244 	just as before, and is equivalent to calling SDL_SetPalette() with
   245 	a flag argument of (SDL_LOGPAL|SDL_PHYSPAL).
   247 	SDL_BlitSurface() no longer modifies the source rectangle, only the
   248 	destination rectangle. The width/height members of the destination
   249 	rectangle are ignored, only the position is used.
   251 	The old source clipping function SDL_SetClipping() has been replaced
   252 	with a more useful function to set the destination clipping rectangle:
   253 		SDL_bool SDL_SetClipRect(SDL_Surface *surface, SDL_Rect *rect)
   255 	Added a function to see what subsystems have been initialized:
   256 		Uint32 SDL_WasInit(Uint32 flags)
   258 	The Big Alpha Flip: SDL now treats alpha as opacity like everybody
   259 	else, and not as transparency:
   261 	A new cpp symbol: SDL_ALPHA_OPAQUE is defined as 255
   262 	A new cpp symbol: SDL_ALPHA_TRANSPARENT is defined as 0
   263 	Values between 0 and 255 vary from fully transparent to fully opaque.
   265 	New functions:
   266 	SDL_DisplayFormatAlpha()
   267 	    Returns a surface converted to a format with alpha-channel
   268 	    that can be blit efficiently to the screen. (In other words,
   269 	    like SDL_DisplayFormat() but the resulting surface has
   270 	    an alpha channel.)  This is useful for surfaces with alpha.
   271 	SDL_MapRGBA()
   272 	    Works as SDL_MapRGB() but takes an additional alpha parameter.
   273 	SDL_GetRGBA()
   274 	    Works as SDL_GetRGB() but also returns the alpha value
   275 	    (SDL_ALPHA_OPAQUE for formats without an alpha channel)
   277 	Both SDL_GetRGB() and SDL_GetRGBA() now always return values in
   278 	the [0..255] interval. Previously, SDL_GetRGB() would return
   279 	(0xf8, 0xfc, 0xf8) for a completely white pixel in RGB565 format.
   280 	(N.B.: This is broken for bit fields < 3 bits.)
   282 	SDL_MapRGB() returns pixels in which the alpha channel is set opaque.
   284 	SDL_SetAlpha() can now be used for both setting the per-surface
   285 	alpha, using the new way of thinking of alpha, and also to enable
   286 	and disable per-pixel alpha blending for surfaces with an alpha
   287 	channel:
   288 		To disable alpha blending:
   289 			SDL_SetAlpha(surface, 0, 0);
   290 		To re-enable alpha blending:
   291 			SDL_SetAlpha(surface, SDL_SRCALPHA, 0);
   292 	Surfaces with an alpha channel have blending enabled by default.
   294 	SDL_SetAlpha() now accepts SDL_RLEACCEL as a flag, which requests
   295 	RLE acceleration of blits, just as like with SDL_SetColorKey().
   296 	This flag can be set for both surfaces with an alpha channel
   297 	and surfaces with an alpha value set by SDL_SetAlpha().
   298 	As always, RLE surfaces must be locked before pixel access is
   299 	allowed, and unlocked before any other SDL operations are done
   300 	on it.
   302 	The blit semantics for surfaces with and without alpha and colorkey
   303 	have now been defined:
   305 	RGBA->RGB:
   306 	    SDL_SRCALPHA set:
   307 		alpha-blend (using alpha-channel).
   308 		SDL_SRCCOLORKEY ignored.
   309 	    SDL_SRCALPHA not set:
   310 		copy RGB.
   311 		if SDL_SRCCOLORKEY set, only copy the pixels matching the
   312 		RGB values of the source colour key, ignoring alpha in the
   313 		comparison.
   315 	RGB->RGBA:
   316 	    SDL_SRCALPHA set:
   317 		alpha-blend (using the source per-surface alpha value);
   318 		set destination alpha to opaque.
   319 	    SDL_SRCALPHA not set:
   320 		copy RGB, set destination alpha to opaque.
   321 	    both:
   322 		if SDL_SRCCOLORKEY set, only copy the pixels matching the
   323 		source colour key.
   325 	RGBA->RGBA:
   326 	    SDL_SRCALPHA set:
   327 		alpha-blend (using the source alpha channel) the RGB values;
   328 		leave destination alpha untouched. [Note: is this correct?]
   329 		SDL_SRCCOLORKEY ignored.
   330 	    SDL_SRCALPHA not set:
   331 		copy all of RGBA to the destination.
   332 		if SDL_SRCCOLORKEY set, only copy the pixels matching the
   333 		RGB values of the source colour key, ignoring alpha in the
   334 		comparison.
   336 	RGB->RGB: 
   337 	    SDL_SRCALPHA set:
   338 		alpha-blend (using the source per-surface alpha value).
   339 	    SDL_SRCALPHA not set:
   340 		copy RGB.
   341 	    both:
   342 		if SDL_SRCCOLORKEY set, only copy the pixels matching the
   343 		source colour key.
   345 	As a special case, blits from surfaces with per-surface alpha
   346 	value of 128 (50% transparency) are optimised and much faster
   347 	than other alpha values. This does not apply to surfaces with
   348 	alpha channels (per-pixel alpha).
   350 	New functions for manipulating the gamma of the display have
   351 	been added:
   352 		int SDL_SetGamma(float red, float green, float blue);
   353 		int SDL_SetGammaRamp(Uint8 *red, Uint8 *green, Uint8 *blue);
   354 		int SDL_GetGammaRamp(Uint8 *red, Uint8 *green, Uint8 *blue);
   355 	Gamma ramps are tables with 256 entries which map the screen color
   356 	components into actually displayed colors.  For an example of
   357 	implementing gamma correction and gamma fades, see test/testgamma.c
   358 	Gamma control is not supported on all hardware.
   360 1.1.4:
   361 	The size of the SDL_CDtrack structure changed from 8 to 12 bytes
   362 	as the size of the length member was extended to 32 bits.
   364         You can now use SDL for 2D blitting with a GL mode by passing the
   365 	SDL_OPENGLBLIT flag to SDL_SetVideoMode().  You can specify 16 or
   366 	32 bpp, and the data in the framebuffer is put into the GL scene
   367 	when you call SDL_UpdateRects(), and the scene will be visible
   368 	when you call SDL_GL_SwapBuffers().
   370 	Run the "testgl" test program with the -logo command line option
   371 	to see an example of this blending of 2D and 3D in SDL.
   373 1.1.3:
   374 	Added SDL_FreeRW() to the API, to complement SDL_AllocRW()
   376 	Added resizable window support - just add SDL_RESIZABLE to the
   377 	SDL_SetVideoMode() flags, and then wait for SDL_VIDEORESIZE events.
   378 	See SDL_events.h for details on the new SDL_ResizeEvent structure.
   380 	Added condition variable support, based on mutexes and semaphores.
   381 		SDL_CreateCond()
   382 		SDL_DestroyCond()
   383 		SDL_CondSignal()
   384 		SDL_CondBroadcast()
   385 		SDL_CondWait()
   386 		SDL_CondTimedWait()
   387 	The new function prototypes are in SDL_mutex.h
   389 	Added counting semaphore support, based on the mutex primitive.
   390 		SDL_CreateSemaphore()
   391 		SDL_DestroySemaphore()
   392 		SDL_SemWait()
   393 		SDL_SemTryWait()
   394 		SDL_SemWaitTimeout()
   395 		SDL_SemPost()
   396 		SDL_SemValue()
   397 	The new function prototypes are in SDL_mutex.h
   399 	Added support for asynchronous blitting.  To take advantage of this,
   400 	you must set the SDL_ASYNCBLIT flag when setting the video mode and
   401 	creating surfaces that you want accelerated in this way.  You must
   402 	lock surfaces that have this flag set, and the lock will block until
   403 	any queued blits have completed.
   405 	Added YUV video overlay support.
   406 	The supported YUV formats are: YV12, IYUV, YUY2, UYVY, and YVYU.
   407 	This function creates an overlay surface:
   408 		SDL_CreateYUVOverlay()
   409 	You must lock and unlock the overlay to get access to the data:
   410 		SDL_LockYUVOverlay() SDL_UnlockYUVOverlay()
   411 	You can then display the overlay:
   412 		SDL_DisplayYUVOverlay()
   413 	You must free the overlay when you are done using it:
   414 		SDL_FreeYUVOverlay()
   415 	See SDL_video.h for the full function prototypes.
   417 	The joystick hat position constants have been changed:
   418 	Old constant            New constant
   419 	------------            ------------
   420 	     0                  SDL_HAT_CENTERED
   421 	     1                  SDL_HAT_UP
   422 	     2                  SDL_HAT_RIGHTUP
   423 	     3                  SDL_HAT_RIGHT
   424 	     4                  SDL_HAT_RIGHTDOWN
   425 	     5                  SDL_HAT_DOWN
   426 	     6                  SDL_HAT_LEFTDOWN
   427 	     7                  SDL_HAT_LEFT
   428 	     8                  SDL_HAT_LEFTUP
   429 	The new constants are bitmasks, so you can check for the
   430 	individual axes like this:
   431 		if ( hat_position & SDL_HAT_UP ) {
   432 		}
   433 	and you'll catch left-up, up, and right-up.
   435 1.1.2:
   436 	Added multiple timer support:
   437 		SDL_AddTimer() and SDL_RemoveTimer()
   439 	SDL_WM_SetIcon() now respects the icon colorkey if mask is NULL.
   441 1.1.0:
   442 	Added initial OpenGL support.
   443 	First set GL attributes (such as RGB depth, alpha depth, etc.)
   444 		SDL_GL_SetAttribute()
   445 	Then call SDL_SetVideoMode() with the SDL_OPENGL flag.
   446 	Perform all of your normal GL drawing.
   447 	Finally swap the buffers with the new SDL function:
   448 		SDL_GL_SwapBuffers()
   449 	See the new 'testgl' test program for an example of using GL with SDL.
   451 	You can load GL extension functions by using the function:
   452 		SDL_GL_LoadProcAddress()
   454 	Added functions to initialize and cleanup specific SDL subsystems:
   455 		SDL_InitSubSystem() and SDL_QuitSubSystem()
   457 	Added user-defined event type:
   458 		typedef struct {
   459         		Uint8 type;
   460         		int code;
   461         		void *data1;
   462         		void *data2;
   463 		} SDL_UserEvent;
   464 	This structure is in the "user" member of an SDL_Event.
   466 	Added a function to push events into the event queue:
   467 		SDL_PushEvent()
   469 	Example of using the new SDL user-defined events:
   470 	{
   471 		SDL_Event event;
   473 		event.type = SDL_USEREVENT;
   474 		event.user.code = my_event_code;
   475 		event.user.data1 = significant_data;
   476 		event.user.data2 = 0;
   477 		SDL_PushEvent(&event);
   478 	}
   480 	Added a function to get mouse deltas since last query:
   481 		SDL_GetRelativeMouseState()
   483 	Added a boolean datatype to SDL_types.h:
   484 		SDL_bool = { SDL_TRUE, SDL_FALSE }
   486 	Added a function to get the current audio status:
   487 		SDL_GetAudioState();
   488 	It returns one of:
   493 	Added an AAlib driver (ASCII Art) - by Stephane Peter.
   495 1.0.6:
   496 	The input grab state is reset after each call to SDL_SetVideoMode().
   497 	The input is grabbed by default in fullscreen mode, and ungrabbed in
   498 	windowed mode.  If you want to set input grab to a particular value,
   499 	you should set it after each call to SDL_SetVideoMode().
   501 1.0.5:
   502 	Exposed SDL_AudioInit(), SDL_VideoInit()
   503 	Added SDL_AudioDriverName() and SDL_VideoDriverName()
   505 	Added new window manager function:
   506 		SDL_WM_ToggleFullScreen()
   507 	This is currently implemented only on Linux
   509 	The ALT-ENTER code has been removed - it's not appropriate for a
   510 	lib to bind keys when they aren't even emergency escape sequences.
   512 	ALT-ENTER functionality can be implemented with the following code:
   514 	int Handle_AltEnter(const SDL_Event *event)
   515 	{
   516 	    if ( event->type == SDL_KEYDOWN ) {
   517 	        if ( (event->key.keysym.sym == SDLK_RETURN) &&
   518 	             (event->key.keysym.mod & KMOD_ALT) ) {   
   519 	                SDL_WM_ToggleFullScreen(SDL_GetVideoSurface());
   520 	                return(0);
   521 	        }
   522 	    }
   523 	    return(1);
   524 	}
   525 	SDL_SetEventFilter(Handle_AltEnter);
   527 1.0.3:
   528 	Under X11, if you grab the input and hide the mouse cursor,
   529 	the mouse will go into a "relative motion" mode where you
   530 	will always get relative motion events no matter how far in
   531 	each direction you move the mouse - relative motion is not
   532 	bounded by the edges of the window (though the absolute values
   533 	of the mouse positions are clamped by the size of the window).
   534 	The SVGAlib, framebuffer console, and DirectInput drivers all
   535 	have this behavior naturally, and the GDI and BWindow drivers
   536 	never go into "relative motion" mode.
   538 1.0.2:
   539 	Added a function to enable keyboard repeat:
   540 		SDL_EnableKeyRepeat()
   542 	Added a function to grab the mouse and keyboard input
   543 		SDL_WM_GrabInput()
   545 	Added a function to iconify the window.
   546 		SDL_WM_IconifyWindow()
   547 	If this function succeeds, the application will receive an event
   548 	signaling SDL_APPACTIVE event 
   550 1.0.1:
   551 	Added constants to SDL_audio.h for 16-bit native byte ordering:
   554 1.0.0:
   555 	New public release
   557 Version 0.11:
   559 0.11.5:
   560 	A new function SDL_GetVideoSurface() has been added, and returns
   561 	a pointer to the current display surface.
   563 	SDL_AllocSurface() has been renamed SDL_CreateRGBSurface(), and
   564 	a new function SDL_CreateRGBSurfaceFrom() has been added to allow
   565 	creating an SDL surface from an existing pixel data buffer.
   567 	Added SDL_GetRGB() to the headers and documentation.
   569 0.11.4:
   570 	SDL_SetLibraryPath() is no longer meaningful, and has been removed.
   572 0.11.3:
   573 	A new flag for SDL_Init(), SDL_INIT_NOPARACHUTE, prevents SDL from
   574 	installing fatal signal handlers on operating systems that support
   575 	them.
   577 Version 0.9:
   579 0.9.15:
   580 	SDL_CreateColorCursor() has been removed.  Color cursors should
   581 	be implemented as sprites, blitted by the application when the
   582 	cursor moves.  To get smooth color cursor updates when the app
   583 	is busy, pass the SDL_INIT_EVENTTHREAD flag to SDL_Init().  This
   584 	allows you to handle the mouse motion in another thread from an
   585 	event filter function, but is currently only supported by Linux
   586 	and BeOS.  Note that you'll have to protect the display surface
   587 	from multi-threaded access by using mutexes if you do this.
   589 	Thread-safe surface support has been removed from SDL.
   590 	This makes blitting somewhat faster, by removing SDL_MiddleBlit().
   591 	Code that used SDL_MiddleBlit() should use SDL_LowerBlit() instead.
   592 	You can make your surfaces thread-safe by allocating your own
   593 	mutex and making lock/unlock calls around accesses to your surface.
   595 0.9.14:
   596 	SDL_GetMouseState() now takes pointers to int rather than Uint16.
   598 	If you set the SDL_WINDOWID environment variable under UNIX X11,
   599 	SDL will use that as the main window instead of creating it's own.
   600 	This is an unsupported extension to SDL, and not portable at all.
   602 0.9.13:
   603 	Added a function SDL_SetLibraryPath() which can be used to specify
   604 	the directory containing the SDL dynamic libraries.  This is useful
   605 	for commercial applications which ship with particular versions
   606 	of the libraries, and for security on multi-user systems.
   607 	If this function is not used, the default system directories are 
   608 	searched using the native dynamic object loading mechanism.
   610 	In order to support C linkage under Visual C++, you must declare
   611 	main() without any return type:
   612 		main(int argc, char *argv[]) {
   613 			/* Do the program... */
   614 			return(0);
   615 		}
   616 	C++ programs should also return a value if compiled under VC++.
   618 	The blit_endian member of the SDL_VideoInfo struct has been removed.
   620 	SDL_SymToASCII() has been replaced with SDL_GetKeyName(), so there
   621 	is now no longer any function to translate a keysym to a character.
   623 	The SDL_keysym structure has been extended with a 'scancode' and
   624 	'unicode' member.  The 'scancode' is a hardware specific scancode
   625 	for the key that was pressed, and may be 0.  The 'unicode' member
   626 	is a 16-bit UNICODE translation of the key that was pressed along
   627 	with any modifiers or compose keys that have been pressed.
   628 	If no UNICODE translation exists for the key, 'unicode' will be 0.
   630 	Added a function SDL_EnableUNICODE() to enable/disable UNICODE
   631 	translation of character keypresses.  Translation defaults off.
   633 	To convert existing code to use the new API, change code which
   634 	uses SDL_SymToASCII() to get the keyname to use SDL_GetKeyName(),
   635 	and change code which uses it to get the ASCII value of a sym to
   636 	use the 'unicode' member of the event keysym.
   638 0.9.12:
   639 	There is partial support for 64-bit datatypes.  I don't recommend 
   640 	you use this if you have a choice, because 64-bit datatypes are not
   641 	supported on many platforms.  On platforms for which it is supported,
   642 	the SDL_HAS_64BIT_TYPE C preprocessor define will be enabled, and
   643 	you can use the Uint64 and Sint64 datatypes.
   645 	Added functions to SDL_endian.h to support 64-bit datatypes:
   646 	    SDL_SwapLE64(), SDL_SwapBE64(),
   647 	    SDL_ReadLE64(), SDL_ReadBE64(), SDL_WriteLE64(), SDL_WriteBE64()
   649 	A new member "len_ratio" has been added to the SDL_AudioCVT structure,
   650 	and allows you to determine either the original buffer length or the
   651 	converted buffer length, given the other.
   653 	A new function SDL_FreeWAV() has been added to the API to free data
   654 	allocated by SDL_LoadWAV_RW().  This is necessary under Win32 since
   655 	the gcc compiled DLL uses a different heap than VC++ compiled apps.
   657 	SDL now has initial support for international keyboards using the
   658 	Latin character set.
   659 	If a particular mapping is desired, you can set the DEFAULT_KEYBOARD
   660 	compile-time variable, or you can set the environment variable 
   661 	"SDL_KEYBOARD" to a string identifying the keyboard mapping you desire.
   662 	The valid values for these variables can be found in SDL_keyboard.c
   664 	Full support for German and French keyboards under X11 is implemented.
   666 0.9.11:
   667 	The THREADED_EVENTS compile-time define has been replaced with the
   668 	SDL_INIT_EVENTTHREAD flag.  If this flag is passed to SDL_Init(),
   669 	SDL will create a separate thread to perform input event handling.
   670 	If this flag is passed to SDL_Init(), and the OS doesn't support 
   671 	event handling in a separate thread, SDL_Init() will fail.
   672 	Be sure to add calls to SDL_Delay() in your main thread to allow
   673 	the OS to schedule your event thread, or it may starve, leading
   674 	to slow event delivery and/or dropped events.
   675 	Currently MacOS and Win32 do not support this flag, while BeOS 
   676 	and Linux do support it.  I recommend that your application only
   677 	use this flag if absolutely necessary.
   679 	The SDL thread function passed to SDL_CreateThread() now returns a
   680 	status.  This status can be retrieved by passing a non-NULL pointer
   681 	as the 'status' argument to SDL_WaitThread().
   683 	The volume parameter to SDL_MixAudio() has been increased in range
   684 	from (0-8) to (0-128)
   686 	SDL now has a data source abstraction which can encompass a file,
   687 	an area of memory, or any custom object you can envision.  It uses
   688 	these abstractions, SDL_RWops, in the endian read/write functions,
   689 	and the built-in WAV and BMP file loaders.  This means you can load
   690 	WAV chunks from memory mapped files, compressed archives, network
   691 	pipes, or anything else that has a data read abstraction.
   693 	There are three built-in data source abstractions:
   694 	    SDL_RWFromFile(), SDL_RWFromFP(), SDL_RWFromMem()
   695 	along with a generic data source allocation function:
   696 	    SDL_AllocRW()
   697 	These data sources can be used like stdio file pointers with the
   698 	following convenience functions:
   699 	    SDL_RWseek(), SDL_RWread(), SDL_RWwrite(), SDL_RWclose()
   700 	These functions are defined in the new header file "SDL_rwops.h"
   702 	The endian swapping functions have been turned into macros for speed
   703 	and SDL_CalculateEndian() has been removed.  SDL_endian.h now defines
   704 	SDL_BYTEORDER as either SDL_BIG_ENDIAN or SDL_LIL_ENDIAN depending on
   705 	the endianness of the host system.
   707 	The endian read/write functions now take an SDL_RWops pointer
   708 	instead of a stdio FILE pointer, to support the new data source
   709 	abstraction.
   711 	The SDL_*LoadWAV() functions have been replaced with a single
   712 	SDL_LoadWAV_RW() function that takes a SDL_RWops pointer as it's
   713 	first parameter, and a flag whether or not to automatically 
   714 	free it as the second parameter.  SDL_LoadWAV() is a macro for
   715 	backward compatibility and convenience:
   716 	    SDL_LoadWAV_RW(SDL_RWFromFile("sample.wav", "rb"), 1, ...);
   718 	The SDL_*LoadBMP()/SDL_*SaveBMP() functions have each been replaced
   719 	with a single function that takes a SDL_RWops pointer as it's
   720 	first parameter, and a flag whether or not to automatically 
   721 	free it as the second parameter.  SDL_LoadBMP() and SDL_SaveBMP()
   722 	are macros for backward compatibility and convenience:
   723 	    SDL_LoadBMP_RW(SDL_RWFromFile("sample.bmp", "rb"), 1, ...);
   724 	    SDL_SaveBMP_RW(SDL_RWFromFile("sample.bmp", "wb"), 1, ...);
   725 	Note that these functions use SDL_RWseek() extensively, and should
   726 	not be used on pipes or other non-seekable data sources.
   728 0.9.10:
   729 	The Linux SDL_SysWMInfo and SDL_SysWMMsg structures have been 
   730 	extended to support multiple types of display drivers, as well as
   731         safe access to the X11 display when THREADED_EVENTS is enabled.
   732         The new structures are documented in the SDL_syswm.h header file.
   734 	Thanks to John Elliott <jce@seasip.demon.co.uk>, the UK keyboard
   735 	should now work properly, as well as the "Windows" keys on US
   736 	keyboards.
   738 	The Linux CD-ROM code now reads the CD-ROM devices from /etc/fstab
   739 	instead of trying to open each block device on the system.
   740 	The CD must be listed in /etc/fstab as using the iso9660 filesystem.
   742 	On Linux, if you define THREADED_EVENTS at compile time, a separate
   743 	thread will be spawned to gather X events asynchronously from the
   744 	graphics updates.  This hasn't been extensively tested, but it does
   745 	provide a means of handling keyboard and mouse input in a separate
   746 	thread from the graphics thread.  (This is now enabled by default.)
   748 	A special access function SDL_PeepEvents() allows you to manipulate
   749 	the event queue in a thread-safe manner, including peeking at events,
   750 	removing events of a specified type, and adding new events of arbitrary
   751 	type to the queue (use the new 'user' member of the SDL_Event type).
   753 	If you use SDL_PeepEvents() to gather events, then the main graphics
   754 	thread needs to call SDL_PumpEvents() periodically to drive the event
   755 	loop and generate input events.  This is not necessary if SDL has been 
   756 	compiled with THREADED_EVENTS defined, but doesn't hurt.
   758 	A new function SDL_ThreadID() returns the identifier associated with
   759 	the current thread.
   761 0.9.9:
   762 	The AUDIO_STEREO format flag has been replaced with a new 'channels'
   763 	member of the SDL_AudioSpec structure.  The channels are 1 for mono
   764 	audio, and 2 for stereo audio.  In the future more channels may be
   765 	supported for 3D surround sound.
   767 	The SDL_MixAudio() function now takes an additional volume parameter,
   768 	which should be set to SDL_MIX_MAXVOLUME for compatibility with the
   769 	original function.
   771 	The CD-ROM functions which take a 'cdrom' parameter can now be
   772 	passed NULL, and will act on the last successfully opened CD-ROM.
   774 0.9.8:
   775 	No changes, bugfixes only.
   777 0.9.7:
   778 	No changes, bugfixes only.
   780 0.9.6:
   781 	Added a fast rectangle fill function: SDL_FillRect()
   783 	Addition of a useful function for getting info on the video hardware:
   784 	    const SDL_VideoInfo *SDL_GetVideoInfo(void)
   785         This function replaces SDL_GetDisplayFormat().
   787 	Initial support for double-buffering:
   788 	  Use the SDL_DOUBLEBUF flag in SDL_SetVideoMode()
   789 	  Update the screen with a new function: SDL_Flip()
   791 	SDL_AllocSurface() takes two new flags:
   792 	SDL_SRCCOLORKEY means that the surface will be used for colorkey blits
   793 	  and if the hardware supports hardware acceleration of colorkey blits
   794 	  between two surfaces in video memory, to place the surface in video
   795 	  memory if possible, otherwise it will be placed in system memory.
   796 	SDL_SRCALPHA means that the surface will be used for alpha blits and
   797 	  if the hardware supports hardware acceleration of alpha blits between
   798 	  two surfaces in video memory, to place the surface in video memory
   799 	  if possible, otherwise it will be placed in system memory.
   800 	SDL_HWSURFACE now means that the surface will be created with the 
   801 	  same format as the display surface, since having surfaces in video
   802 	  memory is only useful for fast blitting to the screen, and you can't
   803 	  blit surfaces with different surface formats in video memory.
   805 0.9.5:
   806 	You can now pass a NULL mask to SDL_WM_SetIcon(), and it will assume
   807 	that the icon consists of the entire image.
   809 	SDL_LowerBlit() is back -- but don't use it on the display surface.
   810 	It is exactly the same as SDL_MiddleBlit(), but doesn't check for
   811 	thread safety.
   813 	Added SDL_FPLoadBMP(), SDL_FPSaveBMP(), SDL_FPLoadWAV(), which take
   814 	a FILE pointer instead of a file name.
   816 	Added CD-ROM audio control API:
   817 	    SDL_CDNumDrives()
   818 	    SDL_CDName()
   819 	    SDL_CDOpen()
   820 	    SDL_CDStatus()
   821 	    SDL_CDPlayTracks()
   822 	    SDL_CDPlay()
   823 	    SDL_CDPause()
   824 	    SDL_CDResume()
   825 	    SDL_CDStop()
   826 	    SDL_CDEject()
   827 	    SDL_CDClose()
   829 0.9.4:
   830 	No changes, bugfixes only.
   832 0.9.3:
   833 	Mouse motion event now includes relative motion information:
   834 	    Sint16 event->motion.xrel, Sint16 event->motion.yrel
   836 	X11 keyrepeat handling can be disabled by defining IGNORE_X_KEYREPEAT
   837 	    (Add -DIGNORE_X_KEYREPEAT to CFLAGS line in obj/x11Makefile)
   839 0.9.2:
   840 	No changes, bugfixes only.
   842 0.9.1:
   843 	Removed SDL_MapSurface() and SDL_UnmapSurface() -- surfaces are now
   844 	automatically mapped on blit.
   846 0.8.0:
   847 	SDL stable release