Doc/to_port/WindowGlut.dox

   1 #include <OSGConfig.h>
   2
   3 using namespace OSG;
   4
   5 /*! \defgroup GrpWindowGlut OpenSG GLUT Window System Library
   6     \ingroup GrpWindowSystems
   7
   8     \brief The library for GLUT windows.
   9
  10     See \ref PageWindowGlut for details.
  11 */
  12
  13 /*! \defgroup GrpWindowGLUTField Fields
  14     \ingroup GrpWindowGlut
  15
  16     See \ref PageBaseField for details.
  17 */
  18
  19 #if (OSG_DOC_LEVEL >= 3)
  20 /*! \defgroup GrpWindowGlutFieldTraits Field Data Traits
  21     \ingroup GrpWindowGLUTField
  22
  23     ToDo
  24 */
  25 #endif
  26
  27 /*! \defgroup GrpWindowGLUTFieldSingle Single-Element Fields
  28     \ingroup GrpWindowGLUTField
  29
  30     ToDo
  31 */
  32
  33 /*! \defgroup GrpWindowGLUTFieldMulti Multi-Element Fields
  34     \ingroup GrpWindowGLUTField
  35
  36     ToDo
  37 */
  38
  39 /*! \page PageWindowGlut GLUT Window System Library
  40
  41 GLUT is the OpenGL Utility Toolkit developed by Mark Kilgard for his columns in
  42 the X journal, but it has sort of established itself as the toolkit of choice
  43 for a large number of programs that only need OpenGL. It is avilable on Unix
  44 and Windows and contains some wrappers to simplify writing software that works
  45 on both platforms. See
  46 http://www.opengl.org/developers/documentation/glut/index.html for general
  47 information and documentation about GLUT.
  48
  49 The GLUT window is the simplest of the OpenSG windows, as GLUT takes care of
  50 almost everything. The only parameter is the integer Window ID that GLUT uses,
  51 but most GLUT applications only use the default window anyway and thus don't
  52 have to setup anything except for calling init() after creating the Window.
  53
  54 activate() calls glutSetWindow, eactivate() is a nop, as GLUT can't be witched
  55 off, and swap() directly calls glutSwapBuffers(). The osg::GLUTWindow is very
  56 simple, but very useful nonetheless. Most of the test and tutorial programs are
  57 written using GLUT.
  58
  59 */