From 4c1b2f7f714e88ef771520555be6e2663f7ee2c1 Mon Sep 17 00:00:00 2001 From: dcnieho Date: Fri, 5 Apr 2013 13:40:32 +0000 Subject: [PATCH] small updates to API doc, some cleanup git-svn-id: https://svn.code.sf.net/p/freeglut/code/trunk@1605 7f0cb862-5218-0410-a997-914c9d46530a --- freeglut/web-src/docs/api.php | 66 ++++++++++++++++++----------------- 1 file changed, 34 insertions(+), 32 deletions(-) diff --git a/freeglut/web-src/docs/api.php b/freeglut/web-src/docs/api.php index 0184bb0..dcf574d 100644 --- a/freeglut/web-src/docs/api.php +++ b/freeglut/web-src/docs/api.php @@ -497,23 +497,24 @@ from the library can be handled by the user.

Usage

-

void glutInitErrorFunc ( void (* callback)( const char *fmt, va_list ap) );
- void glutInitWarningFunc ( void (* callback)( const char *fmt, va_list ap) );

+

void glutInitErrorFunc   ( void (* callback)( const char *fmt, va_list ap) );
+void glutInitWarningFunc ( void (* callback)( const char *fmt, va_list ap) );

Description

The users callback is passed a format string and a variable argument list that can be passed to functions such as printf.
Note that there are the preprocessor definitions -FREEGLUT_PRINT_ERRORS and FREEGLUT_PRINT_WARNINGS. If -defined at library (not client app!) compile time, which is default, -warnings and errors are printed to stderr. If not defined, -warnings and errors are muted (not printed to stderr), though errors -still trigger deinitialization and exit. Whether -FREEGLUT_PRINT_ERRORS and FREEGLUT_PRINT_WARNINGS is -defined does not affect whether the client callback is called, it only -affects whether warnings and errors are printed to stderr when -no callback is defined. +FREEGLUT_PRINT_ERRORS and FREEGLUT_PRINT_WARNINGS, +which affect FreeGLUT's warning and error behavior when no user +callback is defined. If defined at library (not client app!) compile +time--by default it is, warnings and errors are printed to +stderr. If not defined, warnings and errors are muted (not +printed to stderr), though errors still trigger deinitialization and +exit. Whether FREEGLUT_PRINT_ERRORS and +FREEGLUT_PRINT_WARNINGS is defined does not affect whether the +client callback is called, it only affects whether warnings and errors +are printed to stderr when no callback is defined.

Changes From GLUT

@@ -903,9 +904,10 @@ the specified menu.

Description

-Only bitmap fonts (GLUT_BITMAP_xxx) can be used as menu fonts. -A warning is issued if the supplied font is a stroke font, or an unknown -font and the request will be ignored. +Only bitmap fonts (GLUT_BITMAP_xxx, see here for a list) can be used as menu fonts. A +warning is issued and the request is ignored if the supplied font is a +stroke font, or an unknown font.

Changes From GLUT

@@ -1406,7 +1408,7 @@ is not implemented in freeglut.

The glutVisibilityFunc and the glutWindowStatusFunc functions set the window's visibility and windowStatus callbacks for the -current window. Setting one supersedes the other. Freeglut calls +current window. Setting one overwrites the other. Freeglut calls these callbacks when the visibility status of a window changes.

@@ -1419,17 +1421,19 @@ these callbacks when the visibility status of a window changes.

Description

-The state callback parameter is one of GLUT_HIDDEN, GLUT_FULLY_RETAINED, -GLUT_PARTIALLY_RETAINED, or GLUT_FULLY_COVERED depending on the current -window status of the window. GLUT_HIDDEN means that the window is not -shown (often meaning that the window is iconified). GLUT_FULLY_RETAINED -means that the window is fully retained (no pixels belonging to the -window are covered by other windows). GLUT_PARTIALLY_RETAINED means that -the window is partially retained (some but not all pixels belonging to -the window are covered by other windows). GLUT_FULLY_COVERED means the -window is shown but no part of the window is visible, i.e., until the -window's status changes, all further rendering to the window is -discarded.
+glutVisibilityFunc is deprecated and superseded by the more +informative glutWindowStatusFunc.
+For glutWindowStatusFunc, the state callback parameter is one +of GLUT_HIDDEN, GLUT_FULLY_RETAINED, GLUT_PARTIALLY_RETAINED, or +GLUT_FULLY_COVERED depending on the current window status of the window. +GLUT_HIDDEN means that the window is not shown (often meaning that the +window is iconified). GLUT_FULLY_RETAINED means that the window is fully +retained (no pixels belonging to the window are covered by other +windows). GLUT_PARTIALLY_RETAINED means that the window is partially +retained (some but not all pixels belonging to the window are covered by +other windows). GLUT_FULLY_COVERED means the window is shown but no part +of the window is visible, i.e., until the window's status changes, all +further rendering to the window is discarded.
GLUT considers a window visible if any pixel of the window is visible or any pixel of any descendant window is visible on the screen.
GLUT applications are encouraged to disable rendering and/or animation @@ -1442,9 +1446,7 @@ status callback and re-enable the callback, you are guaranteed the next window status change will be reported.
Setting the window status callback for a window disables the visibility callback set for the window (and vice versa). The visibility callback is -set with glutVisibilityFunc. glutVisibilityFunc is -deprecated in favor of the more informative -glutWindowStatusFunc. For glutVisibilityFunc, the +set with glutVisibilityFunc, and its state callback parameter is either GLUT_NOT_VISIBLE or GLUT_VISIBLE depending on the current visibility of the window. GLUT_VISIBLE does not distinguish a window being totally versus partially visible. @@ -2032,7 +2034,7 @@ draws. The functions generate normals appropriate for lighting but, except for the teapot functions, do not generate texture coordinates. Do note that depth testing (GL_LESS) should be enabled for the correct drawing of the nonconvex objects, i.e., the glutTorus, -glutSierpinskiSponge and glutTeapot.
+glutSierpinskiSponge, glutTeapot, glutTeacup and glutTeaspoon.
Also see the GLUT_GEOMETRY_VISUALIZE_NORMALS option that can be set with glutSetOption.

@@ -2386,8 +2388,8 @@ should use:

  glutSolidTeapot(size);
  glFrontFace(GL_CCW);

-

Both these bugs reflect issues in the original teaset's vertex data -(and are thus present in GLUT too).

+

This bug reflect issues in the original teaset's vertex data +(and is thus present in GLUT too).

Changes From GLUT