diff --git a/freeglut/freeglut/doc/freeglut_user_interface.html b/freeglut/freeglut/doc/freeglut_user_interface.html
index c57a4ce..074f2cc 100644
--- a/freeglut/freeglut/doc/freeglut_user_interface.html
+++ b/freeglut/freeglut/doc/freeglut_user_interface.html
@@ -48,7 +48,7 @@ damages in connection with or arising from the use of information or programs
contained herein.
2.0 Introduction
3.0 Background
@@ -200,10 +200,10 @@ Functions
Usage +
void glutInitWindowPosition ( int x, int y ) ;
+
void glutInitWindowSize ( int width, int height ) ;
+
Description +
The "glutInitWindowPosition " and "glutInitWindowSize" +functions specify a desired position and size for windows that freeglut +will create in the future. The position is measured in pixels from +the upper left hand corner of the screen, with "x" increasing to the right +and "y" increasing towards the bottom of the screen. The size is +measured in pixels. Freeglut does not promise to follow these +specifications in creating its windows, it certainly makes an attempt to. +
The position and size of a window are a matter of some subtlety. +Most windows have a usable area surrounded by a border and with a title +bar on the top. The border and title bar are commonly called "decorations." +The position of the window unfortunately varies with the operating system. +On Linux, it is the coordinates of the upper left-hand corner of its decorations. +On Windows, it is the coordinates of the upper left hand corner of its +usable interior. For both operating systems, the size of the window +is the size of the usable interior. +
Windows has some additional quirks which the application programmer +should know about. First, the minimum y-coordinate of a window decoration +is zero. (This is a feature of freeglut and can be adjusted +if so desired.) Second, there appears to be a minimum window width +on Windows which is 104 pixels. The user may specify a smaller width, +but the Windows system calls ignore it. It is also impossible to +make a window narrower than this by dragging on its corner. +
Changes From GLUT +
For some reason, GLUT is not affected by the 104-pixel minimum window +width. If the user clicks on the corner of a window which is narrower +than this amount, the window will immediately snap out to this width, but +the application can call "glutReshapeWindow " and make a window +narrower again.
Changes From GLUT
In GLUT, there was absolutely no way for the application programmer -to have control return from the "glutMainLoop" function to the +to have control return from the "glutMainLoop " function to the calling function. Freeglut allows the programmer to force this by setting the "GLUT_ACTION_ON_WINDOW_CLOSE" option and invoking the "glutLeaveMainLoop" function from one of the callbacks. -Stopping the program this way is preferable to simply calling "exit" -from within a callback because this allows freeglut to free allocated +Stopping the program this way is preferable to simply calling "exit +" from within a callback because this allows freeglut to free allocated memory and otherwise clean up after itself. (I know I just said this, but I think it is important enough that it bears repeating.)
Usage
void glutMainLoopEvent ( void ) ;
Description -
The "glutMainLoopEvent" function causes freeglut +
The "glutMainLoopEvent " function causes freeglut to process one iteration's worth of events in its event loop. This allows the application to control its own event loop and still use the -freeglut windowing system. +freeglut +windowing system.
Changes From GLUT
GLUT does not include this function.
Usage
void glutLeaveMainLoop ( void ) ;
Description -
The "glutLeaveMainLoop" function causes freeglut -to stop the event loop. If the "GLUT_ACTION_ON_WINDOW_CLOSE" -option has been set to "GLUT_ACTION_CONTINUE_EXECUTION", control -will return to the function which called "glutMainLoop"; otherwise +
The "glutLeaveMainLoop " function causes freeglut +to stop the event loop. If the " GLUT_ACTION_ON_WINDOW_CLOSE" +option has been set to "GLUT_ACTION_CONTINUE_EXECUTION ", control +will return to the function which called "glutMainLoop "; otherwise the application will exit. +
If the application has two nested calls to "glutMainLoop" and +calls "glutLeaveMainLoop", the behaviour of freeglut is +undefined. It may leave only the inner nested loop or it may leave +both loops. If the reader has a strong preference for one behaviour +over the other he should contact the freeglut Programming Consortium +and ask for the code to be fixed.
Changes From GLUT
GLUT does not include this function.
Usage +
void glutEstablishOverlay ( void ) ; +
Description +
The "glutEstablishOverlay" function is not implemented in freeglut. +
Changes From GLUT +
GLUT implements this function.
Usage +
void glutRemoveOverlay ( void ) ; +
Description +
The "glutRemoveOverlay" function is not implemented in freeglut. +
Changes From GLUT +
GLUT implements this function.
Usage +
void glutUseLayer ( GLenum layer ) ; +
Description +
The "glutUseLayer" function is not implemented in freeglut. +
Changes From GLUT +
GLUT implements this function.
Usage +
void glutPostOverlayRedisplay ( void ) ; +
Description +
The "glutPostOverlayRedisplay " function is not implemented +in freeglut. +
Changes From GLUT +
GLUT implements this function.
Usage +
void glutPostWindowOverlayRedisplay ( int window ) ; +
Description +
The "glutPostWindowOverlayRedisplay " function is not implemented +in freeglut. +
Changes From GLUT +
GLUT implements this function.
Usage +
void glutShowOverlay( void ) ;
+
void glutHideOverlay( void ) ;
+
Description +
The "glutShowOverlay" and "glutHideOverlay" functions +are not implemented in freeglut . +
Changes From GLUT +
GLUT implements these functions.
Usage +
void glutSpecialFunc ( void (*func) ( int key, int x, int y ) ) +; +
func The window's new special key press callback
+function
+
key The key whose press triggers the
+callback
+
x The x-coordinate of
+the mouse relative to the window at the time the key is pressed
+
y The y-coordinate of
+the mouse relative to the window at the time the key is pressed
+
Description +
The "glutSpecialFunc" function specifies the function
+that freeglut will call when the user presses a special key on the
+keyboard. The callback function has one argument: the name
+of the function to be invoked ("called back") at the time at which the
+special key is pressed. The function returns no value. Freeglut
+sets the current window to the window which is active when the callback
+is invoked. "Special keys" are the function keys, the arrow keys,
+the Page Up and Page Down keys, and the Insert key. The Delete key
+is considered to be a regular key.
+
Calling "glutSpecialUpFunc" with a NULL
+argument disables the call to the window's special key press callback.
+
The "key" argument may take one of the following +defined constant values: +
None.
Usage +
void glutKeyboardUpFunc ( void (*func) ( unsigned char key, int +x, int y ) ) ; +
func The window's new key release callback
+function
+
key The key whose release triggers
+the callback
+
x The x-coordinate of
+the mouse relative to the window at the time the key is released
+
y The y-coordinate of
+the mouse relative to the window at the time the key is released
+
Description +
The "glutKeyboardUpFunc" function specifies the function
+that freeglut will call when the user releases a key from the keyboard.
+The callback function has one argument: the name of the function
+to be invoked ("called back") at the time at which the key is released.
+The function returns no value. Freeglut sets the current
+window to the window which is active when the callback is invoked.
+
While freeglut checks for upper or lower
+case letters, it does not do so for non-alphabetical characters.
+Nor does it account for the Caps-Lock key being on. The operating
+system may send some unexpected characters to freeglut, such as
+"8" when the user is pressing the Shift key. Freeglut also
+invokes the callback when the user releases the Control, Alt, or Shift
+keys, among others. Releasing the Delete key causes this function
+to be invoked with a value of 127 for "key".
+
Calling "glutKeyboardUpFunc" with a NULL
+argument disables the call to the window's key release callback.
+
Changes From GLUT +
This function is not implemented in GLUT versions before Version 4. +It has been designed to be as close to GLUT as possible. Users who +find differences should contact the freeglut development team to +have them fixed.
Usage +
void glutSpecialUpFunc ( void (*func) ( int key, int x, int y ) +) ; +
func The window's new special key release
+callback function
+
key The key whose release triggers
+the callback
+
x The x-coordinate of
+the mouse relative to the window at the time the key is released
+
y The y-coordinate of
+the mouse relative to the window at the time the key is released
+
Description +
The "glutSpecialUpFunc" function specifies the function
+that freeglut will call when the user releases a special key from
+the keyboard. The callback function has one argument: the name
+of the function to be invoked ("called back") at the time at which the
+special key is released. The function returns no value. Freeglut
+sets the current window to the window which is active when the callback
+is invoked. "Special keys" are the function keys, the arrow keys,
+the Page Up and Page Down keys, and the Insert key. The Delete key
+is considered to be a regular key.
+
Calling "glutSpecialUpFunc" with a NULL
+argument disables the call to the window's special key release callback.
+
The "key" argument may take one of the following +defined constant values: +
This function is not implemented in GLUT versions before Version 4. +It has been designed to be as close to GLUT as possible. Users who +find differences should contact the freeglut development team to +have them fixed.
It should be noted that freeglut fonts are
similar but not identical to GLUT fonts. At the moment, freeglut
fonts do not support the "`" (backquote) and "|" (vertical line) characters;
@@ -652,11 +879,11 @@ font to use in rendering the character
character The ASCII code of the character to be
rendered
Description -
The "glutBitmapCharacter" function renders the given +
The "glutBitmapCharacter " function renders the given
character in the specified bitmap font. Freeglut automatically
sets the necessary pixel unpack storage modes and restores the existing
-modes when it has finished. Before the first call to "glutBitMapCharacter"
-the application program should call "glRasterPos*" to set the
+modes when it has finished. Before the first call to "glutBitMapCharacter
+" the application program should call "glRasterPos*" to set the
position of the character in the window. The "glutBitmapCharacter"
function advances the cursor position as part of its call to "glBitmap"
and so the application does not need to call "glRasterPos*" again
@@ -675,7 +902,7 @@ characters in the current window using the specified font.
in rendering the character string
string String of characters to be rendered
Description -
The "glutBitmapString" function renders the given character +
The "glutBitmapString " function renders the given character
string in the specified bitmap font. Freeglut automatically
sets the necessary pixel unpack storage modes and restores the existing
modes when it has finished. Before calling "glutBitMapString"
@@ -710,7 +937,7 @@ a string of bitmapped characters in the specified font.
the character width
string String of characters whose width is to be calculated
Description -
The "glutBitmapLength" function returns the width in +
The "glutBitmapLength " function returns the width in pixels of the given character string in the specified bitmap font. Because the font is bitmapped, the width is an exact integer: the return value is identical to the sum of the character widths returned by @@ -731,7 +958,7 @@ the specified font.
font The bitmapped font to use in calculating the character height
Description -
The "glutBitmapHeight" function returns the height of +
The "glutBitmapHeight " function returns the height of
a character in the specified bitmap font. Because the font is bitmapped,
the height is an exact integer. The fonts are designed such that
all characters have (nominally) the same height.
@@ -748,13 +975,13 @@ to use in rendering the character
character The ASCII code of the character to be
rendered
Description -
The "glutStrokeCharacter" function renders the given +
The "glutStrokeCharacter " function renders the given character in the specified stroke font. Before the first call to "glutStrokeCharacter" the application program should call the OpenGL transformation (positioning and scaling) functions to set the position -of the character in the window. The "glutStrokeCharacter" -function advances the cursor position by a call to "glTranslatef" -and so the application does not need to call the OpenGL positioning functions +of the character in the window. The "glutStrokeCharacter +" function advances the cursor position by a call to "glTranslatef +" and so the application does not need to call the OpenGL positioning functions again for successive characters on the same line.
Changes From GLUT
Nonexistent characters are rendered as asterisks.
@@ -768,11 +995,11 @@ in the current window using the specified stroke font.
rendering the character string
string String of characters to be rendered
Description -
The "glutStrokeString" function renders the given character +
The "glutStrokeString " function renders the given character string in the specified stroke font. Before calling "glutStrokeString" the application program should call the OpenGL transformation (positioning and scaling) functions to set the position of the string in the window. -The "glutStrokeString" function handles carriage returns. +The "glutStrokeString " function handles carriage returns. Nonexistent characters are rendered as asterisks.
Changes From GLUT
GLUT does not include this function.
@@ -802,13 +1029,13 @@ a string of characters in the specified stroke font.
the character width
string String of characters whose width is to be calculated
Description -
The "glutStrokeLength" function returns the width in +
The "glutStrokeLength " function returns the width in pixels of the given character string in the specified stroke font. Because the font is a stroke font, the width of an individual character is a floating-point number. Freeglut adds the floating-point widths and rounds the funal result to return the integer value. Thus the return value may differ from the sum of the character widths returned -by a series of calls to "glutStrokeWidth". The width of +by a series of calls to "glutStrokeWidth ". The width of nonexistent characters is counted to be the width of an asterisk.
If the string contains one or more carriage returns, freeglut @@ -825,7 +1052,7 @@ the specified font.
font The stroke font to use in calculating the character height
Description -
The "glutStrokeHeight" function returns the height of +
The "glutStrokeHeight " function returns the height of a character in the specified stroke font. The application programmer should note that, unlike the other freeglut font functions, this one returns a floating-point number. The fonts are designed such @@ -833,17 +1060,17 @@ that all characters have (nominally) the same height.
Changes From GLUT
GLUT does not include this function.
Description -
The "glutWireSphere" and "glutSolidSphere" functions +
The "glutWireSphere" and " glutSolidSphere" functions render a sphere centered at the origin of the modeling coordinate system. The north and south poles of the sphere are on the positive and negative Z-axes respectively and the prime meridian crosses the positive X-axis. @@ -888,7 +1115,7 @@ number of segments in a single outer circle of the torus
nRings The desired number of outer circles around the origin of the torus
Description -
The "glutWireTorus" and "glutSolidTorus" functions +
The "glutWireTorus" and " glutSolidTorus" functions render a torus centered at the origin of the modeling coordinate system. The torus is circularly symmetric about the Z-axis and starts at the positive X-axis. @@ -913,10 +1140,10 @@ number of slices around the base of the cone number of segments between the base and the tip of the cone (the number of points, including the tip, is stacks + 1)
Description -
The "glutWireCone" and "glutSolidCone" functions render -a right circular cone with a base centered at the origin and in the X-Y -plane and its tip on the positive Z-axis. The wire cone is rendered -with triangular elements. +
The "glutWireCone" and " glutSolidCone" functions +render a right circular cone with a base centered at the origin and in +the X-Y plane and its tip on the positive Z-axis. The wire cone is +rendered with triangular elements.
Changes From GLUT
None that we know of.
dSize The desired length of an edge of the cube
Description -
The "glutWireCube" and "glutSolidCube" functions render -a cube of the desired size, centered at the origin. Its faces are -normal to the coordinate directions. +
The "glutWireCube" and " glutSolidCube" functions +render a cube of the desired size, centered at the origin. Its faces +are normal to the coordinate directions.
Changes From GLUT
None that we know of.
None that we know of.
Usage
void glutWireRhombicDodecahedron ( void ) ;
void glutSolidRhombicDodecahedron ( void ) ;
Description -
The "glutWireRhombicDodecahedron" and "glutSolidRhombicDodecahedron" +
The "glutWireRhombicDodecahedron " and "glutSolidRhombicDodecahedron" functions render a rhombic dodecahedron whose corners are at most a distance of one from the origin. The rhombic dodecahedron has faces which are identical rhombuses (rhombi?) but which have some vertices at which three faces meet and some vertices at which four faces meet. The length of each side is sqrt(3)/2. Vertices at which four faces meet -are found at (0, 0, +1) and (+sqrt(2)/2, +sqrt(2)/2, +are found at (0, 0, +1) and ( +sqrt(2)/2, +sqrt(2)/2, 0).
Changes From GLUT
GLUT does not include these functions. @@ -1024,13 +1251,13 @@ draw a wireframe and solid teapot respectively.
dSize The desired size of the teapot
Description -
The "glutWireTeapot" and "glutSolidTeapot" functions +
The "glutWireTeapot" and " glutSolidTeapot" functions render a teapot of the desired size, centered at the origin. This is the famous OpenGL teapot [add reference].
Changes From GLUT
None that we know of.
@@ -1112,5 +1339,11 @@ is the famous OpenGL teapot [add reference].
+
+
+
+
+
+