view docs/man3/SDL_WM_GrabInput.3 @ 55:55f1f1b3e27d

Added new docs for SDL 1.2.1
author Sam Lantinga <slouken@lokigames.com>
date Sun, 10 Jun 2001 19:31:57 +0000
parents 74212992fb08
children e5bc29de3f0a
line wrap: on
line source

.TH "SDL_WM_GrabInput" "3" "Sun 10 Jun 2001, 19:42" "SDL" "SDL API Reference" 
.SH "NAME"
SDL_WM_GrabInput\- Grabs mouse and keyboard input\&.
.SH "SYNOPSIS"
.PP
\fB#include "SDL\&.h"
.sp
\fBSDL_GrabMode \fBSDL_WM_GrabInput\fP\fR(\fBSDL_GrabMode mode\fR);
.SH "DESCRIPTION"
.PP
Grabbing means that the mouse is confined to the application window, and nearly all keyboard input is passed directly to the application, and not interpreted by a window manager, if any\&.
.PP
When \fBmode\fR is \fBSDL_GRAB_QUERY\fP the grab mode is not changed, but the current grab mode is returned\&.
.PP
.PP
.nf
\f(CWtypedef enum {
  SDL_GRAB_QUERY,
  SDL_GRAB_OFF,
  SDL_GRAB_ON
} SDL_GrabMode;\fR
.fi
.PP
 
.SH "RETURN VALUE"
.PP
The current/new \fBSDL_GrabMode\fR\&.
...\" created by instant / docbook-to-man, Sun 10 Jun 2001, 19:42