Initial standalone code, some stuff runs
[sdl_omap.git] / docs.html
CommitLineData
e14743d1 1<HTML>
2<HEAD><TITLE>SDL Stable Release</TITLE></HEAD>
3<BODY BGCOLOR="#FFEBCD" TEXT="#000000">
4
5<IMG SRC="docs/images/rainbow.gif" ALT="[separator]" WIDTH="100%">
6<P>
7This source is stable, and is fully tested on all supported platforms.<br>
8Please send bug reports or questions to the SDL mailing list:<br>
9<a href="http://www.libsdl.org/mailing-list.php"
10 >http://www.libsdl.org/mailing-list.php</a><br>
11The latest stable release may be found on the
12 <a href="http://www.libsdl.org/">SDL website</A>.
13</P>
14
15<H2> <A HREF="docs/index.html">API Documentation</A> </H2>
16
17<IMG SRC="docs/images/rainbow.gif" ALT="[separator]" WIDTH="100%">
18
19<H2> SDL 1.2.14 Release Notes </H2>
20<P>
21SDL 1.2.14 is a significant bug fix release and a recommended update.
22</P>
23
24<H3> General Notes </H3>
25
26<BLOCKQUOTE>
27<P>
28 Fixed flicker when resizing the SDL window
29</P>
30<P>
31 Fixed crash in SDL_SetGammaRamp()
32</P>
33<P>
34 Fixed freeze in SDL_memset() with 0 length when assembly code is disabled.
35</P>
36<P>
37 Added SDL_DISABLE_LOCK_KEYS environment variable to enable normal up/down events for Caps-Lock and Num-Lock keys.
38</P>
39<P>
40 Fixed audio quality problem when converting between 22050 Hz and 44100 Hz.
41</P>
42<P>
43 Fixed a threading crash when a few threads are rapidly created and complete.
44</P>
45<P>
46 Increased accuracy of alpha blending routines.
47</P>
48<P>
49 Fixed crash loading BMP files saved with the scanlines inverted.
50</P>
51<P>
52 Fixed mouse coordinate clamping if SDL_SetVideoMode() isn't called in response to SDL_VIDEORESIZE event.
53</P>
54<P>
55 Added doxygen documentation for the SDL API headers.
56</P>
57</BLOCKQUOTE>
58
59<H3> Unix Notes </H3>
60
61<BLOCKQUOTE>
62<P>
63 Fixed potential memory corruption due to assembly bug with SDL_revcpy()
64</P>
65<P>
66 Fixed crashes trying to detect SSE features on x86_64 architecture.
67</P>
68<P>
69 Fixed assembly for GCC optimized 50% alpha blending blits.
70</P>
71<P>
72 Added configure option --enable-screensaver, to allow enabling the screensaver by default.
73</P>
74<P>
75 Use XResetScreenSaver() instead of disabling screensaver entirely.
76</P>
77<P>
78 Removed the maximum window size limitation on X11.
79</P>
80<P>
81 Fixed SDL_GL_SWAP_CONTROL on X11.
82</P>
83<P>
84 Fixed setting the X11 window input hint.
85</P>
86<P>
87 Fixed distorted X11 window icon for some visuals.
88</P>
89<P>
90 Fixed detecting X11 libraries for dynamic loading on 64-bit Linux.
91</P>
92<P>
93 SDL_GL_GetAttribute(SDL_GL_SWAP_CONTROL) returns the correct value with GLX_SGI_swap_control.
94</P>
95<P>
96 Added SDL_VIDEO_FULLSCREEN_DISPLAY as a preferred synonym for SDL_VIDEO_FULLSCREEN_HEAD on X11.
97</P>
98<P>
99 The SDL_VIDEO_FULLSCREEN_DISPLAY environment variable can be set to 0 to place fullscreen SDL windows on the first Xinerama screen.
100</P>
101<P>
102 Added the SDL_VIDEO_FBCON_ROTATION environment variable to control output orientation on the framebuffer console.
103 <BR>
104 Valid values are:
105 <UL>
106 <LI>not set - Not rotating, no shadow.
107 <LI>"NONE" - Not rotating, but still using shadow.
108 <LI>"CW" - Rotating screen clockwise.
109 <LI>"UD" - Rotating screen upside down.
110 <LI>"CCW" - Rotating screen counter clockwise.
111 </UL>
112</P>
113<P>
114 Fixed DirectFB detection on some Linux distributions.
115</P>
116<P>
117 Added code to use the PS3 SPE processors for YUV conversion on Linux.
118</P>
119<P>
120 Updated ALSA support to the latest stable API
121</P>
122<P>
123 ALSA is now preferred over OSS audio. (SDL_AUDIODRIVER=dsp will restore the previous behavior.)
124</P>
125<P>
126 Improved support for PulseAudio
127</P>
128<P>
129 The Network Audio System support is now dynamically loaded at runtime.
130</P>
131<P>
132 Fixed crash with the MP-8866 Dual USB Joypad on newer Linux kernels.
133</P>
134<P>
135 Fixed crash in SDL_Quit() when a joystick has been unplugged.
136</P>
137</BLOCKQUOTE>
138
139<H3> Windows Notes </H3>
140
141<BLOCKQUOTE>
142<P>
143 Verified 100% compatibility with Windows 7.
144</P>
145<P>
146 Prevent loss of OpenGL context when setting the video mode in response to a window resize event.
147</P>
148<P>
149 Fixed video initialization with SDL_WINDOWID on Windows XP.
150</P>
151<P>
152 Improved mouse input responsiveness for first-person-shooter games.
153</P>
154<P>
155 IME messages are now generated for localized input.
156</P>
157<P>
158 SDL_RWFromFile() takes a UTF-8 filename when opening a file.
159</P>
160<P>
161 The SDL_STDIO_REDIRECT environment variable can be used to override whether SDL redirects stdio to stdout.txt and stderr.txt.
162</P>
163<P>
164 Fixed dynamic object loading on Windows CE.
165</P>
166</BLOCKQUOTE>
167
168<H3> Mac OS X Notes </H3>
169
170<BLOCKQUOTE>
171<P>
172 SDL now builds on Mac OS X 10.6 (Snow Leopard).
173 <BR>
174 Eric Wing posted a good rundown on the numerous changes here: <A HREF="http://playcontrol.net/ewing/jibberjabber/big_behind-the-scenes_chang.html">http://playcontrol.net/ewing/jibberjabber/big_behind-the-scenes_chang.html</A>
175</P>
176<P>
177 The X11 video driver is built by default.
178</P>
179<P>
180 Fixed SDL_VIDEO_WINDOW_POS environment variable for Quartz target.
181</P>
182<P>
183 Fixed setting the starting working directory in release builds.
184</P>
185</BLOCKQUOTE>
186
187<IMG SRC="docs/images/rainbow.gif" ALT="[separator]" WIDTH="100%">
188
189<H2> SDL 1.2.13 Release Notes </H2>
190<P>
191SDL 1.2.13 is a minor bug fix release.
192</P>
193
194<H3> General Notes </H3>
195
196<BLOCKQUOTE>
197<P>
198 Fixed link error when building with Intel Compiler 10.
199</P>
200<P>
201 Removed stray C++ comment from public headers.
202</P>
203</BLOCKQUOTE>
204
205<H3> Unix Notes </H3>
206
207<BLOCKQUOTE>
208<P>
209 Fixed crash in SDL_SoftStretch() on secure operating systems.
210</P>
211<P>
212 Fixed undefined symbol on X11 implementations without UTF-8 support.
213</P>
214<P>
215 Worked around BadAlloc error when using XVideo on the XFree86 Intel Integrated Graphics driver.
216</P>
217<P>
218 Scan for all joysticks on Linux instead of stopping at one that was removed.
219</P>
220<P>
221 Fixed use of sdl-config arguments in sdl.m4
222</P>
223</BLOCKQUOTE>
224
225<H3> Windows Notes </H3>
226
227<BLOCKQUOTE>
228<P>
229 Fixed crash when a video driver reports higher than 32 bpp video modes.
230</P>
231<P>
232 Fixed restoring the desktop after setting a 24-bit OpenGL video mode.
233</P>
234<P>
235 Fixed window titles on Windows 95/98/ME.
236</P>
237<P>
238 Added SDL_BUTTON_X1 and SDL_BUTTON_X2 constants for extended mouse buttons.
239</P>
240<P>
241 Added support for quoted command line arguments.
242</P>
243</BLOCKQUOTE>
244
245<H3> Mac OS X Notes </H3>
246
247<BLOCKQUOTE>
248<P>
249 SDL now builds on Mac OS X 10.5 (Leopard).
250</P>
251<P>
252 Fixed high frequency crash involving text input.
253</P>
254<P>
255 Fixed beeping when the escape key is pressed and UNICODE translation is enabled.
256</P>
257<P>
258 Improved trackpad scrolling support.
259</P>
260<P>
261 Fixed joystick hat reporting for certain joysticks.
262</P>
263</BLOCKQUOTE>
264
265<IMG SRC="docs/images/rainbow.gif" ALT="[separator]" WIDTH="100%">
266
267<H2> SDL 1.2.12 Release Notes </H2>
268<P>
269SDL 1.2.12 is a minor bug fix release.
270</P>
271
272<H3> General Notes </H3>
273
274<BLOCKQUOTE>
275<P>
276 Added support for the PulseAudio sound server: http://www.pulseaudio.org/
277</P>
278<P>
279 Added SDL_VIDEO_ALLOW_SCREENSAVER to override SDL's disabling of the screensaver on Mac OS X, Windows, and X11.
280</P>
281<P>
282 Fixed buffer overrun crash when resampling audio rates.
283</P>
284<P>
285 Fixed audio bug where converting to mono was doubling the volume.
286</P>
287<P>
288 Fixed off-by-one error in the C implementation of SDL_revcpy()
289</P>
290<P>
291 Fixed compiling with Sun Studio.
292</P>
293<P>
294 Support for AmigaOS has been removed from the main SDL code.
295</P>
296<P>
297 Support for Nokia 9210 "EPOC" driver has been removed from the main SDL code.
298</P>
299<P>
300 Unofficial support for the S60/SymbianOS platform has been added.
301</P>
302<P>
303 Unofficial support for the Nintendo DS platform has been added.
304</P>
305<P>
306 Reenabled MMX assembly for YUV overlay processing (GNU C Compiler only).
307</P>
308</BLOCKQUOTE>
309
310<H3> Unix Notes </H3>
311
312<BLOCKQUOTE>
313<P>
314 Fixed detection of X11 DGA mouse support.
315</P>
316<P>
317 Improved XIM support for asian character sets.
318</P>
319<P>
320 The GFX_Display has been added to the X11 window information in SDL_syswm.h.
321</P>
322<P>
323 Fixed PAGE_SIZE compile error in the fbcon video driver on newer Linux kernels.
324</P>
325<P>
326 Fixed hang or crash at startup if aRts can't access the hardware.
327</P>
328<P>
329 Fixed relative mouse mode when the cursor starts outside the X11 window.
330</P>
331<P>
332 Fixed accidental free of stack memory in X11 mouse acceleration code.
333</P>
334<P>
335 Closed minor memory leak in XME code.
336</P>
337<P>
338 Fixed TEXTRELs in the library to resolve some PIC issues.
339</P>
340</BLOCKQUOTE>
341
342<H3> Windows Notes </H3>
343
344<BLOCKQUOTE>
345<P>
346 The GDI video driver makes better use of the palette in 8-bit modes.
347</P>
348<P>
349 The windib driver now supports more mouse buttons with WM_XBUTTON events.
350</P>
351<P>
352 On Windows, SDL_SetVideoMode() will re-create the window instead of failing if the multisample settings are changed.
353</P>
354<P>
355 Added support for UTF-8 window titles on Windows.
356</P>
357<P>
358 Fixed joystick detection on Windows.
359</P>
360<P>
361 Improved performance with Win32 file I/O.
362</P>
363<P>
364 Fixed HBITMAP leak in GAPI driver.
365</P>
366</BLOCKQUOTE>
367
368<H3> Mac OS X Notes </H3>
369
370<BLOCKQUOTE>
371<P>
372 Added support for multi-axis controllers like 3Dconnxion's SpaceNavigator on Mac OS X.
373</P>
374<P>
375 Fixed YUV overlay crash inside Quicktime on Intel Mac OS X.
376</P>
377<P>
378 Fixed blitting alignment in Altivec alpha blit functions.
379</P>
380<P>
381 Keys F13, F14, and F15 are now usable on Apple keyboards under Mac OS X.
382</P>
383<P>
384 Fixed joystick calibration code on Mac OS X.
385</P>
386<P>
387 Fixed mouse jitter when multiple motion events are queued up in Mac OS X.
388</P>
389<P>
390 Fixed changing the cursor in fullscreen mode on Mac OS X.
391</P>
392</BLOCKQUOTE>
393
394<H3> Mac OS Classic Notes </H3>
395
396<BLOCKQUOTE>
397<P>
398 Added support for gamma ramps to both toolbox and DrawSprocket video drivers.
399</P>
400</BLOCKQUOTE>
401
402<H3> BeOS Notes </H3>
403
404<BLOCKQUOTE>
405<P>
406 Implemented mouse grabbing and mouse relative mode on BeOS.
407</P>
408</BLOCKQUOTE>
409
410<IMG SRC="docs/images/rainbow.gif" ALT="[separator]" WIDTH="100%">
411
412<H2> SDL 1.2.11 Release Notes </H2>
413<P>
414SDL 1.2.11 is a minor bug fix release.
415</P>
416
417<H3> Unix Notes </H3>
418
419<BLOCKQUOTE>
420<P>
421 Dynamic X11 loading is only enabled with gcc 4 supporting -fvisibility=hidden. This fixes crashes related to symbol collisions, and allows building on Solaris and IRIX.
422</P>
423<P>
424 Fixed building SDL with Xinerama disabled.
425</P>
426<P>
427 Fixed DRI OpenGL library loading, using RTLD_GLOBAL in dlopen().
428</P>
429<P>
430 Added pkgconfig configuration support.
431</P>
432</BLOCKQUOTE>
433
434<H3> Windows Notes </H3>
435
436<BLOCKQUOTE>
437<P>
438 Setting SDL_GL_SWAP_CONTROL now works with Windows OpenGL.
439</P>
440<P>
441 The Win32 window positioning code works properly for windows with menus.
442</P>
443<P>
444 DirectSound audio quality has been improved on certain sound cards.
445</P>
446<P>
447 Fixed 5.1 audio channel ordering on Windows and Mac OS X.
448</P>
449<P>
450 Plugged a couple of minor memory leaks in the windib video driver.
451</P>
452<P>
453 Fixed type collision with stdint.h when building with gcc on Win32.
454</P>
455<P>
456 Fixed building with the Digital Mars Compiler on Win32.
457</P>
458</BLOCKQUOTE>
459
460<H3> Mac OS X Notes </H3>
461
462<BLOCKQUOTE>
463<P>
464 The Quartz video driver supports 32x32 cursors on Mac OS X 10.3 and above.
465</P>
466</BLOCKQUOTE>
467
468<IMG SRC="docs/images/rainbow.gif" ALT="[separator]" WIDTH="100%">
469
470<H2> SDL 1.2.10 Release Notes </H2>
471<P>
472SDL 1.2.10 is a major release, featuring a revamp of the build system and many API improvements and bug fixes.
473</P>
474<H3> API enhancements </H3>
475<UL>
476<LI>
477 If SDL_OpenAudio() is passed zero for the desired format
478 fields, the following environment variables will be used
479 to fill them in:
480<pre><code>
481 SDL_AUDIO_FREQUENCY
482 SDL_AUDIO_FORMAT
483 SDL_AUDIO_CHANNELS
484 SDL_AUDIO_SAMPLES
485</code></pre>
486 If an environment variable is not specified, it will be set
487 to a reasonable default value.
488<LI>
489 SDL_SetVideoMode() now accepts 0 for width or height and will use
490 the current video mode (or the desktop mode if no mode has been set.)
491<LI>
492 Added current_w and current_h to the SDL_VideoInfo structure,
493 which is set to the desktop resolution during video intialization,
494 and then set to the current resolution when a video mode is set.
495<LI>
496 SDL_GL_LoadLibrary() will load the system default OpenGL library
497 if it is passed NULL as a parameter.
498<LI>
499 Added SDL_GL_SWAP_CONTROL to wait for vsync in OpenGL applications.
500<LI>
501 Added SDL_GL_ACCELERATED_VISUAL to guarantee hardware acceleration.
502<LI>
503 SDL_WM_SetCaption() now officially takes UTF-8 title and icon strings, and displays international characters on supported platforms.
504<LI>
505 Added SDL_GetKeyRepeat() to query the key repeat settings.
506<LI>
507 Added the "dummy" audio driver, which can be used to emulate audio
508 output without a sound card.
509<LI>
510 Added SDL_config.h, with defaults for various build environments.
511</UL>
512
513<H3> General Notes </H3>
514
515<BLOCKQUOTE>
516<P>
517 The SDL website now has an <A HREF="http://www.libsdl.org/rss/rss.xml">RSS feed</A>!
518<P>
519 The SDL development source code is now managed with <A HREF="http://www.libsdl.org/svn.php">Subversion</A>.
520<P>
521 SDL now uses the Bugzilla <A HREF="http://bugzilla.libsdl.org/">bug tracking system</A>, hosted by icculus.org.
522<P>
523 SDL is licensed under version 2.1 of the GNU Lesser General Public License.
524<P>
525 The entire build system has been revamped to make it much more portable, including versions of C library functions to make it possible to run SDL on a minimal embedded environment. See README.Porting in the SDL source distribution for information on how to port SDL to a new platform.
526<P>
527 SDL_opengl.h has been updated with the latest glext.h from <A HREF="http://oss.sgi.com/projects/ogl-sample/registry/">http://oss.sgi.com/projects/ogl-sample/registry/</A>
528<P>
529 Alex Volkov contributed highly optimized RGB <-> RGBA blitters.
530</BLOCKQUOTE>
531
532<H3> Unix Notes </H3>
533
534<BLOCKQUOTE>
535<P>
536 The X11 libraries are dynamically loaded at runtime by default. This allows the distributed version of SDL to run on systems without X11 libraries installed.
537<P>
538 The XiG XME extension code is now included in the X11 video driver by default.
539<P>
540 XRandR support for video mode switching has been added to the X11 driver, but is disabled because of undesired interactions with window managers. You can enable this by setting the environment variable SDL_VIDEO_X11_XRANDR to 1.
541<P>
542 Xinerama multi-head displays are properly handled now, and the SDL_VIDEO_FULLSCREEN_HEAD environment variable can be used to select the screen used for fullscreen video modes. Note that changing the video modes only works on screen 0.
543<P>
544 XVidMode video modes are now sorted so they maintain the refresh rates specified in the X11 configuration file.
545<P>
546 SDL windows are no longer transparent in X11 compositing systems like XGL.
547<P>
548 The mouse is properly released by the X11 video driver if the fullscreen window loses focus.
549<P>
550 The X11 input driver now uses XIM to handle international input.
551<P>
552 The screensaver and DPMS monitor blanking are disabled while SDL games are running under the X11 and DGA video drivers. This behavior will be formalized and selectable in SDL 1.3.
553<P>
554 Fixed a bug preventing stereo OpenGL contexts from being selected on the X11 driver.
555<P>
556 The DGA video driver now waits for pending blits involving surfaces before they are freed. This prevents display oddities when using SDL_DisplayFormat() to convert many images.
557<P>
558 The framebuffer console video driver now has a parser for /etc/fb.modes for improved video mode handling.
559<P>
560 The framebuffer console video driver now allows asynchronous VT switching, and restores the full contents of the screen when switched back.
561<P>
562 The framebuffer console now uses CTRL-ALT-FN to switch virtual terminals, to avoid collisions with application key bindings.
563<P>
564 The framebuffer console input driver correctly sets IMPS/2 mode for wheel mice. It also properly detects when gpm is in IMPS/2 protocol mode, or passing raw protocol from an IMPS/2 mouse.
565<P>
566 The SVGAlib video driver now has support for banked (non-linear) video modes.
567<P>
568 A video driver for OpenBSD on the Sharp Zaurus has been contributed by Staffan Ulfberg. See the file README.wscons in the SDL source distribution for details.
569<P>
570 Many patches have been incorporated from *BSD ports.
571</BLOCKQUOTE>
572
573<H3> Windows Notes </H3>
574
575<BLOCKQUOTE>
576<P>
577 The "windib" video driver is the default now, to prevent problems with certain laptops, 64-bit Windows, and Windows Vista. The DirectX driver is still available, and can be selected by setting the environment variable SDL_VIDEODRIVER to "directx".
578<P>
579 SDL has been ported to 64-bit Windows.
580<P>
581 Dmitry Yakimov contributed a GAPI video driver for Windows CE.
582<P>
583 The default fullscreen refresh rate has been increased to match the desktop refresh rate, when using equivalent resolutions. A full API for querying and selecting refresh rates is planned for SDL 1.3.
584<P>
585 Dialog boxes are now shown when SDL is in windowed OpenGL mode.
586<P>
587 The SDL window is recreated when necessary to maintain OpenGL context attributes, when switching between windowed and fullscreen modes.
588<P>
589 An SDL_VIDEORESIZE event is properly sent when the SDL window is maximized and restored.
590<P>
591 Window positions are retained when switching between fullscreen and windowed modes.
592<P>
593 ToUnicode() is used, when available, for improved handling of international keyboard input.
594<P>
595 The PrtScrn is now treated normally with both key down and key up events.
596<P>
597 Pressing ALT-F4 now delivers an SDL_QUIT event to SDL applications.
598<P>
599 Joystick names are now correct for joysticks which have been unplugged and then plugged back in since booting.
600<P>
601 An MCI error when playing the last track on a CD-ROM has been fixed.
602<P>
603 OpenWatcom projects for building SDL have been provided by Marc Peter.
604</BLOCKQUOTE>
605
606<H3> Mac OS X Notes </H3>
607
608<BLOCKQUOTE>
609<P>
610 SDL now supports building Universal binaries, both through Xcode projects and when using configure/make. See README.MacOSX in the SDL source archive for details.
611<P>
612 The X11 video driver with GLX support can be built on Mac OS X, if the X11 development SDK is installed.
613<P>
614 Transitions between fullscreen resolutions and windowed mode now use a much faster asynchronous fade to hide desktop flicker.
615<P>
616 Icons set with SDL_WM_SetIcon() now have the proper colors on Intel Macs.
617</BLOCKQUOTE>
618
619<H3> OS/2 Notes </H3>
620
621<BLOCKQUOTE>
622<P>
623 Projects for building SDL on OS/2 with OpenWatcom have been contributed by Doodle. See the file README.OS2 in the SDL source distribution for details.
624</BLOCKQUOTE>
625
626<IMG SRC="docs/images/rainbow.gif" ALT="[separator]" WIDTH="100%">
627
628</BODY>
629</HTML>