WhatsNew
author Sam Lantinga <slouken@libsdl.org>
Fri, 15 Jun 2007 05:21:33 +0000
branchSDL-1.2
changeset 3960 f5daa62ce1c4
parent 1794 5605a9820134
child 4009 1146681dbb74
permissions -rw-r--r--
Updated docs with bug fixes in subversion.
     1 
     2 This is a list of API changes in SDL's version history.
     3 
     4 Version 1.0:
     5 
     6 1.2.12:
     7 	Added SDL_VIDEO_ALLOW_SCREENSAVER to override SDL's disabling
     8 	of the screensaver on Mac OS X and X11.
     9 
    10 1.2.10:
    11 	If SDL_OpenAudio() is passed zero for the desired format
    12 	fields, the following environment variables will be used
    13 	to fill them in:
    14 		SDL_AUDIO_FREQUENCY
    15 		SDL_AUDIO_FORMAT
    16 		SDL_AUDIO_CHANNELS
    17 		SDL_AUDIO_SAMPLES
    18 	If an environment variable is not specified, it will be set
    19 	to a reasonable default value.
    20 
    21 	Added support for the SDL_VIDEO_FULLSCREEN_HEAD environment
    22 	variable, currently supported on X11 Xinerama configurations.
    23 
    24 	Added SDL_GL_SWAP_CONTROL to wait for vsync in OpenGL applications.
    25 
    26 	Added SDL_GL_ACCELERATED_VISUAL to guarantee hardware acceleration.
    27 
    28 	Added current_w and current_h to the SDL_VideoInfo structure,
    29 	which is set to the desktop resolution during video intialization,
    30 	and then set to the current resolution when a video mode is set.
    31 
    32 	SDL_SetVideoMode() now accepts 0 for width or height and will use
    33 	the current video mode (or the desktop mode if no mode has been set.)
    34 
    35 	Added SDL_GetKeyRepeat()
    36 
    37 	Added SDL_config.h, with defaults for various build environments.
    38 
    39 1.2.7:
    40 	Added CPU feature detection functions to SDL_cpuinfo.h:
    41 		SDL_HasRDTSC(), SDL_HasMMX(), SDL_Has3DNow(), SDL_HasSSE(),
    42 		SDL_HasAltiVec()
    43 	Added function to create RWops from const memory: SDL_RWFromConstMem()
    44 
    45 1.2.6:
    46 	Added SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject()
    47 
    48 	Added SDL_GL_MULTISAMPLEBUFFERS and SDL_GL_MULTISAMPLESAMPLES for FSAA
    49 
    50 1.2.5:
    51 	Added SDL_BUTTON_WHEELUP (4) and SDL_BUTTON_WHEELDOWN (5)
    52 
    53 	Added SDL_GL_STEREO for stereoscopic OpenGL contexts
    54 
    55 1.2.0:
    56 	Added SDL_VIDEOEXPOSE event to signal that the screen needs to
    57 	be redrawn.  This is currently only delivered to OpenGL windows
    58 	on X11, though it may be delivered in the future when the video
    59 	memory is lost under DirectX.
    60 
    61 1.1.8:
    62 	You can pass SDL_NOFRAME to SDL_VideoMode() to create a window
    63 	that has no title bar or frame decoration.  Fullscreen video
    64 	modes automatically have this flag set.
    65 
    66 	Added a function to query the clipping rectangle for a surface:
    67 		void SDL_GetClipRect(SDL_Surface *surface, SDL_Rect *rect)
    68 
    69 	Added a function to query the current event filter:
    70 		SDL_EventFilter SDL_GetEventFilter(void)
    71 
    72 	If you pass -1 to SDL_ShowCursor(), it won't change the current
    73 	cursor visibility state, but will still return it.
    74 
    75 	SDL_LockSurface() and SDL_UnlockSurface() are recursive, meaning
    76 	you can nest them as deep as you want, as long as each lock call
    77 	has a matching unlock call.  The surface remains locked until the
    78 	last matching unlock call.
    79 
    80 	Note that you may not blit to or from a locked surface.
    81 
    82 1.1.7:
    83 	The SDL_SetGammaRamp() and SDL_GetGammaRamp() functions now take
    84 	arrays of Uint16 values instead of Uint8 values.  For the most part,
    85 	you can just take your old values and shift them up 8 bits to get
    86 	new correct values for your gamma ramps.
    87 
    88 	You can pass SDL_RLEACCEL in flags passed to SDL_ConvertSurface()
    89         and SDL will try to RLE accelerate colorkey and alpha blits in the
    90 	resulting surface.
    91 
    92 1.1.6:
    93 	Added a function to return the thread ID of a specific thread:
    94 		Uint32 SDL_GetThreadID(SDL_Thread *thread)
    95 	If 'thread' is NULL, this function returns the id for this thread.
    96 
    97 1.1.5:
    98 	The YUV overlay structure has been changed to use an array of
    99 	pitches and pixels representing the planes of a YUV image, to
   100 	better enable hardware acceleration.  The YV12 and IYUV formats
   101 	each have three planes, corresponding to the Y, U, and V portions
   102 	of the image, while packed pixel YUV formats just have one plane.
   103 
   104 	For palettized mode (8bpp), the screen colormap is now split in
   105 	a physical and a logical palette. The physical palette determines
   106 	what colours the screen pixels will get when displayed, and the
   107 	logical palette controls the mapping from blits to/from the screen.
   108 	A new function, SDL_SetPalette() has been added to change
   109 	logical and physical palettes separately. SDL_SetColors() works
   110 	just as before, and is equivalent to calling SDL_SetPalette() with
   111 	a flag argument of (SDL_LOGPAL|SDL_PHYSPAL).
   112 
   113 	SDL_BlitSurface() no longer modifies the source rectangle, only the
   114 	destination rectangle. The width/height members of the destination
   115 	rectangle are ignored, only the position is used.
   116 
   117 	The old source clipping function SDL_SetClipping() has been replaced
   118 	with a more useful function to set the destination clipping rectangle:
   119 		SDL_bool SDL_SetClipRect(SDL_Surface *surface, SDL_Rect *rect)
   120 		
   121 	Added a function to see what subsystems have been initialized:
   122 		Uint32 SDL_WasInit(Uint32 flags)
   123 
   124 	The Big Alpha Flip: SDL now treats alpha as opacity like everybody
   125 	else, and not as transparency:
   126 
   127 	A new cpp symbol: SDL_ALPHA_OPAQUE is defined as 255
   128 	A new cpp symbol: SDL_ALPHA_TRANSPARENT is defined as 0
   129 	Values between 0 and 255 vary from fully transparent to fully opaque.
   130 
   131 	New functions:
   132 	SDL_DisplayFormatAlpha()
   133 	    Returns a surface converted to a format with alpha-channel
   134 	    that can be blit efficiently to the screen. (In other words,
   135 	    like SDL_DisplayFormat() but the resulting surface has
   136 	    an alpha channel.)  This is useful for surfaces with alpha.
   137 	SDL_MapRGBA()
   138 	    Works as SDL_MapRGB() but takes an additional alpha parameter.
   139 	SDL_GetRGBA()
   140 	    Works as SDL_GetRGB() but also returns the alpha value
   141 	    (SDL_ALPHA_OPAQUE for formats without an alpha channel)
   142 
   143 	Both SDL_GetRGB() and SDL_GetRGBA() now always return values in
   144 	the [0..255] interval. Previously, SDL_GetRGB() would return
   145 	(0xf8, 0xfc, 0xf8) for a completely white pixel in RGB565 format.
   146 	(N.B.: This is broken for bit fields < 3 bits.)
   147 
   148 	SDL_MapRGB() returns pixels in which the alpha channel is set opaque.
   149 
   150 	SDL_SetAlpha() can now be used for both setting the per-surface
   151 	alpha, using the new way of thinking of alpha, and also to enable
   152 	and disable per-pixel alpha blending for surfaces with an alpha
   153 	channel:
   154 		To disable alpha blending:
   155 			SDL_SetAlpha(surface, 0, 0);
   156 		To re-enable alpha blending:
   157 			SDL_SetAlpha(surface, SDL_SRCALPHA, 0);
   158 	Surfaces with an alpha channel have blending enabled by default.
   159 
   160 	SDL_SetAlpha() now accepts SDL_RLEACCEL as a flag, which requests
   161 	RLE acceleration of blits, just as like with SDL_SetColorKey().
   162 	This flag can be set for both surfaces with an alpha channel
   163 	and surfaces with an alpha value set by SDL_SetAlpha().
   164 	As always, RLE surfaces must be locked before pixel access is
   165 	allowed, and unlocked before any other SDL operations are done
   166 	on it.
   167 
   168 	The blit semantics for surfaces with and without alpha and colorkey
   169 	have now been defined:
   170 
   171 	RGBA->RGB:
   172 	    SDL_SRCALPHA set:
   173 		alpha-blend (using alpha-channel).
   174 		SDL_SRCCOLORKEY ignored.
   175 	    SDL_SRCALPHA not set:
   176 		copy RGB.
   177 		if SDL_SRCCOLORKEY set, only copy the pixels matching the
   178 		RGB values of the source colour key, ignoring alpha in the
   179 		comparison.
   180 
   181 	RGB->RGBA:
   182 	    SDL_SRCALPHA set:
   183 		alpha-blend (using the source per-surface alpha value);
   184 		set destination alpha to opaque.
   185 	    SDL_SRCALPHA not set:
   186 		copy RGB, set destination alpha to opaque.
   187 	    both:
   188 		if SDL_SRCCOLORKEY set, only copy the pixels matching the
   189 		source colour key.
   190 
   191 	RGBA->RGBA:
   192 	    SDL_SRCALPHA set:
   193 		alpha-blend (using the source alpha channel) the RGB values;
   194 		leave destination alpha untouched. [Note: is this correct?]
   195 		SDL_SRCCOLORKEY ignored.
   196 	    SDL_SRCALPHA not set:
   197 		copy all of RGBA to the destination.
   198 		if SDL_SRCCOLORKEY set, only copy the pixels matching the
   199 		RGB values of the source colour key, ignoring alpha in the
   200 		comparison.
   201 
   202 	RGB->RGB: 
   203 	    SDL_SRCALPHA set:
   204 		alpha-blend (using the source per-surface alpha value).
   205 	    SDL_SRCALPHA not set:
   206 		copy RGB.
   207 	    both:
   208 		if SDL_SRCCOLORKEY set, only copy the pixels matching the
   209 		source colour key.
   210 
   211 	As a special case, blits from surfaces with per-surface alpha
   212 	value of 128 (50% transparency) are optimised and much faster
   213 	than other alpha values. This does not apply to surfaces with
   214 	alpha channels (per-pixel alpha).
   215 
   216 	New functions for manipulating the gamma of the display have
   217 	been added:
   218 		int SDL_SetGamma(float red, float green, float blue);
   219 		int SDL_SetGammaRamp(Uint8 *red, Uint8 *green, Uint8 *blue);
   220 		int SDL_GetGammaRamp(Uint8 *red, Uint8 *green, Uint8 *blue);
   221 	Gamma ramps are tables with 256 entries which map the screen color
   222 	components into actually displayed colors.  For an example of
   223 	implementing gamma correction and gamma fades, see test/testgamma.c
   224 	Gamma control is not supported on all hardware.
   225 
   226 1.1.4:
   227 	The size of the SDL_CDtrack structure changed from 8 to 12 bytes
   228 	as the size of the length member was extended to 32 bits.
   229 
   230         You can now use SDL for 2D blitting with a GL mode by passing the
   231 	SDL_OPENGLBLIT flag to SDL_SetVideoMode().  You can specify 16 or
   232 	32 bpp, and the data in the framebuffer is put into the GL scene
   233 	when you call SDL_UpdateRects(), and the scene will be visible
   234 	when you call SDL_GL_SwapBuffers().
   235 
   236 	Run the "testgl" test program with the -logo command line option
   237 	to see an example of this blending of 2D and 3D in SDL.
   238 
   239 1.1.3:
   240 	Added SDL_FreeRW() to the API, to complement SDL_AllocRW()
   241 
   242 	Added resizable window support - just add SDL_RESIZABLE to the
   243 	SDL_SetVideoMode() flags, and then wait for SDL_VIDEORESIZE events.
   244 	See SDL_events.h for details on the new SDL_ResizeEvent structure.
   245 
   246 	Added condition variable support, based on mutexes and semaphores.
   247 		SDL_CreateCond()
   248 		SDL_DestroyCond()
   249 		SDL_CondSignal()
   250 		SDL_CondBroadcast()
   251 		SDL_CondWait()
   252 		SDL_CondTimedWait()
   253 	The new function prototypes are in SDL_mutex.h
   254 
   255 	Added counting semaphore support, based on the mutex primitive.
   256 		SDL_CreateSemaphore()
   257 		SDL_DestroySemaphore()
   258 		SDL_SemWait()
   259 		SDL_SemTryWait()
   260 		SDL_SemWaitTimeout()
   261 		SDL_SemPost()
   262 		SDL_SemValue()
   263 	The new function prototypes are in SDL_mutex.h
   264 
   265 	Added support for asynchronous blitting.  To take advantage of this,
   266 	you must set the SDL_ASYNCBLIT flag when setting the video mode and
   267 	creating surfaces that you want accelerated in this way.  You must
   268 	lock surfaces that have this flag set, and the lock will block until
   269 	any queued blits have completed.
   270 
   271 	Added YUV video overlay support.
   272 	The supported YUV formats are: YV12, IYUV, YUY2, UYVY, and YVYU.
   273 	This function creates an overlay surface:
   274 		SDL_CreateYUVOverlay()
   275 	You must lock and unlock the overlay to get access to the data:
   276 		SDL_LockYUVOverlay() SDL_UnlockYUVOverlay()
   277 	You can then display the overlay:
   278 		SDL_DisplayYUVOverlay()
   279 	You must free the overlay when you are done using it:
   280 		SDL_FreeYUVOverlay()
   281 	See SDL_video.h for the full function prototypes.
   282 
   283 	The joystick hat position constants have been changed:
   284 	Old constant            New constant
   285 	------------            ------------
   286 	     0                  SDL_HAT_CENTERED
   287 	     1                  SDL_HAT_UP
   288 	     2                  SDL_HAT_RIGHTUP
   289 	     3                  SDL_HAT_RIGHT
   290 	     4                  SDL_HAT_RIGHTDOWN
   291 	     5                  SDL_HAT_DOWN
   292 	     6                  SDL_HAT_LEFTDOWN
   293 	     7                  SDL_HAT_LEFT
   294 	     8                  SDL_HAT_LEFTUP
   295 	The new constants are bitmasks, so you can check for the
   296 	individual axes like this:
   297 		if ( hat_position & SDL_HAT_UP ) {
   298 		}
   299 	and you'll catch left-up, up, and right-up.
   300 
   301 1.1.2:
   302 	Added multiple timer support:
   303 		SDL_AddTimer() and SDL_RemoveTimer()
   304 
   305 	SDL_WM_SetIcon() now respects the icon colorkey if mask is NULL.
   306 
   307 1.1.0:
   308 	Added initial OpenGL support.
   309 	First set GL attributes (such as RGB depth, alpha depth, etc.)
   310 		SDL_GL_SetAttribute()
   311 	Then call SDL_SetVideoMode() with the SDL_OPENGL flag.
   312 	Perform all of your normal GL drawing.
   313 	Finally swap the buffers with the new SDL function:
   314 		SDL_GL_SwapBuffers()
   315 	See the new 'testgl' test program for an example of using GL with SDL.
   316 
   317 	You can load GL extension functions by using the function:
   318 		SDL_GL_LoadProcAddress()
   319 
   320 	Added functions to initialize and cleanup specific SDL subsystems:
   321 		SDL_InitSubSystem() and SDL_QuitSubSystem()
   322 
   323 	Added user-defined event type:
   324 		typedef struct {
   325         		Uint8 type;
   326         		int code;
   327         		void *data1;
   328         		void *data2;
   329 		} SDL_UserEvent;
   330 	This structure is in the "user" member of an SDL_Event.
   331 
   332 	Added a function to push events into the event queue:
   333 		SDL_PushEvent()
   334 
   335 	Example of using the new SDL user-defined events:
   336 	{
   337 		SDL_Event event;
   338 
   339 		event.type = SDL_USEREVENT;
   340 		event.user.code = my_event_code;
   341 		event.user.data1 = significant_data;
   342 		event.user.data2 = 0;
   343 		SDL_PushEvent(&event);
   344 	}
   345 
   346 	Added a function to get mouse deltas since last query:
   347 		SDL_GetRelativeMouseState()
   348 
   349 	Added a boolean datatype to SDL_types.h:
   350 		SDL_bool = { SDL_TRUE, SDL_FALSE }
   351 
   352 	Added a function to get the current audio status:
   353 		SDL_GetAudioState();
   354 	It returns one of:
   355 		SDL_AUDIO_STOPPED,
   356 		SDL_AUDIO_PLAYING,
   357 		SDL_AUDIO_PAUSED
   358 
   359 	Added an AAlib driver (ASCII Art) - by Stephane Peter.
   360 
   361 1.0.6:
   362 	The input grab state is reset after each call to SDL_SetVideoMode().
   363 	The input is grabbed by default in fullscreen mode, and ungrabbed in
   364 	windowed mode.  If you want to set input grab to a particular value,
   365 	you should set it after each call to SDL_SetVideoMode().
   366 
   367 1.0.5:
   368 	Exposed SDL_AudioInit(), SDL_VideoInit()
   369 	Added SDL_AudioDriverName() and SDL_VideoDriverName()
   370 
   371 	Added new window manager function:
   372 		SDL_WM_ToggleFullScreen()
   373 	This is currently implemented only on Linux
   374 
   375 	The ALT-ENTER code has been removed - it's not appropriate for a
   376 	lib to bind keys when they aren't even emergency escape sequences.
   377 
   378 	ALT-ENTER functionality can be implemented with the following code:
   379 
   380 	int Handle_AltEnter(const SDL_Event *event)
   381 	{
   382 	    if ( event->type == SDL_KEYDOWN ) {
   383 	        if ( (event->key.keysym.sym == SDLK_RETURN) &&
   384 	             (event->key.keysym.mod & KMOD_ALT) ) {   
   385 	                SDL_WM_ToggleFullScreen(SDL_GetVideoSurface());
   386 	                return(0);
   387 	        }
   388 	    }
   389 	    return(1);
   390 	}
   391 	SDL_SetEventFilter(Handle_AltEnter);
   392 
   393 1.0.3:
   394 	Under X11, if you grab the input and hide the mouse cursor,
   395 	the mouse will go into a "relative motion" mode where you
   396 	will always get relative motion events no matter how far in
   397 	each direction you move the mouse - relative motion is not
   398 	bounded by the edges of the window (though the absolute values
   399 	of the mouse positions are clamped by the size of the window).
   400 	The SVGAlib, framebuffer console, and DirectInput drivers all
   401 	have this behavior naturally, and the GDI and BWindow drivers
   402 	never go into "relative motion" mode.
   403 
   404 1.0.2:
   405 	Added a function to enable keyboard repeat:
   406 		SDL_EnableKeyRepeat()
   407 
   408 	Added a function to grab the mouse and keyboard input
   409 		SDL_WM_GrabInput()
   410 
   411 	Added a function to iconify the window.
   412 		SDL_WM_IconifyWindow()
   413 	If this function succeeds, the application will receive an event
   414 	signaling SDL_APPACTIVE event 
   415 
   416 1.0.1:
   417 	Added constants to SDL_audio.h for 16-bit native byte ordering:
   418 		AUDIO_U16SYS, AUDIO_S16SYS
   419 
   420 1.0.0:
   421 	New public release
   422 
   423 Version 0.11:
   424 
   425 0.11.5:
   426 	A new function SDL_GetVideoSurface() has been added, and returns
   427 	a pointer to the current display surface.
   428 
   429 	SDL_AllocSurface() has been renamed SDL_CreateRGBSurface(), and
   430 	a new function SDL_CreateRGBSurfaceFrom() has been added to allow
   431 	creating an SDL surface from an existing pixel data buffer.
   432 
   433 	Added SDL_GetRGB() to the headers and documentation.
   434 
   435 0.11.4:
   436 	SDL_SetLibraryPath() is no longer meaningful, and has been removed.
   437 
   438 0.11.3:
   439 	A new flag for SDL_Init(), SDL_INIT_NOPARACHUTE, prevents SDL from
   440 	installing fatal signal handlers on operating systems that support
   441 	them.
   442 
   443 Version 0.9:
   444 
   445 0.9.15:
   446 	SDL_CreateColorCursor() has been removed.  Color cursors should
   447 	be implemented as sprites, blitted by the application when the
   448 	cursor moves.  To get smooth color cursor updates when the app
   449 	is busy, pass the SDL_INIT_EVENTTHREAD flag to SDL_Init().  This
   450 	allows you to handle the mouse motion in another thread from an
   451 	event filter function, but is currently only supported by Linux
   452 	and BeOS.  Note that you'll have to protect the display surface
   453 	from multi-threaded access by using mutexes if you do this.
   454 
   455 	Thread-safe surface support has been removed from SDL.
   456 	This makes blitting somewhat faster, by removing SDL_MiddleBlit().
   457 	Code that used SDL_MiddleBlit() should use SDL_LowerBlit() instead.
   458 	You can make your surfaces thread-safe by allocating your own
   459 	mutex and making lock/unlock calls around accesses to your surface.
   460 
   461 0.9.14:
   462 	SDL_GetMouseState() now takes pointers to int rather than Uint16.
   463 
   464 	If you set the SDL_WINDOWID environment variable under UNIX X11,
   465 	SDL will use that as the main window instead of creating it's own.
   466 	This is an unsupported extension to SDL, and not portable at all.
   467 
   468 0.9.13:
   469 	Added a function SDL_SetLibraryPath() which can be used to specify
   470 	the directory containing the SDL dynamic libraries.  This is useful
   471 	for commercial applications which ship with particular versions
   472 	of the libraries, and for security on multi-user systems.
   473 	If this function is not used, the default system directories are 
   474 	searched using the native dynamic object loading mechanism.
   475 
   476 	In order to support C linkage under Visual C++, you must declare
   477 	main() without any return type:
   478 		main(int argc, char *argv[]) {
   479 			/* Do the program... */
   480 			return(0);
   481 		}
   482 	C++ programs should also return a value if compiled under VC++.
   483 
   484 	The blit_endian member of the SDL_VideoInfo struct has been removed.
   485 
   486 	SDL_SymToASCII() has been replaced with SDL_GetKeyName(), so there
   487 	is now no longer any function to translate a keysym to a character.
   488 
   489 	The SDL_keysym structure has been extended with a 'scancode' and
   490 	'unicode' member.  The 'scancode' is a hardware specific scancode
   491 	for the key that was pressed, and may be 0.  The 'unicode' member
   492 	is a 16-bit UNICODE translation of the key that was pressed along
   493 	with any modifiers or compose keys that have been pressed.
   494 	If no UNICODE translation exists for the key, 'unicode' will be 0.
   495 
   496 	Added a function SDL_EnableUNICODE() to enable/disable UNICODE
   497 	translation of character keypresses.  Translation defaults off.
   498 
   499 	To convert existing code to use the new API, change code which
   500 	uses SDL_SymToASCII() to get the keyname to use SDL_GetKeyName(),
   501 	and change code which uses it to get the ASCII value of a sym to
   502 	use the 'unicode' member of the event keysym.
   503 
   504 0.9.12:
   505 	There is partial support for 64-bit datatypes.  I don't recommend 
   506 	you use this if you have a choice, because 64-bit datatypes are not
   507 	supported on many platforms.  On platforms for which it is supported,
   508 	the SDL_HAS_64BIT_TYPE C preprocessor define will be enabled, and
   509 	you can use the Uint64 and Sint64 datatypes.
   510 
   511 	Added functions to SDL_endian.h to support 64-bit datatypes:
   512 	    SDL_SwapLE64(), SDL_SwapBE64(),
   513 	    SDL_ReadLE64(), SDL_ReadBE64(), SDL_WriteLE64(), SDL_WriteBE64()
   514 
   515 	A new member "len_ratio" has been added to the SDL_AudioCVT structure,
   516 	and allows you to determine either the original buffer length or the
   517 	converted buffer length, given the other.
   518 
   519 	A new function SDL_FreeWAV() has been added to the API to free data
   520 	allocated by SDL_LoadWAV_RW().  This is necessary under Win32 since
   521 	the gcc compiled DLL uses a different heap than VC++ compiled apps.
   522 
   523 	SDL now has initial support for international keyboards using the
   524 	Latin character set.
   525 	If a particular mapping is desired, you can set the DEFAULT_KEYBOARD
   526 	compile-time variable, or you can set the environment variable 
   527 	"SDL_KEYBOARD" to a string identifying the keyboard mapping you desire.
   528 	The valid values for these variables can be found in SDL_keyboard.c
   529 
   530 	Full support for German and French keyboards under X11 is implemented.
   531 
   532 0.9.11:
   533 	The THREADED_EVENTS compile-time define has been replaced with the
   534 	SDL_INIT_EVENTTHREAD flag.  If this flag is passed to SDL_Init(),
   535 	SDL will create a separate thread to perform input event handling.
   536 	If this flag is passed to SDL_Init(), and the OS doesn't support 
   537 	event handling in a separate thread, SDL_Init() will fail.
   538 	Be sure to add calls to SDL_Delay() in your main thread to allow
   539 	the OS to schedule your event thread, or it may starve, leading
   540 	to slow event delivery and/or dropped events.
   541 	Currently MacOS and Win32 do not support this flag, while BeOS 
   542 	and Linux do support it.  I recommend that your application only
   543 	use this flag if absolutely necessary.
   544 
   545 	The SDL thread function passed to SDL_CreateThread() now returns a
   546 	status.  This status can be retrieved by passing a non-NULL pointer
   547 	as the 'status' argument to SDL_WaitThread().
   548 
   549 	The volume parameter to SDL_MixAudio() has been increased in range
   550 	from (0-8) to (0-128)
   551 
   552 	SDL now has a data source abstraction which can encompass a file,
   553 	an area of memory, or any custom object you can envision.  It uses
   554 	these abstractions, SDL_RWops, in the endian read/write functions,
   555 	and the built-in WAV and BMP file loaders.  This means you can load
   556 	WAV chunks from memory mapped files, compressed archives, network
   557 	pipes, or anything else that has a data read abstraction.
   558 
   559 	There are three built-in data source abstractions:
   560 	    SDL_RWFromFile(), SDL_RWFromFP(), SDL_RWFromMem()
   561 	along with a generic data source allocation function:
   562 	    SDL_AllocRW()
   563 	These data sources can be used like stdio file pointers with the
   564 	following convenience functions:
   565 	    SDL_RWseek(), SDL_RWread(), SDL_RWwrite(), SDL_RWclose()
   566 	These functions are defined in the new header file "SDL_rwops.h"
   567 
   568 	The endian swapping functions have been turned into macros for speed
   569 	and SDL_CalculateEndian() has been removed.  SDL_endian.h now defines
   570 	SDL_BYTEORDER as either SDL_BIG_ENDIAN or SDL_LIL_ENDIAN depending on
   571 	the endianness of the host system.
   572 
   573 	The endian read/write functions now take an SDL_RWops pointer
   574 	instead of a stdio FILE pointer, to support the new data source
   575 	abstraction.
   576 
   577 	The SDL_*LoadWAV() functions have been replaced with a single
   578 	SDL_LoadWAV_RW() function that takes a SDL_RWops pointer as it's
   579 	first parameter, and a flag whether or not to automatically 
   580 	free it as the second parameter.  SDL_LoadWAV() is a macro for
   581 	backward compatibility and convenience:
   582 	    SDL_LoadWAV_RW(SDL_RWFromFile("sample.wav", "rb"), 1, ...);
   583 
   584 	The SDL_*LoadBMP()/SDL_*SaveBMP() functions have each been replaced
   585 	with a single function that takes a SDL_RWops pointer as it's
   586 	first parameter, and a flag whether or not to automatically 
   587 	free it as the second parameter.  SDL_LoadBMP() and SDL_SaveBMP()
   588 	are macros for backward compatibility and convenience:
   589 	    SDL_LoadBMP_RW(SDL_RWFromFile("sample.bmp", "rb"), 1, ...);
   590 	    SDL_SaveBMP_RW(SDL_RWFromFile("sample.bmp", "wb"), 1, ...);
   591 	Note that these functions use SDL_RWseek() extensively, and should
   592 	not be used on pipes or other non-seekable data sources.
   593 
   594 0.9.10:
   595 	The Linux SDL_SysWMInfo and SDL_SysWMMsg structures have been 
   596 	extended to support multiple types of display drivers, as well as
   597         safe access to the X11 display when THREADED_EVENTS is enabled.
   598         The new structures are documented in the SDL_syswm.h header file.
   599 
   600 	Thanks to John Elliott <jce@seasip.demon.co.uk>, the UK keyboard
   601 	should now work properly, as well as the "Windows" keys on US
   602 	keyboards.
   603 
   604 	The Linux CD-ROM code now reads the CD-ROM devices from /etc/fstab
   605 	instead of trying to open each block device on the system.
   606 	The CD must be listed in /etc/fstab as using the iso9660 filesystem.
   607 
   608 	On Linux, if you define THREADED_EVENTS at compile time, a separate
   609 	thread will be spawned to gather X events asynchronously from the
   610 	graphics updates.  This hasn't been extensively tested, but it does
   611 	provide a means of handling keyboard and mouse input in a separate
   612 	thread from the graphics thread.  (This is now enabled by default.)
   613 
   614 	A special access function SDL_PeepEvents() allows you to manipulate
   615 	the event queue in a thread-safe manner, including peeking at events,
   616 	removing events of a specified type, and adding new events of arbitrary
   617 	type to the queue (use the new 'user' member of the SDL_Event type).
   618 
   619 	If you use SDL_PeepEvents() to gather events, then the main graphics
   620 	thread needs to call SDL_PumpEvents() periodically to drive the event
   621 	loop and generate input events.  This is not necessary if SDL has been 
   622 	compiled with THREADED_EVENTS defined, but doesn't hurt.
   623 
   624 	A new function SDL_ThreadID() returns the identifier associated with
   625 	the current thread.
   626 
   627 0.9.9:
   628 	The AUDIO_STEREO format flag has been replaced with a new 'channels'
   629 	member of the SDL_AudioSpec structure.  The channels are 1 for mono
   630 	audio, and 2 for stereo audio.  In the future more channels may be
   631 	supported for 3D surround sound.
   632 
   633 	The SDL_MixAudio() function now takes an additional volume parameter,
   634 	which should be set to SDL_MIX_MAXVOLUME for compatibility with the
   635 	original function.
   636 
   637 	The CD-ROM functions which take a 'cdrom' parameter can now be
   638 	passed NULL, and will act on the last successfully opened CD-ROM.
   639 
   640 0.9.8:
   641 	No changes, bugfixes only.
   642 	
   643 0.9.7:
   644 	No changes, bugfixes only.
   645 	
   646 0.9.6:
   647 	Added a fast rectangle fill function: SDL_FillRect()
   648 
   649 	Addition of a useful function for getting info on the video hardware:
   650 	    const SDL_VideoInfo *SDL_GetVideoInfo(void)
   651         This function replaces SDL_GetDisplayFormat().
   652 
   653 	Initial support for double-buffering:
   654 	  Use the SDL_DOUBLEBUF flag in SDL_SetVideoMode()
   655 	  Update the screen with a new function: SDL_Flip()
   656 
   657 	SDL_AllocSurface() takes two new flags:
   658 	SDL_SRCCOLORKEY means that the surface will be used for colorkey blits
   659 	  and if the hardware supports hardware acceleration of colorkey blits
   660 	  between two surfaces in video memory, to place the surface in video
   661 	  memory if possible, otherwise it will be placed in system memory.
   662 	SDL_SRCALPHA means that the surface will be used for alpha blits and
   663 	  if the hardware supports hardware acceleration of alpha blits between
   664 	  two surfaces in video memory, to place the surface in video memory
   665 	  if possible, otherwise it will be placed in system memory.
   666 	SDL_HWSURFACE now means that the surface will be created with the 
   667 	  same format as the display surface, since having surfaces in video
   668 	  memory is only useful for fast blitting to the screen, and you can't
   669 	  blit surfaces with different surface formats in video memory.
   670 
   671 0.9.5:
   672 	You can now pass a NULL mask to SDL_WM_SetIcon(), and it will assume
   673 	that the icon consists of the entire image.
   674 
   675 	SDL_LowerBlit() is back -- but don't use it on the display surface.
   676 	It is exactly the same as SDL_MiddleBlit(), but doesn't check for
   677 	thread safety.
   678 
   679 	Added SDL_FPLoadBMP(), SDL_FPSaveBMP(), SDL_FPLoadWAV(), which take
   680 	a FILE pointer instead of a file name.
   681 
   682 	Added CD-ROM audio control API:
   683 	    SDL_CDNumDrives()
   684 	    SDL_CDName()
   685 	    SDL_CDOpen()
   686 	    SDL_CDStatus()
   687 	    SDL_CDPlayTracks()
   688 	    SDL_CDPlay()
   689 	    SDL_CDPause()
   690 	    SDL_CDResume()
   691 	    SDL_CDStop()
   692 	    SDL_CDEject()
   693 	    SDL_CDClose()
   694 
   695 0.9.4:
   696 	No changes, bugfixes only.
   697 
   698 0.9.3:
   699 	Mouse motion event now includes relative motion information:
   700 	    Sint16 event->motion.xrel, Sint16 event->motion.yrel
   701 
   702 	X11 keyrepeat handling can be disabled by defining IGNORE_X_KEYREPEAT
   703 	    (Add -DIGNORE_X_KEYREPEAT to CFLAGS line in obj/x11Makefile)
   704 
   705 0.9.2:
   706 	No changes, bugfixes only.
   707 
   708 0.9.1:
   709 	Removed SDL_MapSurface() and SDL_UnmapSurface() -- surfaces are now
   710 	automatically mapped on blit.
   711 
   712 0.8.0:
   713 	SDL stable release