FMudanyali/FreeGLUT-Vita
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added API documentation for glutSpaceballXXX functions.

Browse Source 
(cherry picked from commit 21cccdf7f3)

(cherry picked from commit 21cccdf7f3)

git-svn-id: https://svn.code.sf.net/p/freeglut/code/trunk@1787 7f0cb862-5218-0410-a997-914c9d46530a
This commit is contained in:
dcnieho 2016-01-20 19:48:32 +00:00
parent 6dc4eb9dc2
commit 8503b82e20
1 changed files with 28 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
freeglut/web-src/docs/api.php
View File

@ -1326,46 +1326,53 @@ as mouse buttons.
<p> <p>
The <tt>glutSpaceballMotionFunc</tt> function is implemented in The <tt>glutSpaceballMotionFunc</tt> function is implemented in
<i>freeglut</i> on X11 only. On other platforms, function stubs are <i>freeglut</i> on X11 and Windows only. On other platforms, function stubs are
provided so that GLUT-based programs can compile and link against provided so that GLUT-based programs can compile and link against
<i>freeglut</i> without modification. <i>freeglut</i> without modification.
</p> </p>
<p>The <tt>glutSpaceballMotionFunc</tt> function sets the window's Spaceball motion callback. <i>Freeglut</i> invokes this callback when the user push/pull Spaceball cap in <i>x</i>, <i>y</i>, and <i>z</i> directions.
</p>
<p><b>Usage</b></p> <p><b>Usage</b></p>
<p><tt>void glutSpaceballMotionFunc ( void <p><tt>void glutSpaceballMotionFunc ( void (* callback)( int x, int y, int z ) );</tt></p>
(* callback)( int x, int y, int z )</tt><tt> );</tt></p>
<p><b>Description</b></p> <p><b>Description</b></p>
<p>TODO</p> <p>The <i>x</i>, <i>y</i>, and <i>z</i> arguments indicate the amount of translation in integer along x, y, and z axis respectively.</p>
<p>The x, y, and z axes form a common OpenGL right-handed coordinate system. A positive value of <i>x</i>, <i>y</i>, or <i>z</i> indicates movement along the positive direction of the respective axis, while the negative one denotes movement along negative direction.</p>
<h2>12.16 glutSpaceballRotateFunc</h2> <h2>12.16 glutSpaceballRotateFunc</h2>
<p> <p>
The <tt>glutSpaceballRotateFunc</tt> function is implemented in The <tt>glutSpaceballRotateFunc</tt> function is implemented in
<i>freeglut</i> on X11 only. On other platforms, function stubs are <i>freeglut</i> on X11 and Windows only. On other platforms, function stubs are
provided so that GLUT-based programs can compile and link against provided so that GLUT-based programs can compile and link against
<i>freeglut</i> without modification. <i>freeglut</i> without modification.
</p> </p>
<p>The <tt>glutSpaceballRotateFunc</tt> function sets the window's Spaceball rotation callback. <i>Freeglut</i> invokes this callback when the user rotates/twists Spaceball cap.
</p>
<p><b>Usage</b></p> <p><b>Usage</b></p>
<p><tt>void glutSpaceballRotateFunc ( void <p><tt>void glutSpaceballRotateFunc ( void (* callback)( int rx, int ry, int rz ) );</tt></p>
(* callback)( int x, int y, int z )</tt><tt> );</tt></p>
<p><b>Description</b></p> <p><b>Description</b></p>
<p>TODO</p> <p>The <i>rx</i>, <i>ry</i>, and <i>rz</i> arguments indicate the amount of rotation in integer with respect to x, y, and z axis respectively.</p>
<p>The x, y, and z axes form a common OpenGL right-handed coordinate system. Positive value of <i>rx</i>, <i>ry</i>, or <i>rz</i> indicates counter-clock wise rotation along the respective axis, while negative one denotes clock wise rotation.</p>
<h2>12.17 glutSpaceballButtonFunc</h2> <h2>12.17 glutSpaceballButtonFunc</h2>
<p> <p>
The <tt>glutSpaceballButtonFunc</tt> function is implemented in The <tt>glutSpaceballButtonFunc</tt> function is implemented in
<i>freeglut</i> on X11 only. On other platforms, function stubs are <i>freeglut</i> on X11 and Windows only. On other platforms, function stubs are
provided so that GLUT-based programs can compile and link against provided so that GLUT-based programs can compile and link against
<i>freeglut</i> without modification. <i>freeglut</i> without modification.
</p> </p>
<p>
The <tt>glutSpaceballButtonFunc</tt> function sets the window's Spaceball button callback. <i>Freeglut</i> invokes this callback when the user presses/releases one of the Spaceball buttons.
</p>
<p><b>Usage</b></p> <p><b>Usage</b></p>
@ -1374,7 +1381,18 @@ provided so that GLUT-based programs can compile and link against
<p><b>Description</b></p> <p><b>Description</b></p>
<p>TODO</p> <p>The <i>button</i> argument may take one of the following defined constant values</p>
<ul>
<li>
GLUT_SPACEBALL_BUTTON_A, GLUT_SPACEBALL_BUTTON_B,..., GLUT_SPACEBALL_BUTTON_E
</li>
</ul>
<p>The <i>updown</i> argument may take one of the two defined constant values</p>
<ul>
<li>
GLUT_DOWN, GLUT_UP indicating if button is pressed or released.
</li>
</ul>
<h2>12.18 glutButtonBoxFunc</h2> <h2>12.18 glutButtonBoxFunc</h2>