From 094da5dafa0b1bded14c9dce72cc5b07d7c5aff3 Mon Sep 17 00:00:00 2001 From: engelsman Date: Sun, 22 Mar 2009 17:35:02 +0000 Subject: changed html tags to doxygen commands in documentation/src/glut.dox git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6710 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- documentation/src/glut.dox | 125 +++++++++++++++++++++++---------------------- 1 file changed, 64 insertions(+), 61 deletions(-) diff --git a/documentation/src/glut.dox b/documentation/src/glut.dox index adddfdb36..7d8c53bbf 100644 --- a/documentation/src/glut.dox +++ b/documentation/src/glut.dox @@ -9,18 +9,18 @@ the follow-on FreeGLUT 2.4.0 libraries. \section glut_using Using the GLUT Compatibility Header File You should be able to compile existing GLUT source code by including - instead of . This can be -done by editing the source, by changing the -I switches to -the compiler, or by providing a symbolic link from GL/glut.h -to FL/glut.H. +\c instead of \c . This can be +done by editing the source, by changing the \c -I switches to +the compiler, or by providing a symbolic link from \c GL/glut.h +to \c FL/glut.H. -All files calling GLUT procedures must be compiled with C++. You +All files calling GLUT procedures must be compiled with C++. You may have to alter them slightly to get them to compile without warnings, and you may have to rename them to get make to use the C++ compiler. -You must link with the FLTK library. Most of FL/glut.H +You must link with the FLTK library. Most of \c FL/glut.H is inline functions. You should take a look at it (and maybe at -test/glpuzzle.cxx in the FLTK source) if you are having trouble +\c test/glpuzzle.cxx in the FLTK source) if you are having trouble porting your GLUT program. This has been tested with most of the demo programs that come with @@ -32,78 +32,78 @@ The following functions and/or arguments to functions are missing, and you will have to replace them or comment them out for your code to compile: -\li glutGet(GLUT_ELAPSED_TIME) -\li glutGet(GLUT_SCREEN_HEIGHT_MM) -\li glutGet(GLUT_SCREEN_WIDTH_MM) -\li glutGet(GLUT_WINDOW_NUM_CHILDREN) -\li glutInitDisplayMode(GLUT_LUMINANCE) -\li glutLayerGet(GLUT_HAS_OVERLAY) -\li glutLayerGet(GLUT_LAYER_IN_USE) -\li glutPushWindow() -\li glutSetColor(), glutGetColor(), glutCopyColormap() -\li glutVideoResize() missing. -\li glutWarpPointer() -\li glutWindowStatusFunc() +\li \p glutGet(GLUT_ELAPSED_TIME) +\li \p glutGet(GLUT_SCREEN_HEIGHT_MM) +\li \p glutGet(GLUT_SCREEN_WIDTH_MM) +\li \p glutGet(GLUT_WINDOW_NUM_CHILDREN) +\li \p glutInitDisplayMode(GLUT_LUMINANCE) +\li \p glutLayerGet(GLUT_HAS_OVERLAY) +\li \p glutLayerGet(GLUT_LAYER_IN_USE) +\li \p glutPushWindow() +\li \p glutSetColor(), \p glutGetColor(), \p glutCopyColormap() +\li \p glutVideoResize() missing. +\li \p glutWarpPointer() +\li \p glutWindowStatusFunc() \li Spaceball, buttonbox, dials, and tablet functions Most of the symbols/enumerations have different values than GLUT uses. This will break code that relies on the actual values. The only -symbols guaranteed to have the same values are true/false pairs like -GLUT_DOWN and GLUT_UP, mouse buttons -GLUT_LEFT_BUTTON, GLUT_MIDDLE_BUTTON, GLUT_RIGHT_BUTTON, and -GLUT_KEY_F1 thru F12. +symbols guaranteed to have the same values are true/false pairs like +GLUT_DOWN and GLUT_UP, mouse buttons +GLUT_LEFT_BUTTON, GLUT_MIDDLE_BUTTON, GLUT_RIGHT_BUTTON, and +GLUT_KEY_F1 thru GLUT_KEY_F12. The strings passed as menu labels are not copied. -glutPostRedisplay() does not work if called from inside a -display function. You must use glutIdleFunc() if you want +\p glutPostRedisplay() does not work if called from inside a +display function. You must use \p glutIdleFunc() if you want your display to update continuously. -glutSwapBuffers() does not work from inside a display +\p glutSwapBuffers() does not work from inside a display function. This is on purpose, because FLTK swaps the buffers for you. -glutUseLayer() does not work well, and should only be used +\p glutUseLayer() does not work well, and should only be used to initialize transformations inside a resize callback. You should -redraw overlays by using glutOverlayDisplayFunc(). +redraw overlays by using \p glutOverlayDisplayFunc(). -Overlays are cleared before the overlay display function is called. -glutLayerGet(GLUT_OVERLAY_DAMAGED) always returns true for +Overlays are cleared before the overlay display function is called. +\p glutLayerGet(GLUT_OVERLAY_DAMAGED) always returns true for compatibility with some GLUT overlay programs. You must rewrite your -code so that gl_color() is used to choose colors in an +code so that \p gl_color() is used to choose colors in an overlay, or you will get random overlay colors. -glutSetCursor(GLUT_CURSOR_FULL_CROSSHAIR) just results in a +\p glutSetCursor(GLUT_CURSOR_FULL_CROSSHAIR) just results in a small crosshair. -The fonts used by glutBitmapCharacter() and glutBitmapWidth() +The fonts used by \p glutBitmapCharacter() and \p glutBitmapWidth() may be different. -glutInit(argc,argv) will consume different switches than -GLUT does. It accepts the switches recognized by -Fl::args(), and will accept any abbreviation of these +\p glutInit(argc,argv) will consume different switches than +GLUT does. It accepts the switches recognized by +Fl::args(), +and will accept any abbreviation of these switches (such as "-di" for "-display"). \section glut_mixing Mixing GLUT and FLTK Code -You can make your GLUT window a child of a Fl_Window with the +You can make your GLUT window a child of a Fl_Window with the following scheme. The biggest trick is that GLUT insists on -show()'ing the window at the point it is created, which means the -Fl_Window parent window must already be shown. +a call to \p show() the window at the point it is created, which means the +Fl_Window parent window must already be shown. -\li Don't call glutInit(). -\li Create your Fl_Window, and any FLTK widgets. Leave a +\li Don't call \p glutInit(). +\li Create your Fl_Window, and any FLTK widgets. Leave a blank area in the window for your GLUT window. -\li show() the Fl_Window. Perhaps call - show(argc,argv). +\li \p show() the Fl_Window. Perhaps call \p show(argc,argv). \li Call window->begin() so that the GLUT window will be automatically added to it. -\li Use glutInitWindowSize() and glutInitWindowPosition() +\li Use \p glutInitWindowSize() and \p glutInitWindowPosition() to set the location in the parent window to put the GLUT window. \li Put your GLUT code next. It probably does not need many changes. Call window->end() immediately after the - glutCreateWindow()! -\li You can call either glutMainLoop(), Fl::run(), - or loop calling Fl::wait() to run the program. + \p glutCreateWindow()! +\li You can call either \p glutMainLoop(), Fl::run(), + or loop calling Fl::wait() to run the program. \section glut_Fl_Glut_Window class Fl_Glut_Window @@ -129,24 +129,24 @@ to manipulate instances directly rather than use GLUT window id's. These may be created without opening the display, and thus can fit better into FLTK's method of creating windows. -The current GLUT window is available in the global variable -glut_window.

+The current GLUT window is available in the global variable +\p glut_window. -new Fl_Glut_Window(...) is the same as -glutCreateWindow() except it does not show() the window -or make the window current.

+new Fl_Glut_Window(...) is the same as +\p glutCreateWindow() except it does not \p show() the window +or make the window current. -window->make_current() is the same as glutSetWindow(number). -If the window has not had show() called on it yet, some functions +window->make_current() is the same as \p glutSetWindow(number). +If the window has not had \p show() called on it yet, some functions that assumme an OpenGL context will not work. -If you do show() the window, call make_current() -again to set the context.

+If you do \p show() the window, call \p make_current() +again to set the context. -~Fl_Glut_Window() is the same as glutDestroyWindow(). +~Fl_Glut_Window() is the same as \p glutDestroyWindow(). \subsection glut_members Members -The Fl_Glut_Window class contains several public members that can +The Fl_Glut_Window class contains several public members that can be altered directly:
@@ -207,11 +207,12 @@ be altered directly: \subsection glut_methods Methods -\li Fl_Glut_Window -\li ~Fl_Glut_Window -\li make_current +\li \ref glut_fl_glut_window_constructor "Fl_Glut_Window()" +\li \ref glut_fl_glut_window_destructor "~Fl_Glut_Window()" +\li \ref glut_make_current "make_current()" +\anchor glut_fl_glut_window_constructor Fl_Glut_Window::Fl_Glut_Window(int x, int y, int w, int h, const char *title = 0)
Fl_Glut_Window::Fl_Glut_Window(int w, int h, const char *title = 0) @@ -223,12 +224,14 @@ will create the window with a preset size, but the window manager will choose the position according to it's own whims. +\anchor glut_fl_glut_window_destructor virtual Fl_Glut_Window::~Fl_Glut_Window() \par Destroys the GLUT window. +\anchor glut_make_current void Fl_Glut_Window::make_current() \par -- cgit v1.2.3