docs/man3/SDL_QuitEvent.3
author Sam Lantinga <slouken@libsdl.org>
Wed, 08 Mar 2006 18:30:12 +0000
changeset 1486 9d77fc9d0ace
parent 181 e5bc29de3f0a
child 2283 546f7c1eb755
permissions -rw-r--r--
Re-added C runtime support for Visual C++ 5,6
slouken@181
     1
.TH "SDL_QuitEvent" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" 
slouken@0
     2
.SH "NAME"
slouken@0
     3
SDL_QuitEvent\- Quit requested event
slouken@0
     4
.SH "STRUCTURE DEFINITION"
slouken@0
     5
.PP
slouken@0
     6
.nf
slouken@0
     7
\f(CWtypedef struct{
slouken@0
     8
  Uint8 type
slouken@0
     9
} SDL_QuitEvent;\fR
slouken@0
    10
.fi
slouken@0
    11
.PP
slouken@0
    12
.SH "STRUCTURE DATA"
slouken@0
    13
.TP 20
slouken@0
    14
\fBtype\fR
slouken@0
    15
\fBSDL_QUIT\fP
slouken@0
    16
.SH "DESCRIPTION"
slouken@0
    17
.PP
slouken@0
    18
\fBSDL_QuitEvent\fR is a member of the \fI\fBSDL_Event\fR\fR union and is used whan an event of type \fBSDL_QUIT\fP is reported\&.
slouken@0
    19
.PP
slouken@0
    20
As can be seen, the SDL_QuitEvent structure serves no useful purpose\&. The event itself, on the other hand, is very important\&. If you filter out or ignore a quit event then it is impossible for the user to close the window\&. On the other hand, if you do accept a quit event then the application window will be closed, and screen updates will still report success event though the application will no longer be visible\&.
slouken@0
    21
.PP
slouken@0
    22
.RS
slouken@0
    23
\fBNote:  
slouken@0
    24
.PP
slouken@0
    25
The macro \fBSDL_QuitRequested\fP will return non-zero if a quit event is pending
slouken@0
    26
.RE
slouken@0
    27
.SH "SEE ALSO"
slouken@0
    28
.PP
slouken@0
    29
\fI\fBSDL_Event\fR\fR, \fI\fBSDL_SetEventFilter\fP\fR
slouken@181
    30
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59