From 30dd107dd27d76404da5844cf3f4f77c2848a82e Mon Sep 17 00:00:00 2001 From: Sam Lantinga Date: Fri, 14 Sep 2001 02:41:09 +0000 Subject: [PATCH] Updated from the SDL Documentation Project --- docs/html/Makefile.am | 2 + docs/html/event.html | 6 +- docs/html/eventfunctions.html | 237 +++++++++++++++++++++++ docs/html/eventstructures.html | 5 + docs/html/general.html | 5 + docs/html/guideaudioexamples.html | 2 +- docs/html/guidebasicsinit.html | 2 +- docs/html/guidecdromexamples.html | 2 +- docs/html/guideinput.html | 8 +- docs/html/guidetimeexamples.html | 22 ++- docs/html/index.html | 9 +- docs/html/sdlactiveevent.html | 12 +- docs/html/sdladdtimer.html | 14 +- docs/html/sdlaudiocvt.html | 12 +- docs/html/sdlaudiospec.html | 14 +- docs/html/sdlblitsurface.html | 12 +- docs/html/sdlbuildaudiocvt.html | 14 +- docs/html/sdlcd.html | 14 +- docs/html/sdlcdclose.html | 10 +- docs/html/sdlcdeject.html | 12 +- docs/html/sdlcdname.html | 12 +- docs/html/sdlcdnumdrives.html | 10 +- docs/html/sdlcdopen.html | 12 +- docs/html/sdlcdpause.html | 12 +- docs/html/sdlcdplay.html | 12 +- docs/html/sdlcdplaytracks.html | 14 +- docs/html/sdlcdresume.html | 12 +- docs/html/sdlcdstatus.html | 12 +- docs/html/sdlcdstop.html | 12 +- docs/html/sdlcdtrack.html | 12 +- docs/html/sdlcloseaudio.html | 10 +- docs/html/sdlcolor.html | 12 +- docs/html/sdlcondbroadcast.html | 10 +- docs/html/sdlcondsignal.html | 10 +- docs/html/sdlcondwait.html | 10 +- docs/html/sdlcondwaittimeout.html | 10 +- docs/html/sdlconvertaudio.html | 12 +- docs/html/sdlconvertsurface.html | 16 +- docs/html/sdlcreatecond.html | 12 +- docs/html/sdlcreatecursor.html | 14 +- docs/html/sdlcreatemutex.html | 12 +- docs/html/sdlcreatergbsurface.html | 16 +- docs/html/sdlcreatergbsurfacefrom.html | 12 +- docs/html/sdlcreatesemaphore.html | 14 +- docs/html/sdlcreatethread.html | 10 +- docs/html/sdlcreateyuvoverlay.html | 10 +- docs/html/sdldelay.html | 10 +- docs/html/sdldestroycond.html | 10 +- docs/html/sdldestroymutex.html | 10 +- docs/html/sdldestroysemaphore.html | 12 +- docs/html/sdldisplayformat.html | 12 +- docs/html/sdldisplayformatalpha.html | 12 +- docs/html/sdldisplayyuvoverlay.html | 20 +- docs/html/sdlenablekeyrepeat.html | 10 +- docs/html/sdlenableunicode.html | 54 ++++-- docs/html/sdlevent.html | 54 +++++- docs/html/sdleventstate.html | 10 +- docs/html/sdlexposeevent.html | 244 ++++++++++++++++++++++++ docs/html/sdlfillrect.html | 29 ++- docs/html/sdlflip.html | 12 +- docs/html/sdlfreecursor.html | 10 +- docs/html/sdlfreesurface.html | 10 +- docs/html/sdlfreewav.html | 10 +- docs/html/sdlfreeyuvoverlay.html | 10 +- docs/html/sdlgetappstate.html | 12 +- docs/html/sdlgetaudiostatus.html | 10 +- docs/html/sdlgetcliprect.html | 10 +- docs/html/sdlgetcursor.html | 10 +- docs/html/sdlgeterror.html | 197 +++++++++++++++++++ docs/html/sdlgeteventfilter.html | 12 +- docs/html/sdlgetgammaramp.html | 12 +- docs/html/sdlgetkeyname.html | 10 +- docs/html/sdlgetkeystate.html | 14 +- docs/html/sdlgetmodstate.html | 18 +- docs/html/sdlgetmousestate.html | 12 +- docs/html/sdlgetrelativemousestate.html | 10 +- docs/html/sdlgetrgb.html | 10 +- docs/html/sdlgetrgba.html | 10 +- docs/html/sdlgetthreadid.html | 10 +- docs/html/sdlgetticks.html | 10 +- docs/html/sdlgetvideoinfo.html | 10 +- docs/html/sdlgetvideosurface.html | 10 +- docs/html/sdlglattr.html | 10 +- docs/html/sdlglgetattribute.html | 12 +- docs/html/sdlglgetprocaddress.html | 12 +- docs/html/sdlglloadlibrary.html | 10 +- docs/html/sdlglsetattribute.html | 14 +- docs/html/sdlglswapbuffers.html | 10 +- docs/html/sdljoyaxisevent.html | 12 +- docs/html/sdljoyballevent.html | 12 +- docs/html/sdljoybuttonevent.html | 12 +- docs/html/sdljoyhatevent.html | 12 +- docs/html/sdljoystickclose.html | 10 +- docs/html/sdljoystickeventstate.html | 12 +- docs/html/sdljoystickgetaxis.html | 14 +- docs/html/sdljoystickgetball.html | 14 +- docs/html/sdljoystickgetbutton.html | 12 +- docs/html/sdljoystickgethat.html | 12 +- docs/html/sdljoystickindex.html | 12 +- docs/html/sdljoystickname.html | 16 +- docs/html/sdljoysticknumaxes.html | 12 +- docs/html/sdljoysticknumballs.html | 12 +- docs/html/sdljoysticknumbuttons.html | 12 +- docs/html/sdljoysticknumhats.html | 12 +- docs/html/sdljoystickopen.html | 20 +- docs/html/sdljoystickopened.html | 12 +- docs/html/sdljoystickupdate.html | 10 +- docs/html/sdlkey.html | 6 +- docs/html/sdlkeyboardevent.html | 12 +- docs/html/sdlkeysym.html | 12 +- docs/html/sdlkillthread.html | 10 +- docs/html/sdllistmodes.html | 12 +- docs/html/sdlloadbmp.html | 12 +- docs/html/sdlloadwav.html | 12 +- docs/html/sdllockaudio.html | 10 +- docs/html/sdllocksurface.html | 15 +- docs/html/sdllockyuvoverlay.html | 12 +- docs/html/sdlmaprgb.html | 12 +- docs/html/sdlmaprgba.html | 12 +- docs/html/sdlmixaudio.html | 24 ++- docs/html/sdlmousebuttonevent.html | 12 +- docs/html/sdlmousemotionevent.html | 12 +- docs/html/sdlmutexp.html | 10 +- docs/html/sdlmutexv.html | 10 +- docs/html/sdlnumjoysticks.html | 12 +- docs/html/sdlopenaudio.html | 15 +- docs/html/sdloverlay.html | 12 +- docs/html/sdlpalette.html | 12 +- docs/html/sdlpauseaudio.html | 10 +- docs/html/sdlpeepevents.html | 12 +- docs/html/sdlpixelformat.html | 12 +- docs/html/sdlpollevent.html | 12 +- docs/html/sdlpumpevents.html | 10 +- docs/html/sdlpushevent.html | 14 +- docs/html/sdlquitevent.html | 12 +- docs/html/sdlrect.html | 12 +- docs/html/sdlremovetimer.html | 14 +- docs/html/sdlresizeevent.html | 22 +-- docs/html/sdlsavebmp.html | 12 +- docs/html/sdlsempost.html | 14 +- docs/html/sdlsemtrywait.html | 14 +- docs/html/sdlsemvalue.html | 14 +- docs/html/sdlsemwait.html | 14 +- docs/html/sdlsemwaittimeout.html | 14 +- docs/html/sdlsetalpha.html | 14 +- docs/html/sdlsetcliprect.html | 10 +- docs/html/sdlsetcolorkey.html | 12 +- docs/html/sdlsetcolors.html | 14 +- docs/html/sdlsetcursor.html | 10 +- docs/html/sdlseteventfilter.html | 10 +- docs/html/sdlsetgamma.html | 12 +- docs/html/sdlsetgammaramp.html | 12 +- docs/html/sdlsetmodstate.html | 10 +- docs/html/sdlsetpalette.html | 14 +- docs/html/sdlsettimer.html | 12 +- docs/html/sdlsetvideomode.html | 90 +++++++-- docs/html/sdlshowcursor.html | 12 +- docs/html/sdlsurface.html | 14 +- docs/html/sdlsyswmevent.html | 18 +- docs/html/sdlthreadid.html | 8 +- docs/html/sdlunlockaudio.html | 10 +- docs/html/sdlunlocksurface.html | 10 +- docs/html/sdlunlockyuvoverlay.html | 10 +- docs/html/sdlupdaterect.html | 10 +- docs/html/sdlupdaterects.html | 10 +- docs/html/sdluserevent.html | 14 +- docs/html/sdlvideodrivername.html | 12 +- docs/html/sdlvideoinfo.html | 12 +- docs/html/sdlvideomodeok.html | 12 +- docs/html/sdlwaitevent.html | 10 +- docs/html/sdlwaitthread.html | 12 +- docs/html/sdlwarpmouse.html | 10 +- docs/html/sdlwasinit.html | 10 +- docs/html/sdlwmgetcaption.html | 10 +- docs/html/sdlwmgrabinput.html | 10 +- docs/html/sdlwmiconifywindow.html | 10 +- docs/html/sdlwmsetcaption.html | 10 +- docs/html/sdlwmseticon.html | 14 +- docs/html/sdlwmtogglefullscreen.html | 10 +- docs/html/thread.html | 2 +- docs/html/video.html | 10 +- docs/man3/Makefile.am | 2 + docs/man3/SDL_ActiveEvent.3 | 4 +- docs/man3/SDL_AddTimer.3 | 4 +- docs/man3/SDL_AudioCVT.3 | 4 +- docs/man3/SDL_AudioSpec.3 | 4 +- docs/man3/SDL_BlitSurface.3 | 4 +- 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 | 8 +- docs/man3/SDL_CreateCond.3 | 4 +- docs/man3/SDL_CreateCursor.3 | 4 +- docs/man3/SDL_CreateMutex.3 | 4 +- docs/man3/SDL_CreateRGBSurface.3 | 4 +- docs/man3/SDL_CreateRGBSurfaceFrom.3 | 4 +- docs/man3/SDL_CreateSemaphore.3 | 4 +- docs/man3/SDL_CreateThread.3 | 4 +- docs/man3/SDL_CreateYUVOverlay.3 | 4 +- docs/man3/SDL_Delay.3 | 4 +- 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 | 4 +- docs/man3/SDL_DisplayYUVOverlay.3 | 7 +- docs/man3/SDL_EnableKeyRepeat.3 | 4 +- docs/man3/SDL_EnableUNICODE.3 | 14 +- docs/man3/SDL_Event.3 | 11 +- docs/man3/SDL_EventState.3 | 4 +- docs/man3/SDL_ExposeEvent.3 | 24 +++ docs/man3/SDL_FillRect.3 | 10 +- docs/man3/SDL_Flip.3 | 4 +- docs/man3/SDL_FreeCursor.3 | 4 +- docs/man3/SDL_FreeSurface.3 | 4 +- 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_GetError.3 | 15 ++ 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 | 6 +- docs/man3/SDL_GetModState.3 | 6 +- 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 | 6 +- 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 | 10 +- 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 | 5 +- docs/man3/SDL_LockYUVOverlay.3 | 4 +- docs/man3/SDL_MapRGB.3 | 4 +- docs/man3/SDL_MapRGBA.3 | 4 +- docs/man3/SDL_MixAudio.3 | 10 +- docs/man3/SDL_MouseButtonEvent.3 | 4 +- docs/man3/SDL_MouseMotionEvent.3 | 4 +- docs/man3/SDL_NumJoysticks.3 | 4 +- docs/man3/SDL_OpenAudio.3 | 7 +- 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 | 4 +- 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 | 4 +- 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 | 4 +- docs/man3/SDL_SetTimer.3 | 4 +- docs/man3/SDL_SetVideoMode.3 | 24 ++- docs/man3/SDL_ShowCursor.3 | 4 +- docs/man3/SDL_Surface.3 | 4 +- 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 | 4 +- docs/man3/SDL_UpdateRects.3 | 4 +- 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 | 6 +- 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 +- 355 files changed, 2317 insertions(+), 1398 deletions(-) create mode 100644 docs/html/sdlexposeevent.html create mode 100644 docs/html/sdlgeterror.html create mode 100644 docs/man3/SDL_ExposeEvent.3 create mode 100644 docs/man3/SDL_GetError.3 diff --git a/docs/html/Makefile.am b/docs/html/Makefile.am index 7cb0b99d3..8328d354c 100644 --- a/docs/html/Makefile.am +++ b/docs/html/Makefile.am @@ -70,6 +70,7 @@ EXTRA_DIST = \ sdlenableunicode.html \ sdlevent.html \ sdleventstate.html \ + sdlexposeevent.html \ sdlfillrect.html \ sdlflip.html \ sdlfreecursor.html \ @@ -80,6 +81,7 @@ EXTRA_DIST = \ sdlgetaudiostatus.html \ sdlgetcliprect.html \ sdlgetcursor.html \ + sdlgeterror.html \ sdlgeteventfilter.html \ sdlgetgammaramp.html \ sdlgetkeyname.html \ diff --git a/docs/html/event.html b/docs/html/event.html index 69f89a114..d7b29854d 100644 --- a/docs/html/event.html +++ b/docs/html/event.html @@ -85,7 +85,7 @@ >
Introduction

Introduction

SDL_Init(SDL_INIT_VIDEO); -Interally, SDL stores all the events waiting to be handled in an event queue. Using functions like — Enable/disable joystick event polling

SDL_PumpEventsPumps the event loop, gathering events from the input devices
SDL_PeepEventsChecks the event queue for messages and optionally returns them
SDL_PollEventPolls for currently pending events
SDL_WaitEventWaits indefinitely for the next available event
SDL_PushEventPushes an event onto the event queue
SDL_SetEventFilterSets up a filter to process all events
SDL_EventStateAllows you to set the state of processing certain events
SDL_GetKeyStateGet a snapshot of the current keyboard state
SDL_GetModStateGet the state of modifier keys
SDL_SetModStateSet the state of modifier keys
SDL_GetKeyNameGet the name of an SDL virtual keysym
SDL_EnableUNICODEEnable UNICODE translation
SDL_EnableKeyRepeatSet keyboard repeat rate
SDL_GetMouseStateRetrieve the current state of the mouse
SDL_GetRelativeMouseStateRetrieve the current state of the mouse
SDL_GetAppStateGet the state of the application
SDL_JoystickEventStateEnable/disable joystick event polling

— Window resize event structure
SDL_ExposeEvent — Quit requested event
SDL_SysWMEvent — Platform-dependent window manager event.
SDL_WasInit — Check which subsystems are initialized
SDL_GetError — Get SDL error string

SDL_InitSubSystem. ). SDL_Init must be called before any other SDL function. It automatically initializes the Event Handling, File I/O and Threading subsystems and it takes a parameter specifying which other subsystems to initialize. So, to initialize the default subsystems and the Video subsystems you would call: diff --git a/docs/html/guidecdromexamples.html b/docs/html/guidecdromexamples.html index 917a1a3c0..8083adb40 100644 --- a/docs/html/guidecdromexamples.html +++ b/docs/html/guidecdromexamples.html @@ -201,7 +201,7 @@ // Play first and second track and 10 seconds of third track: if ( CD_INDRIVE(SDL_CDStatus(cdrom)) ) - SDL_CDPlayTracks(cdrom, 0, 0, 2, 10);

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 with 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:

    case SDL_JOYHATMOTION:  /* Handle Hat Motion */
-    if ( event.jhat.hat | SDL_HAT_UP )
+    if ( event.jhat.hat & SDL_HAT_UP )
     {
         /* Do up stuff here */
     }
 
-    if ( event.jhat.hat | SDL_HAT_LEFT )
+    if ( event.jhat.hat & SDL_HAT_LEFT )
     {
         /* Do left stuff here */
     }
 
-    if ( event.jhat.hat | SDL_HAT_RIGHTDOWN )
+    if ( event.jhat.hat & SDL_HAT_RIGHTDOWN )
     {
         /* Do right and down together stuff here */
     }
diff --git a/docs/html/guidetimeexamples.html b/docs/html/guidetimeexamples.html
index 28b96945d..3e4aed23b 100644
--- a/docs/html/guidetimeexamples.html
+++ b/docs/html/guidetimeexamples.html
@@ -88,25 +88,27 @@
 CLASS="PROGRAMLISTING"
 >#define TICK_INTERVAL    30
 
-Uint32 TimeLeft(void)
+static Uint32 next_time;
+
+Uint32 time_left(void)
 {
-    static Uint32 next_time = 0;
     Uint32 now;
 
     now = SDL_GetTicks();
-    if ( next_time <= now ) {
-        next_time = now+TICK_INTERVAL;
-        return(0);
-    }
-    return(next_time-now);
+    if(next_time <= now)
+        return 0;
+    else
+        return next_time - now;
 }
 
 
-/* main game loop
+/* main game loop */
 
+    next_time = SDL_GetTicks() + TICK_INTERVAL;
     while ( game_running ) {
-        UpdateGameState();
-        SDL_Delay(TimeLeft());
+        update_game_state();
+        SDL_Delay(time_left());
+        next_time += TICK_INTERVAL;
     }

SDL_WasInit — Check which subsystems are initialized
SDL_GetError — Get SDL error string
Introduction
8-1. SDL Keysym definitions

Name

Structure Definition

Structure Data

Description

See Also

Name

Synopsis

Description

Return Value

Examples

See Also

Name

Structure Definition

Structure Data

Description

See Also

Name

Structure Definition

Structure Data

Description

See Also

Name

Synopsis

Description

Return Value

See Also

Name

Synopsis

Description

Return Values

Examples

See Also

Name

Structure Definition

Structure Data

Description

Examples

See Also

Name

Synopsis

Description

See Also

Name

Synopsis

Description

Return Value

See Also

Name

Synopsis

Description

Examples

See Also

Name

Synopsis

Description

See Also

Name

Synopsis

Description

Examples

See Also

Name

Synopsis

Description

Return Value

See Also

Name

Synopsis

Description

Return Values

See Also

Name

Synopsis

Description

Return Value

Examples

See Also

Name

Synopsis

Description

Return Value

See Also

Name

Synopsis

Description

Example

See Also

Name

Synopsis

Description

Return Value

See Also

Name

Structure Definition

Structure Data

Description

See Also

Name

Synopsis

Description

See Also

Name

Structure Definition

Structure Data

Description

See Also

Name

Synopsis

Description

See Also

Name

Synopsis

Description

See Also

Name

Synopsis

Description

See Also

Name

Synopsis

Description

See Also

Name

Synopsis

Description

Examples

See Also

Name

Synopsis

#include "SDL.h"
#include "SDL/SDL.h"

Description

SDL_DisplayFormat.

This function can only be called after SDL_Init.

Return Value

See Also

Name

Synopsis

Description

Examples

See Also

Name

Synopsis

Description

Example

See Also

Name

Synopsis

Description

Examples

See Also

Name

Synopsis

Description

Return Value

Example

See Also

Name

Synopsis

Description

Return Value

See Also

Name

Synopsis

Description

Return Value

Examples

See Also

Name

Synopsis

Description

See Also

Name

Synopsis

Description

See Also

Name

Synopsis

Description

See Also

Name

Synopsis

Description

See Also

Name

Synopsis

Description

See Also

Name

Synopsis

Description

Examples

See Also

Name

Synopsis

Description

Return Value

See Also

Name

Synopsis

Description

Return Value

See Also

Name

Synopsis

Description

Return Values

Returns 0 on success

See Also

Name

Synopsis

Description

Return Value

Name

Synopsis

Description

Enables/Disables UNICODE keyboard translation.

Enables/Disables Unicode keyboard translation.

If you wish to translate a keysym to it's printable representation, you need to enable UNICODE translation -using this function (enable=0) and then look in the To obtain the character codes corresponding to received keyboard events, +Unicode translation must first be turned on using this function. The +translation incurs a slight overhead for each keyboard event and is therefore +disabled by default. For each subsequently received key down event, the +unicode member -of the member of the +SDL_keysym structure. This value will be zero for keysyms -that do not have a printable representation. UNICODE translation is disabled by default as the conversion can cause a slight overhead.

structure +will then contain the corresponding character code, or zero for keysyms that do +not correspond to any character code.

A value of 1 for enable enables Unicode translation; +0 disables it, and -1 leaves it unchanged (useful for querying the current +translation mode).

Note that only key press events will be translated, not release events.

Return Value

Returns the previous translation mode.

Returns the previous translation mode (0 or 1).

See Also

Name

Structure Definition

Structure Data

exposeApplication window expose eventquit

Description

SDL_VIDEOEXPOSESDL_ExposeEventSDL_USEREVENT

Use

See Also

Name

Synopsis

Description

See Also

SDL_ExposeEvent
SDL Library Documentation
PrevNext

SDL_ExposeEvent

Name

SDL_ExposeEvent -- Quit requested event

Structure Definition

typedef struct{
+  Uint8 type
+} SDL_ExposeEvent;

Structure Data

typeSDL_QUIT

Description

SDL_ExposeEvent is a member of the SDL_Event union and is used whan an event of type SDL_VIDEOEXPOSE is reported.

A VIDEOEXPOSE event is triggered when the screen has been modified +outside of the application, usually by the window manager and needs to +be redrawn.

PrevHomeNext
SDL_ResizeEventUpSDL_SysWMEvent
\ No newline at end of file diff --git a/docs/html/sdlfillrect.html b/docs/html/sdlfillrect.html index c49d08fcb..1eb3a0a9a 100644 --- a/docs/html/sdlfillrect.html +++ b/docs/html/sdlfillrect.html @@ -73,7 +73,7 @@ >

Name

Synopsis

Description

SDL_MapRGB or SDL_MapRGBA -function.

If there is a clip rectangle set on the destination (set via dstrect rectangle.

rectangle and the dstrect rectangle +will be modified to represent the area actually filled.

Return Value

See Also

, SDL_MapRGBA, +

Name

Synopsis

Description

Return Value

See Also

Name

Synopsis

Description

See Also

Name

Synopsis

Description

See Also

Name

Synopsis

Description

See Also

Name

Synopsis

Description

See Also

Name

Synopsis

Description

See Also

Name

Synopsis

Description

See Also

Name

Synopsis

Description

See Also

Name

Synopsis

Description

See Also

SDL_GetError
SDL Library Documentation
PrevNext

SDL_GetError

Name

SDL_GetError -- Get SDL error string

Synopsis

#include "SDL/SDL.h"

char *SDL_GetError(void);

Description

SDL_GetError returns a NULL terminated string containing information about the last internal SDL error.

Return Value

SDL_GetError returns a string containing the last error.

PrevHomeNext
SDL_WasInitUpVideo
\ No newline at end of file diff --git a/docs/html/sdlgeteventfilter.html b/docs/html/sdlgeteventfilter.html index c9cdf9fd1..656b95541 100644 --- a/docs/html/sdlgeteventfilter.html +++ b/docs/html/sdlgeteventfilter.html @@ -73,7 +73,7 @@ >

Name

Synopsis

Description

Return Value

See Also

Name

Synopsis

Description

Return Value

See Also

Name

Synopsis

Description

See Also

Name

Synopsis

Description

SDLK_* symbols. A value of 1 means the key is pressed and a value of 0 means its not.

symbols. A value of 1 means the key is pressed and a value of 0 means its not. The pointer returned is a pointer to an internal SDL array and should not be freed by the caller.

Example

See Also

Name

Synopsis

Description

Returns the current of the modifier keys (CTRL, ALT, etc.).

Returns the current state of the modifier keys (CTRL, ALT, etc.).

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

Name

Synopsis

Description

Example

See Also

Name

Synopsis

Description

See Also

Name

Synopsis

Description

See Also

Name

Synopsis

Description

See Also

Name

Synopsis

Description

See Also

Name

Synopsis

Description

See Also

Name

Synopsis

Description

See Also

Name

Synopsis

Description

See Also

Name

Attributes

Description

See Also

Name

Synopsis

Description

Return Value

See Also

Name

Synopsis

Description

Example

See Also

Name

Synopsis

Description

See Also

Name

Synopsis

Description

Return Value

Example

See Also

Name

Synopsis

Description

See Also

Name

Structure Definition

Structure Data

Description

See Also

Name

Structure Definition

Structure Data

Description

See Also

Name

Structure Definition

Structure Data

Description

See Also

Name

Structure Definition

Structure Data

Description

See Also

Name

Synopsis

Description

See Also

Name

Synopsis

Description

Return Value

See Also

Name

Synopsis

Description

Return Value

Examples

See Also

Name

Synopsis

Description

Return Value

Examples

See Also

Name

Synopsis

Description

Return Value

See Also

Name

Synopsis

Description

Return Value

See Also

Name

Synopsis

Description

Return Value

See Also

Name

Synopsis

Description

Return Value

Examples

See Also

Name

Synopsis

Description

Return Value

See Also

Name

Synopsis

Description

Return Value

See Also

Name

Synopsis

Description

Return Value

See Also

Name

Synopsis

Description

Return Value

See Also

Name

Synopsis

Description

Return Value

Examples

See Also

Name

Synopsis

Description

Return Value

See Also

Name

Synopsis

Description

See Also

Name

Description

Name

Structure Definition

Structure Data

Description

See Also

Name

Structure Definition

Structure Data

Description

See Also

Name

Synopsis

Description

See Also

Name

Synopsis

Description

Example

See Also

Name

Synopsis

Description

Return Value

See Also

Name

Synopsis

Description

Example

See Also

Name

Synopsis

Description

See Also

Name

Synopsis

Description

-

Return Value

See Also

Name

Synopsis

Description

Return Value

See Also

Name

Synopsis

Description

Return Value

See Also

Name

Synopsis

Description

Return Value

See Also

Name

Synopsis

Description

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.

Note: Do not use this function for mixing together more than two streams of sample +data. The output from repeated application of this function may be distorted +by clipping, because there is no accumulator with greater range than the +input (not to mention this being an inefficient way of doing it). +Use mixing functions from SDL_mixer, OpenAL, or write your own mixer instead.

See Also

Name

Structure Definition

Structure Data

Description

See Also

Name

Structure Definition

Structure Data

Description

See Also

Name

Synopsis

Description

See Also

Name

Synopsis

Description

See Also

Name

Synopsis

Description

Return Value

See Also

Name

Synopsis

Description

Examples

See Also

Name

Structure Definition

Structure Data

Description

See Also

Name

Structure Definition

Structure Data

Description

See Also

Name

Synopsis

Description

See Also

Name

Synopsis

Description

Return Value

See Also

Name

Structure Definition

Structure Data

Description

See Also

Name

Synopsis

Description

Examples

See Also

Name

Synopsis

Description

See Also

Name

Synopsis

Description

Return Value

Examples

See Also

Name

Structure Definition

Structure Data

Description

See Also

Name

Structure Definition

Structure Data

Description

See Also

Name

Synopsis

Description

Return Value

Examples

See Also

Next

Name

Structure Definition

Structure Data

Description

See Also

NextSDL_SysWMEventSDL_ExposeEvent

Name

Synopsis

Description

Return Value

See Also

Name

Synopsis

Description

Return Value

Examples

See Also

Name

Synopsis

Description

Return Value

Examples

See Also

Name

Synopsis

Description

Return Value

Examples

See Also

Name

Synopsis

Description

Return Value

Examples

See Also

Name

Synopsis

Description

Return Value

Examples

See Also

Name

Synopsis

Description

Return Value

See Also

Name

Synopsis

Description

See Also

Name

Synopsis

Description

Return Value

See Also

Name

Synopsis

Description

Return Value

Example

See Also

Name

Synopsis

Description

See Also

Name

Synopsis

Description

See Also

Name

Synopsis

Description

Return Value

See Also

Name

Synopsis

Description

Return Value

See Also

Name

Synopsis

Description

See Also

Name

Synopsis

Description

Return Value

Example

See Also

Name

Synopsis

Description

Examples

See Also

Name

Synopsis

Description

Enables the use of asynchronous to the display surface. This will usually slow down blitting on single CPU machines, but may provide a speed increase on SMP systems.Enables the use of asynchronous updates of the display surface. This will +usually slow down blitting on single CPU machines, but may provide a speed +increase on SMP systems.Normally, if a video surface of the requested depth (Normally, if a video surface of the requested bits-per-pixel (bpp) is not available, SDL will emulate one with a shadow surface. Passing SDL_ANYFORMAT prevents this and causes SDL to use the video surface, regardless of its depth. prevents this and causes SDL to use the video surface, regardless of its pixel depth.SDL_SetColors or SDL_SetPalette.Enable double buffering; only valid with SDL_HWSURFACE. Calling Enable hardware double buffering; only valid with SDL_HWSURFACE. Calling +SDL_Flip will flip the buffers and update the screen. If double buffering could not be enabled then will flip the +buffers and update the screen. All drawing will take place on the surface +that is not displayed at the moment. If double buffering could not be enabled +then SDL_Flip will just perform a will just perform a +SDL_UpdateRect on the entire screen. +on the entire screen.SDL will attempt to use a fullscreen modeSDL will attempt to use a fullscreen mode. If a hardware resolution change is +not possible (for whatever reason), the next higher resolution will be used and +the display window centered on a black background.Create an OpenGL rendering context, like above, but allow normal blitting operations.Create an OpenGL rendering context, like above, but allow normal blitting +operations. The screen (2D) surface may have an alpha channel, and +SDL_UpdateRects +must be used for updating changes to the screen surface. member of the returned surface.

Note: The bpp parameter is the number of bits per pixel, +so a bpp of 24 uses the packed representation of +3 bytes/pixel. For the more common 4 bytes/pixel mode, use a +bpp of 32. Somewhat oddly, both 15 and 16 will +request a 2 bytes/pixel mode, but different pixel formats.

Return Value

The framebuffer surface, or NULL if it fails.

if it fails. +The surface returned is freed by SDL_Quit() and should nt be freed by +the caller.

See Also

Name

Synopsis

Description

Return Value

See Also

Name

Structure Definition

Structure Data

Description

See Also

Prev

Name

Description

See Also

PrevSDL_ResizeEventSDL_ExposeEvent

Name

Synopsis

Description

Name

Synopsis

Description

See Also

Name

Synopsis

Description

See Also

Name

Synopsis

Description

See Also

Name

Synopsis

Description

See Also

Name

Synopsis

Description

See Also

Name

Structure Definition

Structure Data

Description

Examples

See Also

Name

Synopsis

Description

Return Value

See Also

Name

Structure Definition

Structure Data

Description

See Also

Name

Synopsis

Description

Example

See Also

Name

Synopsis

Description

See Also

Name

Synopsis

Description

Return Value

See Also

Name

Synopsis

Description

See Also

NextNextVideoSDL_GetError

Name

Synopsis

Description

See Also

Name

Synopsis

Description

Return Value

Name

Synopsis

Description

Return Value

Name

Synopsis

Description

See Also

Name

Synopsis

Description

Sets the icon for the display window.

Sets the icon for the display window. Win32 icons must be 32x32.

This function must be called before the first call to

Example

See Also

Name

Synopsis

Description

Return Value

Note: SDL's threading is not implemented on MacOS, due to that lack of preemptive thread support (eck!)

SDL's threading is not implemented on MacOS, due to that lack of preemptive thread support (MacOS X dos nt suffer from this problem)

PrevPrevSDL_WasInitSDL_GetError0){ "); printf("Name: %s ", SDL_JoystickName(0)); - printf("Number of Axes: %s + printf("Number of Axes: %d ", SDL_JoystickNumAxes(joy)); - printf("Number of Buttons: %s + printf("Number of Buttons: %d ", SDL_JoystickNumButtons(joy)); - printf("Number of Balls: %s + printf("Number of Balls: %d ", SDL_JoystickNumBalls(joy)); } else @@ -48,4 +48,4 @@ if(SDL_NumJoysticks()>0){ .SH "SEE ALSO" .PP \fI\fBSDL_JoystickClose\fP\fR -...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff --git a/docs/man3/SDL_JoystickOpened.3 b/docs/man3/SDL_JoystickOpened.3 index 48a7ce1e9..435775b1c 100644 --- a/docs/man3/SDL_JoystickOpened.3 +++ b/docs/man3/SDL_JoystickOpened.3 @@ -1,4 +1,4 @@ -.TH "SDL_JoystickOpened" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" +.TH "SDL_JoystickOpened" "3" "Tue 11 Sep 2001, 23:00" "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, Sun 10 Jun 2001, 19:41 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff --git a/docs/man3/SDL_JoystickUpdate.3 b/docs/man3/SDL_JoystickUpdate.3 index f42009aa9..35b7cda5a 100644 --- a/docs/man3/SDL_JoystickUpdate.3 +++ b/docs/man3/SDL_JoystickUpdate.3 @@ -1,4 +1,4 @@ -.TH "SDL_JoystickUpdate" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" +.TH "SDL_JoystickUpdate" "3" "Tue 11 Sep 2001, 23:00" "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, Sun 10 Jun 2001, 19:41 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff --git a/docs/man3/SDL_KeyboardEvent.3 b/docs/man3/SDL_KeyboardEvent.3 index 521f95b37..652dc3cd6 100644 --- a/docs/man3/SDL_KeyboardEvent.3 +++ b/docs/man3/SDL_KeyboardEvent.3 @@ -1,4 +1,4 @@ -.TH "SDL_KeyboardEvent" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" +.TH "SDL_KeyboardEvent" "3" "Tue 11 Sep 2001, 22:59" "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, Sun 10 Jun 2001, 19:40 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 diff --git a/docs/man3/SDL_KillThread.3 b/docs/man3/SDL_KillThread.3 index d44cb8f81..4ece02676 100644 --- a/docs/man3/SDL_KillThread.3 +++ b/docs/man3/SDL_KillThread.3 @@ -1,4 +1,4 @@ -.TH "SDL_KillThread" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" +.TH "SDL_KillThread" "3" "Tue 11 Sep 2001, 23:00" "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, Sun 10 Jun 2001, 19:41 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff --git a/docs/man3/SDL_ListModes.3 b/docs/man3/SDL_ListModes.3 index 898b8defd..c0b9c28d4 100644 --- a/docs/man3/SDL_ListModes.3 +++ b/docs/man3/SDL_ListModes.3 @@ -1,4 +1,4 @@ -.TH "SDL_ListModes" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" +.TH "SDL_ListModes" "3" "Tue 11 Sep 2001, 23:01" "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, Sun 10 Jun 2001, 19:42 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff --git a/docs/man3/SDL_LoadBMP.3 b/docs/man3/SDL_LoadBMP.3 index 77086d280..0dc725386 100644 --- a/docs/man3/SDL_LoadBMP.3 +++ b/docs/man3/SDL_LoadBMP.3 @@ -1,4 +1,4 @@ -.TH "SDL_LoadBMP" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" +.TH "SDL_LoadBMP" "3" "Tue 11 Sep 2001, 23:01" "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, Sun 10 Jun 2001, 19:42 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff --git a/docs/man3/SDL_LoadWAV.3 b/docs/man3/SDL_LoadWAV.3 index 330abfc74..b1d758a37 100644 --- a/docs/man3/SDL_LoadWAV.3 +++ b/docs/man3/SDL_LoadWAV.3 @@ -1,4 +1,4 @@ -.TH "SDL_LoadWAV" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" +.TH "SDL_LoadWAV" "3" "Tue 11 Sep 2001, 22:58" "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, Sun 10 Jun 2001, 19:40 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58 diff --git a/docs/man3/SDL_LockAudio.3 b/docs/man3/SDL_LockAudio.3 index 47f46f2f2..08aa8f3cb 100644 --- a/docs/man3/SDL_LockAudio.3 +++ b/docs/man3/SDL_LockAudio.3 @@ -1,4 +1,4 @@ -.TH "SDL_LockAudio" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" +.TH "SDL_LockAudio" "3" "Tue 11 Sep 2001, 22:58" "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, Sun 10 Jun 2001, 19:40 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58 diff --git a/docs/man3/SDL_LockSurface.3 b/docs/man3/SDL_LockSurface.3 index 25e885af1..cb6b95419 100644 --- a/docs/man3/SDL_LockSurface.3 +++ b/docs/man3/SDL_LockSurface.3 @@ -1,4 +1,4 @@ -.TH "SDL_LockSurface" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" +.TH "SDL_LockSurface" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" .SH "NAME" SDL_LockSurface\- Lock a surface for directly access\&. .SH "SYNOPSIS" @@ -39,11 +39,10 @@ It should be noted, that since SDL 1\&.1\&.8 surface locks are recursive\&. This \&.\fR .fi .PP - .SH "RETURN VALUE" .PP \fBSDL_LockSurface\fP returns \fB0\fR, or \fB-1\fR if the surface couldn\&'t be locked\&. .SH "SEE ALSO" .PP \fI\fBSDL_UnlockSurface\fP\fR -...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff --git a/docs/man3/SDL_LockYUVOverlay.3 b/docs/man3/SDL_LockYUVOverlay.3 index 8359deb66..4e2c9e8c7 100644 --- a/docs/man3/SDL_LockYUVOverlay.3 +++ b/docs/man3/SDL_LockYUVOverlay.3 @@ -1,4 +1,4 @@ -.TH "SDL_LockYUVOverlay" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" +.TH "SDL_LockYUVOverlay" "3" "Tue 11 Sep 2001, 23:01" "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, Sun 10 Jun 2001, 19:42 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff --git a/docs/man3/SDL_MapRGB.3 b/docs/man3/SDL_MapRGB.3 index f7ea74bf5..2d5337589 100644 --- a/docs/man3/SDL_MapRGB.3 +++ b/docs/man3/SDL_MapRGB.3 @@ -1,4 +1,4 @@ -.TH "SDL_MapRGB" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" +.TH "SDL_MapRGB" "3" "Tue 11 Sep 2001, 23:01" "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, Sun 10 Jun 2001, 19:42 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff --git a/docs/man3/SDL_MapRGBA.3 b/docs/man3/SDL_MapRGBA.3 index e6cf89761..d5620fb2f 100644 --- a/docs/man3/SDL_MapRGBA.3 +++ b/docs/man3/SDL_MapRGBA.3 @@ -1,4 +1,4 @@ -.TH "SDL_MapRGBA" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" +.TH "SDL_MapRGBA" "3" "Tue 11 Sep 2001, 23:01" "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, Sun 10 Jun 2001, 19:42 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff --git a/docs/man3/SDL_MixAudio.3 b/docs/man3/SDL_MixAudio.3 index 3d97bbe3b..633854fe9 100644 --- a/docs/man3/SDL_MixAudio.3 +++ b/docs/man3/SDL_MixAudio.3 @@ -1,4 +1,4 @@ -.TH "SDL_MixAudio" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" +.TH "SDL_MixAudio" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference" .SH "NAME" SDL_MixAudio\- Mix audio data .SH "SYNOPSIS" @@ -9,7 +9,13 @@ SDL_MixAudio\- Mix audio data .SH "DESCRIPTION" .PP 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\&. +.PP +.RS +\fBNote: +.PP +Do not use this function for mixing together more than two streams of sample data\&. The output from repeated application of this function may be distorted by clipping, because there is no accumulator with greater range than the input (not to mention this being an inefficient way of doing it)\&. Use mixing functions from SDL_mixer, OpenAL, or write your own mixer instead\&. +.RE .SH "SEE ALSO" .PP \fI\fBSDL_OpenAudio\fP\fR -...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58 diff --git a/docs/man3/SDL_MouseButtonEvent.3 b/docs/man3/SDL_MouseButtonEvent.3 index 73a4a3c4e..a57f15eb8 100644 --- a/docs/man3/SDL_MouseButtonEvent.3 +++ b/docs/man3/SDL_MouseButtonEvent.3 @@ -1,4 +1,4 @@ -.TH "SDL_MouseButtonEvent" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" +.TH "SDL_MouseButtonEvent" "3" "Tue 11 Sep 2001, 22:59" "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, Sun 10 Jun 2001, 19:40 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 diff --git a/docs/man3/SDL_MouseMotionEvent.3 b/docs/man3/SDL_MouseMotionEvent.3 index 452c00867..06f424d47 100644 --- a/docs/man3/SDL_MouseMotionEvent.3 +++ b/docs/man3/SDL_MouseMotionEvent.3 @@ -1,4 +1,4 @@ -.TH "SDL_MouseMotionEvent" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" +.TH "SDL_MouseMotionEvent" "3" "Tue 11 Sep 2001, 22:59" "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, Sun 10 Jun 2001, 19:40 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 diff --git a/docs/man3/SDL_NumJoysticks.3 b/docs/man3/SDL_NumJoysticks.3 index 47cf0b327..3d90b4ad7 100644 --- a/docs/man3/SDL_NumJoysticks.3 +++ b/docs/man3/SDL_NumJoysticks.3 @@ -1,4 +1,4 @@ -.TH "SDL_NumJoysticks" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" +.TH "SDL_NumJoysticks" "3" "Tue 11 Sep 2001, 23:00" "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, Sun 10 Jun 2001, 19:41 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff --git a/docs/man3/SDL_OpenAudio.3 b/docs/man3/SDL_OpenAudio.3 index 2b1b25201..c78baa01a 100644 --- a/docs/man3/SDL_OpenAudio.3 +++ b/docs/man3/SDL_OpenAudio.3 @@ -1,4 +1,4 @@ -.TH "SDL_OpenAudio" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" +.TH "SDL_OpenAudio" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference" .SH "NAME" SDL_OpenAudio\- Opens the audio device with the desired parameters\&. .SH "SYNOPSIS" @@ -61,6 +61,9 @@ desired->freq=22050; /* 16-bit signed audio */ desired->format=AUDIO_S16LSB; +/* Mono */ +desired->channels=0; + /* Large audio buffer reduces risk of dropouts but increases response time */ desired->samples=8192; @@ -91,4 +94,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, Sun 10 Jun 2001, 19:40 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58 diff --git a/docs/man3/SDL_Overlay.3 b/docs/man3/SDL_Overlay.3 index c98f1423c..f555e5274 100644 --- a/docs/man3/SDL_Overlay.3 +++ b/docs/man3/SDL_Overlay.3 @@ -1,4 +1,4 @@ -.TH "SDL_Overlay" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" +.TH "SDL_Overlay" "3" "Tue 11 Sep 2001, 23:01" "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, Sun 10 Jun 2001, 19:42 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff --git a/docs/man3/SDL_Palette.3 b/docs/man3/SDL_Palette.3 index 182ef0818..234aef9f8 100644 --- a/docs/man3/SDL_Palette.3 +++ b/docs/man3/SDL_Palette.3 @@ -1,4 +1,4 @@ -.TH "SDL_Palette" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" +.TH "SDL_Palette" "3" "Tue 11 Sep 2001, 23:01" "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, Sun 10 Jun 2001, 19:42 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff --git a/docs/man3/SDL_PauseAudio.3 b/docs/man3/SDL_PauseAudio.3 index e4be0d619..799a3a5c8 100644 --- a/docs/man3/SDL_PauseAudio.3 +++ b/docs/man3/SDL_PauseAudio.3 @@ -1,4 +1,4 @@ -.TH "SDL_PauseAudio" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" +.TH "SDL_PauseAudio" "3" "Tue 11 Sep 2001, 22:58" "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, Sun 10 Jun 2001, 19:40 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58 diff --git a/docs/man3/SDL_PeepEvents.3 b/docs/man3/SDL_PeepEvents.3 index e683ac82b..984a22faa 100644 --- a/docs/man3/SDL_PeepEvents.3 +++ b/docs/man3/SDL_PeepEvents.3 @@ -1,4 +1,4 @@ -.TH "SDL_PeepEvents" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" +.TH "SDL_PeepEvents" "3" "Tue 11 Sep 2001, 22:59" "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, Sun 10 Jun 2001, 19:40 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 diff --git a/docs/man3/SDL_PixelFormat.3 b/docs/man3/SDL_PixelFormat.3 index 1cc246a0e..0ebd7a420 100644 --- a/docs/man3/SDL_PixelFormat.3 +++ b/docs/man3/SDL_PixelFormat.3 @@ -1,4 +1,4 @@ -.TH "SDL_PixelFormat" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" +.TH "SDL_PixelFormat" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" .SH "NAME" SDL_PixelFormat\- Stores surface format information .SH "STRUCTURE DEFINITION" @@ -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, Sun 10 Jun 2001, 19:42 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff --git a/docs/man3/SDL_PollEvent.3 b/docs/man3/SDL_PollEvent.3 index 830b610b6..689f64c60 100644 --- a/docs/man3/SDL_PollEvent.3 +++ b/docs/man3/SDL_PollEvent.3 @@ -1,4 +1,4 @@ -.TH "SDL_PollEvent" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" +.TH "SDL_PollEvent" "3" "Tue 11 Sep 2001, 22:59" "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, Sun 10 Jun 2001, 19:40 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 diff --git a/docs/man3/SDL_PumpEvents.3 b/docs/man3/SDL_PumpEvents.3 index d9309147f..ccd9496ba 100644 --- a/docs/man3/SDL_PumpEvents.3 +++ b/docs/man3/SDL_PumpEvents.3 @@ -1,4 +1,4 @@ -.TH "SDL_PumpEvents" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" +.TH "SDL_PumpEvents" "3" "Tue 11 Sep 2001, 22:59" "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, Sun 10 Jun 2001, 19:40 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 diff --git a/docs/man3/SDL_PushEvent.3 b/docs/man3/SDL_PushEvent.3 index b43d4e66f..9faf8a249 100644 --- a/docs/man3/SDL_PushEvent.3 +++ b/docs/man3/SDL_PushEvent.3 @@ -1,4 +1,4 @@ -.TH "SDL_PushEvent" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" +.TH "SDL_PushEvent" "3" "Tue 11 Sep 2001, 22:59" "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, Sun 10 Jun 2001, 19:40 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 diff --git a/docs/man3/SDL_Quit.3 b/docs/man3/SDL_Quit.3 index 487b42b77..2ebad0e15 100644 --- a/docs/man3/SDL_Quit.3 +++ b/docs/man3/SDL_Quit.3 @@ -1,4 +1,4 @@ -.TH "SDL_Quit" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" +.TH "SDL_Quit" "3" "Tue 11 Sep 2001, 23:00" "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, Sun 10 Jun 2001, 19:41 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff --git a/docs/man3/SDL_QuitEvent.3 b/docs/man3/SDL_QuitEvent.3 index e849a14e5..7060601eb 100644 --- a/docs/man3/SDL_QuitEvent.3 +++ b/docs/man3/SDL_QuitEvent.3 @@ -1,4 +1,4 @@ -.TH "SDL_QuitEvent" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" +.TH "SDL_QuitEvent" "3" "Tue 11 Sep 2001, 22:59" "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, Sun 10 Jun 2001, 19:40 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 diff --git a/docs/man3/SDL_QuitSubSystem.3 b/docs/man3/SDL_QuitSubSystem.3 index 1ba643376..1d26fb05f 100644 --- a/docs/man3/SDL_QuitSubSystem.3 +++ b/docs/man3/SDL_QuitSubSystem.3 @@ -1,4 +1,4 @@ -.TH "SDL_QuitSubSystem" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" +.TH "SDL_QuitSubSystem" "3" "Tue 11 Sep 2001, 23:00" "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, Sun 10 Jun 2001, 19:41 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff --git a/docs/man3/SDL_RWFromFile.3 b/docs/man3/SDL_RWFromFile.3 index 2168baa48..c810a13ee 100644 --- a/docs/man3/SDL_RWFromFile.3 +++ b/docs/man3/SDL_RWFromFile.3 @@ -1,4 +1,4 @@ -.TH "SDL_FunctionName" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" +.TH "SDL_FunctionName" "3" "Tue 11 Sep 2001, 23:00" "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, Sun 10 Jun 2001, 19:40 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff --git a/docs/man3/SDL_Rect.3 b/docs/man3/SDL_Rect.3 index 59ffa81f9..a976cd15a 100644 --- a/docs/man3/SDL_Rect.3 +++ b/docs/man3/SDL_Rect.3 @@ -1,4 +1,4 @@ -.TH "SDL_Rect" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" +.TH "SDL_Rect" "3" "Tue 11 Sep 2001, 23:01" "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, Sun 10 Jun 2001, 19:42 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff --git a/docs/man3/SDL_RemoveTimer.3 b/docs/man3/SDL_RemoveTimer.3 index 842c69e94..a67f62beb 100644 --- a/docs/man3/SDL_RemoveTimer.3 +++ b/docs/man3/SDL_RemoveTimer.3 @@ -1,4 +1,4 @@ -.TH "SDL_RemoveTimer" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" +.TH "SDL_RemoveTimer" "3" "Tue 11 Sep 2001, 23:01" "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, Sun 10 Jun 2001, 19:41 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff --git a/docs/man3/SDL_ResizeEvent.3 b/docs/man3/SDL_ResizeEvent.3 index 0011c5848..374cefea6 100644 --- a/docs/man3/SDL_ResizeEvent.3 +++ b/docs/man3/SDL_ResizeEvent.3 @@ -1,4 +1,4 @@ -.TH "SDL_ResizeEvent" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" +.TH "SDL_ResizeEvent" "3" "Tue 11 Sep 2001, 22:59" "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, Sun 10 Jun 2001, 19:40 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 diff --git a/docs/man3/SDL_SaveBMP.3 b/docs/man3/SDL_SaveBMP.3 index d153e4489..1a113c338 100644 --- a/docs/man3/SDL_SaveBMP.3 +++ b/docs/man3/SDL_SaveBMP.3 @@ -1,4 +1,4 @@ -.TH "SDL_SaveBMP" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" +.TH "SDL_SaveBMP" "3" "Tue 11 Sep 2001, 23:01" "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, Sun 10 Jun 2001, 19:42 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff --git a/docs/man3/SDL_SemPost.3 b/docs/man3/SDL_SemPost.3 index 54ffd243a..ced0d79ad 100644 --- a/docs/man3/SDL_SemPost.3 +++ b/docs/man3/SDL_SemPost.3 @@ -1,4 +1,4 @@ -.TH "SDL_SemPost" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" +.TH "SDL_SemPost" "3" "Tue 11 Sep 2001, 23:00" "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, Sun 10 Jun 2001, 19:41 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff --git a/docs/man3/SDL_SemTryWait.3 b/docs/man3/SDL_SemTryWait.3 index c45b2079c..ad515b219 100644 --- a/docs/man3/SDL_SemTryWait.3 +++ b/docs/man3/SDL_SemTryWait.3 @@ -1,4 +1,4 @@ -.TH "SDL_SemTryWait" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" +.TH "SDL_SemTryWait" "3" "Tue 11 Sep 2001, 23:00" "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, Sun 10 Jun 2001, 19:41 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff --git a/docs/man3/SDL_SemValue.3 b/docs/man3/SDL_SemValue.3 index 8805f4e5a..8c98875c8 100644 --- a/docs/man3/SDL_SemValue.3 +++ b/docs/man3/SDL_SemValue.3 @@ -1,4 +1,4 @@ -.TH "SDL_SemValue" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" +.TH "SDL_SemValue" "3" "Tue 11 Sep 2001, 23:00" "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, Sun 10 Jun 2001, 19:41 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff --git a/docs/man3/SDL_SemWait.3 b/docs/man3/SDL_SemWait.3 index d1d8ab12f..a0cb71baa 100644 --- a/docs/man3/SDL_SemWait.3 +++ b/docs/man3/SDL_SemWait.3 @@ -1,4 +1,4 @@ -.TH "SDL_SemWait" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" +.TH "SDL_SemWait" "3" "Tue 11 Sep 2001, 23:00" "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, Sun 10 Jun 2001, 19:41 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff --git a/docs/man3/SDL_SemWaitTimeout.3 b/docs/man3/SDL_SemWaitTimeout.3 index c761fecb0..215ad16f0 100644 --- a/docs/man3/SDL_SemWaitTimeout.3 +++ b/docs/man3/SDL_SemWaitTimeout.3 @@ -1,4 +1,4 @@ -.TH "SDL_SemWaitTimeout" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" +.TH "SDL_SemWaitTimeout" "3" "Tue 11 Sep 2001, 23:00" "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, Sun 10 Jun 2001, 19:41 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff --git a/docs/man3/SDL_SetAlpha.3 b/docs/man3/SDL_SetAlpha.3 index afb7a5b18..503fe8e8d 100644 --- a/docs/man3/SDL_SetAlpha.3 +++ b/docs/man3/SDL_SetAlpha.3 @@ -1,4 +1,4 @@ -.TH "SDL_SetAlpha" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" +.TH "SDL_SetAlpha" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" .SH "NAME" SDL_SetAlpha\- Adjust the alpha properties of a surface .SH "SYNOPSIS" @@ -63,4 +63,4 @@ 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, Sun 10 Jun 2001, 19:42 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff --git a/docs/man3/SDL_SetClipRect.3 b/docs/man3/SDL_SetClipRect.3 index 85c7a4e80..71b6ceea2 100644 --- a/docs/man3/SDL_SetClipRect.3 +++ b/docs/man3/SDL_SetClipRect.3 @@ -1,4 +1,4 @@ -.TH "SDL_SetClipRect" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" +.TH "SDL_SetClipRect" "3" "Tue 11 Sep 2001, 23:01" "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, Sun 10 Jun 2001, 19:42 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff --git a/docs/man3/SDL_SetColorKey.3 b/docs/man3/SDL_SetColorKey.3 index 40e0e9ed5..837f790a6 100644 --- a/docs/man3/SDL_SetColorKey.3 +++ b/docs/man3/SDL_SetColorKey.3 @@ -1,4 +1,4 @@ -.TH "SDL_SetColorKey" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" +.TH "SDL_SetColorKey" "3" "Tue 11 Sep 2001, 23:01" "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, Sun 10 Jun 2001, 19:42 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff --git a/docs/man3/SDL_SetColors.3 b/docs/man3/SDL_SetColors.3 index a5627e9c2..0134f917c 100644 --- a/docs/man3/SDL_SetColors.3 +++ b/docs/man3/SDL_SetColors.3 @@ -1,4 +1,4 @@ -.TH "SDL_SetColors" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" +.TH "SDL_SetColors" "3" "Tue 11 Sep 2001, 23:01" "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, Sun 10 Jun 2001, 19:42 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff --git a/docs/man3/SDL_SetCursor.3 b/docs/man3/SDL_SetCursor.3 index c30f01adf..6711274ff 100644 --- a/docs/man3/SDL_SetCursor.3 +++ b/docs/man3/SDL_SetCursor.3 @@ -1,4 +1,4 @@ -.TH "SDL_SetCursor" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" +.TH "SDL_SetCursor" "3" "Tue 11 Sep 2001, 23:01" "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, Sun 10 Jun 2001, 19:42 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff --git a/docs/man3/SDL_SetEventFilter.3 b/docs/man3/SDL_SetEventFilter.3 index 056c619bc..15eee4a29 100644 --- a/docs/man3/SDL_SetEventFilter.3 +++ b/docs/man3/SDL_SetEventFilter.3 @@ -1,4 +1,4 @@ -.TH "SDL_SetEventFilter" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" +.TH "SDL_SetEventFilter" "3" "Tue 11 Sep 2001, 22:59" "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, Sun 10 Jun 2001, 19:40 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59 diff --git a/docs/man3/SDL_SetGamma.3 b/docs/man3/SDL_SetGamma.3 index 961b45141..7237c5ea0 100644 --- a/docs/man3/SDL_SetGamma.3 +++ b/docs/man3/SDL_SetGamma.3 @@ -1,4 +1,4 @@ -.TH "SDL_SetGamma" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" +.TH "SDL_SetGamma" "3" "Tue 11 Sep 2001, 23:01" "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, Sun 10 Jun 2001, 19:42 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff --git a/docs/man3/SDL_SetGammaRamp.3 b/docs/man3/SDL_SetGammaRamp.3 index 473829147..c6978ac4a 100644 --- a/docs/man3/SDL_SetGammaRamp.3 +++ b/docs/man3/SDL_SetGammaRamp.3 @@ -1,4 +1,4 @@ -.TH "SDL_SetGammaRamp" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" +.TH "SDL_SetGammaRamp" "3" "Tue 11 Sep 2001, 23:01" "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, Sun 10 Jun 2001, 19:42 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff --git a/docs/man3/SDL_SetModState.3 b/docs/man3/SDL_SetModState.3 index 66fb9b9a2..1777b1fda 100644 --- a/docs/man3/SDL_SetModState.3 +++ b/docs/man3/SDL_SetModState.3 @@ -1,4 +1,4 @@ -.TH "SDL_SetModState" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" +.TH "SDL_SetModState" "3" "Tue 11 Sep 2001, 23:00" "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, Sun 10 Jun 2001, 19:40 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff --git a/docs/man3/SDL_SetPalette.3 b/docs/man3/SDL_SetPalette.3 index 2710cec2d..90387f0e6 100644 --- a/docs/man3/SDL_SetPalette.3 +++ b/docs/man3/SDL_SetPalette.3 @@ -1,4 +1,4 @@ -.TH "SDL_SetPalette" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" +.TH "SDL_SetPalette" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" .SH "NAME" SDL_SetPalette\- Sets the colors in the palette of an 8-bit surface\&. .SH "SYNOPSIS" @@ -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, Sun 10 Jun 2001, 19:42 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff --git a/docs/man3/SDL_SetTimer.3 b/docs/man3/SDL_SetTimer.3 index b7efb481d..dac4650dd 100644 --- a/docs/man3/SDL_SetTimer.3 +++ b/docs/man3/SDL_SetTimer.3 @@ -1,4 +1,4 @@ -.TH "SDL_SetTimer" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" +.TH "SDL_SetTimer" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" .SH "NAME" SDL_SetTimer\- Set a callback to run after the specified number of milliseconds has elapsed\&. .SH "SYNOPSIS" @@ -36,4 +36,4 @@ This function is kept for compatibility but has been superseded by the new timer .SH "SEE ALSO" .PP \fI\fBSDL_AddTimer\fP\fR -...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff --git a/docs/man3/SDL_SetVideoMode.3 b/docs/man3/SDL_SetVideoMode.3 index 24e407c97..f83d1012a 100644 --- a/docs/man3/SDL_SetVideoMode.3 +++ b/docs/man3/SDL_SetVideoMode.3 @@ -1,4 +1,4 @@ -.TH "SDL_SetVideoMode" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" +.TH "SDL_SetVideoMode" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" .SH "NAME" SDL_SetVideoMode\- Set up a video mode with the specified width, height and bits-per-pixel\&. .SH "SYNOPSIS" @@ -21,25 +21,25 @@ Create the video surface in system memory Create the video surface in video memory .TP 20 \fBSDL_ASYNCBLIT\fP -Enables the use of asynchronous to the display surface\&. This will usually slow down blitting on single CPU machines, but may provide a speed increase on SMP systems\&. +Enables the use of asynchronous updates of the display surface\&. This will usually slow down blitting on single CPU machines, but may provide a speed increase on SMP systems\&. .TP 20 \fBSDL_ANYFORMAT\fP -Normally, if a video surface of the requested depth (\fBbpp\fR) is not available, SDL will emulate one with a shadow surface\&. Passing \fBSDL_ANYFORMAT\fP prevents this and causes SDL to use the video surface, regardless of its depth\&. +Normally, if a video surface of the requested bits-per-pixel (\fBbpp\fR) is not available, SDL will emulate one with a shadow surface\&. Passing \fBSDL_ANYFORMAT\fP prevents this and causes SDL to use the video surface, regardless of its pixel depth\&. .TP 20 \fBSDL_HWPALETTE\fP -Give SDL exclusive palette access\&. Without this flag you may not always get the the colors you request with \fI\fBSDL_SetColors\fP\fR\&. +Give SDL exclusive palette access\&. Without this flag you may not always get the the colors you request with \fI\fBSDL_SetColors\fP\fR or \fI\fBSDL_SetPalette\fP\fR\&. .TP 20 \fBSDL_DOUBLEBUF\fP -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\&. +Enable hardware double buffering; only valid with SDL_HWSURFACE\&. Calling \fI\fBSDL_Flip\fP\fR will flip the buffers and update the screen\&. All drawing will take place on the surface that is not displayed at the moment\&. 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 +SDL will attempt to use a fullscreen mode\&. If a hardware resolution change is not possible (for whatever reason), the next higher resolution will be used and the display window centered on a black background\&. .TP 20 \fBSDL_OPENGL\fP Create an OpenGL rendering context\&. You should have previously set OpenGL video attributes with \fI\fBSDL_GL_SetAttribute\fP\fR\&. .TP 20 \fBSDL_OPENGLBLIT\fP -Create an OpenGL rendering context, like above, but allow normal blitting operations\&. +Create an OpenGL rendering context, like above, but allow normal blitting operations\&. The screen (2D) surface may have an alpha channel, and \fI\fBSDL_UpdateRects\fP\fR must be used for updating changes to the screen surface\&. .TP 20 \fBSDL_RESIZABLE\fP Create a resizable window\&. When the window is resized by the user a \fI\fBSDL_VIDEORESIZE\fP\fR event is generated and \fBSDL_SetVideoMode\fP can be called again with the new size\&. @@ -52,10 +52,16 @@ If possible, \fBSDL_NOFRAME\fP causes SDL to create a window with no title bar o .PP Whatever \fBflags\fR \fBSDL_SetVideoMode\fP could satisfy are set in the \fBflags\fR member of the returned surface\&. .RE +.PP +.RS +\fBNote: +.PP +The \fBbpp\fR parameter is the number of bits per pixel, so a \fBbpp\fR of 24 uses the packed representation of 3 bytes/pixel\&. For the more common 4 bytes/pixel mode, use a \fBbpp\fR of 32\&. Somewhat oddly, both 15 and 16 will request a 2 bytes/pixel mode, but different pixel formats\&. +.RE .SH "RETURN VALUE" .PP -The framebuffer surface, or \fBNULL\fR if it fails\&. +The framebuffer surface, or \fBNULL\fR if it fails\&. The surface returned is freed by SDL_Quit() and should nt be freed by the caller\&. .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, Sun 10 Jun 2001, 19:42 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff --git a/docs/man3/SDL_ShowCursor.3 b/docs/man3/SDL_ShowCursor.3 index ea2ed5eff..0b42ed57f 100644 --- a/docs/man3/SDL_ShowCursor.3 +++ b/docs/man3/SDL_ShowCursor.3 @@ -1,4 +1,4 @@ -.TH "SDL_ShowCursor" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" +.TH "SDL_ShowCursor" "3" "Tue 11 Sep 2001, 23:01" "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, Sun 10 Jun 2001, 19:42 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff --git a/docs/man3/SDL_Surface.3 b/docs/man3/SDL_Surface.3 index ed2c22b9f..a627d0644 100644 --- a/docs/man3/SDL_Surface.3 +++ b/docs/man3/SDL_Surface.3 @@ -1,4 +1,4 @@ -.TH "SDL_Surface" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" +.TH "SDL_Surface" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" .SH "NAME" SDL_Surface\- Graphical Surface Structure .SH "STRUCTURE DEFINITION" @@ -93,4 +93,4 @@ Surface uses preallocated memory .SH "SEE ALSO" .PP \fI\fBSDL_PixelFormat\fR\fR -...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff --git a/docs/man3/SDL_SysWMEvent.3 b/docs/man3/SDL_SysWMEvent.3 index b95124f32..84b629ba9 100644 --- a/docs/man3/SDL_SysWMEvent.3 +++ b/docs/man3/SDL_SysWMEvent.3 @@ -1,4 +1,4 @@ -.TH "SDL_SysWMEvent" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" +.TH "SDL_SysWMEvent" "3" "Tue 11 Sep 2001, 23:00" "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, Sun 10 Jun 2001, 19:40 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff --git a/docs/man3/SDL_ThreadID.3 b/docs/man3/SDL_ThreadID.3 index 7418fc0b1..1658c7125 100644 --- a/docs/man3/SDL_ThreadID.3 +++ b/docs/man3/SDL_ThreadID.3 @@ -1,4 +1,4 @@ -.TH "SDL_ThreadID" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" +.TH "SDL_ThreadID" "3" "Tue 11 Sep 2001, 23:00" "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, Sun 10 Jun 2001, 19:41 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff --git a/docs/man3/SDL_UnlockAudio.3 b/docs/man3/SDL_UnlockAudio.3 index c4050c4a5..4d385bf2e 100644 --- a/docs/man3/SDL_UnlockAudio.3 +++ b/docs/man3/SDL_UnlockAudio.3 @@ -1,4 +1,4 @@ -.TH "SDL_UnlockAudio" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" +.TH "SDL_UnlockAudio" "3" "Tue 11 Sep 2001, 22:58" "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, Sun 10 Jun 2001, 19:40 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58 diff --git a/docs/man3/SDL_UnlockSurface.3 b/docs/man3/SDL_UnlockSurface.3 index 0c68fb506..3661467dd 100644 --- a/docs/man3/SDL_UnlockSurface.3 +++ b/docs/man3/SDL_UnlockSurface.3 @@ -1,4 +1,4 @@ -.TH "SDL_UnlockSurface" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" +.TH "SDL_UnlockSurface" "3" "Tue 11 Sep 2001, 23:01" "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, Sun 10 Jun 2001, 19:42 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff --git a/docs/man3/SDL_UnlockYUVOverlay.3 b/docs/man3/SDL_UnlockYUVOverlay.3 index 782ceeaef..5cda838f8 100644 --- a/docs/man3/SDL_UnlockYUVOverlay.3 +++ b/docs/man3/SDL_UnlockYUVOverlay.3 @@ -1,4 +1,4 @@ -.TH "SDL_UnlockYUVOverlay" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" +.TH "SDL_UnlockYUVOverlay" "3" "Tue 11 Sep 2001, 23:01" "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, Sun 10 Jun 2001, 19:42 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff --git a/docs/man3/SDL_UpdateRect.3 b/docs/man3/SDL_UpdateRect.3 index a885d8d09..fbb334038 100644 --- a/docs/man3/SDL_UpdateRect.3 +++ b/docs/man3/SDL_UpdateRect.3 @@ -1,4 +1,4 @@ -.TH "SDL_UpdateRect" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" +.TH "SDL_UpdateRect" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" .SH "NAME" SDL_UpdateRect\- Makes sure the given area is updated on the given screen\&. .SH "SYNOPSIS" @@ -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, Sun 10 Jun 2001, 19:42 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff --git a/docs/man3/SDL_UpdateRects.3 b/docs/man3/SDL_UpdateRects.3 index b4cd733e0..0db2dee89 100644 --- a/docs/man3/SDL_UpdateRects.3 +++ b/docs/man3/SDL_UpdateRects.3 @@ -1,4 +1,4 @@ -.TH "SDL_UpdateRects" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" +.TH "SDL_UpdateRects" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference" .SH "NAME" SDL_UpdateRects\- Makes sure the given list of rectangles is updated on the given screen\&. .SH "SYNOPSIS" @@ -22,4 +22,4 @@ The rectangles are not automatically merged or checked for overlap\&. In general .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, Sun 10 Jun 2001, 19:42 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff --git a/docs/man3/SDL_UserEvent.3 b/docs/man3/SDL_UserEvent.3 index 439ac4167..ed25ea0db 100644 --- a/docs/man3/SDL_UserEvent.3 +++ b/docs/man3/SDL_UserEvent.3 @@ -1,4 +1,4 @@ -.TH "SDL_UserEvent" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" +.TH "SDL_UserEvent" "3" "Tue 11 Sep 2001, 23:00" "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, Sun 10 Jun 2001, 19:40 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff --git a/docs/man3/SDL_VideoDriverName.3 b/docs/man3/SDL_VideoDriverName.3 index ca5c9617f..52b116574 100644 --- a/docs/man3/SDL_VideoDriverName.3 +++ b/docs/man3/SDL_VideoDriverName.3 @@ -1,4 +1,4 @@ -.TH "SDL_VideoDriverName" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" +.TH "SDL_VideoDriverName" "3" "Tue 11 Sep 2001, 23:01" "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, Sun 10 Jun 2001, 19:42 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff --git a/docs/man3/SDL_VideoInfo.3 b/docs/man3/SDL_VideoInfo.3 index ab067eab0..ed11835e1 100644 --- a/docs/man3/SDL_VideoInfo.3 +++ b/docs/man3/SDL_VideoInfo.3 @@ -1,4 +1,4 @@ -.TH "SDL_VideoInfo" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" +.TH "SDL_VideoInfo" "3" "Tue 11 Sep 2001, 23:01" "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, Sun 10 Jun 2001, 19:42 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff --git a/docs/man3/SDL_VideoModeOK.3 b/docs/man3/SDL_VideoModeOK.3 index 3f30e2d87..8245ae6e6 100644 --- a/docs/man3/SDL_VideoModeOK.3 +++ b/docs/man3/SDL_VideoModeOK.3 @@ -1,4 +1,4 @@ -.TH "SDL_VideoModeOK" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" +.TH "SDL_VideoModeOK" "3" "Tue 11 Sep 2001, 23:01" "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, Sun 10 Jun 2001, 19:42 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff --git a/docs/man3/SDL_WM_GetCaption.3 b/docs/man3/SDL_WM_GetCaption.3 index da7fa1449..4507cab6a 100644 --- a/docs/man3/SDL_WM_GetCaption.3 +++ b/docs/man3/SDL_WM_GetCaption.3 @@ -1,4 +1,4 @@ -.TH "SDL_WM_GetCaption" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" +.TH "SDL_WM_GetCaption" "3" "Tue 11 Sep 2001, 23:01" "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, Sun 10 Jun 2001, 19:42 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff --git a/docs/man3/SDL_WM_GrabInput.3 b/docs/man3/SDL_WM_GrabInput.3 index e9079a20e..3948af7ec 100644 --- a/docs/man3/SDL_WM_GrabInput.3 +++ b/docs/man3/SDL_WM_GrabInput.3 @@ -1,4 +1,4 @@ -.TH "SDL_WM_GrabInput" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" +.TH "SDL_WM_GrabInput" "3" "Tue 11 Sep 2001, 23:01" "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, Sun 10 Jun 2001, 19:42 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff --git a/docs/man3/SDL_WM_IconifyWindow.3 b/docs/man3/SDL_WM_IconifyWindow.3 index 4f4146e80..dea10eb12 100644 --- a/docs/man3/SDL_WM_IconifyWindow.3 +++ b/docs/man3/SDL_WM_IconifyWindow.3 @@ -1,4 +1,4 @@ -.TH "SDL_WM_IconifyWindow" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" +.TH "SDL_WM_IconifyWindow" "3" "Tue 11 Sep 2001, 23:02" "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, Sun 10 Jun 2001, 19:42 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:02 diff --git a/docs/man3/SDL_WM_SetCaption.3 b/docs/man3/SDL_WM_SetCaption.3 index 0863644e8..d21ef4f40 100644 --- a/docs/man3/SDL_WM_SetCaption.3 +++ b/docs/man3/SDL_WM_SetCaption.3 @@ -1,4 +1,4 @@ -.TH "SDL_WM_SetCaption" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" +.TH "SDL_WM_SetCaption" "3" "Tue 11 Sep 2001, 23:02" "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, Sun 10 Jun 2001, 19:42 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:02 diff --git a/docs/man3/SDL_WM_SetIcon.3 b/docs/man3/SDL_WM_SetIcon.3 index f23f930eb..fccebe503 100644 --- a/docs/man3/SDL_WM_SetIcon.3 +++ b/docs/man3/SDL_WM_SetIcon.3 @@ -1,4 +1,4 @@ -.TH "SDL_WM_SetIcon" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" +.TH "SDL_WM_SetIcon" "3" "Tue 11 Sep 2001, 23:02" "SDL" "SDL API Reference" .SH "NAME" SDL_WM_SetIcon\- Sets the icon for the display window\&. .SH "SYNOPSIS" @@ -8,7 +8,7 @@ SDL_WM_SetIcon\- Sets the icon for the display window\&. \fBvoid \fBSDL_WM_SetIcon\fP\fR(\fBSDL_Surface *icon, Uint8 *mask\fR); .SH "DESCRIPTION" .PP -Sets the icon for the display window\&. +Sets the icon for the display window\&. Win32 icons must be 32x32\&. .PP This function must be called before the first call to \fISDL_SetVideoMode\fR\&. .PP @@ -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, Sun 10 Jun 2001, 19:42 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:02 diff --git a/docs/man3/SDL_WM_ToggleFullScreen.3 b/docs/man3/SDL_WM_ToggleFullScreen.3 index dcf58366d..a1def8e3f 100644 --- a/docs/man3/SDL_WM_ToggleFullScreen.3 +++ b/docs/man3/SDL_WM_ToggleFullScreen.3 @@ -1,4 +1,4 @@ -.TH "SDL_WM_ToggleFullScreen" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" +.TH "SDL_WM_ToggleFullScreen" "3" "Tue 11 Sep 2001, 23:02" "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, Sun 10 Jun 2001, 19:42 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:02 diff --git a/docs/man3/SDL_WaitEvent.3 b/docs/man3/SDL_WaitEvent.3 index db7b841c1..181cb94a4 100644 --- a/docs/man3/SDL_WaitEvent.3 +++ b/docs/man3/SDL_WaitEvent.3 @@ -1,4 +1,4 @@ -.TH "SDL_WaitEvent" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" +.TH "SDL_WaitEvent" "3" "Tue 11 Sep 2001, 23:00" "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, Sun 10 Jun 2001, 19:40 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff --git a/docs/man3/SDL_WaitThread.3 b/docs/man3/SDL_WaitThread.3 index 79fae97d8..501ba614a 100644 --- a/docs/man3/SDL_WaitThread.3 +++ b/docs/man3/SDL_WaitThread.3 @@ -1,4 +1,4 @@ -.TH "SDL_WaitThread" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" +.TH "SDL_WaitThread" "3" "Tue 11 Sep 2001, 23:01" "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, Sun 10 Jun 2001, 19:41 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff --git a/docs/man3/SDL_WarpMouse.3 b/docs/man3/SDL_WarpMouse.3 index 2657c1ba2..2306f1b54 100644 --- a/docs/man3/SDL_WarpMouse.3 +++ b/docs/man3/SDL_WarpMouse.3 @@ -1,4 +1,4 @@ -.TH "SDL_WarpMouse" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" +.TH "SDL_WarpMouse" "3" "Tue 11 Sep 2001, 23:01" "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, Sun 10 Jun 2001, 19:42 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff --git a/docs/man3/SDL_WasInit.3 b/docs/man3/SDL_WasInit.3 index 68f708a2d..80e56296b 100644 --- a/docs/man3/SDL_WasInit.3 +++ b/docs/man3/SDL_WasInit.3 @@ -1,4 +1,4 @@ -.TH "SDL_WasInit" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" +.TH "SDL_WasInit" "3" "Tue 11 Sep 2001, 23:00" "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, Sun 10 Jun 2001, 19:41 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff --git a/docs/man3/SDL_keysym.3 b/docs/man3/SDL_keysym.3 index 0fad47dba..c5fdf4ac5 100644 --- a/docs/man3/SDL_keysym.3 +++ b/docs/man3/SDL_keysym.3 @@ -1,4 +1,4 @@ -.TH "SDL_keysym" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference" +.TH "SDL_keysym" "3" "Tue 11 Sep 2001, 23:00" "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, Sun 10 Jun 2001, 19:40 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00 diff --git a/docs/man3/SDL_mutexP.3 b/docs/man3/SDL_mutexP.3 index db5794881..612bfde76 100644 --- a/docs/man3/SDL_mutexP.3 +++ b/docs/man3/SDL_mutexP.3 @@ -1,4 +1,4 @@ -.TH "SDL_mutexP" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" +.TH "SDL_mutexP" "3" "Tue 11 Sep 2001, 23:01" "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, Sun 10 Jun 2001, 19:41 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01 diff --git a/docs/man3/SDL_mutexV.3 b/docs/man3/SDL_mutexV.3 index a925fe1da..90c7545d5 100644 --- a/docs/man3/SDL_mutexV.3 +++ b/docs/man3/SDL_mutexV.3 @@ -1,4 +1,4 @@ -.TH "SDL_mutexV" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference" +.TH "SDL_mutexV" "3" "Tue 11 Sep 2001, 23:01" "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, Sun 10 Jun 2001, 19:41 +...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01