~ubuntu-branches/ubuntu/lucid/libsdl1.2/lucid-proposed

« back to all changes in this revision

Viewing changes to docs/man3/SDL_Quit.3

  • Committer: Bazaar Package Importer
  • Author(s): Martin Pitt
  • Date: 2006-07-03 11:30:59 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20060703113059-wtkvnv5lb2tnht1r
Tags: 1.2.10-3ubuntu1
* Merge from debian unstable. Remaining Ubuntu changes:
  - debian/control: Drop libsvga1-dev build dependency and dependencies,
    adapt package descriptions.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH "SDL_Quit" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" 
 
2
.SH "NAME"
 
3
SDL_Quit\- Shut down SDL
 
4
.SH "SYNOPSIS"
 
5
.PP
 
6
\fB#include "SDL\&.h"
 
7
.sp
 
8
\fBvoid \fBSDL_Quit\fP\fR(\fBvoid\fR);
 
9
.SH "DESCRIPTION"
 
10
.PP
 
11
\fBSDL_Quit\fP shuts down all SDL subsystems and frees the resources allocated to them\&. This should always be called before you exit\&. For the sake of simplicity you can set \fBSDL_Quit\fP as your \fBatexit\fP call, like: 
 
12
.PP
 
13
.nf
 
14
\f(CWSDL_Init(SDL_INIT_VIDEO|SDL_INIT_AUDIO);
 
15
atexit(SDL_Quit);
 
16
\&.
 
17
\&.\fR
 
18
.fi
 
19
.PP
 
20
.PP
 
21
.RS
 
22
\fBNote:  
 
23
.PP
 
24
While using \fBatexit\fP maybe be fine for small programs, more advanced users should shut down SDL in their own cleanup code\&. Plus, using \fBatexit\fP in a library is a sure way to crash dynamically loaded code
 
25
.RE
 
26
.SH "SEE ALSO"
 
27
.PP
 
28
\fI\fBSDL_QuitSubsystem\fP\fR, \fI\fBSDL_Init\fP\fR
 
29
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00