docs/man3/SDL_EventState.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_EventState" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" 
slouken@0
     2
.SH "NAME"
slouken@0
     3
SDL_EventState\- This function allows you to set the state of processing certain events\&.
slouken@0
     4
.SH "SYNOPSIS"
slouken@0
     5
.PP
slouken@0
     6
\fB#include "SDL\&.h"
slouken@0
     7
.sp
slouken@0
     8
\fBUint8 \fBSDL_EventState\fP\fR(\fBUint8 type, int state\fR);
slouken@0
     9
.SH "DESCRIPTION"
slouken@0
    10
.PP
slouken@0
    11
This function allows you to set the state of processing certain event \fBtype\fR\&'s\&.
slouken@0
    12
.PP
slouken@0
    13
If \fBstate\fR is set to \fBSDL_IGNORE\fP, that event \fBtype\fR will be automatically dropped from the event queue and will not be filtered\&.
slouken@0
    14
.PP
slouken@0
    15
If \fBstate\fR is set to \fBSDL_ENABLE\fP, that event \fBtype\fR will be processed normally\&.
slouken@0
    16
.PP
slouken@0
    17
If \fBstate\fR is set to \fBSDL_QUERY\fP, \fBSDL_EventState\fP will return the current processing state of the specified event \fBtype\fR\&.
slouken@0
    18
.PP
slouken@0
    19
A list of event \fBtype\fR\&'s can be found in the \fI\fBSDL_Event\fR\fR section\&.
slouken@0
    20
.SH "SEE ALSO"
slouken@0
    21
.PP
slouken@0
    22
\fI\fBSDL_Event\fR\fR
slouken@181
    23
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59