ADC Home > Reference Library > Reference > Mac OS X > Mac OS X Man Pages

 

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



glutGet(3GLUT)                                      GLUT                                      glutGet(3GLUT)



NAME
       glutGet - retrieves simple GLUT state represented by integers.

SYNTAX
       int glutGet(GLenum state);

ARGUMENTS
       state     Name of state to retrieve.

       GLUT_WINDOW_X
               X location in pixels (relative to the screen origin) of the current window.

       GLUT_WINDOW_Y
               Y location in pixels (relative to the screen origin) of the current window.

       GLUT_WINDOW_WIDTH
               Width in pixels of the current window.

       GLUT_WINDOW_HEIGHT
               Height in pixels of the current window.

       GLUT_WINDOW_BUFFER_SIZE
               Total  number of bits for current layer of current window's color buffer. For an RGBA window,
               this is the sum of GLUT_WINDOW_RED_SIZE, GLUT_WINDOW_GREEN_SIZE,  GLUT_WINDOW_BLUE_SIZE,  and
               GLUT_WINDOW_ALPHA_SIZE. For color index windows, this is the size of the color indexes.

       GLUT_WINDOW_STENCIL_SIZE
               Number of bits in the current layer of current window's stencil buffer.

       GLUT_WINDOW_DEPTH_SIZE
               Number of bits in the current layer of current window's depth buffer.

       GLUT_WINDOW_RED_SIZE
               Number of bits of red stored the current layer of current window's color buffer.  Zero if the
               current layer of the current window is color index.

       GLUT_WINDOW_GREEN_SIZE
               Number of bits of green stored the current layer of current window's color buffer.   Zero  if
               the current layer of the current window is color index.

       GLUT_WINDOW_BLUE_SIZE
               Number  of  bits  of blue stored the current layer of current window's color buffer.  Zero if
               the current layer of the current window is color index.

       GLUT_WINDOW_ALPHA_SIZE
               Number of bits of alpha stored the current layer of current window's color buffer.   Zero  if
               the current layer of the current window is color index.

       GLUT_WINDOW_ACCUM_RED_SIZE
               Number  of  bits  of red stored in the current layer of current window's accumulation buffer.
               Zero if the current layer of the current window is color index.

       GLUT_WINDOW_ACCUM_GREEN_SIZE
               Number of bits of green stored in the current layer of current window's accumulation  buffer.
               Zero if the current layer of the current window is color index.

       GLUT_WINDOW_ACCUM_BLUE_SIZE
               Number  of  bits of blue stored in the current layer of current window's accumulation buffer.
               Zero if the current layer of the current window is color index.

       GLUT_WINDOW_ACCUM_ALPHA_SIZE
               Number of bits of alpha stored in the current layer of current window's accumulation  buffer.
               Zero if the current layer of the current window is color index.

       GLUT_WINDOW_DOUBLEBUFFER
               One if the current layer of the current window is double buffered, zero otherwise.

       GLUT_WINDOW_RGBA
               One  if  the  current  layer  of the current window is RGBA mode, zero otherwise (i.e., color
               index).

       GLUT_WINDOW_PARENT
               The window number of the current window's parent; zero if the window is a top-level window.

       GLUT_WINDOW_NUM_CHILDREN
               The number of subwindows the current window has (not counting children of children).

       GLUT_WINDOW_COLORMAP_SIZE
               Size of current layer of current window's color index colormap; zero  for  RGBA  color  model
               layers.

       GLUT_WINDOW_NUM_SAMPLES
               Number of samples for multisampling for the current layer of the current window.

       GLUT_WINDOW_STEREO
               One if the current layer of the current window is stereo, zero otherwise.

       GLUT_WINDOW_CURSOR
               Current cursor for the current window.

       GLUT_SCREEN_WIDTH
               Width of the screen in pixels. Zero indicates the width is unknown or not available.

       GLUT_SCREEN_HEIGHT
               Height of the screen in pixels. Zero indicates the height is unknown or not available.

       GLUT_SCREEN_WIDTH_MM
               Width of the screen in millimeters. Zero indicates the width is unknown or not available.

       GLUT_SCREEN_HEIGHT_MM
               Height of the screen in millimeters. Zero indicates the height is unknown or not available.

       GLUT_MENU_NUM_ITEMS
               Number of menu items in the current menu.

       GLUT_DISPLAY_MODE_POSSIBLE
               Whether the current display mode is supported or not.

       GLUT_INIT_DISPLAY_MODE
               The initial display mode bit mask.

       GLUT_INIT_WINDOW_X
               The X value of the initial window position.

       GLUT_INIT_WINDOW_Y
               The Y value of the initial window position.

       GLUT_INIT_WINDOW_WIDTH
               The width value of the initial window size.

       GLUT_INIT_WINDOW_HEIGHT
               The height value of the initial window size.

       GLUT_ELAPSED_TIME
               Number of milliseconds since glutInit called (or first call to glutGet(GLUT_ELAPSED_TIME)).

       GLUT_WINDOW_FORMAT_ID
               The  window  system  dependent format ID for the current layer of the current window.  On X11
               GLUT implementations, this is the X visual ID.  On Win32 GLUT implementations,  this  is  the
               Win32  Pixel  Format  Descriptor number.  This value is returned for debugging, benchmarking,
               and testing ease.

DESCRIPTION
       glutGet retrieves simple GLUT state represented by integers. The state parameter determines what type
       of  state  to  return.   Where appropriate, window capability state is returned for the layer in use.
       GLUT state names beginning with GLUT_WINDOW_ return state for the current window.  GLUT  state  names
       beginning  with  GLUT_MENU_  return  state for the current menu. Other GLUT state names return global
       state. Requesting state for an invalid GLUT state name returns negative one.

SEE ALSO
       glutDeviceGet(3G), glutLayerGet(3G), glutGetColor(3G), glutGetWindow(3G), glutGetMenu(3G),  glutGetModifiers(3G),  glutExten-sionSupported(3G) glutExtensionSupported(3G)
       sionSupported(3G)


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



GLUT                                                 3.7                                      glutGet(3GLUT)

Did this document help you?
Yes: Tell us what works for you.
It’s good, but: Report typos, inaccuracies, and so forth.
It wasn’t helpful: Tell us what would have helped.