From 21cccdf7f36e75e4f365ce314fdbdd75ea54498a Mon Sep 17 00:00:00 2001 From: Jinrong Xie Date: Mon, 18 Jan 2016 15:42:44 -0800 Subject: [PATCH] Added API documentation for glutSpaceballXXX functions. --- freeglut/web-src/docs/api.php | 38 ++++++++++++++++++++++++++--------- 1 file changed, 28 insertions(+), 10 deletions(-) diff --git a/freeglut/web-src/docs/api.php b/freeglut/web-src/docs/api.php index 37d75e5..ffece5d 100644 --- a/freeglut/web-src/docs/api.php +++ b/freeglut/web-src/docs/api.php @@ -1326,46 +1326,53 @@ as mouse buttons.

The glutSpaceballMotionFunc function is implemented in -freeglut on X11 only. On other platforms, function stubs are +freeglut on X11 and Windows only. On other platforms, function stubs are provided so that GLUT-based programs can compile and link against freeglut without modification.

+

The glutSpaceballMotionFunc function sets the window's Spaceball motion callback. Freeglut invokes this callback when the user push/pull Spaceball cap in x, y, and z directions. +

Usage

-

void glutSpaceballMotionFunc ( void -(* callback)( int x, int y, int z ) );

+

void glutSpaceballMotionFunc ( void (* callback)( int x, int y, int z ) );

Description

-

TODO

+

The x, y, and z arguments indicate the amount of translation in integer along x, y, and z axis respectively.

+

The x, y, and z axes form a common OpenGL right-handed coordinate system. A positive value of x, y, or z indicates movement along the positive direction of the respective axis, while the negative one denotes movement along negative direction.

12.16 glutSpaceballRotateFunc

The glutSpaceballRotateFunc function is implemented in -freeglut on X11 only. On other platforms, function stubs are +freeglut on X11 and Windows only. On other platforms, function stubs are provided so that GLUT-based programs can compile and link against freeglut without modification.

+

The glutSpaceballRotateFunc function sets the window's Spaceball rotation callback. Freeglut invokes this callback when the user rotates/twists Spaceball cap. +

Usage

-

void glutSpaceballRotateFunc ( void -(* callback)( int x, int y, int z ) );

+

void glutSpaceballRotateFunc ( void (* callback)( int rx, int ry, int rz ) );

Description

-

TODO

+

The rx, ry, and rz arguments indicate the amount of rotation in integer with respect to x, y, and z axis respectively.

+

The x, y, and z axes form a common OpenGL right-handed coordinate system. Positive value of rx, ry, or rz indicates counter-clock wise rotation along the respective axis, while negative one denotes clock wise rotation.

12.17 glutSpaceballButtonFunc

The glutSpaceballButtonFunc function is implemented in -freeglut on X11 only. On other platforms, function stubs are +freeglut on X11 and Windows only. On other platforms, function stubs are provided so that GLUT-based programs can compile and link against freeglut without modification.

+

+The glutSpaceballButtonFunc function sets the window's Spaceball button callback. Freeglut invokes this callback when the user presses/releases one of the Spaceball buttons. +

Usage

@@ -1374,7 +1381,18 @@ provided so that GLUT-based programs can compile and link against

Description

-

TODO

+

The button argument may take one of the following defined constant values

+ +

The updown argument may take one of the two defined constant values

+

12.18 glutButtonBoxFunc