WhatsNew
author Sunny Sachanandani <sunnysachanandani@gmail.com>
Fri, 09 Jul 2010 21:36:41 +0530
changeset 4590 1ad70fb49fcb
parent 1895 c121d94672cb
child 5046 4cb778067834
permissions -rw-r--r--
Fix so many things that there is little place in this column to list them all but the result is that blending modes just work now for drawing primitives.

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