author | Ryan C. Gordon <icculus@icculus.org> |
Thu, 14 Jun 2007 14:22:54 +0000 | |
changeset 2121 | 85ed90a755fa |
parent 1895 | c121d94672cb |
child 5046 | 4cb778067834 |
permissions | -rw-r--r-- |
0 | 1 |
|
2 |
This is a list of API changes in SDL's version history. |
|
3 |
||
1895
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1794
diff
changeset
|
4 |
1.3.0: |
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1794
diff
changeset
|
5 |
Added SDL_GetNumVideoDrivers() and SDL_GetVideoDriver(). |
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1794
diff
changeset
|
6 |
Replaced SDL_VideoDriverName() with SDL_GetCurrentVideoDriver() |
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1794
diff
changeset
|
7 |
Added SDL_GetNumAudioDrivers() and SDL_GetAudioDriver(). |
c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
Sam Lantinga <slouken@libsdl.org>
parents:
1794
diff
changeset
|
8 |
Replaced SDL_AudioDriverName() with SDL_GetCurrentAudioDriver() |
0 | 9 |
|
1507 | 10 |
1.2.10: |
1794 | 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 |
||
1765 | 21 |
Added support for the SDL_VIDEO_FULLSCREEN_HEAD environment |
22 |
variable, currently supported on X11 Xinerama configurations. |
|
23 |
||
1736
3b2a92126f4d
Implemented bug #2, 117:
Sam Lantinga <slouken@libsdl.org>
parents:
1545
diff
changeset
|
24 |
Added SDL_GL_SWAP_CONTROL to wait for vsync in OpenGL applications. |
3b2a92126f4d
Implemented bug #2, 117:
Sam Lantinga <slouken@libsdl.org>
parents:
1545
diff
changeset
|
25 |
|
1737 | 26 |
Added SDL_GL_ACCELERATED_VISUAL to guarantee hardware acceleration. |
27 |
||
1545
8d9bb0cf2c2a
Added current_w and current_h to the SDL_VideoInfo structure, which is set to the desktop resolution during video intialization, and then set to the current resolution when a video mode is set.
Sam Lantinga <slouken@libsdl.org>
parents:
1507
diff
changeset
|
28 |
Added current_w and current_h to the SDL_VideoInfo structure, |
8d9bb0cf2c2a
Added current_w and current_h to the SDL_VideoInfo structure, which is set to the desktop resolution during video intialization, and then set to the current resolution when a video mode is set.
Sam Lantinga <slouken@libsdl.org>
parents:
1507
diff
changeset
|
29 |
which is set to the desktop resolution during video intialization, |
8d9bb0cf2c2a
Added current_w and current_h to the SDL_VideoInfo structure, which is set to the desktop resolution during video intialization, and then set to the current resolution when a video mode is set.
Sam Lantinga <slouken@libsdl.org>
parents:
1507
diff
changeset
|
30 |
and then set to the current resolution when a video mode is set. |
8d9bb0cf2c2a
Added current_w and current_h to the SDL_VideoInfo structure, which is set to the desktop resolution during video intialization, and then set to the current resolution when a video mode is set.
Sam Lantinga <slouken@libsdl.org>
parents:
1507
diff
changeset
|
31 |
|
8d9bb0cf2c2a
Added current_w and current_h to the SDL_VideoInfo structure, which is set to the desktop resolution during video intialization, and then set to the current resolution when a video mode is set.
Sam Lantinga <slouken@libsdl.org>
parents:
1507
diff
changeset
|
32 |
SDL_SetVideoMode() now accepts 0 for width or height and will use |
8d9bb0cf2c2a
Added current_w and current_h to the SDL_VideoInfo structure, which is set to the desktop resolution during video intialization, and then set to the current resolution when a video mode is set.
Sam Lantinga <slouken@libsdl.org>
parents:
1507
diff
changeset
|
33 |
the current video mode (or the desktop mode if no mode has been set.) |
8d9bb0cf2c2a
Added current_w and current_h to the SDL_VideoInfo structure, which is set to the desktop resolution during video intialization, and then set to the current resolution when a video mode is set.
Sam Lantinga <slouken@libsdl.org>
parents:
1507
diff
changeset
|
34 |
|
1507 | 35 |
Added SDL_GetKeyRepeat() |
1545
8d9bb0cf2c2a
Added current_w and current_h to the SDL_VideoInfo structure, which is set to the desktop resolution during video intialization, and then set to the current resolution when a video mode is set.
Sam Lantinga <slouken@libsdl.org>
parents:
1507
diff
changeset
|
36 |
|
1507 | 37 |
Added SDL_config.h, with defaults for various build environments. |
38 |
||
739
22dbf364c017
Added SDL_HasMMX(), SDL_Has3DNow(), SDL_HasSSE() in SDL_cpuinfo.h
Sam Lantinga <slouken@libsdl.org>
parents:
656
diff
changeset
|
39 |
1.2.7: |
751
6e9505e0647f
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
739
diff
changeset
|
40 |
Added CPU feature detection functions to SDL_cpuinfo.h: |
781
67176351a1b8
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
764
diff
changeset
|
41 |
SDL_HasRDTSC(), SDL_HasMMX(), SDL_Has3DNow(), SDL_HasSSE(), |
67176351a1b8
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
764
diff
changeset
|
42 |
SDL_HasAltiVec() |
764
974c0fb74bf8
Added function to create RWops from const memory: SDL_RWFromConstMem()
Sam Lantinga <slouken@libsdl.org>
parents:
751
diff
changeset
|
43 |
Added function to create RWops from const memory: SDL_RWFromConstMem() |
739
22dbf364c017
Added SDL_HasMMX(), SDL_Has3DNow(), SDL_HasSSE() in SDL_cpuinfo.h
Sam Lantinga <slouken@libsdl.org>
parents:
656
diff
changeset
|
44 |
|
648
12a21d82a060
Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
451
diff
changeset
|
45 |
1.2.6: |
12a21d82a060
Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
451
diff
changeset
|
46 |
Added SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() |
12a21d82a060
Exposed SDL_LoadObject(), SDL_LoadFunction(), and SDL_UnloadObject() APIs
Sam Lantinga <slouken@libsdl.org>
parents:
451
diff
changeset
|
47 |
|
656
864e2d2a9a55
Merged in Ryan's multisample code for MacOS, and changed the constants to match.
Sam Lantinga <slouken@libsdl.org>
parents:
655
diff
changeset
|
48 |
Added SDL_GL_MULTISAMPLEBUFFERS and SDL_GL_MULTISAMPLESAMPLES for FSAA |
655
9c42ee1b7d77
Date: Thu, 24 Apr 2003 15:13:47 -0400
Sam Lantinga <slouken@libsdl.org>
parents:
648
diff
changeset
|
49 |
|
451
24edec3cafe4
Added SDL_BUTTON_WHEELUP (4) and SDL_BUTTON_WHEELDOWN (5)
Sam Lantinga <slouken@libsdl.org>
parents:
296
diff
changeset
|
50 |
1.2.5: |
24edec3cafe4
Added SDL_BUTTON_WHEELUP (4) and SDL_BUTTON_WHEELDOWN (5)
Sam Lantinga <slouken@libsdl.org>
parents:
296
diff
changeset
|
51 |
Added SDL_BUTTON_WHEELUP (4) and SDL_BUTTON_WHEELDOWN (5) |
24edec3cafe4
Added SDL_BUTTON_WHEELUP (4) and SDL_BUTTON_WHEELDOWN (5)
Sam Lantinga <slouken@libsdl.org>
parents:
296
diff
changeset
|
52 |
|
24edec3cafe4
Added SDL_BUTTON_WHEELUP (4) and SDL_BUTTON_WHEELDOWN (5)
Sam Lantinga <slouken@libsdl.org>
parents:
296
diff
changeset
|
53 |
Added SDL_GL_STEREO for stereoscopic OpenGL contexts |
24edec3cafe4
Added SDL_BUTTON_WHEELUP (4) and SDL_BUTTON_WHEELDOWN (5)
Sam Lantinga <slouken@libsdl.org>
parents:
296
diff
changeset
|
54 |
|
0 | 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 |
0.11.5: |
|
424 |
A new function SDL_GetVideoSurface() has been added, and returns |
|
425 |
a pointer to the current display surface. |
|
426 |
||
427 |
SDL_AllocSurface() has been renamed SDL_CreateRGBSurface(), and |
|
428 |
a new function SDL_CreateRGBSurfaceFrom() has been added to allow |
|
429 |
creating an SDL surface from an existing pixel data buffer. |
|
430 |
||
431 |
Added SDL_GetRGB() to the headers and documentation. |
|
432 |
||
433 |
0.11.4: |
|
434 |
SDL_SetLibraryPath() is no longer meaningful, and has been removed. |
|
435 |
||
436 |
0.11.3: |
|
437 |
A new flag for SDL_Init(), SDL_INIT_NOPARACHUTE, prevents SDL from |
|
438 |
installing fatal signal handlers on operating systems that support |
|
439 |
them. |
|
440 |
||
441 |
0.9.15: |
|
442 |
SDL_CreateColorCursor() has been removed. Color cursors should |
|
443 |
be implemented as sprites, blitted by the application when the |
|
444 |
cursor moves. To get smooth color cursor updates when the app |
|
445 |
is busy, pass the SDL_INIT_EVENTTHREAD flag to SDL_Init(). This |
|
446 |
allows you to handle the mouse motion in another thread from an |
|
447 |
event filter function, but is currently only supported by Linux |
|
448 |
and BeOS. Note that you'll have to protect the display surface |
|
449 |
from multi-threaded access by using mutexes if you do this. |
|
450 |
||
451 |
Thread-safe surface support has been removed from SDL. |
|
452 |
This makes blitting somewhat faster, by removing SDL_MiddleBlit(). |
|
453 |
Code that used SDL_MiddleBlit() should use SDL_LowerBlit() instead. |
|
454 |
You can make your surfaces thread-safe by allocating your own |
|
455 |
mutex and making lock/unlock calls around accesses to your surface. |
|
456 |
||
457 |
0.9.14: |
|
458 |
SDL_GetMouseState() now takes pointers to int rather than Uint16. |
|
459 |
||
460 |
If you set the SDL_WINDOWID environment variable under UNIX X11, |
|
461 |
SDL will use that as the main window instead of creating it's own. |
|
462 |
This is an unsupported extension to SDL, and not portable at all. |
|
463 |
||
464 |
0.9.13: |
|
465 |
Added a function SDL_SetLibraryPath() which can be used to specify |
|
466 |
the directory containing the SDL dynamic libraries. This is useful |
|
467 |
for commercial applications which ship with particular versions |
|
468 |
of the libraries, and for security on multi-user systems. |
|
469 |
If this function is not used, the default system directories are |
|
470 |
searched using the native dynamic object loading mechanism. |
|
471 |
||
472 |
In order to support C linkage under Visual C++, you must declare |
|
473 |
main() without any return type: |
|
474 |
main(int argc, char *argv[]) { |
|
475 |
/* Do the program... */ |
|
476 |
return(0); |
|
477 |
} |
|
478 |
C++ programs should also return a value if compiled under VC++. |
|
479 |
||
480 |
The blit_endian member of the SDL_VideoInfo struct has been removed. |
|
481 |
||
482 |
SDL_SymToASCII() has been replaced with SDL_GetKeyName(), so there |
|
483 |
is now no longer any function to translate a keysym to a character. |
|
484 |
||
485 |
The SDL_keysym structure has been extended with a 'scancode' and |
|
486 |
'unicode' member. The 'scancode' is a hardware specific scancode |
|
487 |
for the key that was pressed, and may be 0. The 'unicode' member |
|
488 |
is a 16-bit UNICODE translation of the key that was pressed along |
|
489 |
with any modifiers or compose keys that have been pressed. |
|
490 |
If no UNICODE translation exists for the key, 'unicode' will be 0. |
|
491 |
||
492 |
Added a function SDL_EnableUNICODE() to enable/disable UNICODE |
|
493 |
translation of character keypresses. Translation defaults off. |
|
494 |
||
495 |
To convert existing code to use the new API, change code which |
|
496 |
uses SDL_SymToASCII() to get the keyname to use SDL_GetKeyName(), |
|
497 |
and change code which uses it to get the ASCII value of a sym to |
|
498 |
use the 'unicode' member of the event keysym. |
|
499 |
||
500 |
0.9.12: |
|
501 |
There is partial support for 64-bit datatypes. I don't recommend |
|
502 |
you use this if you have a choice, because 64-bit datatypes are not |
|
503 |
supported on many platforms. On platforms for which it is supported, |
|
504 |
the SDL_HAS_64BIT_TYPE C preprocessor define will be enabled, and |
|
505 |
you can use the Uint64 and Sint64 datatypes. |
|
506 |
||
507 |
Added functions to SDL_endian.h to support 64-bit datatypes: |
|
508 |
SDL_SwapLE64(), SDL_SwapBE64(), |
|
509 |
SDL_ReadLE64(), SDL_ReadBE64(), SDL_WriteLE64(), SDL_WriteBE64() |
|
510 |
||
511 |
A new member "len_ratio" has been added to the SDL_AudioCVT structure, |
|
512 |
and allows you to determine either the original buffer length or the |
|
513 |
converted buffer length, given the other. |
|
514 |
||
515 |
A new function SDL_FreeWAV() has been added to the API to free data |
|
516 |
allocated by SDL_LoadWAV_RW(). This is necessary under Win32 since |
|
517 |
the gcc compiled DLL uses a different heap than VC++ compiled apps. |
|
518 |
||
519 |
SDL now has initial support for international keyboards using the |
|
520 |
Latin character set. |
|
521 |
If a particular mapping is desired, you can set the DEFAULT_KEYBOARD |
|
522 |
compile-time variable, or you can set the environment variable |
|
523 |
"SDL_KEYBOARD" to a string identifying the keyboard mapping you desire. |
|
524 |
The valid values for these variables can be found in SDL_keyboard.c |
|
525 |
||
526 |
Full support for German and French keyboards under X11 is implemented. |
|
527 |
||
528 |
0.9.11: |
|
529 |
The THREADED_EVENTS compile-time define has been replaced with the |
|
530 |
SDL_INIT_EVENTTHREAD flag. If this flag is passed to SDL_Init(), |
|
531 |
SDL will create a separate thread to perform input event handling. |
|
532 |
If this flag is passed to SDL_Init(), and the OS doesn't support |
|
533 |
event handling in a separate thread, SDL_Init() will fail. |
|
534 |
Be sure to add calls to SDL_Delay() in your main thread to allow |
|
535 |
the OS to schedule your event thread, or it may starve, leading |
|
536 |
to slow event delivery and/or dropped events. |
|
537 |
Currently MacOS and Win32 do not support this flag, while BeOS |
|
538 |
and Linux do support it. I recommend that your application only |
|
539 |
use this flag if absolutely necessary. |
|
540 |
||
541 |
The SDL thread function passed to SDL_CreateThread() now returns a |
|
542 |
status. This status can be retrieved by passing a non-NULL pointer |
|
543 |
as the 'status' argument to SDL_WaitThread(). |
|
544 |
||
545 |
The volume parameter to SDL_MixAudio() has been increased in range |
|
546 |
from (0-8) to (0-128) |
|
547 |
||
548 |
SDL now has a data source abstraction which can encompass a file, |
|
549 |
an area of memory, or any custom object you can envision. It uses |
|
550 |
these abstractions, SDL_RWops, in the endian read/write functions, |
|
551 |
and the built-in WAV and BMP file loaders. This means you can load |
|
552 |
WAV chunks from memory mapped files, compressed archives, network |
|
553 |
pipes, or anything else that has a data read abstraction. |
|
554 |
||
555 |
There are three built-in data source abstractions: |
|
556 |
SDL_RWFromFile(), SDL_RWFromFP(), SDL_RWFromMem() |
|
557 |
along with a generic data source allocation function: |
|
558 |
SDL_AllocRW() |
|
559 |
These data sources can be used like stdio file pointers with the |
|
560 |
following convenience functions: |
|
561 |
SDL_RWseek(), SDL_RWread(), SDL_RWwrite(), SDL_RWclose() |
|
562 |
These functions are defined in the new header file "SDL_rwops.h" |
|
563 |
||
564 |
The endian swapping functions have been turned into macros for speed |
|
565 |
and SDL_CalculateEndian() has been removed. SDL_endian.h now defines |
|
566 |
SDL_BYTEORDER as either SDL_BIG_ENDIAN or SDL_LIL_ENDIAN depending on |
|
567 |
the endianness of the host system. |
|
568 |
||
569 |
The endian read/write functions now take an SDL_RWops pointer |
|
570 |
instead of a stdio FILE pointer, to support the new data source |
|
571 |
abstraction. |
|
572 |
||
573 |
The SDL_*LoadWAV() functions have been replaced with a single |
|
574 |
SDL_LoadWAV_RW() function that takes a SDL_RWops pointer as it's |
|
575 |
first parameter, and a flag whether or not to automatically |
|
576 |
free it as the second parameter. SDL_LoadWAV() is a macro for |
|
577 |
backward compatibility and convenience: |
|
578 |
SDL_LoadWAV_RW(SDL_RWFromFile("sample.wav", "rb"), 1, ...); |
|
579 |
||
580 |
The SDL_*LoadBMP()/SDL_*SaveBMP() functions have each been replaced |
|
581 |
with a single function that takes a SDL_RWops pointer as it's |
|
582 |
first parameter, and a flag whether or not to automatically |
|
583 |
free it as the second parameter. SDL_LoadBMP() and SDL_SaveBMP() |
|
584 |
are macros for backward compatibility and convenience: |
|
585 |
SDL_LoadBMP_RW(SDL_RWFromFile("sample.bmp", "rb"), 1, ...); |
|
586 |
SDL_SaveBMP_RW(SDL_RWFromFile("sample.bmp", "wb"), 1, ...); |
|
587 |
Note that these functions use SDL_RWseek() extensively, and should |
|
588 |
not be used on pipes or other non-seekable data sources. |
|
589 |
||
590 |
0.9.10: |
|
591 |
The Linux SDL_SysWMInfo and SDL_SysWMMsg structures have been |
|
592 |
extended to support multiple types of display drivers, as well as |
|
593 |
safe access to the X11 display when THREADED_EVENTS is enabled. |
|
594 |
The new structures are documented in the SDL_syswm.h header file. |
|
595 |
||
596 |
Thanks to John Elliott <jce@seasip.demon.co.uk>, the UK keyboard |
|
597 |
should now work properly, as well as the "Windows" keys on US |
|
598 |
keyboards. |
|
599 |
||
600 |
The Linux CD-ROM code now reads the CD-ROM devices from /etc/fstab |
|
601 |
instead of trying to open each block device on the system. |
|
602 |
The CD must be listed in /etc/fstab as using the iso9660 filesystem. |
|
603 |
||
604 |
On Linux, if you define THREADED_EVENTS at compile time, a separate |
|
605 |
thread will be spawned to gather X events asynchronously from the |
|
606 |
graphics updates. This hasn't been extensively tested, but it does |
|
607 |
provide a means of handling keyboard and mouse input in a separate |
|
608 |
thread from the graphics thread. (This is now enabled by default.) |
|
609 |
||
610 |
A special access function SDL_PeepEvents() allows you to manipulate |
|
611 |
the event queue in a thread-safe manner, including peeking at events, |
|
612 |
removing events of a specified type, and adding new events of arbitrary |
|
613 |
type to the queue (use the new 'user' member of the SDL_Event type). |
|
614 |
||
615 |
If you use SDL_PeepEvents() to gather events, then the main graphics |
|
616 |
thread needs to call SDL_PumpEvents() periodically to drive the event |
|
617 |
loop and generate input events. This is not necessary if SDL has been |
|
618 |
compiled with THREADED_EVENTS defined, but doesn't hurt. |
|
619 |
||
620 |
A new function SDL_ThreadID() returns the identifier associated with |
|
621 |
the current thread. |
|
622 |
||
623 |
0.9.9: |
|
624 |
The AUDIO_STEREO format flag has been replaced with a new 'channels' |
|
625 |
member of the SDL_AudioSpec structure. The channels are 1 for mono |
|
626 |
audio, and 2 for stereo audio. In the future more channels may be |
|
627 |
supported for 3D surround sound. |
|
628 |
||
629 |
The SDL_MixAudio() function now takes an additional volume parameter, |
|
630 |
which should be set to SDL_MIX_MAXVOLUME for compatibility with the |
|
631 |
original function. |
|
632 |
||
633 |
The CD-ROM functions which take a 'cdrom' parameter can now be |
|
634 |
passed NULL, and will act on the last successfully opened CD-ROM. |
|
635 |
||
636 |
0.9.8: |
|
637 |
No changes, bugfixes only. |
|
638 |
||
639 |
0.9.7: |
|
640 |
No changes, bugfixes only. |
|
641 |
||
642 |
0.9.6: |
|
643 |
Added a fast rectangle fill function: SDL_FillRect() |
|
644 |
||
645 |
Addition of a useful function for getting info on the video hardware: |
|
646 |
const SDL_VideoInfo *SDL_GetVideoInfo(void) |
|
647 |
This function replaces SDL_GetDisplayFormat(). |
|
648 |
||
649 |
Initial support for double-buffering: |
|
650 |
Use the SDL_DOUBLEBUF flag in SDL_SetVideoMode() |
|
651 |
Update the screen with a new function: SDL_Flip() |
|
652 |
||
653 |
SDL_AllocSurface() takes two new flags: |
|
654 |
SDL_SRCCOLORKEY means that the surface will be used for colorkey blits |
|
655 |
and if the hardware supports hardware acceleration of colorkey blits |
|
656 |
between two surfaces in video memory, to place the surface in video |
|
657 |
memory if possible, otherwise it will be placed in system memory. |
|
658 |
SDL_SRCALPHA means that the surface will be used for alpha blits and |
|
659 |
if the hardware supports hardware acceleration of alpha blits between |
|
660 |
two surfaces in video memory, to place the surface in video memory |
|
661 |
if possible, otherwise it will be placed in system memory. |
|
662 |
SDL_HWSURFACE now means that the surface will be created with the |
|
663 |
same format as the display surface, since having surfaces in video |
|
664 |
memory is only useful for fast blitting to the screen, and you can't |
|
665 |
blit surfaces with different surface formats in video memory. |
|
666 |
||
667 |
0.9.5: |
|
668 |
You can now pass a NULL mask to SDL_WM_SetIcon(), and it will assume |
|
669 |
that the icon consists of the entire image. |
|
670 |
||
671 |
SDL_LowerBlit() is back -- but don't use it on the display surface. |
|
672 |
It is exactly the same as SDL_MiddleBlit(), but doesn't check for |
|
673 |
thread safety. |
|
674 |
||
675 |
Added SDL_FPLoadBMP(), SDL_FPSaveBMP(), SDL_FPLoadWAV(), which take |
|
676 |
a FILE pointer instead of a file name. |
|
677 |
||
678 |
Added CD-ROM audio control API: |
|
679 |
SDL_CDNumDrives() |
|
680 |
SDL_CDName() |
|
681 |
SDL_CDOpen() |
|
682 |
SDL_CDStatus() |
|
683 |
SDL_CDPlayTracks() |
|
684 |
SDL_CDPlay() |
|
685 |
SDL_CDPause() |
|
686 |
SDL_CDResume() |
|
687 |
SDL_CDStop() |
|
688 |
SDL_CDEject() |
|
689 |
SDL_CDClose() |
|
690 |
||
691 |
0.9.4: |
|
692 |
No changes, bugfixes only. |
|
693 |
||
694 |
0.9.3: |
|
695 |
Mouse motion event now includes relative motion information: |
|
696 |
Sint16 event->motion.xrel, Sint16 event->motion.yrel |
|
697 |
||
698 |
X11 keyrepeat handling can be disabled by defining IGNORE_X_KEYREPEAT |
|
699 |
(Add -DIGNORE_X_KEYREPEAT to CFLAGS line in obj/x11Makefile) |
|
700 |
||
701 |
0.9.2: |
|
702 |
No changes, bugfixes only. |
|
703 |
||
704 |
0.9.1: |
|
705 |
Removed SDL_MapSurface() and SDL_UnmapSurface() -- surfaces are now |
|
706 |
automatically mapped on blit. |
|
707 |
||
708 |
0.8.0: |
|
709 |
SDL stable release |