Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

SDL_WM_GrabInput (3)

Name

SDL_WM_GrabInput - Grabs mouse and keyboard input.

Synopsis

#include "SDL.h"

SDL_GrabMode SDL_WM_GrabInput(SDL_GrabMode mode);

Description

SDL_WM_GrabInput(3)            SDL API Reference           SDL_WM_GrabInput(3)



NAME
       SDL_WM_GrabInput - Grabs mouse and keyboard input.

SYNOPSIS
       #include "SDL.h"

       SDL_GrabMode SDL_WM_GrabInput(SDL_GrabMode mode);

DESCRIPTION
       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.

       When  mode is SDL_GRAB_QUERY the grab mode is not changed, but the cur-
       rent grab mode is returned.

       typedef enum {
         SDL_GRAB_QUERY,
         SDL_GRAB_OFF,
         SDL_GRAB_ON
       } SDL_GrabMode;

RETURN VALUE
       The current/new SDL_GrabMode.



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | library/sdl      |
       +---------------+------------------+
       |Stability      | Volatile         |
       +---------------+------------------+
NOTES
       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source       was        downloaded        from         https://www.lib-
       sdl.org/release/SDL-1.2.15.tar.gz

       Further information about this software can be found on the open source
       community website at https://www.libsdl.org/.



SDL                         Tue 11 Sep 2001, 23:01         SDL_WM_GrabInput(3)