pandory500/SDL-mirror
2
0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated from the SDL Documentation Project

Browse source 
--HG--
extra : convert_revision : svn%3Ac70aab31-4412-0410-b14c-859654838e24/trunk%40182
This commit is contained in:
Sam Lantinga 2001-09-14 02:41:09 +00:00
parent 627578c0d5
commit 8dd601989f
355 changed files with 2317 additions and 1398 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/man3/Makefile.am
View file

@ -46,6 +46,7 @@ man_MANS = \
SDL_EnableUNICODE.3 \
SDL_Event.3 \
SDL_EventState.3 \
SDL_ExposeEvent.3 \
SDL_FillRect.3 \
SDL_Flip.3 \
SDL_FreeCursor.3 \
@ -62,6 +63,7 @@ man_MANS = \
SDL_GetAudioStatus.3 \
SDL_GetClipRect.3 \
SDL_GetCursor.3 \
SDL_GetError.3 \
SDL_GetEventFilter.3 \
SDL_GetGamma.3 \
SDL_GetGammaRamp.3 \

4
docs/man3/SDL_ActiveEvent.3
View file

@ -1,4 +1,4 @@
.TH "SDL_ActiveEvent" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference"
.TH "SDL_ActiveEvent" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference"
.SH "NAME"
SDL_ActiveEvent\- Application visibility event structure
.SH "STRUCTURE DEFINITION"
@ -35,4 +35,4 @@ This event does not occur when an application window is first created\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_Event\fR\fR, \fI\fBSDL_GetAppState\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

4
docs/man3/SDL_AddTimer.3
View file

@ -1,4 +1,4 @@
.TH "SDL_AddTimer" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_AddTimer" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
.SH "NAME"
SDL_AddTimer\- Add a timer which will call a callback after the specified number of milliseconds has elapsed\&.
.SH "SYNOPSIS"
@ -35,4 +35,4 @@ Returns an ID value for the added timer or \fBNULL\fR if there was an error\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_RemoveTimer\fP\fR, \fI\fBSDL_PushEvent\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

4
docs/man3/SDL_AudioCVT.3
View file

@ -1,4 +1,4 @@
.TH "SDL_AudioCVT" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference"
.TH "SDL_AudioCVT" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference"
.SH "NAME"
SDL_AudioCVT\- Audio Conversion Structure
.SH "STRUCTURE DEFINITION"
@ -65,4 +65,4 @@ Many of the fields in the \fBSDL_AudioCVT\fR structure should be considered priv
.SH "SEE ALSO"
.PP
\fI\fBSDL_BuildAudioCVT\fP\fR, \fI\fBSDL_ConvertAudio\fP\fR, \fI\fBSDL_AudioSpec\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:58

4
docs/man3/SDL_AudioSpec.3
View file

@ -1,4 +1,4 @@
.TH "SDL_AudioSpec" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference"
.TH "SDL_AudioSpec" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference"
.SH "NAME"
SDL_AudioSpec\- Audio Specification Structure
.SH "STRUCTURE DEFINITION"
@ -67,4 +67,4 @@ When used with \fI\fBSDL_OpenAudio\fP\fR this refers to the size of the audio bu
.SH "SEE ALSO"
.PP
\fI\fBSDL_OpenAudio\fP\fR, \fI\fBSDL_LoadWAV\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

4
docs/man3/SDL_BlitSurface.3
View file

@ -1,4 +1,4 @@
.TH "SDL_BlitSurface" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_BlitSurface" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
.SH "NAME"
SDL_BlitSurface\- This performs a fast blit from the source surface to the destination surface\&.
.SH "SYNOPSIS"
@ -57,4 +57,4 @@ If either of the surfaces were in video memory, and the blit returns \fB-2\fR, t
.SH "SEE ALSO"
.PP
\fI\fBSDL_LockSurface\fP\fR, \fI\fBSDL_FillRect\fP\fR, \fI\fBSDL_Surface\fR\fR, \fI\fBSDL_Rect\fR\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01

4
docs/man3/SDL_BuildAudioCVT.3
View file

@ -1,4 +1,4 @@
.TH "SDL_BuildAudioCVT" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference"
.TH "SDL_BuildAudioCVT" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference"
.SH "NAME"
SDL_BuildAudioCVT\- Initializes a SDL_AudioCVT structure for conversion
.SH "SYNOPSIS"
@ -20,4 +20,4 @@ See \fI\fBSDL_ConvertAudio\fP\fR\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_ConvertAudio\fP\fR, \fI\fBSDL_AudioCVT\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58

4
docs/man3/SDL_CD.3
View file

@ -1,4 +1,4 @@
.TH "SDL_CD" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference"
.TH "SDL_CD" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference"
.SH "NAME"
SDL_CD\- CDROM Drive Information
.SH "STRUCTURE DEFINITION"
@ -54,4 +54,4 @@ frame_offset=MSF_TO_FRAMES(min, sec, frame);\fR
.SH "SEE ALSO"
.PP
\fI\fBSDL_CDOpen\fP\fR, \fI\fBSDL_CDtrack\fR\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58

4
docs/man3/SDL_CDClose.3
View file

@ -1,4 +1,4 @@
.TH "SDL_CDClose" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference"
.TH "SDL_CDClose" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference"
.SH "NAME"
SDL_CDClose\- Closes a SDL_CD handle
.SH "SYNOPSIS"
@ -12,4 +12,4 @@ Closes the given \fBcdrom\fR handle\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_CDOpen\fP\fR, \fI\fBSDL_CD\fR\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58

4
docs/man3/SDL_CDEject.3
View file

@ -1,4 +1,4 @@
.TH "SDL_CDEject" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference"
.TH "SDL_CDEject" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference"
.SH "NAME"
SDL_CDEject\- Ejects a CDROM
.SH "SYNOPSIS"
@ -15,4 +15,4 @@ Returns \fB0\fR on success, or \fB-1\fR on an error\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_CD\fR\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58

4
docs/man3/SDL_CDName.3
View file

@ -1,4 +1,4 @@
.TH "SDL_CDName" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference"
.TH "SDL_CDName" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference"
.SH "NAME"
SDL_CDName\- Returns a human-readable, system-dependent identifier for the CD-ROM\&.
.SH "SYNOPSIS"
@ -20,4 +20,4 @@ Returns a human-readable, system-dependent identifier for the CD-ROM\&. \fBdrive
.SH "SEE ALSO"
.PP
\fI\fBSDL_CDNumDrives\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58

4
docs/man3/SDL_CDNumDrives.3
View file

@ -1,4 +1,4 @@
.TH "SDL_CDNumDrives" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference"
.TH "SDL_CDNumDrives" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference"
.SH "NAME"
SDL_CDNumDrives\- Returns the number of CD-ROM drives on the system\&.
.SH "SYNOPSIS"
@ -12,4 +12,4 @@ Returns the number of CD-ROM drives on the system\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_CDOpen\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58

4
docs/man3/SDL_CDOpen.3
View file

@ -1,4 +1,4 @@
.TH "SDL_CDOpen" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference"
.TH "SDL_CDOpen" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference"
.SH "NAME"
SDL_CDOpen\- Opens a CD-ROM drive for access\&.
.SH "SYNOPSIS"
@ -55,4 +55,4 @@ SDL_CDClose(cdrom);\fR
.SH "SEE ALSO"
.PP
\fI\fBSDL_CD\fR\fR, \fI\fBSDL_CDtrack\fR\fR, \fI\fBSDL_CDClose\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58

4
docs/man3/SDL_CDPause.3
View file

@ -1,4 +1,4 @@
.TH "SDL_CDPause" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference"
.TH "SDL_CDPause" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference"
.SH "NAME"
SDL_CDPause\- Pauses a CDROM
.SH "SYNOPSIS"
@ -15,4 +15,4 @@ Returns \fB0\fR on success, or \fB-1\fR on an error\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_CDPlay\fP\fR, \fI\fBSDL_CDResume\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58

4
docs/man3/SDL_CDPlay.3
View file

@ -1,4 +1,4 @@
.TH "SDL_CDPlay" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference"
.TH "SDL_CDPlay" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference"
.SH "NAME"
SDL_CDPlay\- Play a CD
.SH "SYNOPSIS"
@ -15,4 +15,4 @@ Returns \fB0\fR on success, or \fB-1\fR on an error\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_CDPlayTracks\fP\fR, \fI\fBSDL_CDStop\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58

4
docs/man3/SDL_CDPlayTracks.3
View file

@ -1,4 +1,4 @@
.TH "SDL_CDPlayTracks" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference"
.TH "SDL_CDPlayTracks" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference"
.SH "NAME"
SDL_CDPlayTracks\- Play the given CD track(s)
.SH "SYNOPSIS"
@ -44,4 +44,4 @@ if(CD_INDRIVE(SDL_CDStatus(cdrom)))
.SH "SEE ALSO"
.PP
\fI\fBSDL_CDPlay\fP\fR, \fI\fBSDL_CDStatus\fP\fR, \fI\fBSDL_CD\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58

4
docs/man3/SDL_CDResume.3
View file

@ -1,4 +1,4 @@
.TH "SDL_CDResume" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference"
.TH "SDL_CDResume" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference"
.SH "NAME"
SDL_CDResume\- Resumes a CDROM
.SH "SYNOPSIS"
@ -15,4 +15,4 @@ Returns \fB0\fR on success, or \fB-1\fR on an error\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_CDPlay\fP\fR, \fI\fBSDL_CDPause\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58

4
docs/man3/SDL_CDStatus.3
View file

@ -1,4 +1,4 @@
.TH "SDL_CDStatus" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference"
.TH "SDL_CDStatus" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference"
.SH "NAME"
SDL_CDStatus\- Returns the current status of the given drive\&.
.SH "SYNOPSIS"
@ -56,4 +56,4 @@ The macro \fBCD_INDRIVE\fP is provided for convenience, and given a status retur
.SH "SEE ALSO"
.PP
\fI\fBSDL_CD\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58

4
docs/man3/SDL_CDStop.3
View file

@ -1,4 +1,4 @@
.TH "SDL_CDStop" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference"
.TH "SDL_CDStop" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference"
.SH "NAME"
SDL_CDStop\- Stops a CDROM
.SH "SYNOPSIS"
@ -15,4 +15,4 @@ Returns \fB0\fR on success, or \fB-1\fR on an error\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_CDPlay\fP\fR,
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59

4
docs/man3/SDL_CDtrack.3
View file

@ -1,4 +1,4 @@
.TH "SDL_CDtrack" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference"
.TH "SDL_CDtrack" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference"
.SH "NAME"
SDL_CDtrack\- CD Track Information Structure
.SH "STRUCTURE DEFINITION"
@ -37,4 +37,4 @@ Frames can be converted to standard timings\&. There are \fBCD_FPS\fP frames per
.SH "SEE ALSO"
.PP
\fI\fBSDL_CD\fR\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59

4
docs/man3/SDL_CloseAudio.3
View file

@ -1,4 +1,4 @@
.TH "SDL_CloseAudio" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference"
.TH "SDL_CloseAudio" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference"
.SH "NAME"
SDL_CloseAudio\- Shuts down audio processing and closes the audio device\&.
.SH "SYNOPSIS"
@ -12,4 +12,4 @@ This function shuts down audio processing and closes the audio device\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_OpenAudio\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58

4
docs/man3/SDL_Color.3
View file

@ -1,4 +1,4 @@
.TH "SDL_Color" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_Color" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
.SH "NAME"
SDL_Color\- Format independent color description
.SH "STRUCTURE DEFINITION"
@ -31,4 +31,4 @@ Unused
.SH "SEE ALSO"
.PP
\fI\fBSDL_PixelFormat\fR\fR, \fI\fBSDL_SetColors\fP\fR, \fI\fBSDL_Palette\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01

4
docs/man3/SDL_CondBroadcast.3
View file

@ -1,4 +1,4 @@
.TH "SDL_CondBroadcast" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_CondBroadcast" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference"
.SH "NAME"
SDL_CondBroadcast\- Restart all threads waiting on a condition variable
.SH "SYNOPSIS"
@ -13,4 +13,4 @@ Restarts all threads that are waiting on the condition variable, \fBcond\fR\&. R
.SH "SEE ALSO"
.PP
\fI\fBSDL_CondSignal\fP\fR, \fI\fBSDL_CondWait\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00

4
docs/man3/SDL_CondSignal.3
View file

@ -1,4 +1,4 @@
.TH "SDL_CondSignal" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_CondSignal" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference"
.SH "NAME"
SDL_CondSignal\- Restart a thread wait on a condition variable
.SH "SYNOPSIS"
@ -13,4 +13,4 @@ Restart one of the threads that are waiting on the condition variable, \fBcond\f
.SH "SEE ALSO"
.PP
\fI\fBSDL_CondWait\fP\fR, \fI\fBSDL_CondBroadcast\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00

4
docs/man3/SDL_CondWait.3
View file

@ -1,4 +1,4 @@
.TH "SDL_CondWait" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_CondWait" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference"
.SH "NAME"
SDL_CondWait\- Wait on a condition variable
.SH "SYNOPSIS"
@ -13,4 +13,4 @@ Wait on the condition variable \fBcond\fR and unlock the provided mutex\&. The m
.SH "SEE ALSO"
.PP
\fI\fBSDL_CondWaitTimeout\fP\fR, \fI\fBSDL_CondSignal\fP\fR, \fI\fBSDL_mutexP\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00

4
docs/man3/SDL_CondWaitTimeout.3
View file

@ -1,4 +1,4 @@
.TH "SDL_CondWaitTimeout" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_CondWaitTimeout" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference"
.SH "NAME"
SDL_CondWaitTimeout\- Wait on a condition variable, with timeout
.SH "SYNOPSIS"
@ -13,4 +13,4 @@ Wait on the condition variable \fBcond\fR for, at most, \fBms\fR milliseconds\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_CondWait\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00

4
docs/man3/SDL_ConvertAudio.3
View file

@ -1,4 +1,4 @@
.TH "SDL_ConvertAudio" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference"
.TH "SDL_ConvertAudio" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference"
.SH "NAME"
SDL_ConvertAudio\- Convert audio data to a desired audio format\&.
.SH "SYNOPSIS"
@ -92,4 +92,4 @@ SDL_ConvertAudio(&wav_cvt);
.SH "SEE ALSO"
.PP
\fI\fBSDL_BuildAudioCVT\fP\fR, \fI\fBSDL_AudioCVT\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58

8
docs/man3/SDL_ConvertSurface.3
View file

@ -1,9 +1,9 @@
.TH "SDL_ConvertSurface" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_ConvertSurface" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
.SH "NAME"
SDL_ConvertSurface\- Converts a surface to the same format as another surface\&.
.SH "SYNOPSIS"
.PP
\fB#include "SDL\&.h"
\fB#include "SDL/SDL\&.h"
.sp
\fBSDL_Surface *\fBSDL_ConvertSurface\fP\fR(\fBSDL_Surface *src, SDL_PixelFormat *fmt, Uint32 flags\fR);
.SH "DESCRIPTION"
@ -13,10 +13,12 @@ Creates a new surface of the specified format, and then copies and maps the give
The \fBflags\fR parameter is passed to \fI\fBSDL_CreateRGBSurface\fP\fR and has those semantics\&.
.PP
This function is used internally by \fI\fBSDL_DisplayFormat\fP\fR\&.
.PP
This function can only be called after SDL_Init\&.
.SH "RETURN VALUE"
.PP
Returns either a pointer to the new surface, or \fBNULL\fP on error\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_CreateRGBSurface\fP\fR, \fI\fBSDL_DisplayFormat\fP\fR, \fI\fBSDL_PixelFormat\fR\fR, \fI\fBSDL_Surface\fR\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01

4
docs/man3/SDL_CreateCond.3
View file

@ -1,4 +1,4 @@
.TH "SDL_CreateCond" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_CreateCond" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference"
.SH "NAME"
SDL_CreateCond\- Create a condition variable
.SH "SYNOPSIS"
@ -28,4 +28,4 @@ SDL_DestroyCond(cond);\fR
.SH "SEE ALSO"
.PP
\fI\fBSDL_DestroyCond\fP\fR, \fI\fBSDL_CondWait\fP\fR, \fI\fBSDL_CondSignal\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00

4
docs/man3/SDL_CreateCursor.3
View file

@ -1,4 +1,4 @@
.TH "SDL_CreateCursor" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_CreateCursor" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
.SH "NAME"
SDL_CreateCursor\- Creates a new mouse cursor\&.
.SH "SYNOPSIS"
@ -117,4 +117,4 @@ static SDL_Cursor *init_system_cursor(const char *image[])
.SH "SEE ALSO"
.PP
\fI\fBSDL_FreeCursor\fP\fR, \fI\fBSDL_SetCursor\fP\fR, \fI\fBSDL_ShowCursor\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01

4
docs/man3/SDL_CreateMutex.3
View file

@ -1,4 +1,4 @@
.TH "SDL_CreateMutex" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_CreateMutex" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference"
.SH "NAME"
SDL_CreateMutex\- Create a mutex
.SH "SYNOPSIS"
@ -40,4 +40,4 @@ SDL_DestroyMutex(mut);
.SH "SEE ALSO"
.PP
\fI\fBSDL_mutexP\fP\fR, \fI\fBSDL_mutexV\fP\fR, \fI\fBSDL_DestroyMutex\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00

4
docs/man3/SDL_CreateRGBSurface.3
View file

@ -1,4 +1,4 @@
.TH "SDL_CreateRGBSurface" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_CreateRGBSurface" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
.SH "NAME"
SDL_CreateRGBSurface\- Create an empty SDL_Surface
.SH "SYNOPSIS"
@ -66,4 +66,4 @@ Returns the created surface, or \fBNULL\fR upon error\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_CreateRGBSurfaceFrom\fP\fR, \fI\fBSDL_FreeSurface\fP\fR, \fI\fBSDL_SetVideoMode\fP\fR, \fI\fBSDL_LockSurface\fP\fR, \fI\fBSDL_PixelFormat\fR\fR, \fI\fBSDL_Surface\fR\fR \fI\fBSDL_SetAlpha\fP\fR \fI\fBSDL_SetColorKey\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

4
docs/man3/SDL_CreateRGBSurfaceFrom.3
View file

@ -1,4 +1,4 @@
.TH "SDL_CreateRGBSurfaceFrom" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_CreateRGBSurfaceFrom" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
.SH "NAME"
SDL_CreateRGBSurfaceFrom\- Create an SDL_Surface from pixel data
.SH "SYNOPSIS"
@ -19,4 +19,4 @@ Returns the created surface, or \fBNULL\fR upon error\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_CreateRGBSurface\fP\fR, \fI\fBSDL_FreeSurface\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01

4
docs/man3/SDL_CreateSemaphore.3
View file

@ -1,4 +1,4 @@
.TH "SDL_CreateSemaphore" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_CreateSemaphore" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference"
.SH "NAME"
SDL_CreateSemaphore\- Creates a new semaphore and assigns an initial value to it\&.
.SH "SYNOPSIS"
@ -29,4 +29,4 @@ if (my_sem == NULL) {
.SH "SEE ALSO"
.PP
\fI\fBSDL_DestroySemaphore\fP\fR, \fI\fBSDL_SemWait\fP\fR, \fI\fBSDL_SemTryWait\fP\fR, \fI\fBSDL_SemWaitTimeout\fP\fR, \fI\fBSDL_SemPost\fP\fR, \fI\fBSDL_SemValue\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00

4
docs/man3/SDL_CreateThread.3
View file

@ -1,4 +1,4 @@
.TH "SDL_CreateThread" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_CreateThread" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference"
.SH "NAME"
SDL_CreateThread\- Creates a new thread of execution that shares its parent\&'s properties\&.
.SH "SYNOPSIS"
@ -13,4 +13,4 @@ SDL_CreateThread\- Creates a new thread of execution that shares its parent\&'s
.SH "SEE ALSO"
.PP
\fI\fBSDL_KillThread\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00

4
docs/man3/SDL_CreateYUVOverlay.3
View file

@ -1,4 +1,4 @@
.TH "SDL_CreateYUVOverlay" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_CreateYUVOverlay" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
.SH "NAME"
SDL_CreateYUVOverlay\- Create a YUV video overlay
.SH "SYNOPSIS"
@ -14,4 +14,4 @@ The term \&'overlay\&' is a misnomer since, unless the overlay is created in har
.SH "SEE ALSO"
.PP
\fI\fBSDL_Overlay\fR\fR, \fI\fBSDL_DisplayYUVOverlay\fP\fR, \fI\fBSDL_FreeYUVOverlay\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01

4
docs/man3/SDL_Delay.3
View file

@ -1,4 +1,4 @@
.TH "SDL_Delay" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_Delay" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
.SH "NAME"
SDL_Delay\- Wait a specified number of milliseconds before returning\&.
.SH "SYNOPSIS"
@ -18,4 +18,4 @@ Count on a delay granularity of \fIat least\fP 10 ms\&. Some platforms have shor
.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

4
docs/man3/SDL_DestroyCond.3
View file

@ -1,4 +1,4 @@
.TH "SDL_DestroyCond" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_DestroyCond" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference"
.SH "NAME"
SDL_DestroyCond\- Destroy a condition variable
.SH "SYNOPSIS"
@ -13,4 +13,4 @@ Destroys a condition variable\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_CreateCond\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00

4
docs/man3/SDL_DestroyMutex.3
View file

@ -1,4 +1,4 @@
.TH "SDL_DestroyMutex" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_DestroyMutex" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference"
.SH "NAME"
SDL_DestroyMutex\- Destroy a mutex
.SH "SYNOPSIS"
@ -13,4 +13,4 @@ Destroy a previously \fIcreated\fR mutex\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_CreateMutex\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00

4
docs/man3/SDL_DestroySemaphore.3
View file

@ -1,4 +1,4 @@
.TH "SDL_DestroySemaphore" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_DestroySemaphore" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference"
.SH "NAME"
SDL_DestroySemaphore\- Destroys a semaphore that was created by \fISDL_CreateSemaphore\fR\&.
.SH "SYNOPSIS"
@ -23,4 +23,4 @@ SDL_DestroySemaphore\- Destroys a semaphore that was created by \fISDL_CreateSem
.SH "SEE ALSO"
.PP
\fI\fBSDL_CreateSemaphore\fP\fR, \fI\fBSDL_SemWait\fP\fR, \fI\fBSDL_SemTryWait\fP\fR, \fI\fBSDL_SemWaitTimeout\fP\fR, \fI\fBSDL_SemPost\fP\fR, \fI\fBSDL_SemValue\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00

4
docs/man3/SDL_DisplayFormat.3
View file

@ -1,4 +1,4 @@
.TH "SDL_DisplayFormat" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_DisplayFormat" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
.SH "NAME"
SDL_DisplayFormat\- Convert a surface to the display format
.SH "SYNOPSIS"
@ -19,4 +19,4 @@ If the conversion fails or runs out of memory, it returns \fBNULL\fR
.SH "SEE ALSO"
.PP
\fI\fBSDL_ConvertSurface\fP\fR, \fI\fBSDL_DisplayFormatAlpha\fP\fR \fI\fBSDL_SetAlpha\fP\fR, \fI\fBSDL_SetColorKey\fP\fR, \fI\fBSDL_Surface\fR\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01

4
docs/man3/SDL_DisplayFormatAlpha.3
View file

@ -1,4 +1,4 @@
.TH "SDL_DisplayFormatAlpha" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_DisplayFormatAlpha" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
.SH "NAME"
SDL_DisplayFormatAlpha\- Convert a surface to the display format
.SH "SYNOPSIS"
@ -19,4 +19,4 @@ If the conversion fails or runs out of memory, it returns \fBNULL\fR
.SH "SEE ALSO"
.PP
\fISDL_ConvertSurface\fR, \fISDL_SetAlpha\fR, \fISDL_SetColorKey\fR, \fISDL_DisplayFormat\fR, \fISDL_Surface\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

7
docs/man3/SDL_DisplayYUVOverlay.3
View file

@ -1,4 +1,4 @@
.TH "SDL_DisplayYUVOverlay" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_DisplayYUVOverlay" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
.SH "NAME"
SDL_DisplayYUVOverlay\- Blit the overlay to the display
.SH "SYNOPSIS"
@ -9,7 +9,10 @@ SDL_DisplayYUVOverlay\- Blit the overlay to the display
.SH "DESCRIPTION"
.PP
Blit the \fBoverlay\fR to the surface specified when it was \fIcreated\fR\&. The \fI\fBSDL_Rect\fR\fR structure, \fBdstrect\fR, specifies the position and size of the destination\&. If the \fBdstrect\fR is a larger or smaller than the overlay then the overlay will be scaled, this is optimized for 2x scaling\&.
.SH "RETURN VALUES"
.PP
Returns 0 on success
.SH "SEE ALSO"
.PP
\fI\fBSDL_Overlay\fR\fR, \fI\fBSDL_CreateYUVOverlay\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

4
docs/man3/SDL_EnableKeyRepeat.3
View file

@ -1,4 +1,4 @@
.TH "SDL_EnableKeyRepeat" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference"
.TH "SDL_EnableKeyRepeat" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference"
.SH "NAME"
SDL_EnableKeyRepeat\- Set keyboard repeat rate\&.
.SH "SYNOPSIS"
@ -14,4 +14,4 @@ Setting \fBdelay\fR to 0 disables key repeating completely\&. Good default value
.SH "RETURN VALUE"
.PP
Returns \fB0\fR on success and \fB-1\fR on failure\&.
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59

14
docs/man3/SDL_EnableUNICODE.3
View file

@ -1,4 +1,4 @@
.TH "SDL_EnableUNICODE" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference"
.TH "SDL_EnableUNICODE" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference"
.SH "NAME"
SDL_EnableUNICODE\- Enable UNICODE translation
.SH "SYNOPSIS"
@ -8,13 +8,17 @@ SDL_EnableUNICODE\- Enable UNICODE translation
\fBint \fBSDL_EnableUNICODE\fP\fR(\fBint enable\fR);
.SH "DESCRIPTION"
.PP
Enables/Disables UNICODE keyboard translation\&.
Enables/Disables Unicode keyboard translation\&.
.PP
If you wish to translate a keysym to it\&'s printable representation, you need to enable UNICODE translation using this function (\fBenable\fR=0) and then look in the \fBunicode\fR member of the \fI\fBSDL_keysym\fR\fR 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\&.
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 \fBunicode\fR member of the \fI\fBSDL_keysym\fR\fR structure will then contain the corresponding character code, or zero for keysyms that do not correspond to any character code\&.
.PP
A value of 1 for \fBenable\fR enables Unicode translation; 0 disables it, and -1 leaves it unchanged (useful for querying the current translation mode)\&.
.PP
Note that only key press events will be translated, not release events\&.
.SH "RETURN VALUE"
.PP
Returns the previous translation mode\&.
Returns the previous translation mode (\fB0\fR or \fB1\fR)\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_keysym\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

11
docs/man3/SDL_Event.3
View file

@ -1,4 +1,4 @@
.TH "SDL_Event" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference"
.TH "SDL_Event" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference"
.SH "NAME"
SDL_Event\- General event structure
.SH "STRUCTURE DEFINITION"
@ -15,6 +15,7 @@ SDL_Event\- General event structure
SDL_JoyHatEvent jhat;
SDL_JoyButtonEvent jbutton;
SDL_ResizeEvent resize;
SDL_ExposeEvent expose;
SDL_QuitEvent quit;
SDL_UserEvent user;
SDL_SywWMEvent syswm;
@ -53,6 +54,9 @@ The type of event
\fBresize\fR
\fIApplication window resize event\fR
.TP 20
\fBexpose\fR
\fIApplication window expose event\fR
.TP 20
\fBquit\fR
\fIApplication quit request event\fR
.TP 20
@ -102,6 +106,9 @@ The \fBSDL_Event\fR union is the core to all event handling is SDL, its probably
\fBSDL_VIDEORESIZE\fP
\fI\fBSDL_ResizeEvent\fR\fR
.TP 20
\fBSDL_VIDEOEXPOSE\fP
\fI\fBSDL_ExposeEvent\fR\fR
.TP 20
\fBSDL_USEREVENT\fP
\fI\fBSDL_UserEvent\fR\fR
.SH "USE"
@ -172,4 +179,4 @@ SDL_PushEvent(&user_event);\fR
.SH "SEE ALSO"
.PP
\fI\fBSDL_PollEvent\fP\fR, \fI\fBSDL_PushEvent\fP\fR, \fI\fBSDL_PeepEvents\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59

4
docs/man3/SDL_EventState.3
View file

@ -1,4 +1,4 @@
.TH "SDL_EventState" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference"
.TH "SDL_EventState" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference"
.SH "NAME"
SDL_EventState\- This function allows you to set the state of processing certain events\&.
.SH "SYNOPSIS"
@ -20,4 +20,4 @@ A list of event \fBtype\fR\&'s can be found in the \fI\fBSDL_Event\fR\fR section
.SH "SEE ALSO"
.PP
\fI\fBSDL_Event\fR\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59

24
docs/man3/SDL_ExposeEvent.3 Normal file
View file

@ -0,0 +1,24 @@
.TH "SDL_ExposeEvent" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference"
.SH "NAME"
SDL_ExposeEvent\- Quit requested event
.SH "STRUCTURE DEFINITION"
.PP
.nf
\f(CWtypedef struct{
Uint8 type
} SDL_ExposeEvent;\fR
.fi
.PP
.SH "STRUCTURE DATA"
.TP 20
\fBtype\fR
\fBSDL_QUIT\fP
.SH "DESCRIPTION"
.PP
\fBSDL_ExposeEvent\fR is a member of the \fI\fBSDL_Event\fR\fR union and is used whan an event of type \fBSDL_VIDEOEXPOSE\fP is reported\&.
.PP
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\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_Event\fR\fR, \fI\fBSDL_SetEventFilter\fP\fR
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00

10
docs/man3/SDL_FillRect.3
View file

@ -1,4 +1,4 @@
.TH "SDL_FillRect" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_FillRect" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
.SH "NAME"
SDL_FillRect\- This function performs a fast fill of the given rectangle with some color
.SH "SYNOPSIS"
@ -10,13 +10,13 @@ SDL_FillRect\- This function performs a fast fill of the given rectangle with so
.PP
This function performs a fast fill of the given rectangle with \fBcolor\fR\&. If \fBdstrect\fR is \fBNULL\fP, the whole surface will be filled with \fBcolor\fR\&.
.PP
The color should be a pixel of the format used by the surface, and can be generated by the \fISDL_MapRGB\fR function\&.
The color should be a pixel of the format used by the surface, and can be generated by the \fISDL_MapRGB\fR or \fISDL_MapRGBA\fR functions\&. If the color value contains an alpha value then the destination is simply "filled" with that alpha information, no blending takes place\&.
.PP
If there is a clip rectangle set on the destination (set via \fISDL_SetClipRect\fR) then this function will clip based on the intersection of the clip rectangle and the \fBdstrect\fR rectangle\&.
If there is a clip rectangle set on the destination (set via \fISDL_SetClipRect\fR) then this function will clip based on the intersection of the clip rectangle and the \fBdstrect\fR rectangle and the dstrect rectangle will be modified to represent the area actually filled\&.
.SH "RETURN VALUE"
.PP
This function returns \fB0\fR on success, or \fB-1\fR on error\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_MapRGB\fP\fR, \fI\fBSDL_BlitSurface\fP\fR, \fI\fBSDL_Rect\fR\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41
\fI\fBSDL_MapRGB\fP\fR, \fI\fBSDL_MapRGBA\fP\fR, \fI\fBSDL_BlitSurface\fP\fR, \fI\fBSDL_Rect\fR\fR
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01

4
docs/man3/SDL_Flip.3
View file

@ -1,4 +1,4 @@
.TH "SDL_Flip" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_Flip" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
.SH "NAME"
SDL_Flip\- Swaps screen buffers
.SH "SYNOPSIS"
@ -17,4 +17,4 @@ This function returns \fB0\fR if successful, or \fB-1\fR if there was an error\&
.SH "SEE ALSO"
.PP
\fI\fBSDL_SetVideoMode\fP\fR, \fI\fBSDL_UpdateRect\fP\fR, \fI\fBSDL_Surface\fR\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01

4
docs/man3/SDL_FreeCursor.3
View file

@ -1,4 +1,4 @@
.TH "SDL_FreeCursor" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_FreeCursor" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
.SH "NAME"
SDL_FreeCursor\- Frees a cursor created with SDL_CreateCursor\&.
.SH "SYNOPSIS"
@ -12,4 +12,4 @@ Frees a \fBSDL_Cursor\fR that was created using \fISDL_CreateCursor\fR\&.
.SH "SEE ALSO"
.PP
\fISDL_CreateCursor\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01

4
docs/man3/SDL_FreeSurface.3
View file

@ -1,4 +1,4 @@
.TH "SDL_FreeSurface" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_FreeSurface" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
.SH "NAME"
SDL_FreeSurface\- Frees (deletes) a SDL_Surface
.SH "SYNOPSIS"
@ -12,4 +12,4 @@ Frees the resources used by a previously created \fBSDL_Surface\fR\&. If the sur
.SH "SEE ALSO"
.PP
\fI\fBSDL_CreateRGBSurface\fP\fR \fI\fBSDL_CreateRGBSurfaceFrom\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01

4
docs/man3/SDL_FreeWAV.3
View file

@ -1,4 +1,4 @@
.TH "SDL_FreeWAV" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference"
.TH "SDL_FreeWAV" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference"
.SH "NAME"
SDL_FreeWAV\- Frees previously opened WAV data
.SH "SYNOPSIS"
@ -12,4 +12,4 @@ After a WAVE file has been opened with \fI\fBSDL_LoadWAV\fP\fR its data can even
.SH "SEE ALSO"
.PP
\fI\fBSDL_LoadWAV\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58

4
docs/man3/SDL_FreeYUVOverlay.3
View file

@ -1,4 +1,4 @@
.TH "SDL_FreeYUVOverlay" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_FreeYUVOverlay" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
.SH "NAME"
SDL_FreeYUVOverlay\- Free a YUV video overlay
.SH "SYNOPSIS"
@ -12,4 +12,4 @@ Frees and \fI\fBoverlay\fR\fR created by \fI\fBSDL_CreateYUVOverlay\fP\fR\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_Overlay\fR\fR, \fI\fBSDL_DisplayYUVOverlay\fP\fR, \fI\fBSDL_FreeYUVOverlay\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01

4
docs/man3/SDL_GL_GetAttribute.3
View file

@ -1,4 +1,4 @@
.TH "SDL_GL_GetAttribute" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_GL_GetAttribute" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
.SH "NAME"
SDL_GL_GetAttribute\- Get the value of a special SDL/OpenGL attribute
.SH "SYNOPSIS"
@ -15,4 +15,4 @@ Returns \fB0\fR on success, or \fB-1\fR on an error\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_GL_SetAttribute\fP\fR, \fIGL Attributes\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01

4
docs/man3/SDL_GL_GetProcAddress.3
View file

@ -1,4 +1,4 @@
.TH "SDL_GL_GetProcAddress" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_GL_GetProcAddress" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
.SH "NAME"
SDL_GL_GetProcAddress\- Get the address of a GL function
.SH "SYNOPSIS"
@ -45,4 +45,4 @@ else{
.SH "SEE ALSO"
.PP
\fI\fBSDL_GL_LoadLibrary\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01

4
docs/man3/SDL_GL_LoadLibrary.3
View file

@ -1,4 +1,4 @@
.TH "SDL_GL_LoadLibrary" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_GL_LoadLibrary" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
.SH "NAME"
SDL_GL_LoadLibrary\- Specify an OpenGL library
.SH "SYNOPSIS"
@ -12,4 +12,4 @@ If you wish, you may load the OpenGL library at runtime, this must be done befor
.SH "SEE ALSO"
.PP
\fI\fBSDL_GL_GetProcAddress\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01

4
docs/man3/SDL_GL_SetAttribute.3
View file

@ -1,4 +1,4 @@
.TH "SDL_GL_SetAttribute" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_GL_SetAttribute" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
.SH "NAME"
SDL_GL_SetAttribute\- Set a special SDL/OpenGL attribute
.SH "SYNOPSIS"
@ -37,4 +37,4 @@ The \fBSDL_DOUBLEBUF\fP flag is not required to enable double buffering when set
.SH "SEE ALSO"
.PP
\fI\fBSDL_GL_GetAttribute\fP\fR, \fIGL Attributes\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01

4
docs/man3/SDL_GL_SwapBuffers.3
View file

@ -1,4 +1,4 @@
.TH "SDL_GL_SwapBuffers" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference"
.TH "SDL_GL_SwapBuffers" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
.SH "NAME"
SDL_GL_SwapBuffers\- Swap OpenGL framebuffers/Update Display
.SH "SYNOPSIS"
@ -12,4 +12,4 @@ Swap the OpenGL buffers, if double-buffering is supported\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_SetVideoMode\fP\fR, \fI\fBSDL_GL_SetAttribute\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01

4
docs/man3/SDL_GLattr.3
View file

@ -1,4 +1,4 @@
.TH "SDL_GLattr" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference"
.TH "SDL_GLattr" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
.SH "NAME"
SDL_GLattr\- SDL GL Attributes
.SH "ATTRIBUTES"
@ -44,4 +44,4 @@ While you can set most OpenGL attributes normally, the attributes list above mus
.SH "SEE ALSO"
.PP
\fI\fBSDL_GL_SetAttribute\fP\fR, \fI\fBSDL_GL_GetAttribute\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01

4
docs/man3/SDL_GetAppState.3
View file

@ -1,4 +1,4 @@
.TH "SDL_GetAppState" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference"
.TH "SDL_GetAppState" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference"
.SH "NAME"
\fBSDL_GetAppState\fP\- Get the state of the application
.SH "SYNOPSIS"
@ -21,4 +21,4 @@ The application is visible
.SH "SEE ALSO"
.PP
\fI\fBSDL_ActiveEvent\fR\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59

4
docs/man3/SDL_GetAudioStatus.3
View file

@ -1,4 +1,4 @@
.TH "SDL_GetAudioStatus" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference"
.TH "SDL_GetAudioStatus" "3" "Tue 11 Sep 2001, 22:58" "SDL" "SDL API Reference"
.SH "NAME"
SDL_GetAudioStatus\- Get the current audio state
.SH "SYNOPSIS"
@ -21,4 +21,4 @@ Returns either \fBSDL_AUDIO_STOPPED\fP, \fBSDL_AUDIO_PAUSED\fP or \fBSDL_AUDIO_P
.SH "SEE ALSO"
.PP
\fI\fBSDL_PauseAudio\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:58

4
docs/man3/SDL_GetClipRect.3
View file

@ -1,4 +1,4 @@
.TH "SDL_GetClipRect" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference"
.TH "SDL_GetClipRect" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
.SH "NAME"
SDL_GetClipRect\- Gets the clipping rectangle for a surface\&.
.SH "SYNOPSIS"
@ -14,4 +14,4 @@ The rectangle pointed to by \fBrect\fR will be filled with the clipping rectangl
.SH "SEE ALSO"
.PP
\fI\fBSDL_SetClipRect\fP\fR, \fI\fBSDL_BlitSurface\fP\fR, \fI\fBSDL_Surface\fR\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01

4
docs/man3/SDL_GetCursor.3
View file

@ -1,4 +1,4 @@
.TH "SDL_GetCursor" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference"
.TH "SDL_GetCursor" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
.SH "NAME"
SDL_GetCursor\- Get the currently active mouse cursor\&.
.SH "SYNOPSIS"
@ -12,4 +12,4 @@ Returns the currently active mouse cursor\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_SetCursor\fP\fR, \fI\fBSDL_CreateCursor\fP\fR, \fI\fBSDL_ShowCursor\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01

15
docs/man3/SDL_GetError.3 Normal file
View file

@ -0,0 +1,15 @@
.TH "SDL_GetError" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference"
.SH "NAME"
SDL_GetError\- Get SDL error string
.SH "SYNOPSIS"
.PP
\fB#include "SDL/SDL\&.h"
.sp
\fBchar *\fBSDL_GetError\fP\fR(\fBvoid\fR);
.SH "DESCRIPTION"
.PP
\fBSDL_GetError\fP returns a NULL terminated string containing information about the last internal SDL error\&.
.SH "RETURN VALUE"
.PP
\fBSDL_GetError\fP returns a string containing the last error\&.
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00

4
docs/man3/SDL_GetEventFilter.3
View file

@ -1,4 +1,4 @@
.TH "SDL_GetEventFilter" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference"
.TH "SDL_GetEventFilter" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference"
.SH "NAME"
SDL_GetEventFilter\- Retrieves a pointer to he event filter
.SH "SYNOPSIS"
@ -20,4 +20,4 @@ Returns a pointer to the event filter or \fBNULL\fP if no filter has been set\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_Event\fR\fR, \fI\fBSDL_SetEventFilter\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59

4
docs/man3/SDL_GetGamma.3
View file

@ -1,4 +1,4 @@
.TH "SDL_GetGamma" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference"
.TH "SDL_GetGamma" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
.SH "NAME"
SDL_GetGamma\- Gets the gamma of the display
.SH "SYNOPSIS"
@ -18,4 +18,4 @@ This function currently only works on XFreee 4\&.0 and up\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_SetGamma\fP\fR, \fI\fBSDL_SetVideoMode\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01

4
docs/man3/SDL_GetGammaRamp.3
View file

@ -1,4 +1,4 @@
.TH "SDL_GetGammaRamp" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference"
.TH "SDL_GetGammaRamp" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
.SH "NAME"
SDL_GetGammaRamp\- Gets the color gamma lookup tables for the display
.SH "SYNOPSIS"
@ -17,4 +17,4 @@ Returns -1 on error\&.
.SH "SEE ALSO"
.PP
\fISDL_SetGamma\fR \fISDL_SetGammaRamp\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01

4
docs/man3/SDL_GetKeyName.3
View file

@ -1,4 +1,4 @@
.TH "SDL_GetKeyName" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference"
.TH "SDL_GetKeyName" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference"
.SH "NAME"
SDL_GetKeyName\- Get the name of an SDL virtual keysym
.SH "SYNOPSIS"
@ -12,4 +12,4 @@ Returns the SDL-defined name of the \fI\fBSDLKey\fR\fR \fBkey\fR\&.
.SH "SEE ALSO"
.PP
\fI\fBSDLKey\fR\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59

6
docs/man3/SDL_GetKeyState.3
View file

@ -1,4 +1,4 @@
.TH "SDL_GetKeyState" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference"
.TH "SDL_GetKeyState" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference"
.SH "NAME"
SDL_GetKeyState\- Get a snapshot of the current keyboard state
.SH "SYNOPSIS"
@ -8,7 +8,7 @@ SDL_GetKeyState\- Get a snapshot of the current keyboard state
\fBUint8 *\fBSDL_GetKeyState\fP\fR(\fBint *numkeys\fR);
.SH "DESCRIPTION"
.PP
Gets a snapshot of the current keyboard state\&. The current state is return as a pointer to an array, the size of this array is stored in \fBnumkeys\fR\&. The array is indexed by the \fI\fBSDLK_*\fP\fR symbols\&. A value of 1 means the key is pressed and a value of 0 means its not\&.
Gets a snapshot of the current keyboard state\&. The current state is return as a pointer to an array, the size of this array is stored in \fBnumkeys\fR\&. The array is indexed by the \fI\fBSDLK_*\fP\fR 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\&.
.PP
.RS
\fBNote:
@ -27,4 +27,4 @@ if ( keystate[SDLK_RETURN] ) printf("Return Key Pressed\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL Key Symbols\fP\fR, \fI\fBSDL_PumpEvents\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59

6
docs/man3/SDL_GetModState.3
View file

@ -1,4 +1,4 @@
.TH "SDL_GetModState" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference"
.TH "SDL_GetModState" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference"
.SH "NAME"
SDL_GetModState\- Get the state of modifier keys\&.
.SH "SYNOPSIS"
@ -8,7 +8,7 @@ SDL_GetModState\- Get the state of modifier keys\&.
\fBSDLMod \fBSDL_GetModState\fP\fR(\fBvoid\fR);
.SH "DESCRIPTION"
.PP
Returns the current of the modifier keys (CTRL, ALT, etc\&.)\&.
Returns the current state of the modifier keys (CTRL, ALT, etc\&.)\&.
.SH "RETURN VALUE"
.PP
The return value can be an OR\&'d combination of the SDLMod enum\&.
@ -51,4 +51,4 @@ The return value can be an OR\&'d combination of the SDLMod enum\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_GetKeyState\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59

4
docs/man3/SDL_GetMouseState.3
View file

@ -1,4 +1,4 @@
.TH "SDL_GetMouseState" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference"
.TH "SDL_GetMouseState" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference"
.SH "NAME"
SDL_GetMouseState\- Retrieve the current state of the mouse
.SH "SYNOPSIS"
@ -21,4 +21,4 @@ if(SDL_GetMouseState(NULL, NULL)&SDL_BUTTON(1))
.SH "SEE ALSO"
.PP
\fI\fBSDL_GetRelativeMouseState\fP\fR, \fI\fBSDL_PumpEvents\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59

4
docs/man3/SDL_GetRGB.3
View file

@ -1,4 +1,4 @@
.TH "SDL_GetRGB" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference"
.TH "SDL_GetRGB" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
.SH "NAME"
SDL_GetRGB\- Get RGB values from a pixel in the specified pixel format\&.
.SH "SYNOPSIS"
@ -14,4 +14,4 @@ This function uses the entire 8-bit [0\&.\&.255] range when converting color com
.SH "SEE ALSO"
.PP
\fI\fBSDL_GetRGBA\fP\fR, \fI\fBSDL_MapRGB\fP\fR, \fI\fBSDL_MapRGBA\fP\fR, \fI\fBSDL_PixelFormat\fR\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01

4
docs/man3/SDL_GetRGBA.3
View file

@ -1,4 +1,4 @@
.TH "SDL_GetRGBA" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference"
.TH "SDL_GetRGBA" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
.SH "NAME"
SDL_GetRGBA\- Get RGBA values from a pixel in the specified pixel format\&.
.SH "SYNOPSIS"
@ -16,4 +16,4 @@ If the surface has no alpha component, the alpha will be returned as 0xff (100%
.SH "SEE ALSO"
.PP
\fISDL_GetRGB\fR, \fISDL_MapRGB\fR, \fISDL_MapRGBA\fR, \fISDL_PixelFormat\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01

4
docs/man3/SDL_GetRelativeMouseState.3
View file

@ -1,4 +1,4 @@
.TH "SDL_GetRelativeMouseState" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference"
.TH "SDL_GetRelativeMouseState" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference"
.SH "NAME"
SDL_GetRelativeMouseState\- Retrieve the current state of the mouse
.SH "SYNOPSIS"
@ -12,4 +12,4 @@ The current button state is returned as a button bitmask, which can be tested us
.SH "SEE ALSO"
.PP
\fI\fBSDL_GetMouseState\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59

4
docs/man3/SDL_GetThreadID.3
View file

@ -1,4 +1,4 @@
.TH "SDL_GetThreadID" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_GetThreadID" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference"
.SH "NAME"
SDL_GetThreadID\- Get the SDL thread ID of a SDL_Thread
.SH "SYNOPSIS"
@ -13,4 +13,4 @@ Returns the ID of a \fBSDL_Thread\fR created by \fISDL_CreateThread\fR\&.
.SH "SEE ALSO"
.PP
\fISDL_CreateThread\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00

4
docs/man3/SDL_GetTicks.3
View file

@ -1,4 +1,4 @@
.TH "SDL_GetTicks" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_GetTicks" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
.SH "NAME"
SDL_GetTicks\- Get the number of milliseconds since the SDL library initialization\&.
.SH "SYNOPSIS"
@ -12,4 +12,4 @@ Get the number of milliseconds since the SDL library initialization\&. Note that
.SH "SEE ALSO"
.PP
\fI\fBSDL_Delay\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01

4
docs/man3/SDL_GetVideoInfo.3
View file

@ -1,4 +1,4 @@
.TH "SDL_GetVideoInfo" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference"
.TH "SDL_GetVideoInfo" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
.SH "NAME"
SDL_GetVideoInfo\- returns a pointer to information about the video hardware
.SH "SYNOPSIS"
@ -12,4 +12,4 @@ This function returns a read-only pointer to \fIinformation\fR about the video h
.SH "SEE ALSO"
.PP
\fI\fBSDL_SetVideoMode\fP\fR, \fI\fBSDL_VideoInfo\fR\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01

4
docs/man3/SDL_GetVideoSurface.3
View file

@ -1,4 +1,4 @@
.TH "SDL_GetVideoSurface" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference"
.TH "SDL_GetVideoSurface" "3" "Tue 11 Sep 2001, 23:01" "SDL" "SDL API Reference"
.SH "NAME"
SDL_GetVideoSurface\- returns a pointer to the current display surface
.SH "SYNOPSIS"
@ -12,4 +12,4 @@ This function returns a pointer to the current display surface\&. If SDL is doin
.SH "SEE ALSO"
.PP
\fI\fBSDL_Surface\fR\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:01

4
docs/man3/SDL_Init.3
View file

@ -1,4 +1,4 @@
.TH "SDL_Init" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_Init" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference"
.SH "NAME"
SDL_Init\- Initializes SDL
.SH "SYNOPSIS"
@ -38,4 +38,4 @@ Returns \fB-1\fR on an error or \fB0\fR on success\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_Quit\fP\fR, \fI\fBSDL_InitSubSystem\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00

4
docs/man3/SDL_InitSubSystem.3
View file

@ -1,4 +1,4 @@
.TH "SDL_InitSubSystem" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_InitSubSystem" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference"
.SH "NAME"
SDL_InitSubSystem\- Initialize subsystems
.SH "SYNOPSIS"
@ -38,4 +38,4 @@ Returns \fB-1\fR on an error or \fB0\fR on success\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_Init\fP\fR, \fI\fBSDL_Quit\fP\fR, \fI\fBSDL_QuitSubSystem\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00

4
docs/man3/SDL_JoyAxisEvent.3
View file

@ -1,4 +1,4 @@
.TH "SDL_JoyAxisEvent" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference"
.TH "SDL_JoyAxisEvent" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference"
.SH "NAME"
SDL_JoyAxisEvent\- Joystick axis motion event structure
.SH "STRUCTURE DEFINITION"
@ -33,4 +33,4 @@ A \fBSDL_JOYAXISMOTION\fP event occurs when ever a user moves an axis on the joy
.SH "SEE ALSO"
.PP
\fI\fBSDL_Event\fR\fR, \fIJoystick Functions\fR, \fI\fBSDL_JoystickEventState\fP\fR, \fI\fBSDL_JoystickGetAxis\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59

4
docs/man3/SDL_JoyBallEvent.3
View file

@ -1,4 +1,4 @@
.TH "SDL_JoyBallEvent" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference"
.TH "SDL_JoyBallEvent" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference"
.SH "NAME"
SDL_JoyBallEvent\- Joystick trackball motion event structure
.SH "STRUCTURE DEFINITION"
@ -33,4 +33,4 @@ A \fBSDL_JOYBALLMOTION\fP event occurs when a user moves a trackball on the joys
.SH "SEE ALSO"
.PP
\fI\fBSDL_Event\fR\fR, \fIJoystick Functions\fR, \fI\fBSDL_JoystickEventState\fP\fR, \fI\fBSDL_JoystickGetBall\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59

4
docs/man3/SDL_JoyButtonEvent.3
View file

@ -1,4 +1,4 @@
.TH "SDL_JoyButtonEvent" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference"
.TH "SDL_JoyButtonEvent" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference"
.SH "NAME"
SDL_JoyButtonEvent\- Joystick button event structure
.SH "STRUCTURE DEFINITION"
@ -33,4 +33,4 @@ A \fBSDL_JOYBUTTONDOWN\fP or \fBSDL_JOYBUTTONUP\fP event occurs when ever a user
.SH "SEE ALSO"
.PP
\fI\fBSDL_Event\fR\fR, \fIJoystick Functions\fR, \fI\fBSDL_JoystickEventState\fP\fR, \fI\fBSDL_JoystickGetButton\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59

4
docs/man3/SDL_JoyHatEvent.3
View file

@ -1,4 +1,4 @@
.TH "SDL_JoyHatEvent" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference"
.TH "SDL_JoyHatEvent" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference"
.SH "NAME"
SDL_JoyHatEvent\- Joystick hat position change event structure
.SH "STRUCTURE DEFINITION"
@ -53,4 +53,4 @@ The following defines are also provided:
.SH "SEE ALSO"
.PP
\fI\fBSDL_Event\fR\fR, \fIJoystick Functions\fR, \fI\fBSDL_JoystickEventState\fP\fR, \fI\fBSDL_JoystickGetHat\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59

4
docs/man3/SDL_JoystickClose.3
View file

@ -1,4 +1,4 @@
.TH "SDL_JoystickClose" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_JoystickClose" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference"
.SH "NAME"
SDL_JoystickClose\- Closes a previously opened joystick
.SH "SYNOPSIS"
@ -12,4 +12,4 @@ Close a \fBjoystick\fR that was previously opened with \fI\fBSDL_JoystickOpen\fP
.SH "SEE ALSO"
.PP
\fI\fBSDL_JoystickOpen\fP\fR, \fI\fBSDL_JoystickOpened\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00

4
docs/man3/SDL_JoystickEventState.3
View file

@ -1,4 +1,4 @@
.TH "SDL_JoystickEventState" "3" "Sun 10 Jun 2001, 19:40" "SDL" "SDL API Reference"
.TH "SDL_JoystickEventState" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference"
.SH "NAME"
SDL_JoystickEventState\- Enable/disable joystick event polling
.SH "SYNOPSIS"
@ -21,4 +21,4 @@ If \fBstate\fR is \fBSDL_QUERY\fP then the current state is returned, otherwise
.SH "SEE ALSO"
.PP
\fISDL Joystick Functions\fR, \fI\fBSDL_JoystickUpdate\fP\fR, \fI\fBSDL_JoyAxisEvent\fR\fR, \fI\fBSDL_JoyBallEvent\fR\fR, \fI\fBSDL_JoyButtonEvent\fR\fR, \fI\fBSDL_JoyHatEvent\fR\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:40
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59

4
docs/man3/SDL_JoystickGetAxis.3
View file

@ -1,4 +1,4 @@
.TH "SDL_JoystickGetAxis" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_JoystickGetAxis" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference"
.SH "NAME"
SDL_JoystickGetAxis\- Get the current state of an axis
.SH "SYNOPSIS"
@ -29,4 +29,4 @@ y_move=SDL_JoystickGetAxis(joy1, 1);\fR
.SH "SEE ALSO"
.PP
\fI\fBSDL_JoystickNumAxes\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00

4
docs/man3/SDL_JoystickGetBall.3
View file

@ -1,4 +1,4 @@
.TH "SDL_JoystickGetBall" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_JoystickGetBall" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference"
.SH "NAME"
SDL_JoystickGetBall\- Get relative trackball motion
.SH "SYNOPSIS"
@ -34,4 +34,4 @@ printf("Trackball Delta- X:%d, Y:%d
.SH "SEE ALSO"
.PP
\fI\fBSDL_JoystickNumBalls\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00

4
docs/man3/SDL_JoystickGetButton.3
View file

@ -1,4 +1,4 @@
.TH "SDL_JoystickGetButton" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_JoystickGetButton" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference"
.SH "NAME"
SDL_JoystickGetButton\- Get the current state of a given button on a given joystick
.SH "SYNOPSIS"
@ -15,4 +15,4 @@ SDL_JoystickGetButton returns the current state of the given \fBbutton\fR on the
.SH "SEE ALSO"
.PP
\fI\fBSDL_JoystickNumButtons\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00

4
docs/man3/SDL_JoystickGetHat.3
View file

@ -1,4 +1,4 @@
.TH "SDL_JoystickGetHat" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_JoystickGetHat" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference"
.SH "NAME"
SDL_JoystickGetHat\- Get the current state of a joystick hat
.SH "SYNOPSIS"
@ -33,4 +33,4 @@ The current state is returned as a Uint8 which is defined as an OR\&'d combinati
.SH "SEE ALSO"
.PP
\fI\fBSDL_JoystickNumHats\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00

4
docs/man3/SDL_JoystickIndex.3
View file

@ -1,4 +1,4 @@
.TH "SDL_JoystickIndex" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_JoystickIndex" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference"
.SH "NAME"
SDL_JoystickIndex\- Get the index of an SDL_Joystick\&.
.SH "SYNOPSIS"
@ -15,4 +15,4 @@ Index number of the joystick\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_JoystickOpen\fP\fR
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:41
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00

6
docs/man3/SDL_JoystickName.3
View file

@ -1,4 +1,4 @@
.TH "SDL_JoystickName" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_JoystickName" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference"
.SH "NAME"
SDL_JoystickName\- Get joystick name\&.
.SH "SYNOPSIS"
@ -23,10 +23,10 @@ printf("%d joysticks found
", num_joy);
for(i=0;i<num_joy;i++)
printf("%s
", SDL_JoystickName(i);\fR
", SDL_JoystickName(i));\fR
.fi
.PP
.SH "SEE ALSO"
.PP
\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

4
docs/man3/SDL_JoystickNumAxes.3
View file

@ -1,4 +1,4 @@
.TH "SDL_JoystickNumAxes" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_JoystickNumAxes" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference"
.SH "NAME"
SDL_JoystickNumAxes\- Get the number of joystick axes
.SH "SYNOPSIS"
@ -15,4 +15,4 @@ Number of axes\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_JoystickGetAxis\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

4
docs/man3/SDL_JoystickNumBalls.3
View file

@ -1,4 +1,4 @@
.TH "SDL_JoystickNumBalls" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_JoystickNumBalls" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference"
.SH "NAME"
SDL_JoystickNumBalls\- Get the number of joystick trackballs
.SH "SYNOPSIS"
@ -15,4 +15,4 @@ Number of trackballs\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_JoystickGetBall\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

4
docs/man3/SDL_JoystickNumButtons.3
View file

@ -1,4 +1,4 @@
.TH "SDL_JoystickNumButtons" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_JoystickNumButtons" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference"
.SH "NAME"
SDL_JoystickNumButtons\- Get the number of joysitck buttons
.SH "SYNOPSIS"
@ -15,4 +15,4 @@ Number of buttons\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_JoystickGetButton\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

4
docs/man3/SDL_JoystickNumHats.3
View file

@ -1,4 +1,4 @@
.TH "SDL_JoystickNumHats" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_JoystickNumHats" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference"
.SH "NAME"
SDL_JoystickNumHats\- Get the number of joystick hats
.SH "SYNOPSIS"
@ -15,4 +15,4 @@ Number of hats\&.
.SH "SEE ALSO"
.PP
\fI\fBSDL_JoystickGetHat\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

10
docs/man3/SDL_JoystickOpen.3
View file

@ -1,4 +1,4 @@
.TH "SDL_JoystickOpen" "3" "Sun 10 Jun 2001, 19:41" "SDL" "SDL API Reference"
.TH "SDL_JoystickOpen" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference"
.SH "NAME"
SDL_JoystickOpen\- Opens a joystick for use\&.
.SH "SYNOPSIS"
@ -28,11 +28,11 @@ if(SDL_NumJoysticks()>0){
");
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

4
docs/man3/SDL_JoystickOpened.3
View file

@ -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

4
docs/man3/SDL_JoystickUpdate.3
View file

@ -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

Some files were not shown because too many files have changed in this diff Show more