docs.html
author Ryan C. Gordon <icculus@icculus.org>
Thu, 05 Jul 2007 02:53:40 +0000
branchSDL-1.2
changeset 4003 ea059917233c
parent 3994 720c59bd38ac
child 4009 1146681dbb74
permissions -rw-r--r--
Added notes about audio callback behaviour.
slouken@0
     1
<HTML>
slouken@0
     2
<HEAD><TITLE>SDL Stable Release</TITLE></HEAD>
slouken@0
     3
<BODY BGCOLOR="#FFEBCD" TEXT="#000000">
slouken@0
     4
slouken@0
     5
<IMG SRC="docs/images/rainbow.gif" ALT="[separator]" WIDTH="100%">
slouken@0
     6
<P>
slouken@511
     7
This source is stable, and is fully tested on all supported platforms.<br>
slouken@511
     8
Please send bug reports or questions to the SDL mailing list:<br>
slouken@511
     9
<a href="http://www.libsdl.org/mailing-list.php"
slouken@511
    10
        >http://www.libsdl.org/mailing-list.php</a><br>
slouken@511
    11
The latest stable release may be found on the
slouken@511
    12
	<a href="http://www.libsdl.org/">SDL website</A>.
slouken@511
    13
</P>
slouken@0
    14
slouken@0
    15
<H2> <A HREF="docs/index.html">API Documentation</A> </H2>
slouken@1840
    16
slouken@3960
    17
<H2> SDL 1.2.12 Release Notes </H2>
slouken@3960
    18
<P>
slouken@3960
    19
SDL 1.2.12 is a minor bug fix release.
slouken@3960
    20
</P>
slouken@3960
    21
slouken@3960
    22
<H3> General Notes </H3>
slouken@3960
    23
slouken@3960
    24
<BLOCKQUOTE>
slouken@3960
    25
<P>
slouken@3960
    26
	Added support for the PulseAudio sound server: http://www.pulseaudio.org/
slouken@3960
    27
</P>
slouken@3960
    28
<P>
icculus@3982
    29
	Added SDL_VIDEO_ALLOW_SCREENSAVER to override SDL's disabling of the screensaver on Mac OS X, Windows, and X11.
slouken@3960
    30
</P>
slouken@3960
    31
<P>
slouken@3960
    32
	Fixed buffer overrun crash when resampling audio rates.
slouken@3960
    33
</P>
slouken@3960
    34
<P>
slouken@3960
    35
	Fixed audio bug where converting to mono was doubling the volume.
slouken@3960
    36
</P>
slouken@3960
    37
<P>
slouken@3960
    38
	Fixed off-by-one error in the C implementation of SDL_revcpy()
slouken@3960
    39
</P>
slouken@3960
    40
<P>
slouken@3966
    41
	Fixed compiling with Sun Studio.
slouken@3966
    42
</P>
slouken@3966
    43
<P>
slouken@3960
    44
	Support for AmigaOS has been removed from the main SDL code.
slouken@3960
    45
</P>
icculus@3968
    46
<P>
icculus@3968
    47
	Support for Nokia 9210 "EPOC" driver has been removed from the main SDL code.
icculus@3968
    48
</P>
icculus@3975
    49
<P>
icculus@3975
    50
	Unofficial support for the S60/SymbianOS platform has been added.
icculus@3975
    51
</P>
slouken@3976
    52
<P>
slouken@3976
    53
	Unofficial support for the Nintendo DS platform has been added.
slouken@3976
    54
</P>
icculus@4003
    55
<P>
icculus@4003
    56
	Audio callbacks must now initialize the entire stream: applications must write silence to the stream if they can't supply data, and not mix against the buffer, as it may be random data.
icculus@4003
    57
	Users may set SDL_AUDIO_MUST_INIT_BUFFERS to retain the old behaviour, but apps should not depend on this environment variable: just add a memset() at the start of your audio callback instead if you need it.
icculus@4003
    58
</P>
slouken@3960
    59
</BLOCKQUOTE>
slouken@3960
    60
slouken@3960
    61
<H3> Unix Notes </H3>
slouken@3960
    62
slouken@3960
    63
<BLOCKQUOTE>
slouken@3960
    64
<P>
slouken@3994
    65
	Improved XIM support for asian character sets.
slouken@3994
    66
</P>
slouken@3994
    67
<P>
slouken@3960
    68
	The GFX_Display has been added to the X11 window information in SDL_syswm.h.
slouken@3960
    69
</P>
slouken@3960
    70
<P>
slouken@3960
    71
	Fixed PAGE_SIZE compile error in the fbcon video driver on newer Linux kernels.
slouken@3960
    72
</P>
slouken@3960
    73
<P>
slouken@3960
    74
	Fixed hang or crash at startup if aRts can't access the hardware.
slouken@3960
    75
</P>
slouken@3960
    76
<P>
slouken@3960
    77
	Fixed relative mouse mode when the cursor starts outside the X11 window.
slouken@3960
    78
</P>
slouken@3960
    79
<P>
slouken@3960
    80
	Fixed accidental free of stack memory in X11 mouse acceleration code.
slouken@3960
    81
</P>
slouken@3960
    82
<P>
slouken@3960
    83
	Closed minor memory leak in XME code.
slouken@3960
    84
</P>
slouken@3960
    85
</BLOCKQUOTE>
slouken@3960
    86
slouken@3960
    87
<H3> Windows Notes </H3>
slouken@3960
    88
slouken@3960
    89
<BLOCKQUOTE>
slouken@3960
    90
<P>
slouken@3993
    91
	The GDI video driver makes better use of the palette in 8-bit modes.
slouken@3993
    92
</P>
slouken@3993
    93
<P>
icculus@3970
    94
	The windib driver now supports more mouse buttons with WM_XBUTTON events.
icculus@3970
    95
</P>
icculus@3970
    96
<P>
slouken@3960
    97
	Added support for UTF-8 window titles on Windows.
slouken@3960
    98
</P>
slouken@3960
    99
<P>
slouken@3960
   100
	Fixed joystick detection on Windows.
slouken@3960
   101
</P>
slouken@3960
   102
<P>
slouken@3960
   103
	Fixed HBITMAP leak in GAPI driver.
slouken@3960
   104
</P>
slouken@3960
   105
</BLOCKQUOTE>
slouken@3960
   106
slouken@3960
   107
<H3> Mac OS X Notes </H3>
slouken@3960
   108
slouken@3960
   109
<BLOCKQUOTE>
slouken@3960
   110
<P>
slouken@3960
   111
	Added support for multi-axis controllers like 3Dconnxion's SpaceNavigator on Mac OS X.
slouken@3960
   112
</P>
slouken@3960
   113
<P>
slouken@3960
   114
	Fixed YUV overlay crash inside Quicktime on Intel Mac OS X.
slouken@3960
   115
</P>
slouken@3960
   116
<P>
slouken@3960
   117
	Fixed blitting alignment in Altivec alpha blit functions.
slouken@3960
   118
</P>
slouken@3960
   119
<P>
slouken@3960
   120
	Keys F13, F14, and F15 are now usable on Apple keyboards under Mac OS X.
slouken@3960
   121
</P>
slouken@3960
   122
<P>
slouken@3960
   123
	Fixed joystick calibration code on Mac OS X.
slouken@3960
   124
</P>
slouken@3960
   125
<P>
slouken@3960
   126
	Fixed mouse jitter when multiple motion events are queued up in Mac OS X.
slouken@3960
   127
</P>
slouken@3960
   128
</BLOCKQUOTE>
slouken@3960
   129
slouken@3963
   130
<H3> Mac OS Classic Notes </H3>
slouken@3963
   131
slouken@3963
   132
<BLOCKQUOTE>
slouken@3963
   133
<P>
slouken@3963
   134
	Added support for gamma ramps to both toolbox and DrawSprocket video drivers.
slouken@3963
   135
</P>
slouken@3963
   136
</BLOCKQUOTE>
slouken@3963
   137
slouken@3960
   138
<H3> BeOS Notes </H3>
slouken@3960
   139
slouken@3960
   140
<BLOCKQUOTE>
slouken@3960
   141
<P>
slouken@3960
   142
	Implemented mouse grabbing and mouse relative mode on BeOS.
slouken@3960
   143
</P>
slouken@3960
   144
</BLOCKQUOTE>
slouken@3960
   145
slouken@3960
   146
<IMG SRC="docs/images/rainbow.gif" ALT="[separator]" WIDTH="100%">
slouken@3960
   147
slouken@1892
   148
<H2> SDL 1.2.11 Release Notes </H2>
slouken@1892
   149
<P>
slouken@1892
   150
SDL 1.2.11 is a minor bug fix release.
slouken@1892
   151
</P>
slouken@1892
   152
slouken@1892
   153
<H3> Unix Notes </H3>
slouken@1892
   154
slouken@1892
   155
<BLOCKQUOTE>
slouken@1892
   156
<P>
slouken@1892
   157
	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.
slouken@1892
   158
</P>
slouken@1892
   159
<P>
slouken@1892
   160
	Fixed building SDL with Xinerama disabled.
slouken@1892
   161
</P>
slouken@1892
   162
<P>
slouken@1892
   163
	Fixed DRI OpenGL library loading, using RTLD_GLOBAL in dlopen().
slouken@1892
   164
</P>
slouken@1892
   165
<P>
slouken@1892
   166
	Added pkgconfig configuration support.
slouken@1892
   167
</P>
slouken@1892
   168
</BLOCKQUOTE>
slouken@1892
   169
slouken@1892
   170
<H3> Windows Notes </H3>
slouken@1892
   171
slouken@1892
   172
<BLOCKQUOTE>
slouken@1892
   173
<P>
slouken@1892
   174
	Setting SDL_GL_SWAP_CONTROL now works with Windows OpenGL.
slouken@1892
   175
</P>
slouken@1892
   176
<P>
slouken@1892
   177
	The Win32 window positioning code works properly for windows with menus.
slouken@1892
   178
</P>
slouken@1892
   179
<P>
slouken@1892
   180
	DirectSound audio quality has been improved on certain sound cards.
slouken@1892
   181
</P>
slouken@1892
   182
<P>
slouken@1892
   183
	Fixed 5.1 audio channel ordering on Windows and Mac OS X.
slouken@1892
   184
</P>
slouken@1892
   185
<P>
slouken@1892
   186
	Plugged a couple of minor memory leaks in the windib video driver.
slouken@1892
   187
</P>
slouken@1892
   188
<P>
slouken@1892
   189
	Fixed type collision with stdint.h when building with gcc on Win32.
slouken@1892
   190
</P>
slouken@1892
   191
<P>
slouken@1892
   192
	Fixed building with the Digital Mars Compiler on Win32.
slouken@1892
   193
</P>
slouken@1892
   194
</BLOCKQUOTE>
slouken@1892
   195
slouken@1892
   196
<H3> Mac OS X Notes </H3>
slouken@1892
   197
slouken@1892
   198
<BLOCKQUOTE>
slouken@1892
   199
<P>
slouken@1892
   200
	The Quartz video driver supports 32x32 cursors on Mac OS X 10.3 and above.
slouken@1892
   201
</P>
slouken@1892
   202
</BLOCKQUOTE>
slouken@1892
   203
slouken@1892
   204
<IMG SRC="docs/images/rainbow.gif" ALT="[separator]" WIDTH="100%">
slouken@1892
   205
slouken@1840
   206
<H2> SDL 1.2.10 Release Notes </H2>
slouken@0
   207
<P>
slouken@1840
   208
SDL 1.2.10 is a major release, featuring a revamp of the build system and many API improvements and bug fixes.
slouken@1840
   209
</P>
slouken@1840
   210
<H3> API enhancements </H3>
slouken@0
   211
<UL>
slouken@1840
   212
<LI>
slouken@1840
   213
	If SDL_OpenAudio() is passed zero for the desired format
slouken@1840
   214
	fields, the following environment variables will be used
slouken@1840
   215
	to fill them in:
slouken@1840
   216
<pre><code>
slouken@1840
   217
		SDL_AUDIO_FREQUENCY
slouken@1840
   218
		SDL_AUDIO_FORMAT
slouken@1840
   219
		SDL_AUDIO_CHANNELS
slouken@1840
   220
		SDL_AUDIO_SAMPLES
slouken@1840
   221
</code></pre>
slouken@1840
   222
	If an environment variable is not specified, it will be set
slouken@1840
   223
	to a reasonable default value.
slouken@1840
   224
<LI>
slouken@1840
   225
	SDL_SetVideoMode() now accepts 0 for width or height and will use
slouken@1840
   226
	the current video mode (or the desktop mode if no mode has been set.)
slouken@1840
   227
<LI>
slouken@1840
   228
	Added current_w and current_h to the SDL_VideoInfo structure,
slouken@1840
   229
	which is set to the desktop resolution during video intialization,
slouken@1840
   230
	and then set to the current resolution when a video mode is set.
slouken@1840
   231
<LI>
slouken@1840
   232
	SDL_GL_LoadLibrary() will load the system default OpenGL library
slouken@1840
   233
	if it is passed NULL as a parameter.
slouken@1840
   234
<LI>
slouken@1840
   235
	Added SDL_GL_SWAP_CONTROL to wait for vsync in OpenGL applications.
slouken@1840
   236
<LI>
slouken@1840
   237
	Added SDL_GL_ACCELERATED_VISUAL to guarantee hardware acceleration.
slouken@1840
   238
<LI>
slouken@1840
   239
	SDL_WM_SetCaption() now officially takes UTF-8 title and icon strings, and displays international characters on supported platforms.
slouken@1840
   240
<LI>
slouken@1840
   241
	Added SDL_GetKeyRepeat() to query the key repeat settings.
slouken@1840
   242
<LI>
slouken@1840
   243
	Added the "dummy" audio driver, which can be used to emulate audio
slouken@1840
   244
	output without a sound card.
slouken@1840
   245
<LI>
slouken@1840
   246
	Added SDL_config.h, with defaults for various build environments.
slouken@0
   247
</UL>
slouken@0
   248
slouken@1840
   249
<H3> General Notes </H3>
slouken@0
   250
slouken@1840
   251
<BLOCKQUOTE>
slouken@1840
   252
<P>
slouken@1840
   253
	The SDL website now has an <A HREF="http://www.libsdl.org/rss/rss.xml">RSS feed</A>!
slouken@1840
   254
<P>
slouken@1840
   255
	The SDL development source code is now managed with <A HREF="http://www.libsdl.org/svn.php">Subversion</A>.
slouken@1840
   256
<P>
slouken@1840
   257
	SDL now uses the Bugzilla <A HREF="http://bugzilla.libsdl.org/">bug tracking system</A>, hosted by icculus.org.
slouken@1840
   258
<P>
slouken@1840
   259
	SDL is licensed under version 2.1 of the GNU Lesser General Public License.
slouken@1840
   260
<P>
slouken@1840
   261
	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.
slouken@1840
   262
<P>
slouken@1840
   263
	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>
slouken@1840
   264
<P>
slouken@1840
   265
	Alex Volkov contributed highly optimized RGB <-> RGBA blitters.
slouken@1840
   266
</BLOCKQUOTE>
slouken@0
   267
slouken@1840
   268
<H3> Unix Notes </H3>
slouken@0
   269
slouken@1840
   270
<BLOCKQUOTE>
slouken@1840
   271
<P>
slouken@1840
   272
	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.
slouken@1840
   273
<P>
slouken@1840
   274
	The XiG XME extension code is now included in the X11 video driver by default.
slouken@1840
   275
<P>
slouken@1840
   276
	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.
slouken@1840
   277
<P>
slouken@1840
   278
	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.
slouken@1840
   279
<P>
slouken@1840
   280
	XVidMode video modes are now sorted so they maintain the refresh rates specified in the X11 configuration file.
slouken@1840
   281
<P>
slouken@1840
   282
	SDL windows are no longer transparent in X11 compositing systems like XGL.
slouken@1840
   283
<P>
slouken@1840
   284
	The mouse is properly released by the X11 video driver if the fullscreen window loses focus.
slouken@1840
   285
<P>
slouken@1840
   286
	The X11 input driver now uses XIM to handle international input.
slouken@1840
   287
<P>
slouken@1840
   288
	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.
slouken@1840
   289
<P>
slouken@1840
   290
	Fixed a bug preventing stereo OpenGL contexts from being selected on the X11 driver.
slouken@1840
   291
<P>
slouken@1840
   292
	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.
slouken@1840
   293
<P>
slouken@1840
   294
	The framebuffer console video driver now has a parser for /etc/fb.modes for improved video mode handling.
slouken@1840
   295
<P>
slouken@1840
   296
	The framebuffer console video driver now allows asynchronous VT switching, and restores the full contents of the screen when switched back.
slouken@1840
   297
<P>
slouken@1840
   298
	The framebuffer console now uses CTRL-ALT-FN to switch virtual terminals, to avoid collisions with application key bindings.
slouken@1840
   299
<P>
slouken@1840
   300
	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.
slouken@1840
   301
<P>
slouken@1840
   302
	The SVGAlib video driver now has support for banked (non-linear) video modes.
slouken@1840
   303
<P>
slouken@1840
   304
	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.
slouken@1840
   305
<P>
slouken@1840
   306
	Many patches have been incorporated from *BSD ports.
slouken@1840
   307
</BLOCKQUOTE>
slouken@0
   308
slouken@1840
   309
<H3> Windows Notes </H3>
slouken@0
   310
slouken@1840
   311
<BLOCKQUOTE>
slouken@1840
   312
<P>
slouken@1840
   313
	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".
slouken@1840
   314
<P>
slouken@1840
   315
	SDL has been ported to 64-bit Windows.
slouken@1840
   316
<P>
slouken@1840
   317
	Dmitry Yakimov contributed a GAPI video driver for Windows CE.
slouken@1840
   318
<P>
slouken@1840
   319
	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.
slouken@1840
   320
<P>
slouken@1840
   321
	Dialog boxes are now shown when SDL is in windowed OpenGL mode.
slouken@1840
   322
<P>
slouken@1840
   323
	The SDL window is recreated when necessary to maintain OpenGL context attributes, when switching between windowed and fullscreen modes.
slouken@1840
   324
<P>
slouken@1840
   325
	An SDL_VIDEORESIZE event is properly sent when the SDL window is maximized and restored.
slouken@1840
   326
<P>
slouken@1840
   327
	Window positions are retained when switching between fullscreen and windowed modes.
slouken@1840
   328
<P>
slouken@1840
   329
	ToUnicode() is used, when available, for improved handling of international keyboard input.
slouken@1840
   330
<P>
slouken@1840
   331
	The PrtScrn is now treated normally with both key down and key up events.
slouken@1840
   332
<P>
slouken@1840
   333
	Pressing ALT-F4 now delivers an SDL_QUIT event to SDL applications.
slouken@1840
   334
<P>
slouken@1840
   335
	Joystick names are now correct for joysticks which have been unplugged and then plugged back in since booting.
slouken@1840
   336
<P>
slouken@1840
   337
	An MCI error when playing the last track on a CD-ROM has been fixed.
slouken@1840
   338
<P>
slouken@1840
   339
	OpenWatcom projects for building SDL have been provided by Marc Peter.
slouken@1840
   340
</BLOCKQUOTE>
slouken@0
   341
slouken@1840
   342
<H3> Mac OS X Notes </H3>
slouken@1840
   343
slouken@1840
   344
<BLOCKQUOTE>
slouken@0
   345
<P>
slouken@1840
   346
	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.
slouken@1840
   347
<P>
slouken@1840
   348
	The X11 video driver with GLX support can be built on Mac OS X, if the X11 development SDK is installed.
slouken@1840
   349
<P>
slouken@1840
   350
	Transitions between fullscreen resolutions and windowed mode now use a much faster asynchronous fade to hide desktop flicker.
slouken@1840
   351
<P>
slouken@1840
   352
	Icons set with SDL_WM_SetIcon() now have the proper colors on Intel Macs.
slouken@1840
   353
</BLOCKQUOTE>
slouken@1840
   354
slouken@1840
   355
<H3> OS/2 Notes </H3>
slouken@1840
   356
slouken@1840
   357
<BLOCKQUOTE>
slouken@1840
   358
<P>
slouken@1840
   359
	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.
slouken@1840
   360
</BLOCKQUOTE>
slouken@1840
   361
slouken@0
   362
<IMG SRC="docs/images/rainbow.gif" ALT="[separator]" WIDTH="100%">
slouken@0
   363
slouken@0
   364
</BODY>
slouken@0
   365
</HTML>