view docs/man3/SDL_Quit.3 @ 3164:c5b2884c26b4

Added an ifdef so that if you #define SDL_NO_COMPAT before you include SDL.h then SDL_compat.h will never be included in your code. This is useful for making sure that your code uses only SDL 1.3 features. It is also handy for finding things that are in SDL_compat.h that belong elsewhere.
author Bob Pendleton <bob@pendleton.com>
date Thu, 04 Jun 2009 21:00:45 +0000 (2009-06-04)
parents 546f7c1eb755
children 1238da4a7112
line wrap: on
line source
.TH "SDL_Quit" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" 
.SH "NAME"
SDL_Quit \- Shut down SDL
.SH "SYNOPSIS"
.PP
\fB#include "SDL\&.h"
.sp
\fBvoid \fBSDL_Quit\fP\fR(\fBvoid\fR);
.SH "DESCRIPTION"
.PP
\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: 
.PP
.nf
\f(CWSDL_Init(SDL_INIT_VIDEO|SDL_INIT_AUDIO);
atexit(SDL_Quit);
\&.
\&.\fR
.fi
.PP
.PP
.RS
\fBNote:  
.PP
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
.RE
.SH "SEE ALSO"
.PP
\fI\fBSDL_QuitSubsystem\fP\fR, \fI\fBSDL_Init\fP\fR
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00