Tao.FreeGlut SDK Documentation

Glut Fields

The fields of the Glut class are listed below. For a complete list of Glut class members, see the Glut Members topic.

Public Static (Shared) Fields

FREEGLUT FreeGLUT API marker.
FREEGLUT_VERSION_2_0 FreeGLUT API version marker.
GLUT_ACCUM Bit mask to select a window with an accumulation buffer.
GLUT_ACTION_CONTINUE_EXECUTION Continue execution on window close button click.
GLUT_ACTION_EXIT Close window on window close button click.
GLUT_ACTION_GLUTMAINLOOP_RETURNS Return from main loop on window close button click.
GLUT_ACTION_ON_WINDOW_CLOSE Gets current action for window-close.
GLUT_ACTIVE_ALT Set if the Alt modifier is active.
GLUT_ACTIVE_CTRL Set if the Ctrl modifier is active.
GLUT_ACTIVE_SHIFT Set if the Shift modifier or Caps Lock is active.
GLUT_ALLOW_DIRECT_CONTEXT Direct/Indirect rendering context options (has meaning only in Unix/X11)
GLUT_ALPHA Bit mask to select a window with an alpha component to the color buffer(s).
GLUT_API_VERSION GLUT API revision.
GLUT_AUX1
GLUT_AUX2
GLUT_AUX3
GLUT_AUX4
GLUT_BITMAP_8_BY_13 A fixed width font with every character fitting in an 8 by 13 pixel rectangle.
GLUT_BITMAP_9_BY_15 A fixed width font with every character fitting in an 9 by 15 pixel rectangle.
GLUT_BITMAP_HELVETICA_10 A 10-point proportional spaced Helvetica font.
GLUT_BITMAP_HELVETICA_12 A 12-point proportional spaced Helvetica font.
GLUT_BITMAP_HELVETICA_18 A 18-point proportional spaced Helvetica font.
GLUT_BITMAP_TIMES_ROMAN_10 A 10-point proportional spaced Times Roman font.
GLUT_BITMAP_TIMES_ROMAN_24 A 24-point proportional spaced Times Roman font.
GLUT_BLUE Blue color component.
GLUT_CREATE_NEW_CONTEXT Create a new context when user opens a new window.
GLUT_CURSOR_BOTTOM_LEFT_CORNER Arrow pointing to bottom-left corner.
GLUT_CURSOR_BOTTOM_RIGHT_CORNER Arrow pointing to bottom-right corner.
GLUT_CURSOR_BOTTOM_SIDE Arrow pointing to bottom side.
GLUT_CURSOR_CROSSHAIR Simple cross-hair.
GLUT_CURSOR_CYCLE Arrows rotating in a circle.
GLUT_CURSOR_DESTROY Skull and cross bones.
GLUT_CURSOR_FULL_CROSSHAIR Full-screen cross-hair cursor (if possible, otherwise GLUT_CURSOR_CROSSHAIR.
GLUT_CURSOR_HELP Question mark.
GLUT_CURSOR_INFO Pointing hand.
GLUT_CURSOR_INHERIT Use parent's cursor.
GLUT_CURSOR_LEFT_ARROW Arrow pointing up and to the left.
GLUT_CURSOR_LEFT_RIGHT Bi-directional pointing left and right.
GLUT_CURSOR_LEFT_SIDE Arrow pointing to left side.
GLUT_CURSOR_NONE Invisible cursor.
GLUT_CURSOR_RIGHT_ARROW Arrow pointing up and to the right.
GLUT_CURSOR_RIGHT_SIDE Arrow pointing to right side.
GLUT_CURSOR_SPRAY Spray can.
GLUT_CURSOR_TEXT Insertion point cursor for text.
GLUT_CURSOR_TOP_LEFT_CORNER Arrow pointing to top-left corner.
GLUT_CURSOR_TOP_RIGHT_CORNER Arrow pointing to top-right corner.
GLUT_CURSOR_TOP_SIDE Arrow pointing to top side.
GLUT_CURSOR_UP_DOWN Bi-directional pointing up and down.
GLUT_CURSOR_WAIT Wrist watch.
GLUT_DEPTH Bit mask to select a window with a depth buffer.
GLUT_DEVICE_IGNORE_KEY_REPEAT Returns true if the current window's auto repeated keys are ignored. This state is controlled by glutIgnoreKeyRepeat.
GLUT_DEVICE_KEY_REPEAT The window system's global key repeat state. Returns either GLUT_KEY_REPEAT_OFF, GLUT_KEY_REPEAT_ON, or GLUT_KEY_REPEAT_DEFAULT. This will not necessarily return the value last passed to glutSetKeyRepeat.
GLUT_DIRECT_RENDERING
GLUT_DISPLAY_MODE_POSSIBLE Whether the current display mode is supported or not.
GLUT_DOUBLE Bit mask to select a double buffered window. This overrides GLUT_SINGLE if it is also specified.
GLUT_DOWN Mouse button down.
GLUT_ELAPSED_TIME Number of milliseconds since glutInit called (or first call to glutGet(GLUT_ELAPSED_TIME)).
GLUT_ENTERED Mouse pointer has entered the window.
GLUT_FORCE_DIRECT_CONTEXT Direct/Indirect rendering context options (has meaning only in Unix/X11)
GLUT_FORCE_INDIRECT_CONTEXT Direct/Indirect rendering context options (has meaning only in Unix/X11)
GLUT_FULLY_COVERED The window is shown but no part of the window is visible.
GLUT_FULLY_RETAINED No pixels belonging to the window are covered by other windows.
GLUT_GAME_MODE_ACTIVE Non-zero if GLUT's game mode is active; zero if not active. Game mode is not active initially. Game mode becomes active when glutEnterGameMode is called. Game mode becomes inactive when glutLeaveGameMode is called.
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.
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_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_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_WIDTH Width in pixels of the screen when game mode is activated.
GLUT_GREEN Green color component.
GLUT_HAS_DIAL_AND_BUTTON_BOX Non-zero if a dial and button box is available; zero if not available.
GLUT_HAS_JOYSTICK Non-zero if a joystick is available; zero if not available.
GLUT_HAS_KEYBOARD Non-zero if a keyboard is available; zero if not available. For most GLUT implementations, a keyboard can be assumed.
GLUT_HAS_MOUSE Non-zero if a mouse is available; zero if not available. For most GLUT implementations, a keyboard can be assumed.
GLUT_HAS_OVERLAY If the current window has an overlay established.
GLUT_HAS_SPACEBALL Non-zero if a Spaceball is available; zero if not available.
GLUT_HAS_TABLET Non-zero if a tablet is available; zero if not available.
GLUT_HIDDEN The window is not shown or iconified.
GLUT_INDEX Bit mask to select a color index mode window. This overrides GLUT_RGB or GLUT_RGBA if they are also specified.
GLUT_INIT_DISPLAY_MODE The initial display mode bit mask.
GLUT_INIT_STATE Unknown.
GLUT_INIT_WINDOW_HEIGHT The height value of the initial window size.
GLUT_INIT_WINDOW_WIDTH The width value of the initial window size.
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_JOYSTICK_AXES Number of axes supported by the joystick. If no joystick is supposrted, zero is returned.
GLUT_JOYSTICK_BUTTON_A Unknown. Unable to locate definitive documentation on this constant.
GLUT_JOYSTICK_BUTTON_B Unknown. Unable to locate definitive documentation on this constant.
GLUT_JOYSTICK_BUTTON_C Unknown. Unable to locate definitive documentation on this constant.
GLUT_JOYSTICK_BUTTON_D Unknown. Unable to locate definitive documentation on this constant.
GLUT_JOYSTICK_BUTTONS Number of buttons supported by the joystick. If no joystick is supported, zero is returned.
GLUT_JOYSTICK_POLL_RATE Returns the current window's joystick poll rate as set by glutJoystickFunc. If no joystick is supported, the poll rate will always be zero. The joystick poll rate also returns zero if the poll rate last specified to glutJoystickFunc is negative or a NULL callback was registered.
GLUT_KEY_DOWN Down directional key.
GLUT_KEY_END End directional key.
GLUT_KEY_F1 F1 function key.
GLUT_KEY_F10 F10 function key.
GLUT_KEY_F11 F11 function key.
GLUT_KEY_F12 F12 function key.
GLUT_KEY_F2 F2 function key.
GLUT_KEY_F3 F3 function key.
GLUT_KEY_F4 F4 function key.
GLUT_KEY_F5 F5 function key.
GLUT_KEY_F6 F6 function key.
GLUT_KEY_F7 F7 function key.
GLUT_KEY_F8 F8 function key.
GLUT_KEY_F9 F9 function key.
GLUT_KEY_HOME Home directional key.
GLUT_KEY_INSERT Insert directional key.
GLUT_KEY_LEFT Left directional key.
GLUT_KEY_PAGE_DOWN Page Down directional key.
GLUT_KEY_PAGE_UP Page Up directional key.
GLUT_KEY_REPEAT_DEFAULT Reset the key repeat mode for the window system to its default state.
GLUT_KEY_REPEAT_OFF Disable key repeat for the window system on a global basis.
GLUT_KEY_REPEAT_ON Enable key repeat for the window system on a global basis.
GLUT_KEY_RIGHT Right directional key.
GLUT_KEY_UP Up directional key.
GLUT_LAYER_IN_USE Either GLUT_NORMAL or GLUT_OVERLAY depending on whether the normal plane or overlay is the layer in use.
GLUT_LEFT Mouse pointer has left the window.
GLUT_LEFT_BUTTON Left mouse button.
GLUT_LUMINANCE Bit mask to select a window with a "luminance" color model. This model provides the functionality of OpenGL's RGBA color model, but the green and blue components are not maintained in the frame buffer. Instead each pixel's red component is converted to an index between zero and Glut.glutGet(Glut.GLUT_WINDOW_COLORMAP_SIZE) - 1 and looked up in a per-window color map to determine the color of pixels within the window. The initial colormap of GLUT_LUMINANCE windows is initialized to be a linear gray ramp, but can be modified with GLUT's colormap routines.
GLUT_MENU_IN_USE Pop-up menus are in use by the user.
GLUT_MENU_NOT_IN_USE Pop-up menus are not in use by the user.
GLUT_MENU_NUM_ITEMS Number of menu items in the current menu.
GLUT_MIDDLE_BUTTON Middle mouse button.
GLUT_MULTISAMPLE Bit mask to select a window with multisampling support. If multisampling is not available, a non-multisampling window will automatically be chosen. Note: both the OpenGL client-side and server-side implementations must support the GLX_SAMPLE_SGIS extension for multisampling to be available.
GLUT_NORMAL The normal plane.
GLUT_NORMAL_DAMAGED True if the normal plane of the current window has damaged (by window system activity) since the last display callback was triggered. Calling glutPostRedisplay will not set this true.
GLUT_NOT_VISIBLE The window is not visible. No part of the window is visible. All further rendering to the window is discarded until the window's visibility changes.
GLUT_NUM_BUTTON_BOX_BUTTONS Number of buttons supported by the dial and button box device. If no dials and button box device is supported, zero is returned.
GLUT_NUM_DIALS Number of dials supported by the dial and button box device. If no dials and button box device is supported, zero is returned.
GLUT_NUM_MOUSE_BUTTONS Number of buttons supported by the mouse. If no mouse is supported, zero is returned.
GLUT_NUM_SPACEBALL_BUTTONS Number of buttons supported by the Spaceball. If no Spaceball is supported, zero is returned.
GLUT_NUM_TABLET_BUTTONS Number of buttons supported by the tablet. If no tablet is supported, zero is returned.
GLUT_OVERLAY The overlay plane.
GLUT_OVERLAY_DAMAGED True if the overlay plane of the current window has damaged (by window system activity) since the last display callback was triggered. Calling glutPostRedisplay or glutPostOverlayRedisplay will not set this true. Negative one is returned if no overlay is in use.
GLUT_OVERLAY_POSSIBLE Whether an overlay could be established for the current window given the current initial display mode. If false, glutEstablishOverlay will fail with a fatal error if called.
GLUT_OWNS_JOYSTICK Unknown. Unable to locate definitive documentation on this constant.
GLUT_PARTIALLY_RETAINED Some but not all pixels belonging to the window are covered by other windows.
GLUT_RED Red color component.
GLUT_RENDERING_CONTEXT Gets GLUT's rendering context.
GLUT_RGB An alias for GLUT_RGBA.
GLUT_RGBA Bit mask to select an RGBA mode window. This is the default if neither GLUT_RGB, GLUT_RGBA, nor GLUT_INDEX are specified.
GLUT_RIGHT_BUTTON Right mouse button.
GLUT_SCREEN_HEIGHT Height of the screen in pixels. Zero indicates the height 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_SCREEN_WIDTH Width of the screen in pixels. Zero indicates the width 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_SINGLE Bit mask to select a single buffered window. This is the default if neither GLUT_DOUBLE or GLUT_SINGLE are specified.
GLUT_STENCIL Bit mask to select a window with a stencil buffer.
GLUT_STEREO Bit mask to select a stereo window.
GLUT_STROKE_MONO_ROMAN A mono-spaced spaced Roman Simplex font (same characters as GLUT_STROKE_ROMAN) for ASCII characters 32 through 127. The maximum top character in the font is 119.05 units; the bottom descends 33.33 units. Each character is 104.76 units wide.
GLUT_STROKE_ROMAN A proportionally spaced Roman Simplex font for ASCII characters 32 through 127. The maximum top character in the font is 119.05 units; the bottom descends 33.33 units.
GLUT_TRANSPARENT_INDEX The transparent color index of the overlay of the current window; negative one is returned if no overlay is in use.
GLUT_TRY_DIRECT_CONTEXT Direct/Indirect rendering context options (has meaning only in Unix/X11)
GLUT_UP Mouse button up.
GLUT_USE_CURRENT_CONTEXT Use current context when user opens a new window.
GLUT_VERSION Gets GLUT version.
GLUT_VIDEO_RESIZE_HEIGHT Unknown. Unable to locate definitive documentation on this constant.
GLUT_VIDEO_RESIZE_HEIGHT_DELTA Unknown. Unable to locate definitive documentation on this constant.
GLUT_VIDEO_RESIZE_IN_USE Unknown. Unable to locate definitive documentation on this constant.
GLUT_VIDEO_RESIZE_POSSIBLE Non-zero if video resizing is supported by the underlying system; zero if not supported. If this is zero, the other video resize GLUT calls do nothing when called.
GLUT_VIDEO_RESIZE_WIDTH Unknown. Unable to locate definitive documentation on this constant.
GLUT_VIDEO_RESIZE_WIDTH_DELTA Unknown. Unable to locate definitive documentation on this constant.
GLUT_VIDEO_RESIZE_X Unknown. Unable to locate definitive documentation on this constant.
GLUT_VIDEO_RESIZE_X_DELTA Unknown. Unable to locate definitive documentation on this constant.
GLUT_VIDEO_RESIZE_Y Unknown. Unable to locate definitive documentation on this constant.
GLUT_VIDEO_RESIZE_Y_DELTA Unknown. Unable to locate definitive documentation on this constant.
GLUT_VISIBLE The window is visible. Does not distinguish a window being totally versus partially visible.
GLUT_WINDOW_ACCUM_ALPHA_SIZE Number of bits of alpha stored in the current window's accumulation buffer. Zero if the window is color index.
GLUT_WINDOW_ACCUM_BLUE_SIZE Number of bits of blue stored in the current window's accumulation buffer. Zero if the window is color index.
GLUT_WINDOW_ACCUM_GREEN_SIZE Number of bits of green stored in the current window's accumulation buffer. Zero if the window is color index.
GLUT_WINDOW_ACCUM_RED_SIZE Number of bits of red stored in the current window's accumulation buffer. Zero if the window is color index.
GLUT_WINDOW_ALPHA_SIZE Number of bits of alpha stored the current window's color buffer. Zero if the window is color index.
GLUT_WINDOW_BLUE_SIZE Number of bits of blue stored the current window's color buffer. Zero if the window is color index.
GLUT_WINDOW_BORDER_WIDTH Gets the window border width.
GLUT_WINDOW_BUFFER_SIZE Total number of bits for 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_COLORMAP_SIZE Size of current window's color index colormap; zero for RGBA color model windows.
GLUT_WINDOW_CURSOR Current cursor for the current window.
GLUT_WINDOW_DEPTH_SIZE Number of bits in the current window's depth buffer.
GLUT_WINDOW_DOUBLEBUFFER One if the current window is double buffered, zero otherwise.
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.
GLUT_WINDOW_GREEN_SIZE Number of bits of green stored the current window's color buffer. Zero if the window is color index.
GLUT_WINDOW_HEADER_HEIGHT Gets window header height.
GLUT_WINDOW_HEIGHT Height in pixels of the current window.
GLUT_WINDOW_NUM_CHILDREN The number of subwindows the current window has (not counting children of children).
GLUT_WINDOW_NUM_SAMPLES Number of samples for multisampling for the current window.
GLUT_WINDOW_PARENT The window number of the current window's parent; zero if the window is a top-level window.
GLUT_WINDOW_RED_SIZE Number of bits of red stored the current window's color buffer. Zero if the window is color index.
GLUT_WINDOW_RGBA One if the current window is RGBA mode, zero otherwise (i.e., color index).
GLUT_WINDOW_STENCIL_SIZE Number of bits in the current window's stencil buffer.
GLUT_WINDOW_STEREO One if the current window is stereo, zero otherwise.
GLUT_WINDOW_WIDTH Width in pixels of the current window.
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_XLIB_IMPLEMENTATION

See Also

Glut Class | Tao.FreeGlut Namespace