diff docs/man3/SDL_WM_GrabInput.3 @ 0:74212992fb08

Initial revision
author Sam Lantinga <slouken@lokigames.com>
date Thu, 26 Apr 2001 16:45:43 +0000
parents
children 55f1f1b3e27d
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/man3/SDL_WM_GrabInput.3	Thu Apr 26 16:45:43 2001 +0000
@@ -0,0 +1,28 @@
+.TH "SDL_WM_GrabInput" "3" "Mon 12 Mar 2001, 01:05" "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, Mon 12 Mar 2001, 01:05