This document is a Mac OS X manual page. Manual pages are a command-line technology for providing documentation. You can view these manual pages locally using the man(1) command. These manual pages come from many different sources, and thus, have a variety of writing styles.

For more information about the manual page format, see the manual page for manpages(5).

glutGameModeGet(3GLUT)                              GLUT                              glutGameModeGet(3GLUT)



NAME
       glutGameModeGet - retrieves GLUT device information represented by integers.

SYNTAX
       int glutGameModeGet(GLenum info);

ARGUMENTS
       info      Name of game mode information to retrieve.

       GLUT_GAME_MODE_ACTIVE
               Non-zero  if  GLUT's  game  mode is active; zero if not active.  Game mode is not active ini-tially. initially.
               tially.  Game mode becomes active when glutEnterGameMode is called.  Game mode becomes  inac-tive inactive
               tive when glutLeaveGameMode is called.

       GLUT_GAME_MODE_POSSIBLE
               Non-zero if the game mode string last specified to glutGameModeString is a possible game mode
               configuration; zero otherwise.  Being "possible" does not guarantee  that  if  game  mode  is
               entered   with   glutEnterGameMode   that   the   display  settings  will  actually  changed.
               GLUT_GAME_MODE_DISPLAY_CHANGED should be called once game mode is entered to determine if the
               display mode is actually changed.

       GLUT_GAME_MODE_WIDTH
               Width in pixels of the screen when game mode is activated.

       GLUT_GAME_MODE_HEIGHT
               Height in pixels of the screen when game mode is activated.

       GLUT_GAME_MODE_PIXEL_DEPTH
               Pixel depth of the screen when game mode is activiated.

       GLUT_GAME_MODE_REFRESH_RATE
               Screen  refresh  rate  in  cyles  per  second  (hertz)  when game mode is activated.  Zero is
               returned if the refresh rate is unknown or cannot be queried.

       GLUT_GAME_MODE_DISPLAY_CHANGED
               Non-zero if entering game mode actually changed the  display  settings.   If  the  game  mode
               string is not possible or the display mode could not be changed for any other reason, zero is
               returned.

DESCRIPTION
       glutGameModeGet retrieves GLUT game mode information represented  by  integers.  The  info  parameter
       determines  what  type  of  game  mode information to return. Requesting game mode information for an
       invalid GLUT game mode information name returns negative one.

SEE ALSO
       glutGet(3G), glutDeviceGet(3G), glutLayerGet(3G), glutGameModeString(3G), glutEnterGameMode(3G), glutLeaveGameMode(3G)


AUTHOR
       Mark J. Kilgard (mjk@nvidia.com)



GLUT                                                 3.7                              glutGameModeGet(3GLUT)