From 013f3b5a259f11cfe4ac0b4999c3f2bfe8ca297c Mon Sep 17 00:00:00 2001 From: Sam Lantinga Date: Sun, 10 Jun 2001 19:31:57 +0000 Subject: [PATCH] Added new docs for SDL 1.2.1 --- docs/html/Makefile.am | 1 + docs/html/audio.html | 2 +- docs/html/cdrom.html | 2 +- docs/html/event.html | 6 +- docs/html/eventfunctions.html | 2 +- docs/html/eventstructures.html | 2 +- docs/html/general.html | 2 +- docs/html/guide.html | 2 +- docs/html/guideaboutsdldoc.html | 6 +- docs/html/guideaudioexamples.html | 6 +- docs/html/guidebasicsinit.html | 12 +- docs/html/guidecdromexamples.html | 10 +- docs/html/guidecredits.html | 10 +- docs/html/guideeventexamples.html | 14 +- docs/html/guideexamples.html | 25 +- docs/html/guideinput.html | 182 ++++-- docs/html/guideinputkeyboard.html | 62 +- docs/html/guidepreface.html | 2 +- docs/html/guidethebasics.html | 2 +- docs/html/guidetimeexamples.html | 4 +- docs/html/guidevideo.html | 754 ++++++++---------------- docs/html/guidevideoexamples.html | 12 +- docs/html/guidevideoopengl.html | 719 ++++++++++++++++++++++ docs/html/index.html | 125 +++- docs/html/joystick.html | 2 +- docs/html/reference.html | 2 +- docs/html/sdlactiveevent.html | 14 +- docs/html/sdladdtimer.html | 33 +- docs/html/sdlaudiocvt.html | 14 +- docs/html/sdlaudiospec.html | 16 +- docs/html/sdlblitsurface.html | 42 +- docs/html/sdlbuildaudiocvt.html | 16 +- docs/html/sdlcd.html | 16 +- docs/html/sdlcdclose.html | 12 +- docs/html/sdlcdeject.html | 14 +- docs/html/sdlcdname.html | 14 +- docs/html/sdlcdnumdrives.html | 12 +- docs/html/sdlcdopen.html | 14 +- docs/html/sdlcdpause.html | 14 +- docs/html/sdlcdplay.html | 14 +- docs/html/sdlcdplaytracks.html | 16 +- docs/html/sdlcdresume.html | 14 +- docs/html/sdlcdstatus.html | 14 +- docs/html/sdlcdstop.html | 14 +- docs/html/sdlcdtrack.html | 14 +- docs/html/sdlcloseaudio.html | 12 +- docs/html/sdlcolor.html | 14 +- docs/html/sdlcondbroadcast.html | 12 +- docs/html/sdlcondsignal.html | 12 +- docs/html/sdlcondwait.html | 12 +- docs/html/sdlcondwaittimeout.html | 12 +- docs/html/sdlconvertaudio.html | 14 +- docs/html/sdlconvertsurface.html | 14 +- docs/html/sdlcreatecond.html | 14 +- docs/html/sdlcreatecursor.html | 16 +- docs/html/sdlcreatemutex.html | 14 +- docs/html/sdlcreatergbsurface.html | 136 ++++- docs/html/sdlcreatergbsurfacefrom.html | 27 +- docs/html/sdlcreatesemaphore.html | 16 +- docs/html/sdlcreatethread.html | 12 +- docs/html/sdlcreateyuvoverlay.html | 12 +- docs/html/sdldelay.html | 26 +- docs/html/sdldestroycond.html | 12 +- docs/html/sdldestroymutex.html | 12 +- docs/html/sdldestroysemaphore.html | 14 +- docs/html/sdldisplayformat.html | 14 +- docs/html/sdldisplayformatalpha.html | 22 +- docs/html/sdldisplayyuvoverlay.html | 12 +- docs/html/sdlenablekeyrepeat.html | 12 +- docs/html/sdlenableunicode.html | 14 +- docs/html/sdlevent.html | 18 +- docs/html/sdleventstate.html | 12 +- docs/html/sdlfillrect.html | 14 +- docs/html/sdlflip.html | 14 +- docs/html/sdlfreecursor.html | 12 +- docs/html/sdlfreesurface.html | 14 +- docs/html/sdlfreewav.html | 12 +- docs/html/sdlfreeyuvoverlay.html | 12 +- docs/html/sdlgetappstate.html | 14 +- docs/html/sdlgetaudiostatus.html | 12 +- docs/html/sdlgetcliprect.html | 12 +- docs/html/sdlgetcursor.html | 12 +- docs/html/sdlgeteventfilter.html | 14 +- docs/html/sdlgetgammaramp.html | 14 +- docs/html/sdlgetkeyname.html | 12 +- docs/html/sdlgetkeystate.html | 14 +- docs/html/sdlgetmodstate.html | 18 +- docs/html/sdlgetmousestate.html | 14 +- docs/html/sdlgetrelativemousestate.html | 12 +- docs/html/sdlgetrgb.html | 12 +- docs/html/sdlgetrgba.html | 12 +- docs/html/sdlgetthreadid.html | 12 +- docs/html/sdlgetticks.html | 12 +- docs/html/sdlgetvideoinfo.html | 12 +- docs/html/sdlgetvideosurface.html | 12 +- docs/html/sdlglattr.html | 12 +- docs/html/sdlglgetattribute.html | 14 +- docs/html/sdlglgetprocaddress.html | 14 +- docs/html/sdlglloadlibrary.html | 12 +- docs/html/sdlglsetattribute.html | 16 +- docs/html/sdlglswapbuffers.html | 12 +- docs/html/sdlinit.html | 16 +- docs/html/sdlinitsubsystem.html | 16 +- docs/html/sdljoyaxisevent.html | 14 +- docs/html/sdljoyballevent.html | 14 +- docs/html/sdljoybuttonevent.html | 14 +- docs/html/sdljoyhatevent.html | 14 +- docs/html/sdljoystickclose.html | 12 +- docs/html/sdljoystickeventstate.html | 14 +- docs/html/sdljoystickgetaxis.html | 16 +- docs/html/sdljoystickgetball.html | 16 +- docs/html/sdljoystickgetbutton.html | 14 +- docs/html/sdljoystickgethat.html | 14 +- docs/html/sdljoystickindex.html | 14 +- docs/html/sdljoystickname.html | 16 +- docs/html/sdljoysticknumaxes.html | 14 +- docs/html/sdljoysticknumballs.html | 14 +- docs/html/sdljoysticknumbuttons.html | 14 +- docs/html/sdljoysticknumhats.html | 14 +- docs/html/sdljoystickopen.html | 16 +- docs/html/sdljoystickopened.html | 14 +- docs/html/sdljoystickupdate.html | 12 +- docs/html/sdlkey.html | 8 +- docs/html/sdlkeyboardevent.html | 14 +- docs/html/sdlkeysym.html | 14 +- docs/html/sdlkillthread.html | 12 +- docs/html/sdllistmodes.html | 14 +- docs/html/sdlloadbmp.html | 14 +- docs/html/sdlloadwav.html | 14 +- docs/html/sdllockaudio.html | 12 +- docs/html/sdllocksurface.html | 14 +- docs/html/sdllockyuvoverlay.html | 14 +- docs/html/sdlmaprgb.html | 14 +- docs/html/sdlmaprgba.html | 14 +- docs/html/sdlmixaudio.html | 33 +- docs/html/sdlmousebuttonevent.html | 14 +- docs/html/sdlmousemotionevent.html | 14 +- docs/html/sdlmutexp.html | 12 +- docs/html/sdlmutexv.html | 12 +- docs/html/sdlnumjoysticks.html | 14 +- docs/html/sdlopenaudio.html | 14 +- docs/html/sdloverlay.html | 14 +- docs/html/sdlpalette.html | 14 +- docs/html/sdlpauseaudio.html | 12 +- docs/html/sdlpeepevents.html | 14 +- docs/html/sdlpixelformat.html | 24 +- docs/html/sdlpollevent.html | 14 +- docs/html/sdlpumpevents.html | 12 +- docs/html/sdlpushevent.html | 16 +- docs/html/sdlquit.html | 12 +- docs/html/sdlquitevent.html | 14 +- docs/html/sdlquitsubsystem.html | 12 +- docs/html/sdlrect.html | 14 +- docs/html/sdlremovetimer.html | 16 +- docs/html/sdlresizeevent.html | 14 +- docs/html/sdlsavebmp.html | 14 +- docs/html/sdlsempost.html | 16 +- docs/html/sdlsemtrywait.html | 16 +- docs/html/sdlsemvalue.html | 16 +- docs/html/sdlsemwait.html | 16 +- docs/html/sdlsemwaittimeout.html | 16 +- docs/html/sdlsetalpha.html | 96 ++- docs/html/sdlsetcliprect.html | 12 +- docs/html/sdlsetcolorkey.html | 14 +- docs/html/sdlsetcolors.html | 16 +- docs/html/sdlsetcursor.html | 12 +- docs/html/sdlseteventfilter.html | 12 +- docs/html/sdlsetgamma.html | 14 +- docs/html/sdlsetgammaramp.html | 14 +- docs/html/sdlsetmodstate.html | 12 +- docs/html/sdlsetpalette.html | 18 +- docs/html/sdlsettimer.html | 16 +- docs/html/sdlsetvideomode.html | 18 +- docs/html/sdlshowcursor.html | 14 +- docs/html/sdlsurface.html | 47 +- docs/html/sdlsyswmevent.html | 10 +- docs/html/sdlthreadid.html | 10 +- docs/html/sdlunlockaudio.html | 12 +- docs/html/sdlunlocksurface.html | 12 +- docs/html/sdlunlockyuvoverlay.html | 12 +- docs/html/sdlupdaterect.html | 15 +- docs/html/sdlupdaterects.html | 34 +- docs/html/sdluserevent.html | 16 +- docs/html/sdlvideodrivername.html | 14 +- docs/html/sdlvideoinfo.html | 14 +- docs/html/sdlvideomodeok.html | 14 +- docs/html/sdlwaitevent.html | 12 +- docs/html/sdlwaitthread.html | 14 +- docs/html/sdlwarpmouse.html | 12 +- docs/html/sdlwasinit.html | 16 +- docs/html/sdlwmgetcaption.html | 12 +- docs/html/sdlwmgrabinput.html | 12 +- docs/html/sdlwmiconifywindow.html | 12 +- docs/html/sdlwmsetcaption.html | 12 +- docs/html/sdlwmseticon.html | 14 +- docs/html/sdlwmtogglefullscreen.html | 12 +- docs/html/thread.html | 2 +- docs/html/time.html | 2 +- docs/html/video.html | 4 +- docs/html/wm.html | 2 +- docs/man3/SDL_ActiveEvent.3 | 4 +- docs/man3/SDL_AddTimer.3 | 10 +- docs/man3/SDL_AudioCVT.3 | 4 +- docs/man3/SDL_AudioSpec.3 | 4 +- docs/man3/SDL_BlitSurface.3 | 27 +- docs/man3/SDL_BuildAudioCVT.3 | 4 +- docs/man3/SDL_CD.3 | 4 +- docs/man3/SDL_CDClose.3 | 4 +- docs/man3/SDL_CDEject.3 | 4 +- docs/man3/SDL_CDName.3 | 4 +- docs/man3/SDL_CDNumDrives.3 | 4 +- docs/man3/SDL_CDOpen.3 | 4 +- docs/man3/SDL_CDPause.3 | 4 +- docs/man3/SDL_CDPlay.3 | 4 +- docs/man3/SDL_CDPlayTracks.3 | 4 +- docs/man3/SDL_CDResume.3 | 4 +- docs/man3/SDL_CDStatus.3 | 4 +- docs/man3/SDL_CDStop.3 | 4 +- docs/man3/SDL_CDtrack.3 | 4 +- docs/man3/SDL_CloseAudio.3 | 4 +- docs/man3/SDL_Color.3 | 4 +- docs/man3/SDL_CondBroadcast.3 | 4 +- docs/man3/SDL_CondSignal.3 | 4 +- docs/man3/SDL_CondWait.3 | 4 +- docs/man3/SDL_CondWaitTimeout.3 | 4 +- docs/man3/SDL_ConvertAudio.3 | 4 +- docs/man3/SDL_ConvertSurface.3 | 4 +- docs/man3/SDL_CreateCond.3 | 4 +- docs/man3/SDL_CreateCursor.3 | 4 +- docs/man3/SDL_CreateMutex.3 | 4 +- docs/man3/SDL_CreateRGBSurface.3 | 50 +- docs/man3/SDL_CreateRGBSurfaceFrom.3 | 9 +- docs/man3/SDL_CreateSemaphore.3 | 4 +- docs/man3/SDL_CreateThread.3 | 4 +- docs/man3/SDL_CreateYUVOverlay.3 | 4 +- docs/man3/SDL_Delay.3 | 10 +- docs/man3/SDL_DestroyCond.3 | 4 +- docs/man3/SDL_DestroyMutex.3 | 4 +- docs/man3/SDL_DestroySemaphore.3 | 4 +- docs/man3/SDL_DisplayFormat.3 | 4 +- docs/man3/SDL_DisplayFormatAlpha.3 | 6 +- docs/man3/SDL_DisplayYUVOverlay.3 | 4 +- docs/man3/SDL_EnableKeyRepeat.3 | 4 +- docs/man3/SDL_EnableUNICODE.3 | 4 +- docs/man3/SDL_Event.3 | 4 +- docs/man3/SDL_EventState.3 | 4 +- docs/man3/SDL_FillRect.3 | 4 +- docs/man3/SDL_Flip.3 | 4 +- docs/man3/SDL_FreeCursor.3 | 4 +- docs/man3/SDL_FreeSurface.3 | 6 +- docs/man3/SDL_FreeWAV.3 | 4 +- docs/man3/SDL_FreeYUVOverlay.3 | 4 +- docs/man3/SDL_GL_GetAttribute.3 | 4 +- docs/man3/SDL_GL_GetProcAddress.3 | 4 +- docs/man3/SDL_GL_LoadLibrary.3 | 4 +- docs/man3/SDL_GL_SetAttribute.3 | 4 +- docs/man3/SDL_GL_SwapBuffers.3 | 4 +- docs/man3/SDL_GLattr.3 | 4 +- docs/man3/SDL_GetAppState.3 | 4 +- docs/man3/SDL_GetAudioStatus.3 | 4 +- docs/man3/SDL_GetClipRect.3 | 4 +- docs/man3/SDL_GetCursor.3 | 4 +- docs/man3/SDL_GetEventFilter.3 | 4 +- docs/man3/SDL_GetGamma.3 | 4 +- docs/man3/SDL_GetGammaRamp.3 | 4 +- docs/man3/SDL_GetKeyName.3 | 4 +- docs/man3/SDL_GetKeyState.3 | 4 +- docs/man3/SDL_GetModState.3 | 4 +- docs/man3/SDL_GetMouseState.3 | 4 +- docs/man3/SDL_GetRGB.3 | 4 +- docs/man3/SDL_GetRGBA.3 | 4 +- docs/man3/SDL_GetRelativeMouseState.3 | 4 +- docs/man3/SDL_GetThreadID.3 | 4 +- docs/man3/SDL_GetTicks.3 | 4 +- docs/man3/SDL_GetVideoInfo.3 | 4 +- docs/man3/SDL_GetVideoSurface.3 | 4 +- docs/man3/SDL_Init.3 | 4 +- docs/man3/SDL_InitSubSystem.3 | 4 +- docs/man3/SDL_JoyAxisEvent.3 | 4 +- docs/man3/SDL_JoyBallEvent.3 | 4 +- docs/man3/SDL_JoyButtonEvent.3 | 4 +- docs/man3/SDL_JoyHatEvent.3 | 4 +- docs/man3/SDL_JoystickClose.3 | 4 +- docs/man3/SDL_JoystickEventState.3 | 4 +- docs/man3/SDL_JoystickGetAxis.3 | 4 +- docs/man3/SDL_JoystickGetBall.3 | 4 +- docs/man3/SDL_JoystickGetButton.3 | 4 +- docs/man3/SDL_JoystickGetHat.3 | 4 +- docs/man3/SDL_JoystickIndex.3 | 4 +- docs/man3/SDL_JoystickName.3 | 4 +- docs/man3/SDL_JoystickNumAxes.3 | 4 +- docs/man3/SDL_JoystickNumBalls.3 | 4 +- docs/man3/SDL_JoystickNumButtons.3 | 4 +- docs/man3/SDL_JoystickNumHats.3 | 4 +- docs/man3/SDL_JoystickOpen.3 | 4 +- docs/man3/SDL_JoystickOpened.3 | 4 +- docs/man3/SDL_JoystickUpdate.3 | 4 +- docs/man3/SDL_KeyboardEvent.3 | 4 +- docs/man3/SDL_KillThread.3 | 4 +- docs/man3/SDL_ListModes.3 | 4 +- docs/man3/SDL_LoadBMP.3 | 4 +- docs/man3/SDL_LoadWAV.3 | 4 +- docs/man3/SDL_LockAudio.3 | 4 +- docs/man3/SDL_LockSurface.3 | 4 +- docs/man3/SDL_LockYUVOverlay.3 | 4 +- docs/man3/SDL_MapRGB.3 | 4 +- docs/man3/SDL_MapRGBA.3 | 4 +- docs/man3/SDL_MixAudio.3 | 6 +- docs/man3/SDL_MouseButtonEvent.3 | 4 +- docs/man3/SDL_MouseMotionEvent.3 | 4 +- docs/man3/SDL_NumJoysticks.3 | 4 +- docs/man3/SDL_OpenAudio.3 | 4 +- docs/man3/SDL_Overlay.3 | 4 +- docs/man3/SDL_Palette.3 | 4 +- docs/man3/SDL_PauseAudio.3 | 4 +- docs/man3/SDL_PeepEvents.3 | 4 +- docs/man3/SDL_PixelFormat.3 | 8 +- docs/man3/SDL_PollEvent.3 | 4 +- docs/man3/SDL_PumpEvents.3 | 4 +- docs/man3/SDL_PushEvent.3 | 4 +- docs/man3/SDL_Quit.3 | 4 +- docs/man3/SDL_QuitEvent.3 | 4 +- docs/man3/SDL_QuitSubSystem.3 | 4 +- docs/man3/SDL_RWFromFile.3 | 4 +- docs/man3/SDL_Rect.3 | 4 +- docs/man3/SDL_RemoveTimer.3 | 4 +- docs/man3/SDL_ResizeEvent.3 | 4 +- docs/man3/SDL_SaveBMP.3 | 4 +- docs/man3/SDL_SemPost.3 | 4 +- docs/man3/SDL_SemTryWait.3 | 4 +- docs/man3/SDL_SemValue.3 | 4 +- docs/man3/SDL_SemWait.3 | 4 +- docs/man3/SDL_SemWaitTimeout.3 | 4 +- docs/man3/SDL_SetAlpha.3 | 23 +- docs/man3/SDL_SetClipRect.3 | 4 +- docs/man3/SDL_SetColorKey.3 | 4 +- docs/man3/SDL_SetColors.3 | 4 +- docs/man3/SDL_SetCursor.3 | 4 +- docs/man3/SDL_SetEventFilter.3 | 4 +- docs/man3/SDL_SetGamma.3 | 4 +- docs/man3/SDL_SetGammaRamp.3 | 4 +- docs/man3/SDL_SetModState.3 | 4 +- docs/man3/SDL_SetPalette.3 | 6 +- docs/man3/SDL_SetTimer.3 | 6 +- docs/man3/SDL_SetVideoMode.3 | 6 +- docs/man3/SDL_ShowCursor.3 | 4 +- docs/man3/SDL_Surface.3 | 23 +- docs/man3/SDL_SysWMEvent.3 | 4 +- docs/man3/SDL_ThreadID.3 | 4 +- docs/man3/SDL_UnlockAudio.3 | 4 +- docs/man3/SDL_UnlockSurface.3 | 4 +- docs/man3/SDL_UnlockYUVOverlay.3 | 4 +- docs/man3/SDL_UpdateRect.3 | 6 +- docs/man3/SDL_UpdateRects.3 | 16 +- docs/man3/SDL_UserEvent.3 | 4 +- docs/man3/SDL_VideoDriverName.3 | 4 +- docs/man3/SDL_VideoInfo.3 | 4 +- docs/man3/SDL_VideoModeOK.3 | 4 +- docs/man3/SDL_WM_GetCaption.3 | 4 +- docs/man3/SDL_WM_GrabInput.3 | 4 +- docs/man3/SDL_WM_IconifyWindow.3 | 4 +- docs/man3/SDL_WM_SetCaption.3 | 4 +- docs/man3/SDL_WM_SetIcon.3 | 4 +- docs/man3/SDL_WM_ToggleFullScreen.3 | 4 +- docs/man3/SDL_WaitEvent.3 | 4 +- docs/man3/SDL_WaitThread.3 | 4 +- docs/man3/SDL_WarpMouse.3 | 4 +- docs/man3/SDL_WasInit.3 | 4 +- docs/man3/SDL_keysym.3 | 4 +- docs/man3/SDL_mutexP.3 | 4 +- docs/man3/SDL_mutexV.3 | 4 +- 371 files changed, 3244 insertions(+), 2259 deletions(-) create mode 100644 docs/html/guidevideoopengl.html diff --git a/docs/html/Makefile.am b/docs/html/Makefile.am index b9db82902..7cb0b99d3 100644 --- a/docs/html/Makefile.am +++ b/docs/html/Makefile.am @@ -20,6 +20,7 @@ EXTRA_DIST = \ guidetimeexamples.html \ guidevideo.html \ guidevideoexamples.html \ + guidevideoopengl.html \ index.html \ joystick.html \ reference.html \ diff --git a/docs/html/audio.html b/docs/html/audio.html index 4f47a7c15..ed70e21d6 100644 --- a/docs/html/audio.html +++ b/docs/html/audio.html @@ -4,7 +4,7 @@ >AudioCD-ROMEvents
Introduction

Introduction

Event Functions.SDL Event Structures.GeneralSDL GuideAbout SDLdocAbout SDLdoc

SDLdoc (The SDL Documentation Project) was formed to completely rewrite the SDL documentation and to keep it continually up to date. The team consists completely of volunteers ranging from proplr working with SDL in their spare time to people who use SDL in their everyday working lives.

SDLdoc (The SDL Documentation Project) was formed to completely rewrite the SDL documentation and to keep it continually up to date. The team consists completely of volunteers ranging from people working with SDL in their spare time to people who use SDL in their everyday working lives.

The latest version of this documentation can always be found at the project homepage: http://sdldoc.sourceforge.net.

The latest version of this documentation can always be found here: http://sdldoc.csn.ul.ie Downloadable PS, man pages and html tarballs are available at http://sdldoc.csn.ul.ie/pub/

Introduction
Video Examples
Event Examples

Introduction

For the moment these examples are taken directly from the old SDL documentation.

For the moment these examples are taken directly from the old SDL documentation. By the 1.2 release these examples should hopefully deal with most common SDL programming problems.

NextVideo ExamplesEvent Examples
+> \ No newline at end of file diff --git a/docs/html/guideinput.html b/docs/html/guideinput.html index d79300497..0ad9232c9 100644 --- a/docs/html/guideinput.html +++ b/docs/html/guideinput.html @@ -4,7 +4,7 @@ >Input handlingPrev

Initialization

SDL_Init. The joystick flag will usually be used in conjunction with other flags (like the video flag) because the joystick is usually used to control something. -

.  The joystick flag will usually be used in conjunction with other flags (like the video flag) because the joystick is usually used to control something.

Example 3-1. Initializing SDL with Joystick Support

    if ( ! SDL_Init( SDL_INIT_VIDEO | SDL_INIT_JOYSTICK ) )
+>    if (SDL_Init( SDL_INIT_VIDEO | SDL_INIT_JOYSTICK ) < 0)
     {
         fprintf(stderr, "Couldn't initialize SDL: %s\n", SDL_GetError());
         exit(1);
     }
-This will attempt to start SDL with both the video and the joystick subsystems activated.

This will attempt to start SDL with both the video and the joystick subsystems activated.

Querying

. The joystick is specified by an index where 0 is the first joystick and the last joystick is the number returned by SDL_NumJoysticks - 1. In the demonstration a list of all available joysticks is printed to stdout. -

 - 1.  In the demonstration a list of all available joysticks is printed to stdout.

Example 3-2. Querying the Number of Available Joysticks

    printf("%i joysticks were found.\n\n", SDL_NumJoysticks() );
     printf("The names of the joysticks are:\n");
@@ -164,14 +183,14 @@
     {
         printf("    %s\n", SDL_JoystickName(i));
     }

Opening a Joystick and Receiving Joystick Events

SDL_JoystickOpen function. For the example we are only interested in events from the first joystick on the system, regardless of what it may be. To receive events from it we would do this: -

 function. For the example we are only interested in events from the first joystick on the system, regardless of what it may be. To receive events from it we would do this:

Example 3-3. Opening a Joystick

    SDL_Joystick *joystick;
 
     SDL_JoystickEventState(SDL_ENABLE);
     joystick = SDL_JoystickOpen(0);
-If we wanted to receive events for other joysticks we would open them with calls to

If we wanted to receive events for other joysticks we would open them with calls to SDL_JoystickOpen just like we opened joystick 0, except we would store the Up to this point all the code we have is used just to initialize the joysticks in order to read values at run time. All we need now is an event loop, which is something that all SDL programs should have anyway to receive the systems quit events. We must now add code to check the event loop for at least some of the above mentioned events. Let's assume our event loop looks like this:

    SDL_Event *event;
+>    SDL_Event event;
     /* Other initializtion code goes here */   
 
     /* Start main game loop here */
@@ -291,8 +320,17 @@
 
     /* End loop here */
-To handle Joystick events we merely add cases for them, first we'll add axis handling code. Axis checks can get kinda of tricky because alot of the joystick events received are junk. Joystick axis have a tendency to vary just a little between polling due to the way they are designed. To compensate for this you have to set a threshold for changes and ignore the events that have'nt exceeded the threshold. 10% is usually a good threshold value. This sounds a lot more complicated than it is. Here is the Axis event handler: -

Example 3-4. Joystick Axis Events

    case SDL_JOYAXISMOTION:  /* Handle Joystick Motion */
     if ( ( event.jaxis.value < -3200 ) || (event.jaxis.value > 3200 ) ) 
@@ -300,9 +338,19 @@
       /* code goes here */
     }
     break;
-Another trick with axis events is that up-down and left-right movement are two different sets of axes. The most important axis is axis 0 (left-right) and axis 1 (up-down). To handle them seperatly in the code we do the following: -

Another trick with axis events is that up-down and left-right movement are two different sets of axes. The most important axis is axis 0 (left-right) and axis 1 (up-down). To handle them seperatly in the code we do the following:

Example 3-5. More Joystick Axis Events

    case SDL_JOYAXISMOTION:  /* Handle Joystick Motion */
     if ( ( event.jaxis.value < -3200 ) || (event.jaxis.value > 3200 ) ) 
@@ -318,8 +366,9 @@
         }
     }
     break;
-Ideally the code here should use

Ideally the code here should use event.jaxis.value values.

Button handling is simple compared to the axis checking. -

Button handling is simple compared to the axis checking.

Example 3-6. Joystick Button Events

    case SDL_JOYBUTTONDOWN:  /* Handle Joystick Button Presses */
     if ( event.jbutton.button == 0 ) 
@@ -342,9 +400,9 @@
         /* code goes here */
     }
     break;
- -Button checks are simpler than axis checks because a button can only be pressed or not pressed. The

Button checks are simpler than axis checks because a button can only be pressed or not pressed. The SDL_JOYBUTTONDOWN event is triggered when a button is pressed and the

Advanced Joystick Functions

That takes care of the controls that you can count on being on every joystick under the sun, but there are a few extra things that SDL can support. Joyballs are next on our list, they are alot like axis we a few minor differences. Joyballs store relative changes unlike the the absolute postion stored in a axis event. Also one trackball event contains both the change in x and they change in y. Our case for it is as follows: -

That takes care of the controls that you can count on being on every joystick under the sun, but there are a few extra things that SDL can support.  Joyballs are next on our list, they are alot like axis we a few minor differences.  Joyballs store relative changes unlike the the absolute postion stored in a axis event. Also one trackball event contains both the change in x and they change in y.  Our case for it is as follows:

Example 3-7. Joystick Ball Events

    case SDL_JOYBALLMOTION:  /* Handle Joyball Motion */
     if( event.jball.ball == 0 )
@@ -387,8 +454,9 @@
       /* ball handling */
     }
     break;
-The above checks the first joyball on the joystick. The change in position will be stored in

The above checks the first joyball on the joystick. The change in position will be stored in event.jball.xrel

-Our case for the hat may resemble the following: - -

Example 3-8. Joystick Hat Events

    case SDL_JOYHATMOTION:  /* Handle Hat Motion */
     if ( event.jhat.hat | SDL_HAT_UP )
@@ -508,7 +584,7 @@
         /* Do right and down together stuff here */
     }
     break;

In addition to the queries for number of joysticks on the system and their names there are additional functions to query the capabilities of attached joysticks:

-To use these functions we just have to pass in the joystick structure we got when we opened the joystick. For Example: - -

Example 3-9. Querying Joystick Characteristics

    int number_of_buttons;
     SDL_Joystick *joystick;
 
     joystick = SDL_JoystickOpen(0);
     number_of_buttons = SDL_JoystickNumButtons(joystick);
- -This block of code would get the number of buttons on the first joystick in the system.

This block of code would get the number of buttons on the first joystick in the system.

PrevGraphics and VideoUsing OpenGL With SDLHandling the Keyboard

Keyboard Related Structures

SDLKey

SDLMod

SDL_keysym

SDL_KeyboardEvent

Reading Keyboard Events

events using a switch statement, like so: -

 statement, like so:

Example 3-10. Reading Keyboard Events

  SDL_Event event;
   .
@@ -334,15 +343,16 @@
   }
   .
   .
-This is a very basic example. No information about the key press or release is interpreted. We will explore the other extreme out our first full example below - reporting all available information about a keyboard event.

This is a very basic example. No information about the key press or release is interpreted. We will explore the other extreme out our first full example below - reporting all available information about a keyboard event.

A More Detailed Look

Example 3-1. keys.c - Key event informationExample 3-11. Interpreting Key Event Information

Game-type Input

I have found that people using keyboard events for games and other interactive applications don't always understand one fundemental point.

At first glance you may think this is a perfectly reasonable piece of code for the task, but it isn't. Like I said keyboard events only occur when a key changes state, so the user would have to press and release the left cursor key 100 times to move the alien 100 pixels to the left.

To get around this problem we must not use the events to change the position of the alien, we use the events to set flags which are then used in a seperate section of code to move the alien. Something like this: -

To get around this problem we must not use the events to change the position of the alien, we use the events to set flags which are then used in a seperate section of code to move the alien. Something like this:

Example 3-12. Proper Game Movement

    /* Alien screen coordinates */
     int alien_x=0, alien_y=0;
@@ -649,8 +668,9 @@
     /* Update the alien position */
     alien_x += alien_xvel;
     alien_y += alien_yvel;
-As can be seen, we use two extra variables, alien_xvel and alien_yvel, which represent the motion of the ship, it is these variables that we update when we detect keypresses and releases.

As can be seen, we use two extra variables, alien_xvel and alien_yvel, which represent the motion of the ship, it is these variables that we update when we detect keypresses and releases.

PrefaceThe BasicsTime Examples

Time based game loop

Graphics and VideoNextChapter 2. Graphics and Video

Using OpenGL With SDLIntroduction to SDL Video

SDL has the ability to create and use OpenGL contexts on several platforms(Linux/X11, Win32, BeOS, MacOS Classic/Toolbox, MacOS X, FreeBSD/X11 and Solaris/X11). This allows you to use SDL's audio, event handling, threads and times in your OpenGL applications (a function often performed by GLUT).

Video is probably the most common thing that SDL is used for, and +so it has the most complete subsystem. Here are a few +examples to demonstrate the basics.

InitialisationInitializing the Video Display

Initialising SDL to use OpenGL is not very different to initialising SDL normally. There are three differences; you must pass SDL_OPENGL to SDL_SetVideoMode, you must specify several GL attributes (depth buffer size, framebuffer sizes) using SDL_GL_SetAttributeThis is what almost all SDL programs have to do in one way or +another.

and finally, if you wish to use double buffering you must specify it as a GL attribute, not by passing the SDL_DOUBLEBUF flag to SDL_SetVideoMode. -

Example 2-1. Initializing the Video Display

    /* Information about the current video settings. */
-    const SDL_VideoInfo* info = NULL;
-    /* Dimensions of our window. */
-    int width = 0;
-    int height = 0;
-    /* Color depth in bits of our window. */
-    int bpp = 0;
-    /* Flags we will pass into SDL_SetVideoMode. */
-    int flags = 0;
-
-    /* First, initialize SDL's video subsystem. */
-    if( SDL_Init( SDL_INIT_VIDEO ) < 0 ) {
-        /* Failed, exit. */
-        fprintf( stderr, "Video initialization failed: %s\n",
-             SDL_GetError( ) );
-        quit_tutorial( 1 );
-    }
-
-    /* Let's get some video information. */
-    info = SDL_GetVideoInfo( );
+>    SDL_Surface *screen;
 
-    if( !info ) {
-        /* This should probably never happen. */
-        fprintf( stderr, "Video query failed: %s\n",
-             SDL_GetError( ) );
-        quit_tutorial( 1 );
+    /* Initialize the SDL library */
+    if( SDL_Init(SDL_INIT_VIDEO) < 0 ) {
+        fprintf(stderr,
+                "Couldn't initialize SDL: %s\n", SDL_GetError());
+        exit(1);
     }
 
+    /* Clean up on exit */
+    atexit(SDL_Quit);
+    
     /*
-     * Set our width/height to 640/480 (you would
-     * of course let the user decide this in a normal
-     * app). We get the bpp we will request from
-     * the display. On X11, VidMode can't change
-     * resolution, so this is probably being overly
-     * safe. Under Win32, ChangeDisplaySettings
-     * can change the bpp.
-     */
-    width = 640;
-    height = 480;
-    bpp = info->vfmt->BitsPerPixel;
-
-    /*
-     * Now, we want to setup our requested
-     * window attributes for our OpenGL window.
-     * We want *at least* 5 bits of red, green
-     * and blue. We also want at least a 16-bit
-     * depth buffer.
-     *
-     * The last thing we do is request a double
-     * buffered window. '1' turns on double
-     * buffering, '0' turns it off.
-     *
-     * Note that we do not use SDL_DOUBLEBUF in
-     * the flags to SDL_SetVideoMode. That does
-     * not affect the GL attribute state, only
-     * the standard 2D blitting setup.
-     */
-    SDL_GL_SetAttribute( SDL_GL_RED_SIZE, 5 );
-    SDL_GL_SetAttribute( SDL_GL_GREEN_SIZE, 5 );
-    SDL_GL_SetAttribute( SDL_GL_BLUE_SIZE, 5 );
-    SDL_GL_SetAttribute( SDL_GL_DEPTH_SIZE, 16 );
-    SDL_GL_SetAttribute( SDL_GL_DOUBLEBUFFER, 1 );
-
-    /*
-     * We want to request that SDL provide us
-     * with an OpenGL window, in a fullscreen
-     * video mode.
-     *
-     * EXERCISE:
-     * Make starting windowed an option, and
-     * handle the resize events properly with
-     * glViewport.
-     */
-    flags = SDL_OPENGL | SDL_FULLSCREEN;
-
-    /*
-     * Set the video mode
+     * Initialize the display in a 640x480 8-bit palettized mode,
+     * requesting a software surface
      */
-    if( SDL_SetVideoMode( width, height, bpp, flags ) == 0 ) {
-        /* 
-         * This could happen for a variety of reasons,
-         * including DISPLAY not being set, the specified
-         * resolution not being available, etc.
-         */
-        fprintf( stderr, "Video mode set failed: %s\n",
-             SDL_GetError( ) );
-        quit_tutorial( 1 );
+    screen = SDL_SetVideoMode(640, 480, 8, SDL_SWSURFACE);
+    if ( screen == NULL ) {
+        fprintf(stderr, "Couldn't set 640x480x8 video mode: %s\n",
+                        SDL_GetError());
+        exit(1);
     }

DrawingInitializing the Best Video Mode

Apart from initialisation, using OpenGL within SDL is the same as using. However if you have request a double buffered display (using SDL_GL_SetAttribute) and one (which can be checked by using SDL_GL_GetAttribute), then you must use SDL_GL_SwapBuffers()If you have a preference for a certain pixel depth but will accept any +other, use SDL_SetVideoMode with SDL_ANYFORMAT as below. You can also +use SDL_VideoModeOK() to find the native video mode that is closest to +the mode you request.

to swap the buffers and update the display.

A full example code listing is now presented below.

Example 2-2. Initializing the Best Video Mode

    /* Have a preference for 8-bit, but accept any depth */
+    screen = SDL_SetVideoMode(640, 480, 8, SDL_SWSURFACE|SDL_ANYFORMAT);
+    if ( screen == NULL ) {
+        fprintf(stderr, "Couldn't set 640x480x8 video mode: %s\n",
+                        SDL_GetError());
+        exit(1);
+    }
+    printf("Set 640x480 at %d bits-per-pixel mode\n",
+           screen->format->BitsPerPixel);

Loading and Displaying a BMP File

The following function loads and displays a BMP file given as +argument, once SDL is initialised and a video mode has been set.

Example 2-1. gl.c - SDL OpenGL ExampleExample 2-3. Loading and Displaying a BMP File

/*
- * SDL OpenGL Tutorial.
- * (c) Michael Vance, 2000
- * briareos@lokigames.com
- *
- * Distributed under terms of the LGPL. 
- */
-
-#include <SDL/SDL.h>
-#include <GL/gl.h>
-#include <GL/glu.h>
-
-#include <stdio.h>
-#include <stdlib.h>
-
-static GLboolean should_rotate = GL_TRUE;
-
-static void quit_tutorial( int code )
+>void display_bmp(char *file_name)
 {
-    /*
-     * Quit SDL so we can release the fullscreen
-     * mode and restore the previous video settings,
-     * etc.
-     */
-    SDL_Quit( );
+    SDL_Surface *image;
 
-    /* Exit program. */
-    exit( code );
-}
-
-static void handle_key_down( SDL_keysym* keysym )
-{
-
-    /* 
-     * We're only interested if 'Esc' has
-     * been presssed.
-     *
-     * EXERCISE: 
-     * Handle the arrow keys and have that change the
-     * viewing position/angle.
-     */
-    switch( keysym->sym ) {
-    case SDLK_ESCAPE:
-        quit_tutorial( 0 );
-        break;
-    case SDLK_SPACE:
-        should_rotate = !should_rotate;
-        break;
-    default:
-        break;
+    /* Load the BMP file into a surface */
+    image = SDL_LoadBMP(file_name);
+    if (image == NULL) {
+        fprintf(stderr, "Couldn't load %s: %s\n", file_name, SDL_GetError());
+        return;
     }
 
-}
-
-static void process_events( void )
-{
-    /* Our SDL event placeholder. */
-    SDL_Event event;
-
-    /* Grab all the events off the queue. */
-    while( SDL_PollEvent( &event ) ) {
-
-        switch( event.type ) {
-        case SDL_KEYDOWN:
-            /* Handle key presses. */
-            handle_key_down( &event.key.keysym );
-            break;
-        case SDL_QUIT:
-            /* Handle quit requests (like Ctrl-c). */
-            quit_tutorial( 0 );
-            break;
-        }
-
-    }
-
-}
-
-static void draw_screen( void )
-{
-    /* Our angle of rotation. */
-    static float angle = 0.0f;
-
     /*
-     * EXERCISE:
-     * Replace this awful mess with vertex
-     * arrays and a call to glDrawElements.
-     *
-     * EXERCISE:
-     * After completing the above, change
-     * it to use compiled vertex arrays.
-     *
-     * EXERCISE:
-     * Verify my windings are correct here ;).
+     * Palettized screen modes will have a default palette (a standard
+     * 8*8*4 colour cube), but if the image is palettized as well we can
+     * use that palette for a nicer colour matching
      */
-    static GLfloat v0[] = { -1.0f, -1.0f,  1.0f };
-    static GLfloat v1[] = {  1.0f, -1.0f,  1.0f };
-    static GLfloat v2[] = {  1.0f,  1.0f,  1.0f };
-    static GLfloat v3[] = { -1.0f,  1.0f,  1.0f };
-    static GLfloat v4[] = { -1.0f, -1.0f, -1.0f };
-    static GLfloat v5[] = {  1.0f, -1.0f, -1.0f };
-    static GLfloat v6[] = {  1.0f,  1.0f, -1.0f };
-    static GLfloat v7[] = { -1.0f,  1.0f, -1.0f };
-    static GLubyte red[]    = { 255,   0,   0, 255 };
-    static GLubyte green[]  = {   0, 255,   0, 255 };
-    static GLubyte blue[]   = {   0,   0, 255, 255 };
-    static GLubyte white[]  = { 255, 255, 255, 255 };
-    static GLubyte yellow[] = {   0, 255, 255, 255 };
-    static GLubyte black[]  = {   0,   0,   0, 255 };
-    static GLubyte orange[] = { 255, 255,   0, 255 };
-    static GLubyte purple[] = { 255,   0, 255,   0 };
-
-    /* Clear the color and depth buffers. */
-    glClear( GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT );
-
-    /* We don't want to modify the projection matrix. */
-    glMatrixMode( GL_MODELVIEW );
-    glLoadIdentity( );
-
-    /* Move down the z-axis. */
-    glTranslatef( 0.0, 0.0, -5.0 );
-
-    /* Rotate. */
-    glRotatef( angle, 0.0, 1.0, 0.0 );
-
-    if( should_rotate ) {
-
-        if( ++angle > 360.0f ) {
-            angle = 0.0f;
-        }
-
+    if (image->format->palette && screen->format->palette) {
+    SDL_SetColors(screen, image->format->palette->colors, 0,
+                  image->format->palette->ncolors);
     }
 
-    /* Send our triangle data to the pipeline. */
-    glBegin( GL_TRIANGLES );
-
-    glColor4ubv( red );
-    glVertex3fv( v0 );
-    glColor4ubv( green );
-    glVertex3fv( v1 );
-    glColor4ubv( blue );
-    glVertex3fv( v2 );
-
-    glColor4ubv( red );
-    glVertex3fv( v0 );
-    glColor4ubv( blue );
-    glVertex3fv( v2 );
-    glColor4ubv( white );
-    glVertex3fv( v3 );
-
-    glColor4ubv( green );
-    glVertex3fv( v1 );
-    glColor4ubv( black );
-    glVertex3fv( v5 );
-    glColor4ubv( orange );
-    glVertex3fv( v6 );
-
-    glColor4ubv( green );
-    glVertex3fv( v1 );
-    glColor4ubv( orange );
-    glVertex3fv( v6 );
-    glColor4ubv( blue );
-    glVertex3fv( v2 );
-
-    glColor4ubv( black );
-    glVertex3fv( v5 );
-    glColor4ubv( yellow );
-    glVertex3fv( v4 );
-    glColor4ubv( purple );
-    glVertex3fv( v7 );
-
-    glColor4ubv( black );
-    glVertex3fv( v5 );
-    glColor4ubv( purple );
-    glVertex3fv( v7 );
-    glColor4ubv( orange );
-    glVertex3fv( v6 );
+    /* Blit onto the screen surface */
+    if(SDL_BlitSurface(image, NULL, screen, NULL) < 0)
+        fprintf(stderr, "BlitSurface error: %s\n", SDL_GetError());
 
-    glColor4ubv( yellow );
-    glVertex3fv( v4 );
-    glColor4ubv( red );
-    glVertex3fv( v0 );
-    glColor4ubv( white );
-    glVertex3fv( v3 );
+    SDL_UpdateRect(screen, 0, 0, image->w, image->h);
 
-    glColor4ubv( yellow );
-    glVertex3fv( v4 );
-    glColor4ubv( white );
-    glVertex3fv( v3 );
-    glColor4ubv( purple );
-    glVertex3fv( v7 );
-
-    glColor4ubv( white );
-    glVertex3fv( v3 );
-    glColor4ubv( blue );
-    glVertex3fv( v2 );
-    glColor4ubv( orange );
-    glVertex3fv( v6 );
-
-    glColor4ubv( white );
-    glVertex3fv( v3 );
-    glColor4ubv( orange );
-    glVertex3fv( v6 );
-    glColor4ubv( purple );
-    glVertex3fv( v7 );
-
-    glColor4ubv( green );
-    glVertex3fv( v1 );
-    glColor4ubv( red );
-    glVertex3fv( v0 );
-    glColor4ubv( yellow );
-    glVertex3fv( v4 );
-
-    glColor4ubv( green );
-    glVertex3fv( v1 );
-    glColor4ubv( yellow );
-    glVertex3fv( v4 );
-    glColor4ubv( black );
-    glVertex3fv( v5 );
-
-    glEnd( );
-
-    /*
-     * EXERCISE:
-     * Draw text telling the user that 'Spc'
-     * pauses the rotation and 'Esc' quits.
-     * Do it using vetors and textured quads.
-     */
-
-    /*
-     * Swap the buffers. This this tells the driver to
-     * render the next frame from the contents of the
-     * back-buffer, and to set all rendering operations
-     * to occur on what was the front-buffer.
-     *
-     * Double buffering prevents nasty visual tearing
-     * from the application drawing on areas of the
-     * screen that are being updated at the same time.
-     */
-    SDL_GL_SwapBuffers( );
-}
-
-static void setup_opengl( int width, int height )
+    /* Free the allocated BMP surface */
+    SDL_FreeSurface(image);
+}

Drawing Directly to the Display

The following two functions can be used to get and set single +pixels of a surface. They are carefully written to work with any depth +currently supported by SDL. Remember to lock the surface before +calling them, and to unlock it before calling any other SDL +functions.

To convert between pixel values and their red, green, blue +components, use SDL_GetRGB() and SDL_MapRGB().

Example 2-4. getpixel()

/*
+ * Return the pixel value at (x, y)
+ * NOTE: The surface must be locked before calling this!
+ */
+Uint32 getpixel(SDL_Surface *surface, int x, int y)
 {
-    float ratio = (float) width / (float) height;
+    int bpp = surface->format->BytesPerPixel;
+    /* Here p is the address to the pixel we want to retrieve */
+    Uint8 *p = (Uint8 *)surface->pixels + y * surface->pitch + x * bpp;
 
-    /* Our shading model--Gouraud (smooth). */
-    glShadeModel( GL_SMOOTH );
+    switch(bpp) {
+    case 1:
+        return *p;
 
-    /* Culling. */
-    glCullFace( GL_BACK );
-    glFrontFace( GL_CCW );
-    glEnable( GL_CULL_FACE );
+    case 2:
+        return *(Uint16 *)p;
 
-    /* Set the clear color. */
-    glClearColor( 0, 0, 0, 0 );
+    case 3:
+        if(SDL_BYTEORDER == SDL_BIG_ENDIAN)
+            return p[0] << 16 | p[1] << 8 | p[2];
+        else
+            return p[0] | p[1] << 8 | p[2] << 16;
 
-    /* Setup our viewport. */
-    glViewport( 0, 0, width, height );
+    case 4:
+        return *(Uint32 *)p;
 
-    /*
-     * Change to the projection matrix and set
-     * our viewing volume.
-     */
-    glMatrixMode( GL_PROJECTION );
-    glLoadIdentity( );
-    /*
-     * EXERCISE:
-     * Replace this with a call to glFrustum.
-     */
-    gluPerspective( 60.0, ratio, 1.0, 1024.0 );
-}
-
-int main( int argc, char* argv[] )
+    default:
+        return 0;       /* shouldn't happen, but avoids warnings */
+    }
+}

Example 2-5. putpixel()

/*
+ * Set the pixel at (x, y) to the given value
+ * NOTE: The surface must be locked before calling this!
+ */
+void putpixel(SDL_Surface *surface, int x, int y, Uint32 pixel)
 {
-    /* Information about the current video settings. */
-    const SDL_VideoInfo* info = NULL;
-    /* Dimensions of our window. */
-    int width = 0;
-    int height = 0;
-    /* Color depth in bits of our window. */
-    int bpp = 0;
-    /* Flags we will pass into SDL_SetVideoMode. */
-    int flags = 0;
+    int bpp = surface->format->BytesPerPixel;
+    /* Here p is the address to the pixel we want to set */
+    Uint8 *p = (Uint8 *)surface->pixels + y * surface->pitch + x * bpp;
 
-    /* First, initialize SDL's video subsystem. */
-    if( SDL_Init( SDL_INIT_VIDEO ) < 0 ) {
-        /* Failed, exit. */
-        fprintf( stderr, "Video initialization failed: %s\n",
-             SDL_GetError( ) );
-        quit_tutorial( 1 );
-    }
+    switch(bpp) {
+    case 1:
+        *p = pixel;
+        break;
 
-    /* Let's get some video information. */
-    info = SDL_GetVideoInfo( );
+    case 2:
+        *(Uint16 *)p = pixel;
+        break;
 
-    if( !info ) {
-        /* This should probably never happen. */
-        fprintf( stderr, "Video query failed: %s\n",
-             SDL_GetError( ) );
-        quit_tutorial( 1 );
+    case 3:
+        if(SDL_BYTEORDER == SDL_BIG_ENDIAN) {
+            p[0] = (pixel >> 16) & 0xff;
+            p[1] = (pixel >> 8) & 0xff;
+            p[2] = pixel & 0xff;
+        } else {
+            p[0] = pixel & 0xff;
+            p[1] = (pixel >> 8) & 0xff;
+            p[2] = (pixel >> 16) & 0xff;
+        }
+        break;
+
+    case 4:
+        *(Uint32 *)p = pixel;
+        break;
     }
+}

The following code uses the putpixel() function above to set a +yellow pixel in the middle of the screen.

Example 2-6. Using putpixel()


    /* Code to set a yellow pixel at the center of the screen */
 
-    /*
-     * Set our width/height to 640/480 (you would
-     * of course let the user decide this in a normal
-     * app). We get the bpp we will request from
-     * the display. On X11, VidMode can't change
-     * resolution, so this is probably being overly
-     * safe. Under Win32, ChangeDisplaySettings
-     * can change the bpp.
-     */
-    width = 640;
-    height = 480;
-    bpp = info->vfmt->BitsPerPixel;
+    int x, y;
+    Uint32 yellow;
 
-    /*
-     * Now, we want to setup our requested
-     * window attributes for our OpenGL window.
-     * We want *at least* 5 bits of red, green
-     * and blue. We also want at least a 16-bit
-     * depth buffer.
-     *
-     * The last thing we do is request a double
-     * buffered window. '1' turns on double
-     * buffering, '0' turns it off.
-     *
-     * Note that we do not use SDL_DOUBLEBUF in
-     * the flags to SDL_SetVideoMode. That does
-     * not affect the GL attribute state, only
-     * the standard 2D blitting setup.
-     */
-    SDL_GL_SetAttribute( SDL_GL_RED_SIZE, 5 );
-    SDL_GL_SetAttribute( SDL_GL_GREEN_SIZE, 5 );
-    SDL_GL_SetAttribute( SDL_GL_BLUE_SIZE, 5 );
-    SDL_GL_SetAttribute( SDL_GL_DEPTH_SIZE, 16 );
-    SDL_GL_SetAttribute( SDL_GL_DOUBLEBUFFER, 1 );
+    /* Map the color yellow to this display (R=0xff, G=0xFF, B=0x00)
+       Note:  If the display is palettized, you must set the palette first.
+    */
+    yellow = SDL_MapRGB(screen->format, 0xff, 0xff, 0x00);
 
-    /*
-     * We want to request that SDL provide us
-     * with an OpenGL window, in a fullscreen
-     * video mode.
-     *
-     * EXERCISE:
-     * Make starting windowed an option, and
-     * handle the resize events properly with
-     * glViewport.
-     */
-    flags = SDL_OPENGL | SDL_FULLSCREEN;
+    x = screen->w / 2;
+    y = screen->h / 2;
 
-    /*
-     * Set the video mode
-     */
-    if( SDL_SetVideoMode( width, height, bpp, flags ) == 0 ) {
-        /* 
-         * This could happen for a variety of reasons,
-         * including DISPLAY not being set, the specified
-         * resolution not being available, etc.
-         */
-        fprintf( stderr, "Video mode set failed: %s\n",
-             SDL_GetError( ) );
-        quit_tutorial( 1 );
+    /* Lock the screen for direct access to the pixels */
+    if ( SDL_MUSTLOCK(screen) ) {
+        if ( SDL_LockSurface(screen) < 0 ) {
+            fprintf(stderr, "Can't lock screen: %s\n", SDL_GetError());
+            return;
+        }
     }
 
-    /*
-     * At this point, we should have a properly setup
-     * double-buffered window for use with OpenGL.
-     */
-    setup_opengl( width, height );
+    putpixel(screen, x, y, yellow);
 
-    /*
-     * Now we want to begin our normal app process--
-     * an event loop with a lot of redrawing.
-     */
-    while( 1 ) {
-        /* Process incoming events. */
-        process_events( );
-        /* Draw the screen. */
-        draw_screen( );
+    if ( SDL_MUSTLOCK(screen) ) {
+        SDL_UnlockSurface(screen);
     }
+    /* Update just the part of the display that we've changed */
+    SDL_UpdateRect(screen, x, y, 1, 1);
 
-    /*
-     * EXERCISE:
-     * Record timings using SDL_GetTicks() and
-     * and print out frames per second at program
-     * end.
-     */
-
-    /* Never reached. */
-    return 0;
-}
NextInput handlingUsing OpenGL With SDL
Video Examples

Initializing the video display

Initializing the best video mode

Loading and displaying a BMP file

Drawing directly to the display

Fastest possible surface blit

Using OpenGL With SDL

SDL Library Documentation
PrevChapter 2. Graphics and VideoNext

Using OpenGL With SDL

SDL has the ability to create and use OpenGL contexts on several platforms(Linux/X11, Win32, BeOS, MacOS Classic/Toolbox, MacOS X, FreeBSD/X11 and Solaris/X11). This allows you to use SDL's audio, event handling, threads and times in your OpenGL applications (a function often performed by GLUT).

Initialisation

Initialising SDL to use OpenGL is not very different to initialising SDL normally. There are three differences; you must pass SDL_OPENGL to SDL_SetVideoMode, you must specify several GL attributes (depth buffer size, framebuffer sizes) using SDL_GL_SetAttribute and finally, if you wish to use double buffering you must specify it as a GL attribute, not by passing the SDL_DOUBLEBUF flag to SDL_SetVideoMode.

Example 2-7. Initializing SDL with OpenGL

    /* Information about the current video settings. */
+    const SDL_VideoInfo* info = NULL;
+    /* Dimensions of our window. */
+    int width = 0;
+    int height = 0;
+    /* Color depth in bits of our window. */
+    int bpp = 0;
+    /* Flags we will pass into SDL_SetVideoMode. */
+    int flags = 0;
+
+    /* First, initialize SDL's video subsystem. */
+    if( SDL_Init( SDL_INIT_VIDEO ) < 0 ) {
+        /* Failed, exit. */
+        fprintf( stderr, "Video initialization failed: %s\n",
+             SDL_GetError( ) );
+        quit_tutorial( 1 );
+    }
+
+    /* Let's get some video information. */
+    info = SDL_GetVideoInfo( );
+
+    if( !info ) {
+        /* This should probably never happen. */
+        fprintf( stderr, "Video query failed: %s\n",
+             SDL_GetError( ) );
+        quit_tutorial( 1 );
+    }
+
+    /*
+     * Set our width/height to 640/480 (you would
+     * of course let the user decide this in a normal
+     * app). We get the bpp we will request from
+     * the display. On X11, VidMode can't change
+     * resolution, so this is probably being overly
+     * safe. Under Win32, ChangeDisplaySettings
+     * can change the bpp.
+     */
+    width = 640;
+    height = 480;
+    bpp = info->vfmt->BitsPerPixel;
+
+    /*
+     * Now, we want to setup our requested
+     * window attributes for our OpenGL window.
+     * We want *at least* 5 bits of red, green
+     * and blue. We also want at least a 16-bit
+     * depth buffer.
+     *
+     * The last thing we do is request a double
+     * buffered window. '1' turns on double
+     * buffering, '0' turns it off.
+     *
+     * Note that we do not use SDL_DOUBLEBUF in
+     * the flags to SDL_SetVideoMode. That does
+     * not affect the GL attribute state, only
+     * the standard 2D blitting setup.
+     */
+    SDL_GL_SetAttribute( SDL_GL_RED_SIZE, 5 );
+    SDL_GL_SetAttribute( SDL_GL_GREEN_SIZE, 5 );
+    SDL_GL_SetAttribute( SDL_GL_BLUE_SIZE, 5 );
+    SDL_GL_SetAttribute( SDL_GL_DEPTH_SIZE, 16 );
+    SDL_GL_SetAttribute( SDL_GL_DOUBLEBUFFER, 1 );
+
+    /*
+     * We want to request that SDL provide us
+     * with an OpenGL window, in a fullscreen
+     * video mode.
+     *
+     * EXERCISE:
+     * Make starting windowed an option, and
+     * handle the resize events properly with
+     * glViewport.
+     */
+    flags = SDL_OPENGL | SDL_FULLSCREEN;
+
+    /*
+     * Set the video mode
+     */
+    if( SDL_SetVideoMode( width, height, bpp, flags ) == 0 ) {
+        /* 
+         * This could happen for a variety of reasons,
+         * including DISPLAY not being set, the specified
+         * resolution not being available, etc.
+         */
+        fprintf( stderr, "Video mode set failed: %s\n",
+             SDL_GetError( ) );
+        quit_tutorial( 1 );
+    }

Drawing

Apart from initialisation, using OpenGL within SDL is the same as using OpenGL +with any other API, e.g. GLUT. You still use all the same function calls and +data types. However if you are using a double-buffered display, then you must +use +SDL_GL_SwapBuffers() +to swap the buffers and update the display. To request double-buffering +with OpenGL, use +SDL_GL_SetAttribute +with SDL_GL_DOUBLEBUFFER, and use +SDL_GL_GetAttribute +to see if you actually got it.

A full example code listing is now presented below.

Example 2-8. SDL and OpenGL

/*
+ * SDL OpenGL Tutorial.
+ * (c) Michael Vance, 2000
+ * briareos@lokigames.com
+ *
+ * Distributed under terms of the LGPL. 
+ */
+
+#include <SDL/SDL.h>
+#include <GL/gl.h>
+#include <GL/glu.h>
+
+#include <stdio.h>
+#include <stdlib.h>
+
+static GLboolean should_rotate = GL_TRUE;
+
+static void quit_tutorial( int code )
+{
+    /*
+     * Quit SDL so we can release the fullscreen
+     * mode and restore the previous video settings,
+     * etc.
+     */
+    SDL_Quit( );
+
+    /* Exit program. */
+    exit( code );
+}
+
+static void handle_key_down( SDL_keysym* keysym )
+{
+
+    /* 
+     * We're only interested if 'Esc' has
+     * been presssed.
+     *
+     * EXERCISE: 
+     * Handle the arrow keys and have that change the
+     * viewing position/angle.
+     */
+    switch( keysym->sym ) {
+    case SDLK_ESCAPE:
+        quit_tutorial( 0 );
+        break;
+    case SDLK_SPACE:
+        should_rotate = !should_rotate;
+        break;
+    default:
+        break;
+    }
+
+}
+
+static void process_events( void )
+{
+    /* Our SDL event placeholder. */
+    SDL_Event event;
+
+    /* Grab all the events off the queue. */
+    while( SDL_PollEvent( &event ) ) {
+
+        switch( event.type ) {
+        case SDL_KEYDOWN:
+            /* Handle key presses. */
+            handle_key_down( &event.key.keysym );
+            break;
+        case SDL_QUIT:
+            /* Handle quit requests (like Ctrl-c). */
+            quit_tutorial( 0 );
+            break;
+        }
+
+    }
+
+}
+
+static void draw_screen( void )
+{
+    /* Our angle of rotation. */
+    static float angle = 0.0f;
+
+    /*
+     * EXERCISE:
+     * Replace this awful mess with vertex
+     * arrays and a call to glDrawElements.
+     *
+     * EXERCISE:
+     * After completing the above, change
+     * it to use compiled vertex arrays.
+     *
+     * EXERCISE:
+     * Verify my windings are correct here ;).
+     */
+    static GLfloat v0[] = { -1.0f, -1.0f,  1.0f };
+    static GLfloat v1[] = {  1.0f, -1.0f,  1.0f };
+    static GLfloat v2[] = {  1.0f,  1.0f,  1.0f };
+    static GLfloat v3[] = { -1.0f,  1.0f,  1.0f };
+    static GLfloat v4[] = { -1.0f, -1.0f, -1.0f };
+    static GLfloat v5[] = {  1.0f, -1.0f, -1.0f };
+    static GLfloat v6[] = {  1.0f,  1.0f, -1.0f };
+    static GLfloat v7[] = { -1.0f,  1.0f, -1.0f };
+    static GLubyte red[]    = { 255,   0,   0, 255 };
+    static GLubyte green[]  = {   0, 255,   0, 255 };
+    static GLubyte blue[]   = {   0,   0, 255, 255 };
+    static GLubyte white[]  = { 255, 255, 255, 255 };
+    static GLubyte yellow[] = {   0, 255, 255, 255 };
+    static GLubyte black[]  = {   0,   0,   0, 255 };
+    static GLubyte orange[] = { 255, 255,   0, 255 };
+    static GLubyte purple[] = { 255,   0, 255,   0 };
+
+    /* Clear the color and depth buffers. */
+    glClear( GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT );
+
+    /* We don't want to modify the projection matrix. */
+    glMatrixMode( GL_MODELVIEW );
+    glLoadIdentity( );
+
+    /* Move down the z-axis. */
+    glTranslatef( 0.0, 0.0, -5.0 );
+
+    /* Rotate. */
+    glRotatef( angle, 0.0, 1.0, 0.0 );
+
+    if( should_rotate ) {
+
+        if( ++angle > 360.0f ) {
+            angle = 0.0f;
+        }
+
+    }
+
+    /* Send our triangle data to the pipeline. */
+    glBegin( GL_TRIANGLES );
+
+    glColor4ubv( red );
+    glVertex3fv( v0 );
+    glColor4ubv( green );
+    glVertex3fv( v1 );
+    glColor4ubv( blue );
+    glVertex3fv( v2 );
+
+    glColor4ubv( red );
+    glVertex3fv( v0 );
+    glColor4ubv( blue );
+    glVertex3fv( v2 );
+    glColor4ubv( white );
+    glVertex3fv( v3 );
+
+    glColor4ubv( green );
+    glVertex3fv( v1 );
+    glColor4ubv( black );
+    glVertex3fv( v5 );
+    glColor4ubv( orange );
+    glVertex3fv( v6 );
+
+    glColor4ubv( green );
+    glVertex3fv( v1 );
+    glColor4ubv( orange );
+    glVertex3fv( v6 );
+    glColor4ubv( blue );
+    glVertex3fv( v2 );
+
+    glColor4ubv( black );
+    glVertex3fv( v5 );
+    glColor4ubv( yellow );
+    glVertex3fv( v4 );
+    glColor4ubv( purple );
+    glVertex3fv( v7 );
+
+    glColor4ubv( black );
+    glVertex3fv( v5 );
+    glColor4ubv( purple );
+    glVertex3fv( v7 );
+    glColor4ubv( orange );
+    glVertex3fv( v6 );
+
+    glColor4ubv( yellow );
+    glVertex3fv( v4 );
+    glColor4ubv( red );
+    glVertex3fv( v0 );
+    glColor4ubv( white );
+    glVertex3fv( v3 );
+
+    glColor4ubv( yellow );
+    glVertex3fv( v4 );
+    glColor4ubv( white );
+    glVertex3fv( v3 );
+    glColor4ubv( purple );
+    glVertex3fv( v7 );
+
+    glColor4ubv( white );
+    glVertex3fv( v3 );
+    glColor4ubv( blue );
+    glVertex3fv( v2 );
+    glColor4ubv( orange );
+    glVertex3fv( v6 );
+
+    glColor4ubv( white );
+    glVertex3fv( v3 );
+    glColor4ubv( orange );
+    glVertex3fv( v6 );
+    glColor4ubv( purple );
+    glVertex3fv( v7 );
+
+    glColor4ubv( green );
+    glVertex3fv( v1 );
+    glColor4ubv( red );
+    glVertex3fv( v0 );
+    glColor4ubv( yellow );
+    glVertex3fv( v4 );
+
+    glColor4ubv( green );
+    glVertex3fv( v1 );
+    glColor4ubv( yellow );
+    glVertex3fv( v4 );
+    glColor4ubv( black );
+    glVertex3fv( v5 );
+
+    glEnd( );
+
+    /*
+     * EXERCISE:
+     * Draw text telling the user that 'Spc'
+     * pauses the rotation and 'Esc' quits.
+     * Do it using vetors and textured quads.
+     */
+
+    /*
+     * Swap the buffers. This this tells the driver to
+     * render the next frame from the contents of the
+     * back-buffer, and to set all rendering operations
+     * to occur on what was the front-buffer.
+     *
+     * Double buffering prevents nasty visual tearing
+     * from the application drawing on areas of the
+     * screen that are being updated at the same time.
+     */
+    SDL_GL_SwapBuffers( );
+}
+
+static void setup_opengl( int width, int height )
+{
+    float ratio = (float) width / (float) height;
+
+    /* Our shading model--Gouraud (smooth). */
+    glShadeModel( GL_SMOOTH );
+
+    /* Culling. */
+    glCullFace( GL_BACK );
+    glFrontFace( GL_CCW );
+    glEnable( GL_CULL_FACE );
+
+    /* Set the clear color. */
+    glClearColor( 0, 0, 0, 0 );
+
+    /* Setup our viewport. */
+    glViewport( 0, 0, width, height );
+
+    /*
+     * Change to the projection matrix and set
+     * our viewing volume.
+     */
+    glMatrixMode( GL_PROJECTION );
+    glLoadIdentity( );
+    /*
+     * EXERCISE:
+     * Replace this with a call to glFrustum.
+     */
+    gluPerspective( 60.0, ratio, 1.0, 1024.0 );
+}
+
+int main( int argc, char* argv[] )
+{
+    /* Information about the current video settings. */
+    const SDL_VideoInfo* info = NULL;
+    /* Dimensions of our window. */
+    int width = 0;
+    int height = 0;
+    /* Color depth in bits of our window. */
+    int bpp = 0;
+    /* Flags we will pass into SDL_SetVideoMode. */
+    int flags = 0;
+
+    /* First, initialize SDL's video subsystem. */
+    if( SDL_Init( SDL_INIT_VIDEO ) < 0 ) {
+        /* Failed, exit. */
+        fprintf( stderr, "Video initialization failed: %s\n",
+             SDL_GetError( ) );
+        quit_tutorial( 1 );
+    }
+
+    /* Let's get some video information. */
+    info = SDL_GetVideoInfo( );
+
+    if( !info ) {
+        /* This should probably never happen. */
+        fprintf( stderr, "Video query failed: %s\n",
+             SDL_GetError( ) );
+        quit_tutorial( 1 );
+    }
+
+    /*
+     * Set our width/height to 640/480 (you would
+     * of course let the user decide this in a normal
+     * app). We get the bpp we will request from
+     * the display. On X11, VidMode can't change
+     * resolution, so this is probably being overly
+     * safe. Under Win32, ChangeDisplaySettings
+     * can change the bpp.
+     */
+    width = 640;
+    height = 480;
+    bpp = info->vfmt->BitsPerPixel;
+
+    /*
+     * Now, we want to setup our requested
+     * window attributes for our OpenGL window.
+     * We want *at least* 5 bits of red, green
+     * and blue. We also want at least a 16-bit
+     * depth buffer.
+     *
+     * The last thing we do is request a double
+     * buffered window. '1' turns on double
+     * buffering, '0' turns it off.
+     *
+     * Note that we do not use SDL_DOUBLEBUF in
+     * the flags to SDL_SetVideoMode. That does
+     * not affect the GL attribute state, only
+     * the standard 2D blitting setup.
+     */
+    SDL_GL_SetAttribute( SDL_GL_RED_SIZE, 5 );
+    SDL_GL_SetAttribute( SDL_GL_GREEN_SIZE, 5 );
+    SDL_GL_SetAttribute( SDL_GL_BLUE_SIZE, 5 );
+    SDL_GL_SetAttribute( SDL_GL_DEPTH_SIZE, 16 );
+    SDL_GL_SetAttribute( SDL_GL_DOUBLEBUFFER, 1 );
+
+    /*
+     * We want to request that SDL provide us
+     * with an OpenGL window, in a fullscreen
+     * video mode.
+     *
+     * EXERCISE:
+     * Make starting windowed an option, and
+     * handle the resize events properly with
+     * glViewport.
+     */
+    flags = SDL_OPENGL | SDL_FULLSCREEN;
+
+    /*
+     * Set the video mode
+     */
+    if( SDL_SetVideoMode( width, height, bpp, flags ) == 0 ) {
+        /* 
+         * This could happen for a variety of reasons,
+         * including DISPLAY not being set, the specified
+         * resolution not being available, etc.
+         */
+        fprintf( stderr, "Video mode set failed: %s\n",
+             SDL_GetError( ) );
+        quit_tutorial( 1 );
+    }
+
+    /*
+     * At this point, we should have a properly setup
+     * double-buffered window for use with OpenGL.
+     */
+    setup_opengl( width, height );
+
+    /*
+     * Now we want to begin our normal app process--
+     * an event loop with a lot of redrawing.
+     */
+    while( 1 ) {
+        /* Process incoming events. */
+        process_events( );
+        /* Draw the screen. */
+        draw_screen( );
+    }
+
+    /*
+     * EXERCISE:
+     * Record timings using SDL_GetTicks() and
+     * and print out frames per second at program
+     * end.
+     */
+
+    /* Never reached. */
+    return 0;
+}

PrevHomeNext
Graphics and VideoUpInput handling
\ No newline at end of file diff --git a/docs/html/index.html b/docs/html/index.html index ed2dc1624..1417c74d9 100644 --- a/docs/html/index.html +++ b/docs/html/index.html @@ -4,7 +4,7 @@ >
Introduction to SDL Video
Using OpenGL With SDL
Introduction
Video Examples
Event Examples
SDL_FreeSurface — Frees (deletes) and SDL_Surface — Frees (deletes) a SDL_Surface
Introduction
8-1. SDL Keysym definitions
List of Examples
1-1. Initializing SDL
2-1. gl.c - SDL OpenGL ExampleInitializing the Video Display
2-2. Initializing the Best Video Mode
2-3. Loading and Displaying a BMP File
2-4. getpixel()
2-5. putpixel()
2-6. Using putpixel()
2-7. Initializing SDL with OpenGL
2-8. SDL and OpenGL
3-1. keys.c - Key event informationInitializing SDL with Joystick Support
3-2. Querying the Number of Available Joysticks
3-3. Opening a Joystick
3-4. Joystick Axis Events
3-5. More Joystick Axis Events
3-6. Joystick Button Events
3-7. Joystick Ball Events
3-8. Joystick Hat Events
3-9. Querying Joystick Characteristics
3-10. Reading Keyboard Events
3-11. Interpreting Key Event Information
3-12. Proper Game Movement
JoystickSDL ReferenceSDL_ActiveEvent

Name

Structure Definition

Structure Data

Description

See Also

SDL_AddTimer

Name

Synopsis

Description

.

The timer callback function may run in a different thread than your -main program, and so shouldn't call any functions from within itself.

SDL_PushEvent, however.

The maximum resolution of this timer is 10 ms, which means that if +>The granularity of the timer is platform-dependent, but you should count +on it being at least 10 ms as this is the most common number. +This means that if you request a 16 ms timer, your callback will run approximately 20 ms later on an unloaded system. If you wanted to set a flag signaling a frame update at 30 frames per second (every 33 ms), you might set a @@ -173,7 +179,7 @@ >

Return Value

Examples

See Also

SDL_RemoveTimer, +SDL_PushEvent

SDL_AudioCVT

Name

Structure Definition

Structure Data

Description

See Also

SDL_AudioSpec

Name

Structure Definition

Structure Data

Description

See Also

SDL_BlitSurface

Name

Synopsis

Description

is not modified).

The blit function should not be called on a locked surface.

Note: The results of blitting operations vary greatly depending on whether SDL_SRCAPLHA is set or not. See SDL_SetAlpha.

for an explaination of how this affects your results. Colorkeying and alpha attributes also interact with surface blitting, as the following pseudo-code should hopefully explain. +
if (source surface has SDL_SRCALPHA set) {
+    if (source surface has alpha channel (that is, format->Amask != 0))
+        blit using per-pixel alpha, ignoring any colour key
+    else {
+        if (source surface has SDL_SRCCOLORKEY set)
+            blit using the colour key AND the per-surface alpha value
+        else
+            blit using the per-surface alpha value
+    }
+} else {
+    if (source surface has SDL_SRCCOLORKEY set)
+        blit using the colour key
+    else
+        ordinary opaque rectangular blit
+}

Return Value

See Also

SDL_BuildAudioCVT

Name

Synopsis

Description

Return Values

Examples

See Also

SDL_CD

Name

Structure Definition

Structure Data

Description

Examples

See Also

SDL_CDClose

Name

Synopsis

Description

See Also

SDL_CDEject

Name

Synopsis

Description

Return Value

See Also

SDL_CDName

Name

Synopsis

Description

Examples

See Also

SDL_CDNumDrives

Name

Synopsis

Description

See Also

SDL_CDOpen

Name

Synopsis

Description

Examples

See Also

SDL_CDPause

Name

Synopsis

Description

Return Value

See Also

SDL_CDPlay

Name

Synopsis

Description

Return Values

See Also

SDL_CDPlayTracks

Name

Synopsis

Description

Return Value

Examples

See Also

SDL_CDResume

Name

Synopsis

Description

Return Value

See Also

SDL_CDStatus

Name

Synopsis

Description

Example

See Also

SDL_CDStop

Name

Synopsis

Description

Return Value

See Also

SDL_CDtrack

Name

Structure Definition

Structure Data

Description

See Also

SDL_CloseAudio

Name

Synopsis

Description

See Also

SDL_Color

Name

Structure Definition

Structure Data

Description

See Also

SDL_CondBroadcast

Name

Synopsis

Description

See Also

SDL_CondSignal

Name

Synopsis

Description

See Also

SDL_CondWait

Name

Synopsis

Description

See Also

SDL_CondWaitTimeout

Name

Synopsis

Description

See Also

SDL_ConvertAudio

Name

Synopsis

Description

Examples

See Also

SDL_ConvertSurface

Name

Synopsis

Description

Return Value

See Also

SDL_CreateCond

Name

Synopsis

Description

Examples

See Also

SDL_CreateCursor

Name

Synopsis

Description

Example

See Also

SDL_CreateMutex

Name

Synopsis

Description

Examples

See Also

SDL_CreateRGBSurface

Name

Synopsis

Description

With this flag SDL will attempt to find the best location for this surface, either in system memory or video memory, to obtain hardware colorkey blitting support.This flag turns on colourkeying for blits from this surface. If +SDL_HWSURFACE is also specified and colourkeyed blits +are hardware-accelerated, then SDL will attempt to place the surface in +video memory. +Use SDL_SetColorKey +to set or clear this flag after surface creation.With this flag SDL will attempt to find the best location for this surface, either in system memory or video memory, to obtain hardware alpha supportThis flag turns on alpha-blending for blits from this surface. If +SDL_HWSURFACE is also specified and alpha-blending blits +are hardware-accelerated, then the surface will be placed in video memory if +possible. +Use SDL_SetAlpha to +set or clear this flag after surface creation.

Note: If an alpha-channel is specified (that is, if Amask is +nonzero), then the SDL_SRCALPHA flag is automatically +set. You may remove this flag by calling +SDL_SetAlpha +after surface creation.

Return Value

Returns the created surface, or NULL upon error.

Example

    /* Create a 32-bit surface with the bytes of each pixel in R,G,B,A order,
+       as expected by OpenGL for textures */
+    SDL_Surface *surface;
+    Uint32 rmask, gmask, bmask, amask;
+
+    /* SDL interprets each pixel as a 32-bit number, so our masks must depend
+       on the endianness (byte order) of the machine */
+#if SDL_BYTEORDER == SDL_BIG_ENDIAN
+    rmask = 0xff000000;
+    gmask = 0x00ff0000;
+    bmask = 0x0000ff00;
+    amask = 0x000000ff;
+#else
+    rmask = 0x000000ff;
+    gmask = 0x0000ff00;
+    bmask = 0x00ff0000;
+    amask = 0xff000000;
+#endif
+
+    surface = SDL_CreateRGBSurface(SDL_SWSURFACE, width, height, 32,
+                                   rmask, gmask, bmask, amask);
+    if(surface == NULL) {
+        fprintf(stderr, "CreateRGBSurface failed: %s\n", SDL_GetError());
+        exit(1);
+    }

See Also

SDL_Surface +SDL_SetAlpha +SDL_SetColorKey

SDL_CreateRGBSurfaceFrom

Name

Synopsis

Description

specified in the parameter list. The pixel data is not copied into the SDL_Surface structure so it should no be freed until the surface has been freed with a called to structure so it should not be freed until the surface has been freed with a called to SDL_FreeSurface.

Return Value

Returns the created surface, or NULL upon error.

See Also

SDL_CreateSemaphore

Name

Synopsis

Description

Return Value

Examples

See Also

SDL_CreateThread

Name

Synopsis

Description

See Also

SDL_CreateYUVOverlay

Name

Synopsis

Description

See Also

SDL_Delay

Name

Synopsis

Description

least the specified time, but possible longer due to OS scheduling.

Note: Count on a delay granularity of at least 10 ms. +Some platforms have shorter clock ticks but this is the most common.

See Also

SDL_DestroyCond

Name

Synopsis

Description

See Also

SDL_DestroyMutex

Name

Synopsis

Description

See Also

SDL_DestroySemaphore

Name

Synopsis

Description

Examples

See Also

SDL_DisplayFormat

Name

Synopsis

Description

Return Value

See Also

SDL_DisplayFormatAlpha

Name

Synopsis

Description

If you want to take advantage of hardware colorkey or alpha blit acceleration, you should set the colorkey and alpha value before calling this function.

This function can be used to convert a colourkey to an alpha channel, +if the SDL_SRCCOLORKEY flag is set on the surface. +The generated surface will then be transparent (alpha=0) where the +pixels match the colourkey, and opaque (alpha=255) elsewhere.

Return Value

See Also

SDL_DisplayYUVOverlay

Name

Synopsis

Description

See Also

SDL_EnableKeyRepeat

Name

Synopsis

Description

Return Value

SDL_EnableUNICODE

Name

Synopsis

Description

Return Value

See Also

SDL_Event

Name

Structure Definition

Structure Data

Description

Use

See Also

SDL_EventState

Name

Synopsis

Description

See Also

SDL_FillRect

Name

Synopsis

Description

Return Value

See Also

SDL_Flip

Name

Synopsis

Description

Return Value

See Also

SDL_FreeCursor

Name

Synopsis

Description

See Also

SDL_FreeSurface

Name

SDL_FreeSurface -- Frees (deletes) and SDL_Surface
SDL_FreeSurface -- Frees (deletes) a SDL_Surface

Synopsis

Description

See Also

SDL_FreeWAV

Name

Synopsis

Description

See Also

SDL_FreeYUVOverlay

Name

Synopsis

Description

See Also

SDL_GetAppState

Name

Synopsis

Description

See Also

SDL_GetAudioStatus

Name

Synopsis

Description

See Also

SDL_GetClipRect

Name

Synopsis

Description

See Also

SDL_GetCursor

Name

Synopsis

Description

See Also

SDL_GetEventFilter

Name

Synopsis

Description

Return Value

See Also

SDL_GetGammaRamp

Name

Synopsis

Description

Return Value

See Also

SDL_GetKeyName

Name

Synopsis

Description

See Also

SDL_GetKeyState

Name

Synopsis

Description

Example

See Also

SDL_GetModState

Name

Synopsis

Description

Return Value

The return value can be an OR'd combination of the SDLMod enum.

SDL also defines the following symbols for convenience:

See Also

SDL_GetMouseState

Name

Synopsis

Description

Example

See Also

SDL_GetRelativeMouseState

Name

Synopsis

Description

See Also

SDL_GetRGB

Name

Synopsis

Description

See Also

SDL_GetRGBA

Name

Synopsis

Description

See Also

SDL_GetThreadID

Name

Synopsis

Description

See Also

SDL_GetTicks

Name

Synopsis

Description

See Also

SDL_GetVideoInfo

Name

Synopsis

Description

See Also

SDL_GetVideoSurface

Name

Synopsis

Description

See Also

SDL_GLattr

Name

Attributes

Description

See Also

SDL_GL_GetAttribute

Name

Synopsis

Description

Return Value

See Also

SDL_GL_GetProcAddress

Name

Synopsis

Description

Example

See Also

SDL_GL_LoadLibrary

Name

Synopsis

Description

See Also

SDL_GL_SetAttribute

Name

Synopsis

Description

Return Value

Example

See Also

SDL_GL_SwapBuffers

Name

Synopsis

Description

See Also

SDL_Init

Name

Synopsis

Description

Return Value

See Also

SDL_InitSubSystem

Name

Synopsis

Description

Examples

Return Value

See Also

SDL_JoyAxisEvent

Name

Structure Definition

Structure Data

Description

See Also

SDL_JoyBallEvent

Name

Structure Definition

Structure Data

Description

See Also

SDL_JoyButtonEvent

Name

Structure Definition

Structure Data

Description

See Also

SDL_JoyHatEvent

Name

Structure Definition

Structure Data

Description

See Also

SDL_JoystickClose

Name

Synopsis

Description

See Also

SDL_JoystickEventState

Name

Synopsis

Description

Return Value

See Also

SDL_JoystickGetAxis

Name

Synopsis

Description

Return Value

Examples

See Also

SDL_JoystickGetBall

Name

Synopsis

Description

Return Value

Examples

See Also

SDL_JoystickGetButton

Name

Synopsis

Description

Return Value

See Also

SDL_JoystickGetHat

Name

Synopsis

Description

Return Value

See Also

SDL_JoystickIndex

Name

Synopsis

Description

Return Value

See Also

SDL_JoystickName

Name

Synopsis

Description

Return Value

Examples

See Also

SDL_JoystickNumAxes

Name

Synopsis

Description

Return Value

See Also

SDL_JoystickNumBalls

Name

Synopsis

Description

Return Value

See Also

SDL_JoystickNumButtons

Name

Synopsis

Description

Return Value

See Also

SDL_JoystickNumHats

Name

Synopsis

Description

Return Value

See Also

SDL_JoystickOpen

Name

Synopsis

Description

Return Value

Examples

See Also

SDL_JoystickOpened

Name

Synopsis

Description

Return Value

See Also

SDL_JoystickUpdate

Name

Synopsis

Description

See Also

SDLKey

Name

Description

SDL_KeyboardEvent

Name

Structure Definition

Structure Data

Description

See Also

SDL_keysym

Name

Structure Definition

Structure Data

Description

See Also

SDL_KillThread

Name

Synopsis

Description

See Also

SDL_ListModes

Name

Synopsis

Description

Example

See Also

SDL_LoadBMP

Name

Synopsis

Description

Return Value

See Also

SDL_LoadWAV

Name

Synopsis

Description

Example

See Also

SDL_LockAudio

Name

Synopsis

Description

See Also

SDL_LockSurface

Name

Synopsis

Description

Return Value

See Also

SDL_LockYUVOverlay

Name

Synopsis

Description

Return Value

See Also

SDL_MapRGB

Name

Synopsis

Description

Return Value

See Also

SDL_MapRGBA

Name

Synopsis

Description

Return Value

See Also

SDL_MixAudio

Name

Synopsis

Description

This takes two audio buffers of the playing audio format and mixes -them, performing addition, volume adjustment, and overflow clipping. -The This function takes two audio buffers of len bytes each +of the playing audio format and mixes them, performing addition, volume +adjustment, and overflow clipping. The volume ranges from 0 - 128, -and should be set to ranges +from 0 to SDL_MIX_MAXVOLUME -for full audio volume. Note this does not change hardware volume. -This is provided for convenience -- you can mix your own audio data.

and should be set to the maximum +value for full audio volume. Note this does not change hardware volume. This is +provided for convenience -- you can mix your own audio data.

See Also

SDL_MouseButtonEvent

Name

Structure Definition

Structure Data

Description

See Also

SDL_MouseMotionEvent

Name

Structure Definition

Structure Data

Description

See Also

SDL_mutexP

Name

Synopsis

Description

See Also

SDL_mutexV

Name

Synopsis

Description

See Also

SDL_NumJoysticks

Name

Synopsis

Description

Return Value

See Also

SDL_OpenAudio

Name

Synopsis

Description

Examples

See Also

SDL_Overlay

Name

Structure Definition

Structure Data

Description

See Also

SDL_Palette

Name

Structure Definition

Structure Data

Description

See Also

SDL_PauseAudio

Name

Synopsis

Description

See Also

SDL_PeepEvents

Name

Synopsis

Description

Return Value

See Also

SDL_PixelFormat

Name

Structure Definition

Structure Data

Description

Pixel formats above 8-bit are an entirely different experience. They are considered to be "TrueColor" formats and the color information is stored in the pixels themselves, not in a palette (packed-pixel). The mask, shift and loss fields tell us how the color information is encoded. The mask fields allow us to isolate each color component, the shift fields tell us how far left we have to shift the masked value and the loss fields tell us for far right we have to shift the final value to convert it to a full 8-bit color component. +>Pixel formats above 8-bit are an entirely different experience. They are +considered to be "TrueColor" formats and the color information is stored in the +pixels themselves, not in a palette. The mask, shift and loss fields tell us +how the color information is encoded. The mask fields allow us to isolate each +color component, the shift fields tell us the number of bits to the right of +each component in the pixel value and the loss fields tell us the number of +bits lost from each component when packing 8-bit color component in a pixel.

/* Extracting color components from a 32-bit color value */
@@ -396,7 +402,7 @@
 .
 fmt=surface->format;
 SDL_LockSurface(surface);
-pixel=(Uint32*)surface->pixels;
+pixel=*((Uint32*)surface->pixels);
 SDL_UnlockSurface(surface);
 
 /* Get Red component */
@@ -432,7 +438,7 @@
 >

See Also

SDL_PollEvent

Name

Synopsis

Description

Examples

See Also

SDL_PumpEvents

Name

Synopsis

Description

See Also

SDL_PushEvent

Name

Synopsis

Description

Return Value

Examples

See Also

SDL_Quit

Name

Synopsis

Description

See Also

SDL_QuitEvent

Name

Structure Definition

Structure Data

Description

See Also

SDL_QuitSubSystem

Name

Synopsis

Description

See Also

SDL_Rect

Name

Structure Definition

Structure Data

Description

See Also

SDL_RemoveTimer

Name

Synopsis

Description

Return Value

Examples

See Also

SDL_ResizeEvent

Name

Structure Definition

Structure Data

Description

See Also

SDL_SaveBMP

Name

Synopsis

Description

Return Value

See Also

SDL_SemPost

Name

Synopsis

Description

Return Value

Examples

See Also

SDL_SemTryWait

Name

Synopsis

Description

Return Value

Examples

See Also

SDL_SemValue

Name

Synopsis

Description

Return Value

Examples

See Also

SDL_SemWait

Name

Synopsis

Description

Return Value

Examples

See Also

SDL_SemWaitTimeout

Name

Synopsis

Description

Return Value

Examples

See Also

SDL_SetAlpha

Name

Synopsis

Description

SDL_SetAlpha is used for setting the per-surface alpha and/or enabling and disabling per-pixel alpha blending.

is used for setting the per-surface alpha +value and/or enabling and disabling alpha blending.

The Thesurface parameter specifies which surface whose alpha attributes you wish to adjust. parameter specifies which surface whose alpha +attributes you wish to adjust. flags is used to specify whether alpha blending should be used ( is used to specify +whether alpha blending should be used (SDL_SRCALPHA) and whether the surface should use RLE acceleration for blitting () and +whether the surface should use RLE acceleration for blitting +(SDL_RLEACCEL). flags can be an OR'd combination of these two options, one of these options or 0. If can be an OR'd +combination of these two options, one of these options or 0. If +SDL_SRCALPHA is not passed as a flag then all alpha information is ignored when blitting the surface. The is not passed as a flag then all alpha +information is ignored when blitting the surface. The +alpha parameter is the per-surface alpha value, a surface need not have an alpha channel to use per-surface alpha and blitting can still be accelerated with parameter is the per-surface alpha value; a +surface need not have an alpha channel to use per-surface alpha and blitting +can still be accelerated with SDL_RLEACCEL. Setting the per-surface alpha value to 0 disables per-surface alpha blending.

.

Note: The per-surface alpha value of 128 is considered a special case and is optimised, so it's much faster than other per-surface values.

The per-surface alpha value of 128 is considered a special case and +is optimised, so it's much faster than other per-surface values.

The source is alpha-blended with the destination using the per-surface alpha value. If The source is alpha-blended with the destination using the per-surface alpha +value. If SDL_SRCCOLORKEYliteral> is set, only the pixels not matching the colorkey value are copied.

is set, only the pixels not +matching the colorkey value are copied. The alpha channel of the copied pixels +is set to opaque.

The RGB data is copied from the source and the destination alpha is zero to opaque. If The RGB data is copied from the source and the alpha value of the copied pixels +is set to opaque. If SDL_SRCCOLORKEY is set, only the pixels not matching the colorkey value are copied.

is set, only the pixels +not matching the colorkey value are copied.

The source is alpha-blended with the destination using the source alpha channel. The alpha channel in the destination surface is left untouched. The source is alpha-blended with the destination using the source alpha +channel. The alpha channel in the destination surface is left untouched. +SDL_SRCCOLORKEY is ignored.

Note: Note that RGBA->RGBA blits (with SDL_SRCALPHA set) keep the alpha +of the destination surface. This means that you cannot compose two arbitrary +RGBA surfaces this way and get the result you would expect from "overlaying" +them; the destination alpha will work as a mask.

Also note that per-pixel and per-surface alpha cannot be combined; +the per-pixel alpha is always used if available

Return Value

This function returns 0, or +-1 if there was an error.

See Also

SDL_SetClipRect

Name

Synopsis

Description

See Also

SDL_SetColorKey

Name

Synopsis

Description

Return Value

See Also

SDL_SetColors

Name

Synopsis

Description

Return Value

Example

See Also

SDL_SetCursor

Name

Synopsis

Description

See Also

SDL_SetEventFilter

Name

Synopsis

Description

See Also

SDL_SetGamma

Name

Synopsis

Description

Return Value

See Also

SDL_SetGammaRamp

Name

Synopsis

Description

Return Value

See Also

SDL_SetModState

Name

Synopsis

Description

See Also

SDL_SetPalette

Name

Synopsis

SDL_SetPalette(SDL_Surface *surface, int flags, int SDL_Color *colors, int firstcolor, int ncolors);(SDL_Surface *surface, int flags, SDL_Color *colors, int firstcolor, int ncolors);

Description

Return Value

Example

See Also

SDL_SetTimer

Name

Synopsis

Description

Note: This function is kept for compatibility but has been superceeded +>This function is kept for compatibility but has been superseded by the new timer functions

Examples

See Also

SDL_SetVideoMode

Name

Synopsis

Description

Enable double buffering. Calling Enable double buffering; only valid with SDL_HWSURFACE. Calling

Return Value

See Also

SDL_ShowCursor

Name

Synopsis

Description

Return Value

See Also

SDL_Surface

Name

Structure Definition

Structure Data

clip_minx, clip_maxxX clip coordsclip_rect

Description

SDL_SRCOLORKEYSDL_SRCCOLORKEY

See Also

SDL_SysWMEvent

Name

Description

See Also

SDL_ThreadID

Name

Synopsis

Description

SDL_UnlockAudio

Name

Synopsis

Description

See Also

SDL_UnlockSurface

Name

Synopsis

Description

See Also

SDL_UnlockYUVOverlay

Name

Synopsis

Description

See Also

SDL_UpdateRect

Name

Synopsis

Description

Makes sure the given area is updated on the given screen.

Makes sure the given area is updated on the given screen. The rectangle must +be confined within the screen boundaries (no clipping is done).

If '

See Also

SDL_UpdateRects

Name

Synopsis

Description

Makes sure the given list of rectangles is updated on the given screen.

Makes sure the given list of rectangles is updated on the given screen. +The rectangles must all be confined within the screen boundaries (no +clipping is done).

This function should not be called while locked.

.

Note: It is adviced to call this function only once per frame, since each +call has some processing overhead. This is no restriction since you +can pass any number of rectangles each time.

The rectangles are not automatically merged or checked for overlap. In +general, the programmer can use his knowledge about his particular +rectangles to merge them in an efficient way, to avoid overdraw.

See Also

SDL_UserEvent

Name

Structure Definition

Structure Data

Description

Examples

See Also

SDL_VideoDriverName

Name

Synopsis

Description

Return Value

See Also

SDL_VideoInfo

Name

Structure Definition

Structure Data

Description

See Also

SDL_VideoModeOK

Name

Synopsis

Description

Example

See Also

SDL_WaitEvent

Name

Synopsis

Description

See Also

SDL_WaitThread

Name

Synopsis

Description

Return Value

See Also

SDL_WarpMouse

Name

Synopsis

Description

See Also

SDL_WasInit

Name

Synopsis

Description

Return Value

Examples

See Also

SDL_WM_GetCaption

Name

Synopsis

Description

See Also

SDL_WM_GrabInput

Name

Synopsis

Description

Return Value

SDL_WM_IconifyWindow

Name

Synopsis

Description

Return Value

SDL_WM_SetCaption

Name

Synopsis

Description

See Also

SDL_WM_SetIcon

Name

Synopsis

Description

Example

See Also

SDL_WM_ToggleFullScreen

Name

Synopsis

Description

Return Value

Multi-threaded ProgrammingTimeVideoSDL_FreeSurface — Frees (deletes) and SDL_Surface
— Frees (deletes) a SDL_Surface
Window ManagementAmask != 0)) + blit using per-pixel alpha, ignoring any colour key + else { + if (source surface has SDL_SRCCOLORKEY set) + blit using the colour key AND the per-surface alpha value + else + blit using the per-surface alpha value + } +} else { + if (source surface has SDL_SRCCOLORKEY set) + blit using the colour key + else + ordinary opaque rectangular blit +}\fR +.fi .PP -The results of blitting operations vary greatly depending on whether \fBSDL_SRCAPLHA\fP is set or not\&. See \fISDL_SetAlpha\fR\&. -.RE .SH "RETURN VALUE" .PP If the blit is successful, it returns \fB0\fR, otherwise it returns \fB-1\fR\&. @@ -42,4 +57,4 @@ If either of the surfaces were in video memory, and the blit returns \fB-2\fR, t .SH "SEE ALSO" .PP \fI\fBSDL_LockSurface\fP\fR, \fI\fBSDL_FillRect\fP\fR, \fI\fBSDL_Surface\fR\fR, \fI\fBSDL_Rect\fR\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_BuildAudioCVT.3 b/docs/man3/SDL_BuildAudioCVT.3 index 25b01a19f..25116a16f 100644 --- a/docs/man3/SDL_BuildAudioCVT.3 +++ b/docs/man3/SDL_BuildAudioCVT.3 @@ -1,4 +1,4 @@ -.TH "SDL_BuildAudioCVT" "3" "Mon 12 Mar 2001, 01:02" "SDL" "SDL API Reference" +.TH "SDL_BuildAudioCVT" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_BuildAudioCVT\- Initializes a SDL_AudioCVT structure for conversion .SH "SYNOPSIS" @@ -20,4 +20,4 @@ See \fI\fBSDL_ConvertAudio\fP\fR\&. .SH "SEE ALSO" .PP \fI\fBSDL_ConvertAudio\fP\fR, \fI\fBSDL_AudioCVT\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:02 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_CD.3 b/docs/man3/SDL_CD.3 index 088781803..bf3472589 100644 --- a/docs/man3/SDL_CD.3 +++ b/docs/man3/SDL_CD.3 @@ -1,4 +1,4 @@ -.TH "SDL_CD" "3" "Mon 12 Mar 2001, 01:02" "SDL" "SDL API Reference" +.TH "SDL_CD" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_CD\- CDROM Drive Information .SH "STRUCTURE DEFINITION" @@ -54,4 +54,4 @@ frame_offset=MSF_TO_FRAMES(min, sec, frame);\fR .SH "SEE ALSO" .PP \fI\fBSDL_CDOpen\fP\fR, \fI\fBSDL_CDtrack\fR\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:02 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_CDClose.3 b/docs/man3/SDL_CDClose.3 index bc60cb558..a89d2f9bd 100644 --- a/docs/man3/SDL_CDClose.3 +++ b/docs/man3/SDL_CDClose.3 @@ -1,4 +1,4 @@ -.TH "SDL_CDClose" "3" "Mon 12 Mar 2001, 01:02" "SDL" "SDL API Reference" +.TH "SDL_CDClose" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_CDClose\- Closes a SDL_CD handle .SH "SYNOPSIS" @@ -12,4 +12,4 @@ Closes the given \fBcdrom\fR handle\&. .SH "SEE ALSO" .PP \fI\fBSDL_CDOpen\fP\fR, \fI\fBSDL_CD\fR\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:02 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_CDEject.3 b/docs/man3/SDL_CDEject.3 index f2848d8e9..7228b1c21 100644 --- a/docs/man3/SDL_CDEject.3 +++ b/docs/man3/SDL_CDEject.3 @@ -1,4 +1,4 @@ -.TH "SDL_CDEject" "3" "Mon 12 Mar 2001, 01:02" "SDL" "SDL API Reference" +.TH "SDL_CDEject" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_CDEject\- Ejects a CDROM .SH "SYNOPSIS" @@ -15,4 +15,4 @@ Returns \fB0\fR on success, or \fB-1\fR on an error\&. .SH "SEE ALSO" .PP \fI\fBSDL_CD\fR\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:02 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_CDName.3 b/docs/man3/SDL_CDName.3 index eb890798f..e1071e4d8 100644 --- a/docs/man3/SDL_CDName.3 +++ b/docs/man3/SDL_CDName.3 @@ -1,4 +1,4 @@ -.TH "SDL_CDName" "3" "Mon 12 Mar 2001, 01:02" "SDL" "SDL API Reference" +.TH "SDL_CDName" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_CDName\- Returns a human-readable, system-dependent identifier for the CD-ROM\&. .SH "SYNOPSIS" @@ -20,4 +20,4 @@ Returns a human-readable, system-dependent identifier for the CD-ROM\&. \fBdrive .SH "SEE ALSO" .PP \fI\fBSDL_CDNumDrives\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:02 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_CDNumDrives.3 b/docs/man3/SDL_CDNumDrives.3 index ebcfd9be5..6bbf6e9db 100644 --- a/docs/man3/SDL_CDNumDrives.3 +++ b/docs/man3/SDL_CDNumDrives.3 @@ -1,4 +1,4 @@ -.TH "SDL_CDNumDrives" "3" "Mon 12 Mar 2001, 01:02" "SDL" "SDL API Reference" +.TH "SDL_CDNumDrives" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_CDNumDrives\- Returns the number of CD-ROM drives on the system\&. .SH "SYNOPSIS" @@ -12,4 +12,4 @@ Returns the number of CD-ROM drives on the system\&. .SH "SEE ALSO" .PP \fI\fBSDL_CDOpen\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:02 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_CDOpen.3 b/docs/man3/SDL_CDOpen.3 index fc424d776..d8604b5e8 100644 --- a/docs/man3/SDL_CDOpen.3 +++ b/docs/man3/SDL_CDOpen.3 @@ -1,4 +1,4 @@ -.TH "SDL_CDOpen" "3" "Mon 12 Mar 2001, 01:02" "SDL" "SDL API Reference" +.TH "SDL_CDOpen" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_CDOpen\- Opens a CD-ROM drive for access\&. .SH "SYNOPSIS" @@ -55,4 +55,4 @@ SDL_CDClose(cdrom);\fR .SH "SEE ALSO" .PP \fI\fBSDL_CD\fR\fR, \fI\fBSDL_CDtrack\fR\fR, \fI\fBSDL_CDClose\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:02 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_CDPause.3 b/docs/man3/SDL_CDPause.3 index 7eed27ff6..d2c211c56 100644 --- a/docs/man3/SDL_CDPause.3 +++ b/docs/man3/SDL_CDPause.3 @@ -1,4 +1,4 @@ -.TH "SDL_CDPause" "3" "Mon 12 Mar 2001, 01:02" "SDL" "SDL API Reference" +.TH "SDL_CDPause" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_CDPause\- Pauses a CDROM .SH "SYNOPSIS" @@ -15,4 +15,4 @@ Returns \fB0\fR on success, or \fB-1\fR on an error\&. .SH "SEE ALSO" .PP \fI\fBSDL_CDPlay\fP\fR, \fI\fBSDL_CDResume\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:02 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_CDPlay.3 b/docs/man3/SDL_CDPlay.3 index 82a75670b..d875c7d9a 100644 --- a/docs/man3/SDL_CDPlay.3 +++ b/docs/man3/SDL_CDPlay.3 @@ -1,4 +1,4 @@ -.TH "SDL_CDPlay" "3" "Mon 12 Mar 2001, 01:02" "SDL" "SDL API Reference" +.TH "SDL_CDPlay" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_CDPlay\- Play a CD .SH "SYNOPSIS" @@ -15,4 +15,4 @@ Returns \fB0\fR on success, or \fB-1\fR on an error\&. .SH "SEE ALSO" .PP \fI\fBSDL_CDPlayTracks\fP\fR, \fI\fBSDL_CDStop\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:02 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_CDPlayTracks.3 b/docs/man3/SDL_CDPlayTracks.3 index 83ad9a919..72ed25e40 100644 --- a/docs/man3/SDL_CDPlayTracks.3 +++ b/docs/man3/SDL_CDPlayTracks.3 @@ -1,4 +1,4 @@ -.TH "SDL_CDPlayTracks" "3" "Mon 12 Mar 2001, 01:02" "SDL" "SDL API Reference" +.TH "SDL_CDPlayTracks" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_CDPlayTracks\- Play the given CD track(s) .SH "SYNOPSIS" @@ -44,4 +44,4 @@ if(CD_INDRIVE(SDL_CDStatus(cdrom))) .SH "SEE ALSO" .PP \fI\fBSDL_CDPlay\fP\fR, \fI\fBSDL_CDStatus\fP\fR, \fI\fBSDL_CD\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:02 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_CDResume.3 b/docs/man3/SDL_CDResume.3 index 245b7925f..c230d40a6 100644 --- a/docs/man3/SDL_CDResume.3 +++ b/docs/man3/SDL_CDResume.3 @@ -1,4 +1,4 @@ -.TH "SDL_CDResume" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_CDResume" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_CDResume\- Resumes a CDROM .SH "SYNOPSIS" @@ -15,4 +15,4 @@ Returns \fB0\fR on success, or \fB-1\fR on an error\&. .SH "SEE ALSO" .PP \fI\fBSDL_CDPlay\fP\fR, \fI\fBSDL_CDPause\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_CDStatus.3 b/docs/man3/SDL_CDStatus.3 index 215303e93..f63a2ffe2 100644 --- a/docs/man3/SDL_CDStatus.3 +++ b/docs/man3/SDL_CDStatus.3 @@ -1,4 +1,4 @@ -.TH "SDL_CDStatus" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_CDStatus" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_CDStatus\- Returns the current status of the given drive\&. .SH "SYNOPSIS" @@ -56,4 +56,4 @@ The macro \fBCD_INDRIVE\fP is provided for convenience, and given a status retur .SH "SEE ALSO" .PP \fI\fBSDL_CD\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_CDStop.3 b/docs/man3/SDL_CDStop.3 index 34c17b805..e49fa2c96 100644 --- a/docs/man3/SDL_CDStop.3 +++ b/docs/man3/SDL_CDStop.3 @@ -1,4 +1,4 @@ -.TH "SDL_CDStop" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_CDStop" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_CDStop\- Stops a CDROM .SH "SYNOPSIS" @@ -15,4 +15,4 @@ Returns \fB0\fR on success, or \fB-1\fR on an error\&. .SH "SEE ALSO" .PP \fI\fBSDL_CDPlay\fP\fR, -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_CDtrack.3 b/docs/man3/SDL_CDtrack.3 index 4217b93d2..658d55d88 100644 --- a/docs/man3/SDL_CDtrack.3 +++ b/docs/man3/SDL_CDtrack.3 @@ -1,4 +1,4 @@ -.TH "SDL_CDtrack" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_CDtrack" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_CDtrack\- CD Track Information Structure .SH "STRUCTURE DEFINITION" @@ -37,4 +37,4 @@ Frames can be converted to standard timings\&. There are \fBCD_FPS\fP frames per .SH "SEE ALSO" .PP \fI\fBSDL_CD\fR\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_CloseAudio.3 b/docs/man3/SDL_CloseAudio.3 index 789e9a987..3c07641e4 100644 --- a/docs/man3/SDL_CloseAudio.3 +++ b/docs/man3/SDL_CloseAudio.3 @@ -1,4 +1,4 @@ -.TH "SDL_CloseAudio" "3" "Mon 12 Mar 2001, 01:02" "SDL" "SDL API Reference" +.TH "SDL_CloseAudio" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_CloseAudio\- Shuts down audio processing and closes the audio device\&. .SH "SYNOPSIS" @@ -12,4 +12,4 @@ This function shuts down audio processing and closes the audio device\&. .SH "SEE ALSO" .PP \fI\fBSDL_OpenAudio\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:02 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_Color.3 b/docs/man3/SDL_Color.3 index d39c8f701..17431b83b 100644 --- a/docs/man3/SDL_Color.3 +++ b/docs/man3/SDL_Color.3 @@ -1,4 +1,4 @@ -.TH "SDL_Color" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_Color" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_Color\- Format independent color description .SH "STRUCTURE DEFINITION" @@ -31,4 +31,4 @@ Unused .SH "SEE ALSO" .PP \fI\fBSDL_PixelFormat\fR\fR, \fI\fBSDL_SetColors\fP\fR, \fI\fBSDL_Palette\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_CondBroadcast.3 b/docs/man3/SDL_CondBroadcast.3 index da91bd315..5e2116705 100644 --- a/docs/man3/SDL_CondBroadcast.3 +++ b/docs/man3/SDL_CondBroadcast.3 @@ -1,4 +1,4 @@ -.TH "SDL_CondBroadcast" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_CondBroadcast" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_CondBroadcast\- Restart all threads waiting on a condition variable .SH "SYNOPSIS" @@ -13,4 +13,4 @@ Restarts all threads that are waiting on the condition variable, \fBcond\fR\&. R .SH "SEE ALSO" .PP \fI\fBSDL_CondSignal\fP\fR, \fI\fBSDL_CondWait\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_CondSignal.3 b/docs/man3/SDL_CondSignal.3 index 0a9fb7006..c71047822 100644 --- a/docs/man3/SDL_CondSignal.3 +++ b/docs/man3/SDL_CondSignal.3 @@ -1,4 +1,4 @@ -.TH "SDL_CondSignal" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_CondSignal" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_CondSignal\- Restart a thread wait on a condition variable .SH "SYNOPSIS" @@ -13,4 +13,4 @@ Restart one of the threads that are waiting on the condition variable, \fBcond\f .SH "SEE ALSO" .PP \fI\fBSDL_CondWait\fP\fR, \fI\fBSDL_CondBroadcast\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_CondWait.3 b/docs/man3/SDL_CondWait.3 index 1390c6fdc..75b96c26d 100644 --- a/docs/man3/SDL_CondWait.3 +++ b/docs/man3/SDL_CondWait.3 @@ -1,4 +1,4 @@ -.TH "SDL_CondWait" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_CondWait" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_CondWait\- Wait on a condition variable .SH "SYNOPSIS" @@ -13,4 +13,4 @@ Wait on the condition variable \fBcond\fR and unlock the provided mutex\&. The m .SH "SEE ALSO" .PP \fI\fBSDL_CondWaitTimeout\fP\fR, \fI\fBSDL_CondSignal\fP\fR, \fI\fBSDL_mutexP\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_CondWaitTimeout.3 b/docs/man3/SDL_CondWaitTimeout.3 index e8a9acf4b..a5ade5c2f 100644 --- a/docs/man3/SDL_CondWaitTimeout.3 +++ b/docs/man3/SDL_CondWaitTimeout.3 @@ -1,4 +1,4 @@ -.TH "SDL_CondWaitTimeout" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_CondWaitTimeout" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_CondWaitTimeout\- Wait on a condition variable, with timeout .SH "SYNOPSIS" @@ -13,4 +13,4 @@ Wait on the condition variable \fBcond\fR for, at most, \fBms\fR milliseconds\&. .SH "SEE ALSO" .PP \fI\fBSDL_CondWait\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_ConvertAudio.3 b/docs/man3/SDL_ConvertAudio.3 index 0d185058c..21dab9142 100644 --- a/docs/man3/SDL_ConvertAudio.3 +++ b/docs/man3/SDL_ConvertAudio.3 @@ -1,4 +1,4 @@ -.TH "SDL_ConvertAudio" "3" "Mon 12 Mar 2001, 01:02" "SDL" "SDL API Reference" +.TH "SDL_ConvertAudio" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_ConvertAudio\- Convert audio data to a desired audio format\&. .SH "SYNOPSIS" @@ -92,4 +92,4 @@ SDL_ConvertAudio(&wav_cvt); .SH "SEE ALSO" .PP \fI\fBSDL_BuildAudioCVT\fP\fR, \fI\fBSDL_AudioCVT\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:02 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_ConvertSurface.3 b/docs/man3/SDL_ConvertSurface.3 index 6984d2fe6..9f8afbfa6 100644 --- a/docs/man3/SDL_ConvertSurface.3 +++ b/docs/man3/SDL_ConvertSurface.3 @@ -1,4 +1,4 @@ -.TH "SDL_ConvertSurface" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_ConvertSurface" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_ConvertSurface\- Converts a surface to the same format as another surface\&. .SH "SYNOPSIS" @@ -19,4 +19,4 @@ Returns either a pointer to the new surface, or \fBNULL\fP on error\&. .SH "SEE ALSO" .PP \fI\fBSDL_CreateRGBSurface\fP\fR, \fI\fBSDL_DisplayFormat\fP\fR, \fI\fBSDL_PixelFormat\fR\fR, \fI\fBSDL_Surface\fR\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_CreateCond.3 b/docs/man3/SDL_CreateCond.3 index 8d976e512..1fdfc2fe0 100644 --- a/docs/man3/SDL_CreateCond.3 +++ b/docs/man3/SDL_CreateCond.3 @@ -1,4 +1,4 @@ -.TH "SDL_CreateCond" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_CreateCond" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_CreateCond\- Create a condition variable .SH "SYNOPSIS" @@ -28,4 +28,4 @@ SDL_DestroyCond(cond);\fR .SH "SEE ALSO" .PP \fI\fBSDL_DestroyCond\fP\fR, \fI\fBSDL_CondWait\fP\fR, \fI\fBSDL_CondSignal\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_CreateCursor.3 b/docs/man3/SDL_CreateCursor.3 index aef17d417..0d20c2ee5 100644 --- a/docs/man3/SDL_CreateCursor.3 +++ b/docs/man3/SDL_CreateCursor.3 @@ -1,4 +1,4 @@ -.TH "SDL_CreateCursor" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_CreateCursor" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_CreateCursor\- Creates a new mouse cursor\&. .SH "SYNOPSIS" @@ -117,4 +117,4 @@ static SDL_Cursor *init_system_cursor(const char *image[]) .SH "SEE ALSO" .PP \fI\fBSDL_FreeCursor\fP\fR, \fI\fBSDL_SetCursor\fP\fR, \fI\fBSDL_ShowCursor\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_CreateMutex.3 b/docs/man3/SDL_CreateMutex.3 index 009e6098a..0e8cec4b0 100644 --- a/docs/man3/SDL_CreateMutex.3 +++ b/docs/man3/SDL_CreateMutex.3 @@ -1,4 +1,4 @@ -.TH "SDL_CreateMutex" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_CreateMutex" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_CreateMutex\- Create a mutex .SH "SYNOPSIS" @@ -40,4 +40,4 @@ SDL_DestroyMutex(mut); .SH "SEE ALSO" .PP \fI\fBSDL_mutexP\fP\fR, \fI\fBSDL_mutexV\fP\fR, \fI\fBSDL_DestroyMutex\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_CreateRGBSurface.3 b/docs/man3/SDL_CreateRGBSurface.3 index 38ab6117d..524875b39 100644 --- a/docs/man3/SDL_CreateRGBSurface.3 +++ b/docs/man3/SDL_CreateRGBSurface.3 @@ -1,4 +1,4 @@ -.TH "SDL_CreateRGBSurface" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_CreateRGBSurface" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_CreateRGBSurface\- Create an empty SDL_Surface .SH "SYNOPSIS" @@ -19,11 +19,51 @@ SDL will create the surface in system memory\&. This improves the performance of SDL will attempt to create the surface in video memory\&. This will allow SDL to take advantage of Video->Video blits (which are often accelerated)\&. .TP 20 \fBSDL_SRCCOLORKEY\fP -With this flag SDL will attempt to find the best location for this surface, either in system memory or video memory, to obtain hardware colorkey blitting support\&. +This flag turns on colourkeying for blits from this surface\&. If \fBSDL_HWSURFACE\fP is also specified and colourkeyed blits are hardware-accelerated, then SDL will attempt to place the surface in video memory\&. Use \fI\fBSDL_SetColorKey\fP\fR to set or clear this flag after surface creation\&. .TP 20 \fBSDL_SRCALPHA\fP -With this flag SDL will attempt to find the best location for this surface, either in system memory or video memory, to obtain hardware alpha support +This flag turns on alpha-blending for blits from this surface\&. If \fBSDL_HWSURFACE\fP is also specified and alpha-blending blits are hardware-accelerated, then the surface will be placed in video memory if possible\&. Use \fI\fBSDL_SetAlpha\fP\fR to set or clear this flag after surface creation\&. +.PP +.RS +\fBNote: +.PP +If an alpha-channel is specified (that is, if \fBAmask\fR is nonzero), then the \fBSDL_SRCALPHA\fP flag is automatically set\&. You may remove this flag by calling \fI\fBSDL_SetAlpha\fP\fR after surface creation\&. +.RE +.SH "RETURN VALUE" +.PP +Returns the created surface, or \fBNULL\fR upon error\&. +.SH "EXAMPLE" +.PP +.nf +\f(CW /* Create a 32-bit surface with the bytes of each pixel in R,G,B,A order, + as expected by OpenGL for textures */ + SDL_Surface *surface; + Uint32 rmask, gmask, bmask, amask; + + /* SDL interprets each pixel as a 32-bit number, so our masks must depend + on the endianness (byte order) of the machine */ +#if SDL_BYTEORDER == SDL_BIG_ENDIAN + rmask = 0xff000000; + gmask = 0x00ff0000; + bmask = 0x0000ff00; + amask = 0x000000ff; +#else + rmask = 0x000000ff; + gmask = 0x0000ff00; + bmask = 0x00ff0000; + amask = 0xff000000; +#endif + + surface = SDL_CreateRGBSurface(SDL_SWSURFACE, width, height, 32, + rmask, gmask, bmask, amask); + if(surface == NULL) { + fprintf(stderr, "CreateRGBSurface failed: %s +", SDL_GetError()); + exit(1); + }\fR +.fi +.PP .SH "SEE ALSO" .PP -\fI\fBSDL_CreateRGBSurfaceFrom\fP\fR, \fI\fBSDL_FreeSurface\fP\fR, \fI\fBSDL_SetVideoMode\fP\fR, \fI\fBSDL_LockSurface\fP\fR, \fI\fBSDL_PixelFormat\fR\fR, \fI\fBSDL_Surface\fR\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +\fI\fBSDL_CreateRGBSurfaceFrom\fP\fR, \fI\fBSDL_FreeSurface\fP\fR, \fI\fBSDL_SetVideoMode\fP\fR, \fI\fBSDL_LockSurface\fP\fR, \fI\fBSDL_PixelFormat\fR\fR, \fI\fBSDL_Surface\fR\fR \fI\fBSDL_SetAlpha\fP\fR \fI\fBSDL_SetColorKey\fP\fR +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_CreateRGBSurfaceFrom.3 b/docs/man3/SDL_CreateRGBSurfaceFrom.3 index 34d66c241..1ac6b89af 100644 --- a/docs/man3/SDL_CreateRGBSurfaceFrom.3 +++ b/docs/man3/SDL_CreateRGBSurfaceFrom.3 @@ -1,4 +1,4 @@ -.TH "SDL_CreateRGBSurfaceFrom" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_CreateRGBSurfaceFrom" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_CreateRGBSurfaceFrom\- Create an SDL_Surface from pixel data .SH "SYNOPSIS" @@ -10,10 +10,13 @@ SDL_CreateRGBSurfaceFrom\- Create an SDL_Surface from pixel data .PP Creates an SDL_Surface from the provided pixel data\&. .PP -The data stored in \fBpixels\fR is assumed to be of the \fBdepth\fR specified in the parameter list\&. The pixel data is not copied into the \fBSDL_Surface\fR structure so it should no be freed until the surface has been freed with a called to \fISDL_FreeSurface\fR\&. \fBpitch\fR is the length of each scanline in bytes\&. +The data stored in \fBpixels\fR is assumed to be of the \fBdepth\fR specified in the parameter list\&. The pixel data is not copied into the \fBSDL_Surface\fR structure so it should not be freed until the surface has been freed with a called to \fISDL_FreeSurface\fR\&. \fBpitch\fR is the length of each scanline in bytes\&. .PP See \fI\fBSDL_CreateRGBSurface\fP\fR for a more detailed description of the other parameters\&. +.SH "RETURN VALUE" +.PP +Returns the created surface, or \fBNULL\fR upon error\&. .SH "SEE ALSO" .PP \fI\fBSDL_CreateRGBSurface\fP\fR, \fI\fBSDL_FreeSurface\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_CreateSemaphore.3 b/docs/man3/SDL_CreateSemaphore.3 index 553497dfe..010fc6e28 100644 --- a/docs/man3/SDL_CreateSemaphore.3 +++ b/docs/man3/SDL_CreateSemaphore.3 @@ -1,4 +1,4 @@ -.TH "SDL_CreateSemaphore" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_CreateSemaphore" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_CreateSemaphore\- Creates a new semaphore and assigns an initial value to it\&. .SH "SYNOPSIS" @@ -29,4 +29,4 @@ if (my_sem == NULL) { .SH "SEE ALSO" .PP \fI\fBSDL_DestroySemaphore\fP\fR, \fI\fBSDL_SemWait\fP\fR, \fI\fBSDL_SemTryWait\fP\fR, \fI\fBSDL_SemWaitTimeout\fP\fR, \fI\fBSDL_SemPost\fP\fR, \fI\fBSDL_SemValue\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_CreateThread.3 b/docs/man3/SDL_CreateThread.3 index db7b7d006..b3cb2db40 100644 --- a/docs/man3/SDL_CreateThread.3 +++ b/docs/man3/SDL_CreateThread.3 @@ -1,4 +1,4 @@ -.TH "SDL_CreateThread" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_CreateThread" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_CreateThread\- Creates a new thread of execution that shares its parent\&'s properties\&. .SH "SYNOPSIS" @@ -13,4 +13,4 @@ SDL_CreateThread\- Creates a new thread of execution that shares its parent\&'s .SH "SEE ALSO" .PP \fI\fBSDL_KillThread\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_CreateYUVOverlay.3 b/docs/man3/SDL_CreateYUVOverlay.3 index 21991655e..398c4835a 100644 --- a/docs/man3/SDL_CreateYUVOverlay.3 +++ b/docs/man3/SDL_CreateYUVOverlay.3 @@ -1,4 +1,4 @@ -.TH "SDL_CreateYUVOverlay" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_CreateYUVOverlay" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_CreateYUVOverlay\- Create a YUV video overlay .SH "SYNOPSIS" @@ -14,4 +14,4 @@ The term \&'overlay\&' is a misnomer since, unless the overlay is created in har .SH "SEE ALSO" .PP \fI\fBSDL_Overlay\fR\fR, \fI\fBSDL_DisplayYUVOverlay\fP\fR, \fI\fBSDL_FreeYUVOverlay\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_Delay.3 b/docs/man3/SDL_Delay.3 index cef12d0ea..72d9746ea 100644 --- a/docs/man3/SDL_Delay.3 +++ b/docs/man3/SDL_Delay.3 @@ -1,4 +1,4 @@ -.TH "SDL_Delay" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_Delay" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_Delay\- Wait a specified number of milliseconds before returning\&. .SH "SYNOPSIS" @@ -9,7 +9,13 @@ SDL_Delay\- Wait a specified number of milliseconds before returning\&. .SH "DESCRIPTION" .PP Wait a specified number of milliseconds before returning\&. \fBSDL_Delay\fP will wait at \fIleast\fP the specified time, but possible longer due to OS scheduling\&. +.PP +.RS +\fBNote: +.PP +Count on a delay granularity of \fIat least\fP 10 ms\&. Some platforms have shorter clock ticks but this is the most common\&. +.RE .SH "SEE ALSO" .PP \fI\fBSDL_AddTimer\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_DestroyCond.3 b/docs/man3/SDL_DestroyCond.3 index c1f6a92c6..777e1a187 100644 --- a/docs/man3/SDL_DestroyCond.3 +++ b/docs/man3/SDL_DestroyCond.3 @@ -1,4 +1,4 @@ -.TH "SDL_DestroyCond" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_DestroyCond" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_DestroyCond\- Destroy a condition variable .SH "SYNOPSIS" @@ -13,4 +13,4 @@ Destroys a condition variable\&. .SH "SEE ALSO" .PP \fI\fBSDL_CreateCond\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_DestroyMutex.3 b/docs/man3/SDL_DestroyMutex.3 index 6e52a7a09..b86798921 100644 --- a/docs/man3/SDL_DestroyMutex.3 +++ b/docs/man3/SDL_DestroyMutex.3 @@ -1,4 +1,4 @@ -.TH "SDL_DestroyMutex" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_DestroyMutex" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_DestroyMutex\- Destroy a mutex .SH "SYNOPSIS" @@ -13,4 +13,4 @@ Destroy a previously \fIcreated\fR mutex\&. .SH "SEE ALSO" .PP \fI\fBSDL_CreateMutex\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_DestroySemaphore.3 b/docs/man3/SDL_DestroySemaphore.3 index abd194f7f..84175a3b5 100644 --- a/docs/man3/SDL_DestroySemaphore.3 +++ b/docs/man3/SDL_DestroySemaphore.3 @@ -1,4 +1,4 @@ -.TH "SDL_DestroySemaphore" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_DestroySemaphore" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_DestroySemaphore\- Destroys a semaphore that was created by \fISDL_CreateSemaphore\fR\&. .SH "SYNOPSIS" @@ -23,4 +23,4 @@ SDL_DestroySemaphore\- Destroys a semaphore that was created by \fISDL_CreateSem .SH "SEE ALSO" .PP \fI\fBSDL_CreateSemaphore\fP\fR, \fI\fBSDL_SemWait\fP\fR, \fI\fBSDL_SemTryWait\fP\fR, \fI\fBSDL_SemWaitTimeout\fP\fR, \fI\fBSDL_SemPost\fP\fR, \fI\fBSDL_SemValue\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_DisplayFormat.3 b/docs/man3/SDL_DisplayFormat.3 index 04f43bf3e..5caaae910 100644 --- a/docs/man3/SDL_DisplayFormat.3 +++ b/docs/man3/SDL_DisplayFormat.3 @@ -1,4 +1,4 @@ -.TH "SDL_DisplayFormat" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_DisplayFormat" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_DisplayFormat\- Convert a surface to the display format .SH "SYNOPSIS" @@ -19,4 +19,4 @@ If the conversion fails or runs out of memory, it returns \fBNULL\fR .SH "SEE ALSO" .PP \fI\fBSDL_ConvertSurface\fP\fR, \fI\fBSDL_DisplayFormatAlpha\fP\fR \fI\fBSDL_SetAlpha\fP\fR, \fI\fBSDL_SetColorKey\fP\fR, \fI\fBSDL_Surface\fR\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_DisplayFormatAlpha.3 b/docs/man3/SDL_DisplayFormatAlpha.3 index 40f57a00b..e451dfc78 100644 --- a/docs/man3/SDL_DisplayFormatAlpha.3 +++ b/docs/man3/SDL_DisplayFormatAlpha.3 @@ -1,4 +1,4 @@ -.TH "SDL_DisplayFormatAlpha" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_DisplayFormatAlpha" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_DisplayFormatAlpha\- Convert a surface to the display format .SH "SYNOPSIS" @@ -11,10 +11,12 @@ SDL_DisplayFormatAlpha\- Convert a surface to the display format This function takes a surface and copies it to a new surface of the pixel format and colors of the video framebuffer plus an alpha channel, suitable for fast blitting onto the display surface\&. It calls \fISDL_ConvertSurface\fR .PP If you want to take advantage of hardware colorkey or alpha blit acceleration, you should set the colorkey and alpha value before calling this function\&. +.PP +This function can be used to convert a colourkey to an alpha channel, if the \fBSDL_SRCCOLORKEY\fP flag is set on the surface\&. The generated surface will then be transparent (alpha=0) where the pixels match the colourkey, and opaque (alpha=255) elsewhere\&. .SH "RETURN VALUE" .PP If the conversion fails or runs out of memory, it returns \fBNULL\fR .SH "SEE ALSO" .PP \fISDL_ConvertSurface\fR, \fISDL_SetAlpha\fR, \fISDL_SetColorKey\fR, \fISDL_DisplayFormat\fR, \fISDL_Surface\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_DisplayYUVOverlay.3 b/docs/man3/SDL_DisplayYUVOverlay.3 index f3f4dd6f2..84a96f7e3 100644 --- a/docs/man3/SDL_DisplayYUVOverlay.3 +++ b/docs/man3/SDL_DisplayYUVOverlay.3 @@ -1,4 +1,4 @@ -.TH "SDL_DisplayYUVOverlay" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_DisplayYUVOverlay" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_DisplayYUVOverlay\- Blit the overlay to the display .SH "SYNOPSIS" @@ -12,4 +12,4 @@ Blit the \fBoverlay\fR to the surface specified when it was \fIcreated\fR\&. The .SH "SEE ALSO" .PP \fI\fBSDL_Overlay\fR\fR, \fI\fBSDL_CreateYUVOverlay\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_EnableKeyRepeat.3 b/docs/man3/SDL_EnableKeyRepeat.3 index f3ba0899e..3934d38ee 100644 --- a/docs/man3/SDL_EnableKeyRepeat.3 +++ b/docs/man3/SDL_EnableKeyRepeat.3 @@ -1,4 +1,4 @@ -.TH "SDL_EnableKeyRepeat" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_EnableKeyRepeat" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_EnableKeyRepeat\- Set keyboard repeat rate\&. .SH "SYNOPSIS" @@ -14,4 +14,4 @@ Setting \fBdelay\fR to 0 disables key repeating completely\&. Good default value .SH "RETURN VALUE" .PP Returns \fB0\fR on success and \fB-1\fR on failure\&. -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_EnableUNICODE.3 b/docs/man3/SDL_EnableUNICODE.3 index 54e0f3881..899c634cb 100644 --- a/docs/man3/SDL_EnableUNICODE.3 +++ b/docs/man3/SDL_EnableUNICODE.3 @@ -1,4 +1,4 @@ -.TH "SDL_EnableUNICODE" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_EnableUNICODE" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_EnableUNICODE\- Enable UNICODE translation .SH "SYNOPSIS" @@ -17,4 +17,4 @@ Returns the previous translation mode\&. .SH "SEE ALSO" .PP \fI\fBSDL_keysym\fR\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_Event.3 b/docs/man3/SDL_Event.3 index 4eb738810..ebca66a22 100644 --- a/docs/man3/SDL_Event.3 +++ b/docs/man3/SDL_Event.3 @@ -1,4 +1,4 @@ -.TH "SDL_Event" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_Event" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_Event\- General event structure .SH "STRUCTURE DEFINITION" @@ -172,4 +172,4 @@ SDL_PushEvent(&user_event);\fR .SH "SEE ALSO" .PP \fI\fBSDL_PollEvent\fP\fR, \fI\fBSDL_PushEvent\fP\fR, \fI\fBSDL_PeepEvents\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_EventState.3 b/docs/man3/SDL_EventState.3 index cef080e1f..1878cff2d 100644 --- a/docs/man3/SDL_EventState.3 +++ b/docs/man3/SDL_EventState.3 @@ -1,4 +1,4 @@ -.TH "SDL_EventState" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_EventState" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_EventState\- This function allows you to set the state of processing certain events\&. .SH "SYNOPSIS" @@ -20,4 +20,4 @@ A list of event \fBtype\fR\&'s can be found in the \fI\fBSDL_Event\fR\fR section .SH "SEE ALSO" .PP \fI\fBSDL_Event\fR\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_FillRect.3 b/docs/man3/SDL_FillRect.3 index 8e49e4a81..4e8f324f0 100644 --- a/docs/man3/SDL_FillRect.3 +++ b/docs/man3/SDL_FillRect.3 @@ -1,4 +1,4 @@ -.TH "SDL_FillRect" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_FillRect" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_FillRect\- This function performs a fast fill of the given rectangle with some color .SH "SYNOPSIS" @@ -19,4 +19,4 @@ This function returns \fB0\fR on success, or \fB-1\fR on error\&. .SH "SEE ALSO" .PP \fI\fBSDL_MapRGB\fP\fR, \fI\fBSDL_BlitSurface\fP\fR, \fI\fBSDL_Rect\fR\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_Flip.3 b/docs/man3/SDL_Flip.3 index 1d09409b0..536191bb8 100644 --- a/docs/man3/SDL_Flip.3 +++ b/docs/man3/SDL_Flip.3 @@ -1,4 +1,4 @@ -.TH "SDL_Flip" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_Flip" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_Flip\- Swaps screen buffers .SH "SYNOPSIS" @@ -17,4 +17,4 @@ This function returns \fB0\fR if successful, or \fB-1\fR if there was an error\& .SH "SEE ALSO" .PP \fI\fBSDL_SetVideoMode\fP\fR, \fI\fBSDL_UpdateRect\fP\fR, \fI\fBSDL_Surface\fR\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_FreeCursor.3 b/docs/man3/SDL_FreeCursor.3 index 4aa7fdea0..9e6aa5f1d 100644 --- a/docs/man3/SDL_FreeCursor.3 +++ b/docs/man3/SDL_FreeCursor.3 @@ -1,4 +1,4 @@ -.TH "SDL_FreeCursor" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_FreeCursor" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_FreeCursor\- Frees a cursor created with SDL_CreateCursor\&. .SH "SYNOPSIS" @@ -12,4 +12,4 @@ Frees a \fBSDL_Cursor\fR that was created using \fISDL_CreateCursor\fR\&. .SH "SEE ALSO" .PP \fISDL_CreateCursor\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_FreeSurface.3 b/docs/man3/SDL_FreeSurface.3 index b5811d3d5..ab9e32006 100644 --- a/docs/man3/SDL_FreeSurface.3 +++ b/docs/man3/SDL_FreeSurface.3 @@ -1,6 +1,6 @@ -.TH "SDL_FreeSurface" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_FreeSurface" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" -SDL_FreeSurface\- Frees (deletes) and SDL_Surface +SDL_FreeSurface\- Frees (deletes) a SDL_Surface .SH "SYNOPSIS" .PP \fB#include "SDL\&.h" @@ -12,4 +12,4 @@ Frees the resources used by a previously created \fBSDL_Surface\fR\&. If the sur .SH "SEE ALSO" .PP \fI\fBSDL_CreateRGBSurface\fP\fR \fI\fBSDL_CreateRGBSurfaceFrom\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_FreeWAV.3 b/docs/man3/SDL_FreeWAV.3 index 3f0ea56e4..42663746a 100644 --- a/docs/man3/SDL_FreeWAV.3 +++ b/docs/man3/SDL_FreeWAV.3 @@ -1,4 +1,4 @@ -.TH "SDL_FreeWAV" "3" "Mon 12 Mar 2001, 01:02" "SDL" "SDL API Reference" +.TH "SDL_FreeWAV" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_FreeWAV\- Frees previously opened WAV data .SH "SYNOPSIS" @@ -12,4 +12,4 @@ After a WAVE file has been opened with \fI\fBSDL_LoadWAV\fP\fR its data can even .SH "SEE ALSO" .PP \fI\fBSDL_LoadWAV\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:02 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_FreeYUVOverlay.3 b/docs/man3/SDL_FreeYUVOverlay.3 index e9bc8a6e3..d41b4d641 100644 --- a/docs/man3/SDL_FreeYUVOverlay.3 +++ b/docs/man3/SDL_FreeYUVOverlay.3 @@ -1,4 +1,4 @@ -.TH "SDL_FreeYUVOverlay" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_FreeYUVOverlay" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_FreeYUVOverlay\- Free a YUV video overlay .SH "SYNOPSIS" @@ -12,4 +12,4 @@ Frees and \fI\fBoverlay\fR\fR created by \fI\fBSDL_CreateYUVOverlay\fP\fR\&. .SH "SEE ALSO" .PP \fI\fBSDL_Overlay\fR\fR, \fI\fBSDL_DisplayYUVOverlay\fP\fR, \fI\fBSDL_FreeYUVOverlay\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_GL_GetAttribute.3 b/docs/man3/SDL_GL_GetAttribute.3 index 8ffe130fb..aa0c67076 100644 --- a/docs/man3/SDL_GL_GetAttribute.3 +++ b/docs/man3/SDL_GL_GetAttribute.3 @@ -1,4 +1,4 @@ -.TH "SDL_GL_GetAttribute" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_GL_GetAttribute" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_GL_GetAttribute\- Get the value of a special SDL/OpenGL attribute .SH "SYNOPSIS" @@ -15,4 +15,4 @@ Returns \fB0\fR on success, or \fB-1\fR on an error\&. .SH "SEE ALSO" .PP \fI\fBSDL_GL_SetAttribute\fP\fR, \fIGL Attributes\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_GL_GetProcAddress.3 b/docs/man3/SDL_GL_GetProcAddress.3 index 59fd83174..19db7ec9d 100644 --- a/docs/man3/SDL_GL_GetProcAddress.3 +++ b/docs/man3/SDL_GL_GetProcAddress.3 @@ -1,4 +1,4 @@ -.TH "SDL_GL_GetProcAddress" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_GL_GetProcAddress" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_GL_GetProcAddress\- Get the address of a GL function .SH "SYNOPSIS" @@ -45,4 +45,4 @@ else{ .SH "SEE ALSO" .PP \fI\fBSDL_GL_LoadLibrary\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_GL_LoadLibrary.3 b/docs/man3/SDL_GL_LoadLibrary.3 index 4a8490a11..0fcd2c31c 100644 --- a/docs/man3/SDL_GL_LoadLibrary.3 +++ b/docs/man3/SDL_GL_LoadLibrary.3 @@ -1,4 +1,4 @@ -.TH "SDL_GL_LoadLibrary" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_GL_LoadLibrary" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_GL_LoadLibrary\- Specify an OpenGL library .SH "SYNOPSIS" @@ -12,4 +12,4 @@ If you wish, you may load the OpenGL library at runtime, this must be done befor .SH "SEE ALSO" .PP \fI\fBSDL_GL_GetProcAddress\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_GL_SetAttribute.3 b/docs/man3/SDL_GL_SetAttribute.3 index accfc50ad..03df6f59a 100644 --- a/docs/man3/SDL_GL_SetAttribute.3 +++ b/docs/man3/SDL_GL_SetAttribute.3 @@ -1,4 +1,4 @@ -.TH "SDL_GL_SetAttribute" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_GL_SetAttribute" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_GL_SetAttribute\- Set a special SDL/OpenGL attribute .SH "SYNOPSIS" @@ -37,4 +37,4 @@ The \fBSDL_DOUBLEBUF\fP flag is not required to enable double buffering when set .SH "SEE ALSO" .PP \fI\fBSDL_GL_GetAttribute\fP\fR, \fIGL Attributes\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_GL_SwapBuffers.3 b/docs/man3/SDL_GL_SwapBuffers.3 index 0a699358e..d75e8c27f 100644 --- a/docs/man3/SDL_GL_SwapBuffers.3 +++ b/docs/man3/SDL_GL_SwapBuffers.3 @@ -1,4 +1,4 @@ -.TH "SDL_GL_SwapBuffers" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_GL_SwapBuffers" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_GL_SwapBuffers\- Swap OpenGL framebuffers/Update Display .SH "SYNOPSIS" @@ -12,4 +12,4 @@ Swap the OpenGL buffers, if double-buffering is supported\&. .SH "SEE ALSO" .PP \fI\fBSDL_SetVideoMode\fP\fR, \fI\fBSDL_GL_SetAttribute\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_GLattr.3 b/docs/man3/SDL_GLattr.3 index 4d6757c4a..cb1e70116 100644 --- a/docs/man3/SDL_GLattr.3 +++ b/docs/man3/SDL_GLattr.3 @@ -1,4 +1,4 @@ -.TH "SDL_GLattr" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_GLattr" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_GLattr\- SDL GL Attributes .SH "ATTRIBUTES" @@ -44,4 +44,4 @@ While you can set most OpenGL attributes normally, the attributes list above mus .SH "SEE ALSO" .PP \fI\fBSDL_GL_SetAttribute\fP\fR, \fI\fBSDL_GL_GetAttribute\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_GetAppState.3 b/docs/man3/SDL_GetAppState.3 index b596971db..fd381e122 100644 --- a/docs/man3/SDL_GetAppState.3 +++ b/docs/man3/SDL_GetAppState.3 @@ -1,4 +1,4 @@ -.TH "SDL_GetAppState" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_GetAppState" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" \fBSDL_GetAppState\fP\- Get the state of the application .SH "SYNOPSIS" @@ -21,4 +21,4 @@ The application is visible .SH "SEE ALSO" .PP \fI\fBSDL_ActiveEvent\fR\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_GetAudioStatus.3 b/docs/man3/SDL_GetAudioStatus.3 index 0ecb9eedd..3cd631619 100644 --- a/docs/man3/SDL_GetAudioStatus.3 +++ b/docs/man3/SDL_GetAudioStatus.3 @@ -1,4 +1,4 @@ -.TH "SDL_GetAudioStatus" "3" "Mon 12 Mar 2001, 01:02" "SDL" "SDL API Reference" +.TH "SDL_GetAudioStatus" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_GetAudioStatus\- Get the current audio state .SH "SYNOPSIS" @@ -21,4 +21,4 @@ Returns either \fBSDL_AUDIO_STOPPED\fP, \fBSDL_AUDIO_PAUSED\fP or \fBSDL_AUDIO_P .SH "SEE ALSO" .PP \fI\fBSDL_PauseAudio\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:02 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_GetClipRect.3 b/docs/man3/SDL_GetClipRect.3 index 1dee367ba..ce08ff486 100644 --- a/docs/man3/SDL_GetClipRect.3 +++ b/docs/man3/SDL_GetClipRect.3 @@ -1,4 +1,4 @@ -.TH "SDL_GetClipRect" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_GetClipRect" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_GetClipRect\- Gets the clipping rectangle for a surface\&. .SH "SYNOPSIS" @@ -14,4 +14,4 @@ The rectangle pointed to by \fBrect\fR will be filled with the clipping rectangl .SH "SEE ALSO" .PP \fI\fBSDL_SetClipRect\fP\fR, \fI\fBSDL_BlitSurface\fP\fR, \fI\fBSDL_Surface\fR\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_GetCursor.3 b/docs/man3/SDL_GetCursor.3 index b225ba88e..69fd540f7 100644 --- a/docs/man3/SDL_GetCursor.3 +++ b/docs/man3/SDL_GetCursor.3 @@ -1,4 +1,4 @@ -.TH "SDL_GetCursor" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_GetCursor" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_GetCursor\- Get the currently active mouse cursor\&. .SH "SYNOPSIS" @@ -12,4 +12,4 @@ Returns the currently active mouse cursor\&. .SH "SEE ALSO" .PP \fI\fBSDL_SetCursor\fP\fR, \fI\fBSDL_CreateCursor\fP\fR, \fI\fBSDL_ShowCursor\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_GetEventFilter.3 b/docs/man3/SDL_GetEventFilter.3 index e7f6ec60b..b65a390d5 100644 --- a/docs/man3/SDL_GetEventFilter.3 +++ b/docs/man3/SDL_GetEventFilter.3 @@ -1,4 +1,4 @@ -.TH "SDL_GetEventFilter" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_GetEventFilter" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_GetEventFilter\- Retrieves a pointer to he event filter .SH "SYNOPSIS" @@ -20,4 +20,4 @@ Returns a pointer to the event filter or \fBNULL\fP if no filter has been set\&. .SH "SEE ALSO" .PP \fI\fBSDL_Event\fR\fR, \fI\fBSDL_SetEventFilter\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_GetGamma.3 b/docs/man3/SDL_GetGamma.3 index e77f78d02..87840fd38 100644 --- a/docs/man3/SDL_GetGamma.3 +++ b/docs/man3/SDL_GetGamma.3 @@ -1,4 +1,4 @@ -.TH "SDL_GetGamma" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_GetGamma" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_GetGamma\- Gets the gamma of the display .SH "SYNOPSIS" @@ -18,4 +18,4 @@ This function currently only works on XFreee 4\&.0 and up\&. .SH "SEE ALSO" .PP \fI\fBSDL_SetGamma\fP\fR, \fI\fBSDL_SetVideoMode\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_GetGammaRamp.3 b/docs/man3/SDL_GetGammaRamp.3 index 27476f2b2..b2d02e47e 100644 --- a/docs/man3/SDL_GetGammaRamp.3 +++ b/docs/man3/SDL_GetGammaRamp.3 @@ -1,4 +1,4 @@ -.TH "SDL_GetGammaRamp" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_GetGammaRamp" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_GetGammaRamp\- Gets the color gamma lookup tables for the display .SH "SYNOPSIS" @@ -17,4 +17,4 @@ Returns -1 on error\&. .SH "SEE ALSO" .PP \fISDL_SetGamma\fR \fISDL_SetGammaRamp\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_GetKeyName.3 b/docs/man3/SDL_GetKeyName.3 index ab8e37e10..7cf0ace5c 100644 --- a/docs/man3/SDL_GetKeyName.3 +++ b/docs/man3/SDL_GetKeyName.3 @@ -1,4 +1,4 @@ -.TH "SDL_GetKeyName" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_GetKeyName" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_GetKeyName\- Get the name of an SDL virtual keysym .SH "SYNOPSIS" @@ -12,4 +12,4 @@ Returns the SDL-defined name of the \fI\fBSDLKey\fR\fR \fBkey\fR\&. .SH "SEE ALSO" .PP \fI\fBSDLKey\fR\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_GetKeyState.3 b/docs/man3/SDL_GetKeyState.3 index 75d1602b7..1444ac900 100644 --- a/docs/man3/SDL_GetKeyState.3 +++ b/docs/man3/SDL_GetKeyState.3 @@ -1,4 +1,4 @@ -.TH "SDL_GetKeyState" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_GetKeyState" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_GetKeyState\- Get a snapshot of the current keyboard state .SH "SYNOPSIS" @@ -27,4 +27,4 @@ if ( keystate[SDLK_RETURN] ) printf("Return Key Pressed\&. .SH "SEE ALSO" .PP \fI\fBSDL Key Symbols\fP\fR, \fI\fBSDL_PumpEvents\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_GetModState.3 b/docs/man3/SDL_GetModState.3 index e399ec13e..a2efa67ca 100644 --- a/docs/man3/SDL_GetModState.3 +++ b/docs/man3/SDL_GetModState.3 @@ -1,4 +1,4 @@ -.TH "SDL_GetModState" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_GetModState" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_GetModState\- Get the state of modifier keys\&. .SH "SYNOPSIS" @@ -51,4 +51,4 @@ The return value can be an OR\&'d combination of the SDLMod enum\&. .SH "SEE ALSO" .PP \fI\fBSDL_GetKeyState\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_GetMouseState.3 b/docs/man3/SDL_GetMouseState.3 index 65fde4fce..5f1a6a505 100644 --- a/docs/man3/SDL_GetMouseState.3 +++ b/docs/man3/SDL_GetMouseState.3 @@ -1,4 +1,4 @@ -.TH "SDL_GetMouseState" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_GetMouseState" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_GetMouseState\- Retrieve the current state of the mouse .SH "SYNOPSIS" @@ -21,4 +21,4 @@ if(SDL_GetMouseState(NULL, NULL)&SDL_BUTTON(1)) .SH "SEE ALSO" .PP \fI\fBSDL_GetRelativeMouseState\fP\fR, \fI\fBSDL_PumpEvents\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_GetRGB.3 b/docs/man3/SDL_GetRGB.3 index 2cb17bff4..704124fd0 100644 --- a/docs/man3/SDL_GetRGB.3 +++ b/docs/man3/SDL_GetRGB.3 @@ -1,4 +1,4 @@ -.TH "SDL_GetRGB" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_GetRGB" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_GetRGB\- Get RGB values from a pixel in the specified pixel format\&. .SH "SYNOPSIS" @@ -14,4 +14,4 @@ This function uses the entire 8-bit [0\&.\&.255] range when converting color com .SH "SEE ALSO" .PP \fI\fBSDL_GetRGBA\fP\fR, \fI\fBSDL_MapRGB\fP\fR, \fI\fBSDL_MapRGBA\fP\fR, \fI\fBSDL_PixelFormat\fR\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_GetRGBA.3 b/docs/man3/SDL_GetRGBA.3 index afcf25ba3..68f4609e5 100644 --- a/docs/man3/SDL_GetRGBA.3 +++ b/docs/man3/SDL_GetRGBA.3 @@ -1,4 +1,4 @@ -.TH "SDL_GetRGBA" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_GetRGBA" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_GetRGBA\- Get RGBA values from a pixel in the specified pixel format\&. .SH "SYNOPSIS" @@ -16,4 +16,4 @@ If the surface has no alpha component, the alpha will be returned as 0xff (100% .SH "SEE ALSO" .PP \fISDL_GetRGB\fR, \fISDL_MapRGB\fR, \fISDL_MapRGBA\fR, \fISDL_PixelFormat\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_GetRelativeMouseState.3 b/docs/man3/SDL_GetRelativeMouseState.3 index 05e855da2..f50f928a0 100644 --- a/docs/man3/SDL_GetRelativeMouseState.3 +++ b/docs/man3/SDL_GetRelativeMouseState.3 @@ -1,4 +1,4 @@ -.TH "SDL_GetRelativeMouseState" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_GetRelativeMouseState" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_GetRelativeMouseState\- Retrieve the current state of the mouse .SH "SYNOPSIS" @@ -12,4 +12,4 @@ The current button state is returned as a button bitmask, which can be tested us .SH "SEE ALSO" .PP \fI\fBSDL_GetMouseState\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_GetThreadID.3 b/docs/man3/SDL_GetThreadID.3 index 33aac31d0..e7e494787 100644 --- a/docs/man3/SDL_GetThreadID.3 +++ b/docs/man3/SDL_GetThreadID.3 @@ -1,4 +1,4 @@ -.TH "SDL_GetThreadID" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_GetThreadID" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_GetThreadID\- Get the SDL thread ID of a SDL_Thread .SH "SYNOPSIS" @@ -13,4 +13,4 @@ Returns the ID of a \fBSDL_Thread\fR created by \fISDL_CreateThread\fR\&. .SH "SEE ALSO" .PP \fISDL_CreateThread\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_GetTicks.3 b/docs/man3/SDL_GetTicks.3 index 052e06b50..5eee4e0c3 100644 --- a/docs/man3/SDL_GetTicks.3 +++ b/docs/man3/SDL_GetTicks.3 @@ -1,4 +1,4 @@ -.TH "SDL_GetTicks" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_GetTicks" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_GetTicks\- Get the number of milliseconds since the SDL library initialization\&. .SH "SYNOPSIS" @@ -12,4 +12,4 @@ Get the number of milliseconds since the SDL library initialization\&. Note that .SH "SEE ALSO" .PP \fI\fBSDL_Delay\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_GetVideoInfo.3 b/docs/man3/SDL_GetVideoInfo.3 index 40ff6f22c..6662bfe10 100644 --- a/docs/man3/SDL_GetVideoInfo.3 +++ b/docs/man3/SDL_GetVideoInfo.3 @@ -1,4 +1,4 @@ -.TH "SDL_GetVideoInfo" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_GetVideoInfo" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_GetVideoInfo\- returns a pointer to information about the video hardware .SH "SYNOPSIS" @@ -12,4 +12,4 @@ This function returns a read-only pointer to \fIinformation\fR about the video h .SH "SEE ALSO" .PP \fI\fBSDL_SetVideoMode\fP\fR, \fI\fBSDL_VideoInfo\fR\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_GetVideoSurface.3 b/docs/man3/SDL_GetVideoSurface.3 index 92678c449..059bf8cbd 100644 --- a/docs/man3/SDL_GetVideoSurface.3 +++ b/docs/man3/SDL_GetVideoSurface.3 @@ -1,4 +1,4 @@ -.TH "SDL_GetVideoSurface" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_GetVideoSurface" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_GetVideoSurface\- returns a pointer to the current display surface .SH "SYNOPSIS" @@ -12,4 +12,4 @@ This function returns a pointer to the current display surface\&. If SDL is doin .SH "SEE ALSO" .PP \fI\fBSDL_Surface\fR\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_Init.3 b/docs/man3/SDL_Init.3 index 4baa3a75c..67af7bbdc 100644 --- a/docs/man3/SDL_Init.3 +++ b/docs/man3/SDL_Init.3 @@ -1,4 +1,4 @@ -.TH "SDL_Init" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_Init" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_Init\- Initializes SDL .SH "SYNOPSIS" @@ -38,4 +38,4 @@ Returns \fB-1\fR on an error or \fB0\fR on success\&. .SH "SEE ALSO" .PP \fI\fBSDL_Quit\fP\fR, \fI\fBSDL_InitSubSystem\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_InitSubSystem.3 b/docs/man3/SDL_InitSubSystem.3 index 8e17f6efd..254d54f73 100644 --- a/docs/man3/SDL_InitSubSystem.3 +++ b/docs/man3/SDL_InitSubSystem.3 @@ -1,4 +1,4 @@ -.TH "SDL_InitSubSystem" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_InitSubSystem" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_InitSubSystem\- Initialize subsystems .SH "SYNOPSIS" @@ -38,4 +38,4 @@ Returns \fB-1\fR on an error or \fB0\fR on success\&. .SH "SEE ALSO" .PP \fI\fBSDL_Init\fP\fR, \fI\fBSDL_Quit\fP\fR, \fI\fBSDL_QuitSubSystem\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_JoyAxisEvent.3 b/docs/man3/SDL_JoyAxisEvent.3 index 8bbb899d0..aad468b37 100644 --- a/docs/man3/SDL_JoyAxisEvent.3 +++ b/docs/man3/SDL_JoyAxisEvent.3 @@ -1,4 +1,4 @@ -.TH "SDL_JoyAxisEvent" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_JoyAxisEvent" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_JoyAxisEvent\- Joystick axis motion event structure .SH "STRUCTURE DEFINITION" @@ -33,4 +33,4 @@ A \fBSDL_JOYAXISMOTION\fP event occurs when ever a user moves an axis on the joy .SH "SEE ALSO" .PP \fI\fBSDL_Event\fR\fR, \fIJoystick Functions\fR, \fI\fBSDL_JoystickEventState\fP\fR, \fI\fBSDL_JoystickGetAxis\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_JoyBallEvent.3 b/docs/man3/SDL_JoyBallEvent.3 index 75357ba3a..0699f958b 100644 --- a/docs/man3/SDL_JoyBallEvent.3 +++ b/docs/man3/SDL_JoyBallEvent.3 @@ -1,4 +1,4 @@ -.TH "SDL_JoyBallEvent" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_JoyBallEvent" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_JoyBallEvent\- Joystick trackball motion event structure .SH "STRUCTURE DEFINITION" @@ -33,4 +33,4 @@ A \fBSDL_JOYBALLMOTION\fP event occurs when a user moves a trackball on the joys .SH "SEE ALSO" .PP \fI\fBSDL_Event\fR\fR, \fIJoystick Functions\fR, \fI\fBSDL_JoystickEventState\fP\fR, \fI\fBSDL_JoystickGetBall\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_JoyButtonEvent.3 b/docs/man3/SDL_JoyButtonEvent.3 index 942474383..6f8bc83ec 100644 --- a/docs/man3/SDL_JoyButtonEvent.3 +++ b/docs/man3/SDL_JoyButtonEvent.3 @@ -1,4 +1,4 @@ -.TH "SDL_JoyButtonEvent" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_JoyButtonEvent" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_JoyButtonEvent\- Joystick button event structure .SH "STRUCTURE DEFINITION" @@ -33,4 +33,4 @@ A \fBSDL_JOYBUTTONDOWN\fP or \fBSDL_JOYBUTTONUP\fP event occurs when ever a user .SH "SEE ALSO" .PP \fI\fBSDL_Event\fR\fR, \fIJoystick Functions\fR, \fI\fBSDL_JoystickEventState\fP\fR, \fI\fBSDL_JoystickGetButton\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_JoyHatEvent.3 b/docs/man3/SDL_JoyHatEvent.3 index 188032484..1886cc904 100644 --- a/docs/man3/SDL_JoyHatEvent.3 +++ b/docs/man3/SDL_JoyHatEvent.3 @@ -1,4 +1,4 @@ -.TH "SDL_JoyHatEvent" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_JoyHatEvent" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_JoyHatEvent\- Joystick hat position change event structure .SH "STRUCTURE DEFINITION" @@ -53,4 +53,4 @@ The following defines are also provided: .SH "SEE ALSO" .PP \fI\fBSDL_Event\fR\fR, \fIJoystick Functions\fR, \fI\fBSDL_JoystickEventState\fP\fR, \fI\fBSDL_JoystickGetHat\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_JoystickClose.3 b/docs/man3/SDL_JoystickClose.3 index 466d37b44..156a6e505 100644 --- a/docs/man3/SDL_JoystickClose.3 +++ b/docs/man3/SDL_JoystickClose.3 @@ -1,4 +1,4 @@ -.TH "SDL_JoystickClose" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_JoystickClose" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_JoystickClose\- Closes a previously opened joystick .SH "SYNOPSIS" @@ -12,4 +12,4 @@ Close a \fBjoystick\fR that was previously opened with \fI\fBSDL_JoystickOpen\fP .SH "SEE ALSO" .PP \fI\fBSDL_JoystickOpen\fP\fR, \fI\fBSDL_JoystickOpened\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_JoystickEventState.3 b/docs/man3/SDL_JoystickEventState.3 index b0d6a7348..8f1fb4be5 100644 --- a/docs/man3/SDL_JoystickEventState.3 +++ b/docs/man3/SDL_JoystickEventState.3 @@ -1,4 +1,4 @@ -.TH "SDL_JoystickEventState" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_JoystickEventState" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_JoystickEventState\- Enable/disable joystick event polling .SH "SYNOPSIS" @@ -21,4 +21,4 @@ If \fBstate\fR is \fBSDL_QUERY\fP then the current state is returned, otherwise .SH "SEE ALSO" .PP \fISDL Joystick Functions\fR, \fI\fBSDL_JoystickUpdate\fP\fR, \fI\fBSDL_JoyAxisEvent\fR\fR, \fI\fBSDL_JoyBallEvent\fR\fR, \fI\fBSDL_JoyButtonEvent\fR\fR, \fI\fBSDL_JoyHatEvent\fR\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_JoystickGetAxis.3 b/docs/man3/SDL_JoystickGetAxis.3 index e69645f22..94d86431c 100644 --- a/docs/man3/SDL_JoystickGetAxis.3 +++ b/docs/man3/SDL_JoystickGetAxis.3 @@ -1,4 +1,4 @@ -.TH "SDL_JoystickGetAxis" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_JoystickGetAxis" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_JoystickGetAxis\- Get the current state of an axis .SH "SYNOPSIS" @@ -29,4 +29,4 @@ y_move=SDL_JoystickGetAxis(joy1, 1);\fR .SH "SEE ALSO" .PP \fI\fBSDL_JoystickNumAxes\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_JoystickGetBall.3 b/docs/man3/SDL_JoystickGetBall.3 index 142ad30b1..fb2fffbd0 100644 --- a/docs/man3/SDL_JoystickGetBall.3 +++ b/docs/man3/SDL_JoystickGetBall.3 @@ -1,4 +1,4 @@ -.TH "SDL_JoystickGetBall" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_JoystickGetBall" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_JoystickGetBall\- Get relative trackball motion .SH "SYNOPSIS" @@ -34,4 +34,4 @@ printf("Trackball Delta- X:%d, Y:%d .SH "SEE ALSO" .PP \fI\fBSDL_JoystickNumBalls\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_JoystickGetButton.3 b/docs/man3/SDL_JoystickGetButton.3 index f4cd66466..05b01edd8 100644 --- a/docs/man3/SDL_JoystickGetButton.3 +++ b/docs/man3/SDL_JoystickGetButton.3 @@ -1,4 +1,4 @@ -.TH "SDL_JoystickGetButton" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_JoystickGetButton" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_JoystickGetButton\- Get the current state of a given button on a given joystick .SH "SYNOPSIS" @@ -15,4 +15,4 @@ SDL_JoystickGetButton returns the current state of the given \fBbutton\fR on the .SH "SEE ALSO" .PP \fI\fBSDL_JoystickNumButtons\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_JoystickGetHat.3 b/docs/man3/SDL_JoystickGetHat.3 index 440f3c433..d2604f13f 100644 --- a/docs/man3/SDL_JoystickGetHat.3 +++ b/docs/man3/SDL_JoystickGetHat.3 @@ -1,4 +1,4 @@ -.TH "SDL_JoystickGetHat" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_JoystickGetHat" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_JoystickGetHat\- Get the current state of a joystick hat .SH "SYNOPSIS" @@ -33,4 +33,4 @@ The current state is returned as a Uint8 which is defined as an OR\&'d combinati .SH "SEE ALSO" .PP \fI\fBSDL_JoystickNumHats\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_JoystickIndex.3 b/docs/man3/SDL_JoystickIndex.3 index b581f4a6d..4f0968e97 100644 --- a/docs/man3/SDL_JoystickIndex.3 +++ b/docs/man3/SDL_JoystickIndex.3 @@ -1,4 +1,4 @@ -.TH "SDL_JoystickIndex" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_JoystickIndex" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_JoystickIndex\- Get the index of an SDL_Joystick\&. .SH "SYNOPSIS" @@ -15,4 +15,4 @@ Index number of the joystick\&. .SH "SEE ALSO" .PP \fI\fBSDL_JoystickOpen\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_JoystickName.3 b/docs/man3/SDL_JoystickName.3 index 5f82dec74..67c96ad27 100644 --- a/docs/man3/SDL_JoystickName.3 +++ b/docs/man3/SDL_JoystickName.3 @@ -1,4 +1,4 @@ -.TH "SDL_JoystickName" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_JoystickName" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_JoystickName\- Get joystick name\&. .SH "SYNOPSIS" @@ -29,4 +29,4 @@ for(i=0;i0){ .SH "SEE ALSO" .PP \fI\fBSDL_JoystickClose\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_JoystickOpened.3 b/docs/man3/SDL_JoystickOpened.3 index 1c35fc90b..48a7ce1e9 100644 --- a/docs/man3/SDL_JoystickOpened.3 +++ b/docs/man3/SDL_JoystickOpened.3 @@ -1,4 +1,4 @@ -.TH "SDL_JoystickOpened" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_JoystickOpened" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_JoystickOpened\- Determine if a joystick has been opened .SH "SYNOPSIS" @@ -15,4 +15,4 @@ Returns \fB1\fR if the joystick has been opened, or \fB0\fR if it has not\&. .SH "SEE ALSO" .PP \fI\fBSDL_JoystickOpen\fP\fR, \fI\fBSDL_JoystickClose\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_JoystickUpdate.3 b/docs/man3/SDL_JoystickUpdate.3 index 8b05a6acc..f42009aa9 100644 --- a/docs/man3/SDL_JoystickUpdate.3 +++ b/docs/man3/SDL_JoystickUpdate.3 @@ -1,4 +1,4 @@ -.TH "SDL_JoystickUpdate" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_JoystickUpdate" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_JoystickUpdate\- Updates the state of all joysticks .SH "SYNOPSIS" @@ -12,4 +12,4 @@ Updates the state(position, buttons, etc\&.) of all open joysticks\&. If joystic .SH "SEE ALSO" .PP \fI\fBSDL_JoystickEventState\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_KeyboardEvent.3 b/docs/man3/SDL_KeyboardEvent.3 index 893101594..521f95b37 100644 --- a/docs/man3/SDL_KeyboardEvent.3 +++ b/docs/man3/SDL_KeyboardEvent.3 @@ -1,4 +1,4 @@ -.TH "SDL_KeyboardEvent" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_KeyboardEvent" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_KeyboardEvent\- Keyboard event structure .SH "STRUCTURE DEFINITION" @@ -35,4 +35,4 @@ Repeating \fBSDL_KEYDOWN\fP events will occur if key repeat is enabled (see \fI\ .SH "SEE ALSO" .PP \fI\fBSDL_Event\fR\fR, \fI\fBSDL_keysym\fR\fR, \fI\fBSDL_EnableKeyRepeat\fP\fR, \fI\fBSDL_EnableUNICODE\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_KillThread.3 b/docs/man3/SDL_KillThread.3 index 6f04a93ec..d44cb8f81 100644 --- a/docs/man3/SDL_KillThread.3 +++ b/docs/man3/SDL_KillThread.3 @@ -1,4 +1,4 @@ -.TH "SDL_KillThread" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_KillThread" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_KillThread\- Gracelessly terminates the thread\&. .SH "SYNOPSIS" @@ -13,4 +13,4 @@ SDL_KillThread\- Gracelessly terminates the thread\&. .SH "SEE ALSO" .PP \fI\fBSDL_CreateThread\fP\fR, \fI\fBSDL_WaitThread\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_ListModes.3 b/docs/man3/SDL_ListModes.3 index 240be987e..898b8defd 100644 --- a/docs/man3/SDL_ListModes.3 +++ b/docs/man3/SDL_ListModes.3 @@ -1,4 +1,4 @@ -.TH "SDL_ListModes" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_ListModes" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_ListModes\- Returns a pointer to an array of available screen dimensions for the given format and video flags .SH "SYNOPSIS" @@ -50,4 +50,4 @@ else{ .SH "SEE ALSO" .PP \fI\fBSDL_SetVideoMode\fP\fR, \fI\fBSDL_GetVideoInfo\fP\fR, \fI\fBSDL_Rect\fR\fR, \fI\fBSDL_PixelFormat\fR\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_LoadBMP.3 b/docs/man3/SDL_LoadBMP.3 index eb2a0c562..77086d280 100644 --- a/docs/man3/SDL_LoadBMP.3 +++ b/docs/man3/SDL_LoadBMP.3 @@ -1,4 +1,4 @@ -.TH "SDL_LoadBMP" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_LoadBMP" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_LoadBMP\- Load a Windows BMP file into an SDL_Surface\&. .SH "SYNOPSIS" @@ -15,4 +15,4 @@ Returns the new surface, or \fBNULL\fP if there was an error\&. .SH "SEE ALSO" .PP \fI\fBSDL_SaveBMP\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_LoadWAV.3 b/docs/man3/SDL_LoadWAV.3 index 0f0c9dd62..330abfc74 100644 --- a/docs/man3/SDL_LoadWAV.3 +++ b/docs/man3/SDL_LoadWAV.3 @@ -1,4 +1,4 @@ -.TH "SDL_LoadWAV" "3" "Mon 12 Mar 2001, 01:02" "SDL" "SDL API Reference" +.TH "SDL_LoadWAV" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_LoadWAV\- Load a WAVE file .SH "SYNOPSIS" @@ -39,4 +39,4 @@ SDL_FreeWAV(wav_buffer);\fR .SH "SEE ALSO" .PP \fI\fBSDL_AudioSpec\fR\fR, \fI\fBSDL_OpenAudio\fP\fR, \fI\fBSDL_FreeWAV\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:02 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_LockAudio.3 b/docs/man3/SDL_LockAudio.3 index f8ecab40f..47f46f2f2 100644 --- a/docs/man3/SDL_LockAudio.3 +++ b/docs/man3/SDL_LockAudio.3 @@ -1,4 +1,4 @@ -.TH "SDL_LockAudio" "3" "Mon 12 Mar 2001, 01:02" "SDL" "SDL API Reference" +.TH "SDL_LockAudio" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_LockAudio\- Lock out the callback function .SH "SYNOPSIS" @@ -12,4 +12,4 @@ The lock manipulated by these functions protects the callback function\&. During .SH "SEE ALSO" .PP \fI\fBSDL_OpenAudio\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:02 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_LockSurface.3 b/docs/man3/SDL_LockSurface.3 index e1a03a37d..25e885af1 100644 --- a/docs/man3/SDL_LockSurface.3 +++ b/docs/man3/SDL_LockSurface.3 @@ -1,4 +1,4 @@ -.TH "SDL_LockSurface" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_LockSurface" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_LockSurface\- Lock a surface for directly access\&. .SH "SYNOPSIS" @@ -46,4 +46,4 @@ It should be noted, that since SDL 1\&.1\&.8 surface locks are recursive\&. This .SH "SEE ALSO" .PP \fI\fBSDL_UnlockSurface\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_LockYUVOverlay.3 b/docs/man3/SDL_LockYUVOverlay.3 index 42d477729..8359deb66 100644 --- a/docs/man3/SDL_LockYUVOverlay.3 +++ b/docs/man3/SDL_LockYUVOverlay.3 @@ -1,4 +1,4 @@ -.TH "SDL_LockYUVOverlay" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_LockYUVOverlay" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_LockYUVOverlay\- Lock an overlay .SH "SYNOPSIS" @@ -15,4 +15,4 @@ Returns \fB0\fR on success, or \fB-1\fR on an error\&. .SH "SEE ALSO" .PP \fI\fBSDL_UnlockYUVOverlay\fP\fR, \fI\fBSDL_CreateYUVOverlay\fP\fR, \fI\fBSDL_Overlay\fR\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_MapRGB.3 b/docs/man3/SDL_MapRGB.3 index 2416f3c8c..f7ea74bf5 100644 --- a/docs/man3/SDL_MapRGB.3 +++ b/docs/man3/SDL_MapRGB.3 @@ -1,4 +1,4 @@ -.TH "SDL_MapRGB" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_MapRGB" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_MapRGB\- Map a RGB color value to a pixel format\&. .SH "SYNOPSIS" @@ -19,4 +19,4 @@ A pixel value best approximating the given RGB color value for a given pixel for .SH "SEE ALSO" .PP \fI\fBSDL_GetRGB\fP\fR, \fI\fBSDL_GetRGBA\fP\fR, \fI\fBSDL_MapRGBA\fP\fR, \fI\fBSDL_PixelFormat\fR\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_MapRGBA.3 b/docs/man3/SDL_MapRGBA.3 index cc4da83d5..e6cf89761 100644 --- a/docs/man3/SDL_MapRGBA.3 +++ b/docs/man3/SDL_MapRGBA.3 @@ -1,4 +1,4 @@ -.TH "SDL_MapRGBA" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_MapRGBA" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_MapRGBA\- Map a RGBA color value to a pixel format\&. .SH "SYNOPSIS" @@ -19,4 +19,4 @@ A pixel value best approximating the given RGBA color value for a given pixel fo .SH "SEE ALSO" .PP \fISDL_GetRGB\fR, \fISDL_GetRGBA\fR, \fISDL_MapRGB\fR, \fISDL_PixelFormat\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_MixAudio.3 b/docs/man3/SDL_MixAudio.3 index 23f422d31..3d97bbe3b 100644 --- a/docs/man3/SDL_MixAudio.3 +++ b/docs/man3/SDL_MixAudio.3 @@ -1,4 +1,4 @@ -.TH "SDL_MixAudio" "3" "Mon 12 Mar 2001, 01:02" "SDL" "SDL API Reference" +.TH "SDL_MixAudio" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_MixAudio\- Mix audio data .SH "SYNOPSIS" @@ -8,8 +8,8 @@ SDL_MixAudio\- Mix audio data \fBvoid \fBSDL_MixAudio\fP\fR(\fBUint8 *dst, Uint8 *src, Uint32 len, int volume\fR); .SH "DESCRIPTION" .PP -This takes two audio buffers of the playing audio format and mixes them, performing addition, volume adjustment, and overflow clipping\&. The \fBvolume\fR ranges from 0 - 128, and should be set to \fBSDL_MIX_MAXVOLUME\fP for full audio volume\&. Note this does not change hardware volume\&. This is provided for convenience -- you can mix your own audio data\&. +This function takes two audio buffers of \fBlen\fR bytes each of the playing audio format and mixes them, performing addition, volume adjustment, and overflow clipping\&. The \fBvolume\fR ranges from 0 to \fBSDL_MIX_MAXVOLUME\fP and should be set to the maximum value for full audio volume\&. Note this does not change hardware volume\&. This is provided for convenience -- you can mix your own audio data\&. .SH "SEE ALSO" .PP \fI\fBSDL_OpenAudio\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:02 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_MouseButtonEvent.3 b/docs/man3/SDL_MouseButtonEvent.3 index 91436c1b3..73a4a3c4e 100644 --- a/docs/man3/SDL_MouseButtonEvent.3 +++ b/docs/man3/SDL_MouseButtonEvent.3 @@ -1,4 +1,4 @@ -.TH "SDL_MouseButtonEvent" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_MouseButtonEvent" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_MouseButtonEvent\- Mouse button event structure .SH "STRUCTURE DEFINITION" @@ -33,4 +33,4 @@ When a mouse button press or release is detected then number of the button press .SH "SEE ALSO" .PP \fI\fBSDL_Event\fR\fR, \fI\fBSDL_MouseMotionEvent\fR\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_MouseMotionEvent.3 b/docs/man3/SDL_MouseMotionEvent.3 index f3c234658..452c00867 100644 --- a/docs/man3/SDL_MouseMotionEvent.3 +++ b/docs/man3/SDL_MouseMotionEvent.3 @@ -1,4 +1,4 @@ -.TH "SDL_MouseMotionEvent" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_MouseMotionEvent" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_MouseMotionEvent\- Mouse motion event structure .SH "STRUCTURE DEFINITION" @@ -35,4 +35,4 @@ If the cursor is hidden (\fI\fBSDL_ShowCursor\fP(0)\fR) and the input is grabbed .SH "SEE ALSO" .PP \fI\fBSDL_Event\fR\fR, \fI\fBSDL_MouseButtonEvent\fR\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_NumJoysticks.3 b/docs/man3/SDL_NumJoysticks.3 index e0730131d..47cf0b327 100644 --- a/docs/man3/SDL_NumJoysticks.3 +++ b/docs/man3/SDL_NumJoysticks.3 @@ -1,4 +1,4 @@ -.TH "SDL_NumJoysticks" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_NumJoysticks" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_NumJoysticks\- Count available joysticks\&. .SH "SYNOPSIS" @@ -15,4 +15,4 @@ Returns the number of attached joysticks .SH "SEE ALSO" .PP \fI\fBSDL_JoystickName\fP\fR, \fI\fBSDL_JoystickOpen\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_OpenAudio.3 b/docs/man3/SDL_OpenAudio.3 index 8d3777724..2b1b25201 100644 --- a/docs/man3/SDL_OpenAudio.3 +++ b/docs/man3/SDL_OpenAudio.3 @@ -1,4 +1,4 @@ -.TH "SDL_OpenAudio" "3" "Mon 12 Mar 2001, 01:02" "SDL" "SDL API Reference" +.TH "SDL_OpenAudio" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_OpenAudio\- Opens the audio device with the desired parameters\&. .SH "SYNOPSIS" @@ -91,4 +91,4 @@ SDL_PauseAudio(0);\fR .SH "SEE ALSO" .PP \fI\fBSDL_AudioSpec\fP\fR, \fI\fBSDL_LockAudio\fP\fR, \fI\fBSDL_UnlockAudio\fP\fR, \fI\fBSDL_PauseAudio\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:02 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_Overlay.3 b/docs/man3/SDL_Overlay.3 index dec707761..c98f1423c 100644 --- a/docs/man3/SDL_Overlay.3 +++ b/docs/man3/SDL_Overlay.3 @@ -1,4 +1,4 @@ -.TH "SDL_Overlay" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_Overlay" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_Overlay\- YUV video overlay .SH "STRUCTURE DEFINITION" @@ -49,4 +49,4 @@ A \fBSDL_Overlay\fR is similar to a \fI\fBSDL_Surface\fR\fR except it stores a Y .SH "SEE ALSO" .PP \fI\fBSDL_CreateYUVOverlay\fP\fR, \fI\fBSDL_LockYUVOverlay\fP\fR, \fI\fBSDL_UnlockYUVOverlay\fP\fR, \fI\fBSDL_FreeYUVOverlay\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_Palette.3 b/docs/man3/SDL_Palette.3 index 6cb40358a..182ef0818 100644 --- a/docs/man3/SDL_Palette.3 +++ b/docs/man3/SDL_Palette.3 @@ -1,4 +1,4 @@ -.TH "SDL_Palette" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_Palette" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_Palette\- Color palette for 8-bit pixel formats .SH "STRUCTURE DEFINITION" @@ -23,4 +23,4 @@ Each pixel in an 8-bit surface is an index into the \fBcolors\fR field of the \f .SH "SEE ALSO" .PP \fI\fBSDL_Color\fR\fR, \fI\fBSDL_Surface\fR\fR, \fI\fBSDL_SetColors\fP\fR \fI\fBSDL_SetPalette\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_PauseAudio.3 b/docs/man3/SDL_PauseAudio.3 index d16920d82..e4be0d619 100644 --- a/docs/man3/SDL_PauseAudio.3 +++ b/docs/man3/SDL_PauseAudio.3 @@ -1,4 +1,4 @@ -.TH "SDL_PauseAudio" "3" "Mon 12 Mar 2001, 01:02" "SDL" "SDL API Reference" +.TH "SDL_PauseAudio" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_PauseAudio\- Pauses and unpauses the audio callback processing .SH "SYNOPSIS" @@ -12,4 +12,4 @@ This function pauses and unpauses the audio callback processing\&. It should be .SH "SEE ALSO" .PP \fI\fBSDL_GetAudioStatus\fP\fR, \fI\fBSDL_OpenAudio\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:02 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_PeepEvents.3 b/docs/man3/SDL_PeepEvents.3 index 451a3061e..e683ac82b 100644 --- a/docs/man3/SDL_PeepEvents.3 +++ b/docs/man3/SDL_PeepEvents.3 @@ -1,4 +1,4 @@ -.TH "SDL_PeepEvents" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_PeepEvents" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_PeepEvents\- Checks the event queue for messages and optionally returns them\&. .SH "SYNOPSIS" @@ -23,4 +23,4 @@ This function returns the number of events actually stored, or \fB-1\fR if there .SH "SEE ALSO" .PP \fI\fBSDL_Event\fR\fR, \fI\fBSDL_PollEvent\fP\fR, \fI\fBSDL_PushEvent\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_PixelFormat.3 b/docs/man3/SDL_PixelFormat.3 index b9a3af760..1cc246a0e 100644 --- a/docs/man3/SDL_PixelFormat.3 +++ b/docs/man3/SDL_PixelFormat.3 @@ -1,4 +1,4 @@ -.TH "SDL_PixelFormat" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_PixelFormat" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_PixelFormat\- Stores surface format information .SH "STRUCTURE DEFINITION" @@ -87,7 +87,7 @@ printf("Pixel Color-> Red: %d, Green: %d, Blue: %d\&. Index: %d .fi .PP .PP -Pixel formats above 8-bit are an entirely different experience\&. They are considered to be "TrueColor" formats and the color information is stored in the pixels themselves, not in a palette (packed-pixel)\&. The mask, shift and loss fields tell us how the color information is encoded\&. The mask fields allow us to isolate each color component, the shift fields tell us how far left we have to shift the masked value and the loss fields tell us for far right we have to shift the final value to convert it to a full 8-bit color component\&. +Pixel formats above 8-bit are an entirely different experience\&. They are considered to be "TrueColor" formats and the color information is stored in the pixels themselves, not in a palette\&. The mask, shift and loss fields tell us how the color information is encoded\&. The mask fields allow us to isolate each color component, the shift fields tell us the number of bits to the right of each component in the pixel value and the loss fields tell us the number of bits lost from each component when packing 8-bit color component in a pixel\&. .PP .nf \f(CW/* Extracting color components from a 32-bit color value */ @@ -100,7 +100,7 @@ Uint8 red, green, blue, alpha; \&. fmt=surface->format; SDL_LockSurface(surface); -pixel=(Uint32*)surface->pixels; +pixel=*((Uint32*)surface->pixels); SDL_UnlockSurface(surface); /* Get Red component */ @@ -137,4 +137,4 @@ printf("Pixel Color -> R: %d, G: %d, B: %d, A: %d .SH "SEE ALSO" .PP \fI\fBSDL_Surface\fR\fR, \fI\fBSDL_MapRGB\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_PollEvent.3 b/docs/man3/SDL_PollEvent.3 index b66b59699..830b610b6 100644 --- a/docs/man3/SDL_PollEvent.3 +++ b/docs/man3/SDL_PollEvent.3 @@ -1,4 +1,4 @@ -.TH "SDL_PollEvent" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_PollEvent" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_PollEvent\- Polls for currently pending events\&. .SH "SYNOPSIS" @@ -41,4 +41,4 @@ while(SDL_PollEvent(&event)){ /* Loop until there are no events left on the que .SH "SEE ALSO" .PP \fI\fBSDL_Event\fR\fR, \fI\fBSDL_WaitEvent\fP\fR, \fI\fBSDL_PeepEvents\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_PumpEvents.3 b/docs/man3/SDL_PumpEvents.3 index 9d63aa428..d9309147f 100644 --- a/docs/man3/SDL_PumpEvents.3 +++ b/docs/man3/SDL_PumpEvents.3 @@ -1,4 +1,4 @@ -.TH "SDL_PumpEvents" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_PumpEvents" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_PumpEvents\- Pumps the event loop, gathering events from the input devices\&. .SH "SYNOPSIS" @@ -20,4 +20,4 @@ You can only call this function in the thread that set the video mode\&. .SH "SEE ALSO" .PP \fI\fBSDL_PollEvent\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_PushEvent.3 b/docs/man3/SDL_PushEvent.3 index 0c68cca20..b43d4e66f 100644 --- a/docs/man3/SDL_PushEvent.3 +++ b/docs/man3/SDL_PushEvent.3 @@ -1,4 +1,4 @@ -.TH "SDL_PushEvent" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_PushEvent" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_PushEvent\- Pushes an event onto the event queue .SH "SYNOPSIS" @@ -24,4 +24,4 @@ See \fI\fBSDL_Event\fR\fR\&. .SH "SEE ALSO" .PP \fI\fBSDL_PollEvent\fP\fR, \fI\fBSDL_PeepEvents\fP\fR, \fI\fBSDL_Event\fR\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_Quit.3 b/docs/man3/SDL_Quit.3 index 3f47ea3b5..487b42b77 100644 --- a/docs/man3/SDL_Quit.3 +++ b/docs/man3/SDL_Quit.3 @@ -1,4 +1,4 @@ -.TH "SDL_Quit" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_Quit" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_Quit\- Shut down SDL .SH "SYNOPSIS" @@ -26,4 +26,4 @@ While using \fBatexit\fP maybe be fine for small programs, more advanced users s .SH "SEE ALSO" .PP \fI\fBSDL_QuitSubsystem\fP\fR, \fI\fBSDL_Init\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_QuitEvent.3 b/docs/man3/SDL_QuitEvent.3 index 910653c16..e849a14e5 100644 --- a/docs/man3/SDL_QuitEvent.3 +++ b/docs/man3/SDL_QuitEvent.3 @@ -1,4 +1,4 @@ -.TH "SDL_QuitEvent" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_QuitEvent" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_QuitEvent\- Quit requested event .SH "STRUCTURE DEFINITION" @@ -27,4 +27,4 @@ The macro \fBSDL_QuitRequested\fP will return non-zero if a quit event is pendin .SH "SEE ALSO" .PP \fI\fBSDL_Event\fR\fR, \fI\fBSDL_SetEventFilter\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_QuitSubSystem.3 b/docs/man3/SDL_QuitSubSystem.3 index a2551a7aa..1ba643376 100644 --- a/docs/man3/SDL_QuitSubSystem.3 +++ b/docs/man3/SDL_QuitSubSystem.3 @@ -1,4 +1,4 @@ -.TH "SDL_QuitSubSystem" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_QuitSubSystem" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_QuitSubSystem\- Shut down a subsystem .SH "SYNOPSIS" @@ -12,4 +12,4 @@ SDL_QuitSubSystem\- Shut down a subsystem .SH "SEE ALSO" .PP \fI\fBSDL_Quit\fP\fR, \fI\fBSDL_Init\fP\fR, \fI\fBSDL_InitSubSystem\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_RWFromFile.3 b/docs/man3/SDL_RWFromFile.3 index 55d2724de..2168baa48 100644 --- a/docs/man3/SDL_RWFromFile.3 +++ b/docs/man3/SDL_RWFromFile.3 @@ -1,4 +1,4 @@ -.TH "SDL_FunctionName" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_FunctionName" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_FunctionName\- Short description of function .SH "SYNOPSIS" @@ -15,4 +15,4 @@ examples here .SH "SEE ALSO" .PP \fISDL_AnotherFunction\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_Rect.3 b/docs/man3/SDL_Rect.3 index fc5ee55f3..59ffa81f9 100644 --- a/docs/man3/SDL_Rect.3 +++ b/docs/man3/SDL_Rect.3 @@ -1,4 +1,4 @@ -.TH "SDL_Rect" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_Rect" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_Rect\- Defines a rectangular area .SH "STRUCTURE DEFINITION" @@ -23,4 +23,4 @@ A \fBSDL_Rect\fR defines a rectangular area of pixels\&. It is used by \fI\fBSDL .SH "SEE ALSO" .PP \fI\fBSDL_BlitSurface\fP\fR, \fI\fBSDL_UpdateRect\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_RemoveTimer.3 b/docs/man3/SDL_RemoveTimer.3 index 7744b126f..842c69e94 100644 --- a/docs/man3/SDL_RemoveTimer.3 +++ b/docs/man3/SDL_RemoveTimer.3 @@ -1,4 +1,4 @@ -.TH "SDL_RemoveTimer" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_RemoveTimer" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_RemoveTimer\- Remove a timer which was added with \fISDL_AddTimer\fR\&. .SH "SYNOPSIS" @@ -22,4 +22,4 @@ Returns a boolean value indicating success\&. .SH "SEE ALSO" .PP \fI\fBSDL_AddTimer\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_ResizeEvent.3 b/docs/man3/SDL_ResizeEvent.3 index 1a7c4357d..0011c5848 100644 --- a/docs/man3/SDL_ResizeEvent.3 +++ b/docs/man3/SDL_ResizeEvent.3 @@ -1,4 +1,4 @@ -.TH "SDL_ResizeEvent" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_ResizeEvent" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_ResizeEvent\- Window resize event structure .SH "STRUCTURE DEFINITION" @@ -25,4 +25,4 @@ When \fBSDL_RESIZABLE\fP is passed as a \fBflag\fR to \fI\fBSDL_SetVideoMode\fP\ .SH "SEE ALSO" .PP \fI\fBSDL_Event\fR\fR, \fI\fBSDL_SetVideoMode\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_SaveBMP.3 b/docs/man3/SDL_SaveBMP.3 index aff6e632a..d153e4489 100644 --- a/docs/man3/SDL_SaveBMP.3 +++ b/docs/man3/SDL_SaveBMP.3 @@ -1,4 +1,4 @@ -.TH "SDL_SaveBMP" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_SaveBMP" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_SaveBMP\- Save an SDL_Surface as a Windows BMP file\&. .SH "SYNOPSIS" @@ -15,4 +15,4 @@ Returns \fB0\fR if successful or \fB-1\fR if there was an error\&. .SH "SEE ALSO" .PP \fI\fBSDL_LoadBMP\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_SemPost.3 b/docs/man3/SDL_SemPost.3 index 00827ffb6..54ffd243a 100644 --- a/docs/man3/SDL_SemPost.3 +++ b/docs/man3/SDL_SemPost.3 @@ -1,4 +1,4 @@ -.TH "SDL_SemPost" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_SemPost" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_SemPost\- Unlock a semaphore\&. .SH "SYNOPSIS" @@ -25,4 +25,4 @@ Returns \fB0\fR if successful or \fB-1\fR if there was an error (leaving the sem .SH "SEE ALSO" .PP \fI\fBSDL_CreateSemaphore\fP\fR, \fI\fBSDL_DestroySemaphore\fP\fR, \fI\fBSDL_SemWait\fP\fR, \fI\fBSDL_SemTryWait\fP\fR, \fI\fBSDL_SemWaitTimeout\fP\fR, \fI\fBSDL_SemValue\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_SemTryWait.3 b/docs/man3/SDL_SemTryWait.3 index 24be3ba3d..c45b2079c 100644 --- a/docs/man3/SDL_SemTryWait.3 +++ b/docs/man3/SDL_SemTryWait.3 @@ -1,4 +1,4 @@ -.TH "SDL_SemTryWait" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_SemTryWait" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_SemTryWait\- Attempt to lock a semaphore but don\&'t suspend the thread\&. .SH "SYNOPSIS" @@ -38,4 +38,4 @@ SDL_SemPost(my_sem);\fR .SH "SEE ALSO" .PP \fI\fBSDL_CreateSemaphore\fP\fR, \fI\fBSDL_DestroySemaphore\fP\fR, \fI\fBSDL_SemWait\fP\fR, \fI\fBSDL_SemWaitTimeout\fP\fR, \fI\fBSDL_SemPost\fP\fR, \fI\fBSDL_SemValue\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_SemValue.3 b/docs/man3/SDL_SemValue.3 index 3b850d91b..8805f4e5a 100644 --- a/docs/man3/SDL_SemValue.3 +++ b/docs/man3/SDL_SemValue.3 @@ -1,4 +1,4 @@ -.TH "SDL_SemValue" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_SemValue" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_SemValue\- Return the current value of a semaphore\&. .SH "SYNOPSIS" @@ -23,4 +23,4 @@ Returns current value of the semaphore\&. .SH "SEE ALSO" .PP \fI\fBSDL_CreateSemaphore\fP\fR, \fI\fBSDL_DestroySemaphore\fP\fR, \fI\fBSDL_SemWait\fP\fR, \fI\fBSDL_SemTryWait\fP\fR, \fI\fBSDL_SemWaitTimeout\fP\fR, \fI\fBSDL_SemPost\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_SemWait.3 b/docs/man3/SDL_SemWait.3 index e37dcb284..d1d8ab12f 100644 --- a/docs/man3/SDL_SemWait.3 +++ b/docs/man3/SDL_SemWait.3 @@ -1,4 +1,4 @@ -.TH "SDL_SemWait" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_SemWait" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_SemWait\- Lock a semaphore and suspend the thread if the semaphore value is zero\&. .SH "SYNOPSIS" @@ -31,4 +31,4 @@ SDL_SemPost(my_sem);\fR .SH "SEE ALSO" .PP \fI\fBSDL_CreateSemaphore\fP\fR, \fI\fBSDL_DestroySemaphore\fP\fR, \fI\fBSDL_SemTryWait\fP\fR, \fI\fBSDL_SemWaitTimeout\fP\fR, \fI\fBSDL_SemPost\fP\fR, \fI\fBSDL_SemValue\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_SemWaitTimeout.3 b/docs/man3/SDL_SemWaitTimeout.3 index aa0f77888..c761fecb0 100644 --- a/docs/man3/SDL_SemWaitTimeout.3 +++ b/docs/man3/SDL_SemWaitTimeout.3 @@ -1,4 +1,4 @@ -.TH "SDL_SemWaitTimeout" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_SemWaitTimeout" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_SemWaitTimeout\- Lock a semaphore, but only wait up to a specified maximum time\&. .SH "SYNOPSIS" @@ -38,4 +38,4 @@ SDL_SemPost(my_sem);\fR .SH "SEE ALSO" .PP \fI\fBSDL_CreateSemaphore\fP\fR, \fI\fBSDL_DestroySemaphore\fP\fR, \fI\fBSDL_SemWait\fP\fR, \fI\fBSDL_SemTryWait\fP\fR, \fI\fBSDL_SemPost\fP\fR, \fI\fBSDL_SemValue\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_SetAlpha.3 b/docs/man3/SDL_SetAlpha.3 index 1e30ab980..afb7a5b18 100644 --- a/docs/man3/SDL_SetAlpha.3 +++ b/docs/man3/SDL_SetAlpha.3 @@ -1,4 +1,4 @@ -.TH "SDL_SetAlpha" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_SetAlpha" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_SetAlpha\- Adjust the alpha properties of a surface .SH "SYNOPSIS" @@ -14,9 +14,9 @@ SDL_SetAlpha\- Adjust the alpha properties of a surface This function and the semantics of SDL alpha blending have changed since version 1\&.1\&.4\&. Up until version 1\&.1\&.5, an alpha value of 0 was considered opaque and a value of 255 was considered transparent\&. This has now been inverted: 0 (\fBSDL_ALPHA_TRANSPARENT\fP) is now considered transparent and 255 (\fBSDL_ALPHA_OPAQUE\fP) is now considered opaque\&. .RE .PP -\fBSDL_SetAlpha\fP is used for setting the per-surface alpha and/or enabling and disabling per-pixel alpha blending\&. +\fBSDL_SetAlpha\fP is used for setting the per-surface alpha value and/or enabling and disabling alpha blending\&. .PP -The \fBsurface\fR parameter specifies which surface whose alpha attributes you wish to adjust\&. \fBflags\fR is used to specify whether alpha blending should be used (\fBSDL_SRCALPHA\fP) and whether the surface should use RLE acceleration for blitting (\fBSDL_RLEACCEL\fP)\&. \fBflags\fR can be an OR\&'d combination of these two options, one of these options or 0\&. If \fBSDL_SRCALPHA\fP is not passed as a flag then all alpha information is ignored when blitting the surface\&. The \fBalpha\fR parameter is the per-surface alpha value, a surface need not have an alpha channel to use per-surface alpha and blitting can still be accelerated with \fBSDL_RLEACCEL\fP\&. Setting the per-surface alpha value to 0 disables per-surface alpha blending\&. +The\fBsurface\fR parameter specifies which surface whose alpha attributes you wish to adjust\&. \fBflags\fR is used to specify whether alpha blending should be used (\fBSDL_SRCALPHA\fP) and whether the surface should use RLE acceleration for blitting (\fBSDL_RLEACCEL\fP)\&. \fBflags\fR can be an OR\&'d combination of these two options, one of these options or 0\&. If \fBSDL_SRCALPHA\fP is not passed as a flag then all alpha information is ignored when blitting the surface\&. The \fBalpha\fR parameter is the per-surface alpha value; a surface need not have an alpha channel to use per-surface alpha and blitting can still be accelerated with \fBSDL_RLEACCEL\fP\&. .PP .RS \fBNote: @@ -33,10 +33,10 @@ RGBA->RGB without \fBSDL_SRCALPHA\fP The RGB data is copied from the source\&. The source alpha channel and the per-surface alpha value are ignored\&. .TP 20 RGB->RGBA with \fBSDL_SRCALPHA\fP -The source is alpha-blended with the destination using the per-surface alpha value\&. If \fBSDL_SRCCOLORKEY\fPliteral> is set, only the pixels not matching the colorkey value are copied\&. +The source is alpha-blended with the destination using the per-surface alpha value\&. If \fBSDL_SRCCOLORKEY\fP is set, only the pixels not matching the colorkey value are copied\&. The alpha channel of the copied pixels is set to opaque\&. .TP 20 RGB->RGBA without \fBSDL_SRCALPHA\fP -The RGB data is copied from the source and the destination alpha is zero to opaque\&. If \fBSDL_SRCCOLORKEY\fP is set, only the pixels not matching the colorkey value are copied\&. +The RGB data is copied from the source and the alpha value of the copied pixels is set to opaque\&. If \fBSDL_SRCCOLORKEY\fP is set, only the pixels not matching the colorkey value are copied\&. .TP 20 RGBA->RGBA with \fBSDL_SRCALPHA\fP The source is alpha-blended with the destination using the source alpha channel\&. The alpha channel in the destination surface is left untouched\&. \fBSDL_SRCCOLORKEY\fP is ignored\&. @@ -49,7 +49,18 @@ The source is alpha-blended with the destination using the per-surface alpha val .TP 20 RGB->RGB without \fBSDL_SRCALPHA\fP The RGB data is copied from the source\&. If \fBSDL_SRCCOLORKEY\fP is set, only the pixels not matching the colorkey value are copied\&. +.PP +.RS +\fBNote: +.PP + Note that RGBA->RGBA blits (with SDL_SRCALPHA set) keep the alpha of the destination surface\&. This means that you cannot compose two arbitrary RGBA surfaces this way and get the result you would expect from "overlaying" them; the destination alpha will work as a mask\&. +.PP +Also note that per-pixel and per-surface alpha cannot be combined; the per-pixel alpha is always used if available +.RE +.SH "RETURN VALUE" +.PP +This function returns \fB0\fR, or \fB-1\fR if there was an error\&. .SH "SEE ALSO" .PP \fI\fBSDL_MapRGBA\fP\fR, \fI\fBSDL_GetRGBA\fP\fR, \fI\fBSDL_DisplayFormatAlpha\fP\fR, \fI\fBSDL_BlitSurface\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_SetClipRect.3 b/docs/man3/SDL_SetClipRect.3 index 40b238ab4..85c7a4e80 100644 --- a/docs/man3/SDL_SetClipRect.3 +++ b/docs/man3/SDL_SetClipRect.3 @@ -1,4 +1,4 @@ -.TH "SDL_SetClipRect" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_SetClipRect" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_SetClipRect\- Sets the clipping rectangle for a surface\&. .SH "SYNOPSIS" @@ -16,4 +16,4 @@ If \fBrect\fR is \fBNULL\fP the clipping rectangle will be set to the full size .SH "SEE ALSO" .PP \fI\fBSDL_GetClipRect\fP\fR, \fI\fBSDL_BlitSurface\fP\fR, \fI\fBSDL_Surface\fR\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_SetColorKey.3 b/docs/man3/SDL_SetColorKey.3 index 61f13f45f..40e0e9ed5 100644 --- a/docs/man3/SDL_SetColorKey.3 +++ b/docs/man3/SDL_SetColorKey.3 @@ -1,4 +1,4 @@ -.TH "SDL_SetColorKey" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_SetColorKey" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_SetColorKey\- Sets the color key (transparent pixel) in a blittable surface and RLE acceleration\&. .SH "SYNOPSIS" @@ -23,4 +23,4 @@ This function returns \fB0\fR, or \fB-1\fR if there was an error\&. .SH "SEE ALSO" .PP \fI\fBSDL_BlitSurface\fP\fR, \fI\fBSDL_DisplayFormat\fP\fR, \fI\fBSDL_MapRGB\fP\fR, \fI\fBSDL_SetAlpha\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_SetColors.3 b/docs/man3/SDL_SetColors.3 index 7ce5c96c9..a5627e9c2 100644 --- a/docs/man3/SDL_SetColors.3 +++ b/docs/man3/SDL_SetColors.3 @@ -1,4 +1,4 @@ -.TH "SDL_SetColors" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_SetColors" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_SetColors\- Sets a portion of the colormap for the given 8-bit surface\&. .SH "SYNOPSIS" @@ -54,4 +54,4 @@ SDL_SetColors(screen, colors, 0, 256); .SH "SEE ALSO" .PP \fI\fBSDL_Color\fR\fR \fI\fBSDL_Surface\fR\fR, \fI\fBSDL_SetPalette\fP\fR, \fI\fBSDL_SetVideoMode\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_SetCursor.3 b/docs/man3/SDL_SetCursor.3 index e10e1907c..c30f01adf 100644 --- a/docs/man3/SDL_SetCursor.3 +++ b/docs/man3/SDL_SetCursor.3 @@ -1,4 +1,4 @@ -.TH "SDL_SetCursor" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_SetCursor" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_SetCursor\- Set the currently active mouse cursor\&. .SH "SYNOPSIS" @@ -12,4 +12,4 @@ Sets the currently active cursor to the specified one\&. If the cursor is curren .SH "SEE ALSO" .PP \fI\fBSDL_GetCursor\fP\fR, \fI\fBSDL_CreateCursor\fP\fR, \fI\fBSDL_ShowCursor\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_SetEventFilter.3 b/docs/man3/SDL_SetEventFilter.3 index 675d87c22..056c619bc 100644 --- a/docs/man3/SDL_SetEventFilter.3 +++ b/docs/man3/SDL_SetEventFilter.3 @@ -1,4 +1,4 @@ -.TH "SDL_SetEventFilter" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_SetEventFilter" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_SetEventFilter\- Sets up a filter to process all events before they are posted to the event queue\&. .SH "SYNOPSIS" @@ -32,4 +32,4 @@ Events pushed onto the queue with \fI\fBSDL_PushEvent\fP\fR or \fI\fBSDL_PeepEve .SH "SEE ALSO" .PP \fI\fBSDL_Event\fR\fR, \fI\fBSDL_GetEventFilter\fP\fR, \fI\fBSDL_PushEvent\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_SetGamma.3 b/docs/man3/SDL_SetGamma.3 index 8eca14ae2..961b45141 100644 --- a/docs/man3/SDL_SetGamma.3 +++ b/docs/man3/SDL_SetGamma.3 @@ -1,4 +1,4 @@ -.TH "SDL_SetGamma" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_SetGamma" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_SetGamma\- Sets the color gamma function for the display .SH "SYNOPSIS" @@ -19,4 +19,4 @@ Returns -1 on error (or if gamma adjustment is not supported)\&. .SH "SEE ALSO" .PP \fISDL_GetGammaRamp\fR \fISDL_SetGammaRamp\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_SetGammaRamp.3 b/docs/man3/SDL_SetGammaRamp.3 index 91431e650..473829147 100644 --- a/docs/man3/SDL_SetGammaRamp.3 +++ b/docs/man3/SDL_SetGammaRamp.3 @@ -1,4 +1,4 @@ -.TH "SDL_SetGammaRamp" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_SetGammaRamp" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_SetGammaRamp\- Sets the color gamma lookup tables for the display .SH "SYNOPSIS" @@ -19,4 +19,4 @@ Returns -1 on error (or if gamma adjustment is not supported)\&. .SH "SEE ALSO" .PP \fISDL_SetGamma\fR \fISDL_GetGammaRamp\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_SetModState.3 b/docs/man3/SDL_SetModState.3 index ec0b84bcc..66fb9b9a2 100644 --- a/docs/man3/SDL_SetModState.3 +++ b/docs/man3/SDL_SetModState.3 @@ -1,4 +1,4 @@ -.TH "SDL_SetModState" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_SetModState" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_SetModState\- Set the current key modifier state .SH "SYNOPSIS" @@ -32,4 +32,4 @@ Simply pass your desired modifier states into \fBmodstate\fR\&. This value my be .SH "SEE ALSO" .PP \fI\fBSDL_GetModState\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_SetPalette.3 b/docs/man3/SDL_SetPalette.3 index 1ecd20d7f..2710cec2d 100644 --- a/docs/man3/SDL_SetPalette.3 +++ b/docs/man3/SDL_SetPalette.3 @@ -1,11 +1,11 @@ -.TH "SDL_SetPalette" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_SetPalette" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_SetPalette\- Sets the colors in the palette of an 8-bit surface\&. .SH "SYNOPSIS" .PP \fB#include "SDL\&.h" .sp -\fBint \fBSDL_SetPalette\fP\fR(\fBSDL_Surface *surface, int flags, int SDL_Color *colors, int firstcolor, int ncolors\fR); +\fBint \fBSDL_SetPalette\fP\fR(\fBSDL_Surface *surface, int flags, SDL_Color *colors, int firstcolor, int ncolors\fR); .SH "DESCRIPTION" .PP Sets a portion of the palette for the given 8-bit surface\&. @@ -56,4 +56,4 @@ If \fBsurface\fR is not a palettized surface, this function does nothing, return .SH "SEE ALSO" .PP \fISDL_SetColors\fR, \fISDL_SetVideoMode\fR, \fISDL_Surface\fR, \fISDL_Color\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_SetTimer.3 b/docs/man3/SDL_SetTimer.3 index 2c12cfcb3..b7efb481d 100644 --- a/docs/man3/SDL_SetTimer.3 +++ b/docs/man3/SDL_SetTimer.3 @@ -1,4 +1,4 @@ -.TH "SDL_SetTimer" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_SetTimer" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_SetTimer\- Set a callback to run after the specified number of milliseconds has elapsed\&. .SH "SYNOPSIS" @@ -24,7 +24,7 @@ If you use this function, you need to pass \fBSDL_INIT_TIMER\fP to \fBSDL_Init() .RS \fBNote: .PP -This function is kept for compatibility but has been superceeded by the new timer functions \fISDL_AddTimer\fR and \fISDL_RemoveTimer\fR which support multiple timers\&. +This function is kept for compatibility but has been superseded by the new timer functions \fISDL_AddTimer\fR and \fISDL_RemoveTimer\fR which support multiple timers\&. .RE .SH "EXAMPLES" .PP @@ -36,4 +36,4 @@ This function is kept for compatibility but has been superceeded by the new time .SH "SEE ALSO" .PP \fI\fBSDL_AddTimer\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_SetVideoMode.3 b/docs/man3/SDL_SetVideoMode.3 index a770d28b0..24e407c97 100644 --- a/docs/man3/SDL_SetVideoMode.3 +++ b/docs/man3/SDL_SetVideoMode.3 @@ -1,4 +1,4 @@ -.TH "SDL_SetVideoMode" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_SetVideoMode" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_SetVideoMode\- Set up a video mode with the specified width, height and bits-per-pixel\&. .SH "SYNOPSIS" @@ -30,7 +30,7 @@ Normally, if a video surface of the requested depth (\fBbpp\fR) is not available Give SDL exclusive palette access\&. Without this flag you may not always get the the colors you request with \fI\fBSDL_SetColors\fP\fR\&. .TP 20 \fBSDL_DOUBLEBUF\fP -Enable double buffering\&. Calling \fI\fBSDL_Flip\fP\fR will flip the buffers and update the screen\&. If double buffering could not be enabled then \fBSDL_Flip\fP will just perform a \fI\fBSDL_UpdateRect\fP\fR on the entire screen\&. +Enable double buffering; only valid with SDL_HWSURFACE\&. Calling \fI\fBSDL_Flip\fP\fR will flip the buffers and update the screen\&. If double buffering could not be enabled then \fBSDL_Flip\fP will just perform a \fI\fBSDL_UpdateRect\fP\fR on the entire screen\&. .TP 20 \fBSDL_FULLSCREEN\fP SDL will attempt to use a fullscreen mode @@ -58,4 +58,4 @@ The framebuffer surface, or \fBNULL\fR if it fails\&. .SH "SEE ALSO" .PP \fI\fBSDL_LockSurface\fP\fR, \fI\fBSDL_SetColors\fP\fR, \fI\fBSDL_Flip\fP\fR, \fI\fBSDL_Surface\fR\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_ShowCursor.3 b/docs/man3/SDL_ShowCursor.3 index c6de668e3..ea2ed5eff 100644 --- a/docs/man3/SDL_ShowCursor.3 +++ b/docs/man3/SDL_ShowCursor.3 @@ -1,4 +1,4 @@ -.TH "SDL_ShowCursor" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_ShowCursor" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_ShowCursor\- Toggle whether or not the cursor is shown on the screen\&. .SH "SYNOPSIS" @@ -17,4 +17,4 @@ Returns the current state of the cursor\&. .SH "SEE ALSO" .PP \fI\fBSDL_CreateCursor\fP\fR, \fI\fBSDL_SetCursor\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_Surface.3 b/docs/man3/SDL_Surface.3 index b1ca38d19..ed2c22b9f 100644 --- a/docs/man3/SDL_Surface.3 +++ b/docs/man3/SDL_Surface.3 @@ -1,4 +1,4 @@ -.TH "SDL_Surface" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_Surface" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_Surface\- Graphical Surface Structure .SH "STRUCTURE DEFINITION" @@ -10,24 +10,14 @@ SDL_Surface\- Graphical Surface Structure int w, h; /* Read-only */ Uint16 pitch; /* Read-only */ void *pixels; /* Read-write */ - int offset; /* Private */ - - /* Hardware-specific surface info */ - struct private_hwdata *hwdata; /* clipping information */ SDL_Rect clip_rect; /* Read-only */ - Uint32 unused1; /* for binary compatibility */ - Uint32 unused2; /* for binary compatibility */ - - /* info for fast blit mapping to other surfaces */ - struct SDL_BlitMap *map; /* Private */ - - /* format version, bumped at every change to invalidate blit maps */ - unsigned int format_version; /* Private */ /* Reference count -- used when freeing surface */ int refcount; /* Read-mostly */ + + /* This structure also contains private fields not shown here */ } SDL_Surface;\fR .fi .PP @@ -48,9 +38,6 @@ Length of a surface scanline in bytes \fBpixels\fR Pointer to the actual pixel data .TP 20 -\fBclip_minx, clip_maxx\fR -X clip coords -.TP 20 \fBclip_rect\fR surface clip \fIrectangle\fR .SH "DESCRIPTION" @@ -92,7 +79,7 @@ Surface is resizable (Display Surface) \fBSDL_HWACCEL\fP Surface blit uses hardware acceleration .TP 20 -\fBSDL_SRCOLORKEY\fP +\fBSDL_SRCCOLORKEY\fP Surface use colorkey blitting .TP 20 \fBSDL_RLEACCEL\fP @@ -106,4 +93,4 @@ Surface uses preallocated memory .SH "SEE ALSO" .PP \fI\fBSDL_PixelFormat\fR\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_SysWMEvent.3 b/docs/man3/SDL_SysWMEvent.3 index 97d60c118..b95124f32 100644 --- a/docs/man3/SDL_SysWMEvent.3 +++ b/docs/man3/SDL_SysWMEvent.3 @@ -1,4 +1,4 @@ -.TH "SDL_SysWMEvent" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_SysWMEvent" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_SysWMEvent\- Platform-dependent window manager event\&. .SH "DESCRIPTION" @@ -18,4 +18,4 @@ The system window manager event contains a pointer to system-specific informatio .SH "SEE ALSO" .PP \fI\fBSDL_EventState\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_ThreadID.3 b/docs/man3/SDL_ThreadID.3 index f247c1193..7418fc0b1 100644 --- a/docs/man3/SDL_ThreadID.3 +++ b/docs/man3/SDL_ThreadID.3 @@ -1,4 +1,4 @@ -.TH "SDL_ThreadID" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_ThreadID" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_ThreadID\- Get the 32-bit thread identifier for the current thread\&. .SH "SYNOPSIS" @@ -10,4 +10,4 @@ SDL_ThreadID\- Get the 32-bit thread identifier for the current thread\&. .SH "DESCRIPTION" .PP Get the 32-bit thread identifier for the current thread\&. -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_UnlockAudio.3 b/docs/man3/SDL_UnlockAudio.3 index 5f317c309..c4050c4a5 100644 --- a/docs/man3/SDL_UnlockAudio.3 +++ b/docs/man3/SDL_UnlockAudio.3 @@ -1,4 +1,4 @@ -.TH "SDL_UnlockAudio" "3" "Mon 12 Mar 2001, 01:02" "SDL" "SDL API Reference" +.TH "SDL_UnlockAudio" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_UnlockAudio\- Unlock the callback function .SH "SYNOPSIS" @@ -12,4 +12,4 @@ Unlocks a previous \fI\fBSDL_LockAudio\fP\fR call\&. .SH "SEE ALSO" .PP \fI\fBSDL_OpenAudio\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:02 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_UnlockSurface.3 b/docs/man3/SDL_UnlockSurface.3 index e645d9e18..0c68fb506 100644 --- a/docs/man3/SDL_UnlockSurface.3 +++ b/docs/man3/SDL_UnlockSurface.3 @@ -1,4 +1,4 @@ -.TH "SDL_UnlockSurface" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_UnlockSurface" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_UnlockSurface\- Unlocks a previously locked surface\&. .SH "SYNOPSIS" @@ -14,4 +14,4 @@ It should be noted that since 1\&.1\&.8, surface locks are recursive\&. See \fI\ .SH "SEE ALSO" .PP \fI\fBSDL_LockSurface\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_UnlockYUVOverlay.3 b/docs/man3/SDL_UnlockYUVOverlay.3 index 61bc97de1..782ceeaef 100644 --- a/docs/man3/SDL_UnlockYUVOverlay.3 +++ b/docs/man3/SDL_UnlockYUVOverlay.3 @@ -1,4 +1,4 @@ -.TH "SDL_UnlockYUVOverlay" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_UnlockYUVOverlay" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_UnlockYUVOverlay\- Unlock an overlay .SH "SYNOPSIS" @@ -12,4 +12,4 @@ The opposite to \fI\fBSDL_LockYUVOverlay\fP\fR\&. Unlocks a previously locked ov .SH "SEE ALSO" .PP \fI\fBSDL_UnlockYUVOverlay\fP\fR, \fI\fBSDL_CreateYUVOverlay\fP\fR, \fI\fBSDL_Overlay\fR\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_UpdateRect.3 b/docs/man3/SDL_UpdateRect.3 index 3fcec9b27..a885d8d09 100644 --- a/docs/man3/SDL_UpdateRect.3 +++ b/docs/man3/SDL_UpdateRect.3 @@ -1,4 +1,4 @@ -.TH "SDL_UpdateRect" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_UpdateRect" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_UpdateRect\- Makes sure the given area is updated on the given screen\&. .SH "SYNOPSIS" @@ -8,7 +8,7 @@ SDL_UpdateRect\- Makes sure the given area is updated on the given screen\&. \fBvoid \fBSDL_UpdateRect\fP\fR(\fBSDL_Surface *screen, Sint32 x, Sint32 y, Sint32 w, Sint32 h\fR); .SH "DESCRIPTION" .PP -Makes sure the given area is updated on the given screen\&. +Makes sure the given area is updated on the given screen\&. The rectangle must be confined within the screen boundaries (no clipping is done)\&. .PP If \&'\fBx\fR\&', \&'\fBy\fR\&', \&'\fBw\fR\&' and \&'\fBh\fR\&' are all 0, \fBSDL_UpdateRect\fP will update the entire screen\&. .PP @@ -16,4 +16,4 @@ This function should not be called while \&'\fBscreen\fR\&' is \fIlocked\fR\&. .SH "SEE ALSO" .PP \fI\fBSDL_UpdateRects\fP\fR, \fI\fBSDL_Rect\fR\fR, \fI\fBSDL_Surface\fR\fR, \fI\fBSDL_LockSurface\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_UpdateRects.3 b/docs/man3/SDL_UpdateRects.3 index f56a6200e..b4cd733e0 100644 --- a/docs/man3/SDL_UpdateRects.3 +++ b/docs/man3/SDL_UpdateRects.3 @@ -1,4 +1,4 @@ -.TH "SDL_UpdateRects" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_UpdateRects" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_UpdateRects\- Makes sure the given list of rectangles is updated on the given screen\&. .SH "SYNOPSIS" @@ -8,10 +8,18 @@ SDL_UpdateRects\- Makes sure the given list of rectangles is updated on the give \fBvoid \fBSDL_UpdateRects\fP\fR(\fBSDL_Surface *screen, int numrects, SDL_Rect *rects\fR); .SH "DESCRIPTION" .PP -Makes sure the given list of rectangles is updated on the given screen\&. +Makes sure the given list of rectangles is updated on the given screen\&. The rectangles must all be confined within the screen boundaries (no clipping is done)\&. .PP -This function should not be called while \fBscreen\fR is \fIlocked\fR\&. +This function should not be called while \fBscreen\fR is \fIlocked\fR\&. +.PP +.RS +\fBNote: +.PP +It is adviced to call this function only once per frame, since each call has some processing overhead\&. This is no restriction since you can pass any number of rectangles each time\&. +.PP +The rectangles are not automatically merged or checked for overlap\&. In general, the programmer can use his knowledge about his particular rectangles to merge them in an efficient way, to avoid overdraw\&. +.RE .SH "SEE ALSO" .PP \fI\fBSDL_UpdateRect\fP\fR, \fI\fBSDL_Rect\fR\fR, \fI\fBSDL_Surface\fR\fR, \fI\fBSDL_LockSurface\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_UserEvent.3 b/docs/man3/SDL_UserEvent.3 index 21d70f2a1..439ac4167 100644 --- a/docs/man3/SDL_UserEvent.3 +++ b/docs/man3/SDL_UserEvent.3 @@ -1,4 +1,4 @@ -.TH "SDL_UserEvent" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_UserEvent" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_UserEvent\- A user-defined event type .SH "STRUCTURE DEFINITION" @@ -44,4 +44,4 @@ SDL_PushEvent(&event);\fR .SH "SEE ALSO" .PP \fI\fBSDL_Event\fR\fR, \fI\fBSDL_PushEvent\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_VideoDriverName.3 b/docs/man3/SDL_VideoDriverName.3 index 575501af4..ca5c9617f 100644 --- a/docs/man3/SDL_VideoDriverName.3 +++ b/docs/man3/SDL_VideoDriverName.3 @@ -1,4 +1,4 @@ -.TH "SDL_VideoDriverName" "3" "Mon 12 Mar 2001, 01:05" "SDL" "SDL API Reference" +.TH "SDL_VideoDriverName" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_VideoDriverName\- Obtain the name of the video driver .SH "SYNOPSIS" @@ -15,4 +15,4 @@ Returns \fBNULL\fP if video has not been initialised with \fBSDL_Init\fP or a po .SH "SEE ALSO" .PP \fI\fBSDL_Init\fP\fR \fI\fBSDL_InitSubSystem\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:05 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_VideoInfo.3 b/docs/man3/SDL_VideoInfo.3 index e55f97a0b..ab067eab0 100644 --- a/docs/man3/SDL_VideoInfo.3 +++ b/docs/man3/SDL_VideoInfo.3 @@ -1,4 +1,4 @@ -.TH "SDL_VideoInfo" "3" "Mon 12 Mar 2001, 01:05" "SDL" "SDL API Reference" +.TH "SDL_VideoInfo" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_VideoInfo\- Video Target information .SH "STRUCTURE DEFINITION" @@ -59,4 +59,4 @@ This (read-only) structure is returned by \fI\fBSDL_GetVideoInfo\fP\fR\&. It con .SH "SEE ALSO" .PP \fI\fBSDL_PixelFormat\fR\fR, \fI\fBSDL_GetVideoInfo\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:05 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_VideoModeOK.3 b/docs/man3/SDL_VideoModeOK.3 index 2e2c50c8a..3f30e2d87 100644 --- a/docs/man3/SDL_VideoModeOK.3 +++ b/docs/man3/SDL_VideoModeOK.3 @@ -1,4 +1,4 @@ -.TH "SDL_VideoModeOK" "3" "Mon 12 Mar 2001, 01:05" "SDL" "SDL API Reference" +.TH "SDL_VideoModeOK" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_VideoModeOK\- Check to see if a particular video mode is supported\&. .SH "SYNOPSIS" @@ -41,4 +41,4 @@ screen=SDL_SetVideoMode(640, 480, bpp, SDL_HWSURFACE); .SH "SEE ALSO" .PP \fI\fBSDL_SetVideoMode\fP\fR, \fI\fBSDL_GetVideoInfo\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:05 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_WM_GetCaption.3 b/docs/man3/SDL_WM_GetCaption.3 index 829dd1968..da7fa1449 100644 --- a/docs/man3/SDL_WM_GetCaption.3 +++ b/docs/man3/SDL_WM_GetCaption.3 @@ -1,4 +1,4 @@ -.TH "SDL_WM_GetCaption" "3" "Mon 12 Mar 2001, 01:05" "SDL" "SDL API Reference" +.TH "SDL_WM_GetCaption" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_WM_GetCaption\- Gets the window title and icon name\&. .SH "SYNOPSIS" @@ -12,4 +12,4 @@ Set pointers to the window \fBtitle\fR and \fBicon\fR name\&. .SH "SEE ALSO" .PP \fI\fBSDL_WM_SetCaption\fP\fR, \fI\fBSDL_WM_SetIcon\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:05 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_WM_GrabInput.3 b/docs/man3/SDL_WM_GrabInput.3 index 4f07769d5..e9079a20e 100644 --- a/docs/man3/SDL_WM_GrabInput.3 +++ b/docs/man3/SDL_WM_GrabInput.3 @@ -1,4 +1,4 @@ -.TH "SDL_WM_GrabInput" "3" "Mon 12 Mar 2001, 01:05" "SDL" "SDL API Reference" +.TH "SDL_WM_GrabInput" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_WM_GrabInput\- Grabs mouse and keyboard input\&. .SH "SYNOPSIS" @@ -25,4 +25,4 @@ When \fBmode\fR is \fBSDL_GRAB_QUERY\fP the grab mode is not changed, but the cu .SH "RETURN VALUE" .PP The current/new \fBSDL_GrabMode\fR\&. -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:05 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_WM_IconifyWindow.3 b/docs/man3/SDL_WM_IconifyWindow.3 index f35020430..4f4146e80 100644 --- a/docs/man3/SDL_WM_IconifyWindow.3 +++ b/docs/man3/SDL_WM_IconifyWindow.3 @@ -1,4 +1,4 @@ -.TH "SDL_WM_IconifyWindow" "3" "Mon 12 Mar 2001, 01:05" "SDL" "SDL API Reference" +.TH "SDL_WM_IconifyWindow" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_WM_IconifyWindow\- Iconify/Minimise the window .SH "SYNOPSIS" @@ -12,4 +12,4 @@ If the application is running in a window managed environment SDL attempts to ic .SH "RETURN VALUE" .PP Returns non-zero on success or \fB0\fR if iconification is not support or was refused by the window manager\&. -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:05 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_WM_SetCaption.3 b/docs/man3/SDL_WM_SetCaption.3 index 758c9bc2d..0863644e8 100644 --- a/docs/man3/SDL_WM_SetCaption.3 +++ b/docs/man3/SDL_WM_SetCaption.3 @@ -1,4 +1,4 @@ -.TH "SDL_WM_SetCaption" "3" "Mon 12 Mar 2001, 01:05" "SDL" "SDL API Reference" +.TH "SDL_WM_SetCaption" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_WM_SetCaption\- Sets the window tile and icon name\&. .SH "SYNOPSIS" @@ -12,4 +12,4 @@ Sets the title-bar and icon name of the display window\&. .SH "SEE ALSO" .PP \fI\fBSDL_WM_GetCaption\fP\fR, \fI\fBSDL_WM_SetIcon\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:05 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_WM_SetIcon.3 b/docs/man3/SDL_WM_SetIcon.3 index d7f9c743d..f23f930eb 100644 --- a/docs/man3/SDL_WM_SetIcon.3 +++ b/docs/man3/SDL_WM_SetIcon.3 @@ -1,4 +1,4 @@ -.TH "SDL_WM_SetIcon" "3" "Mon 12 Mar 2001, 01:05" "SDL" "SDL API Reference" +.TH "SDL_WM_SetIcon" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_WM_SetIcon\- Sets the icon for the display window\&. .SH "SYNOPSIS" @@ -24,4 +24,4 @@ If \fBmask\fR is \fBNULL\fP, the entire icon surface will be used as the icon\&. .SH "SEE ALSO" .PP \fI\fBSDL_SetVideoMode\fP\fR, \fI\fBSDL_WM_SetCaption\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:05 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_WM_ToggleFullScreen.3 b/docs/man3/SDL_WM_ToggleFullScreen.3 index 0d1c557b3..dcf58366d 100644 --- a/docs/man3/SDL_WM_ToggleFullScreen.3 +++ b/docs/man3/SDL_WM_ToggleFullScreen.3 @@ -1,4 +1,4 @@ -.TH "SDL_WM_ToggleFullScreen" "3" "Mon 12 Mar 2001, 01:05" "SDL" "SDL API Reference" +.TH "SDL_WM_ToggleFullScreen" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_WM_ToggleFullScreen\- Toggles fullscreen mode .SH "SYNOPSIS" @@ -12,4 +12,4 @@ Toggles the application between windowed and fullscreen mode, if supported\&. (X .SH "RETURN VALUE" .PP Returns \fB0\fR on failure or \fB1\fR on success\&. -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:05 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_WaitEvent.3 b/docs/man3/SDL_WaitEvent.3 index 013f670fd..db7b841c1 100644 --- a/docs/man3/SDL_WaitEvent.3 +++ b/docs/man3/SDL_WaitEvent.3 @@ -1,4 +1,4 @@ -.TH "SDL_WaitEvent" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_WaitEvent" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_WaitEvent\- Waits indefinitely for the next available event\&. .SH "SYNOPSIS" @@ -14,4 +14,4 @@ If \fBevent\fR is not \fBNULL\fP, the next event is removed from the queue and s .SH "SEE ALSO" .PP \fI\fBSDL_Event\fR\fR, \fI\fBSDL_PollEvent\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_WaitThread.3 b/docs/man3/SDL_WaitThread.3 index 93e297b91..79fae97d8 100644 --- a/docs/man3/SDL_WaitThread.3 +++ b/docs/man3/SDL_WaitThread.3 @@ -1,4 +1,4 @@ -.TH "SDL_WaitThread" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_WaitThread" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_WaitThread\- Wait for a thread to finish\&. .SH "SYNOPSIS" @@ -16,4 +16,4 @@ The return code for the thread function is placed in the area pointed to by \fBs .SH "SEE ALSO" .PP \fI\fBSDL_CreateThread\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_WarpMouse.3 b/docs/man3/SDL_WarpMouse.3 index 2892d714d..2657c1ba2 100644 --- a/docs/man3/SDL_WarpMouse.3 +++ b/docs/man3/SDL_WarpMouse.3 @@ -1,4 +1,4 @@ -.TH "SDL_WarpMouse" "3" "Mon 12 Mar 2001, 01:05" "SDL" "SDL API Reference" +.TH "SDL_WarpMouse" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" .SH "NAME" SDL_WarpMouse\- Set the position of the mouse cursor\&. .SH "SYNOPSIS" @@ -12,4 +12,4 @@ Set the position of the mouse cursor (generates a mouse motion event)\&. .SH "SEE ALSO" .PP \fI\fBSDL_MouseMotionEvent\fR\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:05 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 diff --git a/docs/man3/SDL_WasInit.3 b/docs/man3/SDL_WasInit.3 index b3b300e54..68f708a2d 100644 --- a/docs/man3/SDL_WasInit.3 +++ b/docs/man3/SDL_WasInit.3 @@ -1,4 +1,4 @@ -.TH "SDL_WasInit" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_WasInit" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_WasInit\- Check which subsystems are initialized .SH "SYNOPSIS" @@ -60,4 +60,4 @@ else .SH "SEE ALSO" .PP \fI\fBSDL_Init\fP\fR, \fI\fBSDL_Subsystem\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_keysym.3 b/docs/man3/SDL_keysym.3 index 5b918aac7..0fad47dba 100644 --- a/docs/man3/SDL_keysym.3 +++ b/docs/man3/SDL_keysym.3 @@ -1,4 +1,4 @@ -.TH "SDL_keysym" "3" "Mon 12 Mar 2001, 01:03" "SDL" "SDL API Reference" +.TH "SDL_keysym" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" .SH "NAME" SDL_keysym\- Keysym structure .SH "STRUCTURE DEFINITION" @@ -66,4 +66,4 @@ else { .SH "SEE ALSO" .PP \fI\fBSDLKey\fR\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:03 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 diff --git a/docs/man3/SDL_mutexP.3 b/docs/man3/SDL_mutexP.3 index b08355178..db5794881 100644 --- a/docs/man3/SDL_mutexP.3 +++ b/docs/man3/SDL_mutexP.3 @@ -1,4 +1,4 @@ -.TH "SDL_mutexP" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_mutexP" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_mutexP\- Lock a mutex .SH "SYNOPSIS" @@ -15,4 +15,4 @@ SDL also defines a macro \fB#define SDL_LockMutex(m) SDL_mutexP(m)\fP\&. .SH "SEE ALSO" .PP \fI\fBSDL_CreateMutex\fP\fR, \fI\fBSDL_mutexV\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 diff --git a/docs/man3/SDL_mutexV.3 b/docs/man3/SDL_mutexV.3 index 5fc67ded3..a925fe1da 100644 --- a/docs/man3/SDL_mutexV.3 +++ b/docs/man3/SDL_mutexV.3 @@ -1,4 +1,4 @@ -.TH "SDL_mutexV" "3" "Mon 12 Mar 2001, 01:04" "SDL" "SDL API Reference" +.TH "SDL_mutexV" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" .SH "NAME" SDL_mutexV\- Unlock a mutex .SH "SYNOPSIS" @@ -15,4 +15,4 @@ SDL also defines a macro \fB#define SDL_UnlockMutex(m) SDL_mutexV(m)\fP\&. .SH "SEE ALSO" .PP \fI\fBSDL_CreateMutex\fP\fR, \fI\fBSDL_mutexP\fP\fR -...\" created by instant / docbook-to-man, Mon 12 Mar 2001, 01:04 +...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41