docs/man3/SDL_EventState.3
author Aaron Wishnick <schnarf@gmail.com>
Wed, 18 Jun 2008 04:51:10 +0000
branchgsoc2008_audio_resampling
changeset 2655 b8e736c8a5a8
parent 2283 546f7c1eb755
child 4311 1238da4a7112
permissions -rw-r--r--
Added beginnings of resampling code.
     1 .TH "SDL_EventState" "3" "Tue 11 Sep 2001, 22:59" "SDL" "SDL API Reference" 
     2 .SH "NAME"
     3 SDL_EventState \- This function allows you to set the state of processing certain events\&.
     4 .SH "SYNOPSIS"
     5 .PP
     6 \fB#include "SDL\&.h"
     7 .sp
     8 \fBUint8 \fBSDL_EventState\fP\fR(\fBUint8 type, int state\fR);
     9 .SH "DESCRIPTION"
    10 .PP
    11 This function allows you to set the state of processing certain event \fBtype\fR\&'s\&.
    12 .PP
    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\&.
    14 .PP
    15 If \fBstate\fR is set to \fBSDL_ENABLE\fP, that event \fBtype\fR will be processed normally\&.
    16 .PP
    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\&.
    18 .PP
    19 A list of event \fBtype\fR\&'s can be found in the \fI\fBSDL_Event\fR\fR section\&.
    20 .SH "SEE ALSO"
    21 .PP
    22 \fI\fBSDL_Event\fR\fR
    23 ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 22:59