<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html
  PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0//EN" "http://www.w3.org/TR/MathML2/dtd/xhtml-math11-f.dtd">
<html
	xmlns="http://www.w3.org/1999/xhtml"
	xmlns:mml="http://www.w3.org/1998/Math/MathML"
><head><title>glutJoystickFunc</title><link rel="stylesheet" href="style.css" type="text/css"/><meta name="generator" content="DocBook XSL Stylesheets V1.59.1"/><link rel="home" href="index.xml" title="PyOpenGL 2.0.1.07 Man Pages"/><link rel="up" href="reference-GLUT.xml" title="GLUT"/><link rel="previous" href="glutInitWindowPosition.3GLUT.xml" title="glutInitWindowPosition"/><link rel="next" href="glutKeyboardFunc.3GLUT.xml" title="glutKeyboardFunc"/></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">glutJoystickFunc</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="glutInitWindowPosition.3GLUT.xml">Prev</a> </td><th width="60%" align="center">GLUT</th><td width="20%" align="right"> <a accesskey="n" href="glutKeyboardFunc.3GLUT.xml">Next</a></td></tr></table><hr/></div><div class="refentry" lang="en"><a name="glutJoystickFunc.3GLUT"/><div class="titlepage"/><div class="refnamediv"><a name="glutJoystickFunc.3GLUT-name"/><h2>Name</h2><p>glutJoystickFunc &#8212; sets the joystick callback for the current window.</p></div><div class="refsynopsisdiv"><a name="glutJoystickFunc.3GLUT-c_spec"/><h2>C Specification</h2><table class="funcprototype" border="0" cellpadding="0" cellspacing="0"><tr><td valign="top"><code>void <tt>glutJoystickFunc</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code>void (*<i><tt>func</tt></i>)(unsigned int buttonMask, int x, int y, int z), int <i><tt>pollInterval</tt></i>);</code></td></tr></table></div><div class="refsynopsisdiv"><a name="glutJoystickFunc.3GLUT-python_spec"/><h2>Python Specification</h2><table class="funcprototype" border="0" cellpadding="0" cellspacing="0"><tr><td valign="top"><code><tt>glutJoystickFunc</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code><i><tt>func</tt></i>, <i><tt>pollInterval</tt></i>) &#8594; <tt>None</tt></code></td></tr></table></div><div class="refsect1" lang="en"><a name="glutJoystickFunc.3GLUT-parameters"/><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><i><tt>func</tt></i></span></dt><dd>
						The new joystick callback function.
					</dd><dt><span class="term"><i><tt>pollInterval</tt></i></span></dt><dd>
						Joystick polling interval in milliseconds.
					</dd></dl></div></div><div class="refsect1" lang="en"><a name="glutJoystickFunc.3GLUT-description"/><h2>Description</h2><p>
			<tt>glutJoystickFunc</tt> sets the joystick callback for the current window.
		</p><p>
			The joystick callback is called either due to polling of the joystick at the uniform timer interval specified by
			<i><tt>pollInterval</tt></i> (in milliseconds) or in response to calling <a href="glutForceJoystickFunc.3GLUT.xml"><tt>glutForceJoystickFunc</tt></a>. If the <i><tt>pollInterval</tt></i> is non-positive, no
			joystick polling is performed and the GLUT application must frequently (usually from an idle callback) call <a href="glutForceJoystickFunc.3GLUT.xml"><tt>glutForceJoystickFunc</tt></a>.
		</p><p>
			The joystick buttons are reported by the callback's <i><tt>buttonMask</tt></i> parameter. The constants
			<tt>GLUT_JOYSTICK_BUTTON_A</tt> (0x1), <tt>GLUT_JOYSTICK_BUTTON_B</tt> (0x2),
			<tt>GLUT_JOYSTICK_BUTTON_C</tt> (0x4), and <tt>GLUT_JOYSTICK_BUTTON_D</tt> (0x8) are provided
			for programming convience.
		</p><p>
			The x, y, and z callback parameters report the X, Y, and Z axes of the joystick. The joystick is centered at (0,0,0).
			X, Y, and Z are scaled to range between -1000 and 1000. Moving the joystick left reports negative X; right reports
			positive X. Pulling the stick towards you reports negative Y; push the stick away from you reports positive Y. If the
			joystick has a third axis (rudder or up/down), down reports negative Z; up reports positive Z.
		</p><p>
			Passing a <tt>NULL</tt> func to <tt>glutJoystickFunc</tt> disables the generation of joystick
			callbacks. Without a joystick callback registered, <a href="glutForceJoystickFunc.3GLUT.xml"><tt>glutForceJoystickFunc</tt></a> does
			nothing.
		</p><p>
			When a new window is created, no joystick callback is initially registered.
		</p></div><div class="refsect1" lang="en"><a name="glutJoystickFunc.3GLUT-limitations"/><h2>Limitations</h2><p>
			The GLUT joystick callback only reports the first 3 axes and 32 buttons. GLUT supports only a single joystick.
		</p></div><div class="refsect1" lang="en"><a name="glutJoystickFunc.3GLUT-glut_implementation_notes_for_x11"/><h2>Glut Implementation Notes For X11</h2><p>
			The current implementation of GLUT for X11 supports the joystick API, but not joystick input. A future implementation
			of GLUT for X11 may add joystick support.
		</p></div><div class="refsect1" lang="en"><a name="glutJoystickFunc.3GLUT-glut_implementation_notes_for_win32"/><h2>Glut Implementation Notes For Win32</h2><p>
			The current implementation of GLUT for Win32 supports the joystick API and joystick input, but does so through the
			dated <tt>joySetCapture</tt> and <tt>joyGetPosEx</tt>
			Win32 Multimedia API. The current GLUT joystick support for Win32 has all the limitations of the Win32 Multimedia API
			joystick support. A future implementation of GLUT for Win32 may use DirectInput.
		</p></div><div class="refsect1" lang="en"><a name="glutJoystickFunc.3GLUT-glut_implementation_notes_for_non-analog_joysticks"/><h2>Glut Implementation Notes For Non-Analog Joysticks</h2><p>
			If the connected joystick does not return (x,y,z) as a continuous range (for example, an 8 position Atari 2600
			joystick), the implementation should report the most extreme (x,y,z) location. That is, if a 2D joystick is pushed to
			the upper left, report (-1000,1000,0).
		</p></div><div class="refsect1" lang="en"><a name="glutJoystickFunc.3GLUT-see_also"/><h2>See Also</h2><p>
			<span class="simplelist"><a href="glutForceJoystickFunc.3GLUT.xml">glutForceJoystickFunc</a>, <a href="glutMotionFunc.3GLUT.xml">glutMotionFunc</a>, <a href="glutMouseFunc.3GLUT.xml">glutMouseFunc</a>, <a href="glutSpaceballButtonFunc.3GLUT.xml">glutSpaceballButtonFunc</a>, <a href="glutSpaceballMotionFunc.3GLUT.xml">glutSpaceballMotionFunc</a>, <a href="glutButtonBoxFunc.3GLUT.xml">glutButtonBoxFunc</a>, <a href="glutTabletButtonFunc.3GLUT.xml">glutTabletButtonFunc</a>, <a href="glutDeviceGet.3GLUT.xml">glutDeviceGet</a></span>
		</p></div></div><div class="navfooter"><hr/><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="glutInitWindowPosition.3GLUT.xml">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="reference-GLUT.xml">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="glutKeyboardFunc.3GLUT.xml">Next</a></td></tr><tr><td width="40%" align="left" valign="top">glutInitWindowPosition </td><td width="20%" align="center"><a accesskey="h" href="index.xml">Home</a></td><td width="40%" align="right" valign="top"> glutKeyboardFunc</td></tr></table></div></body></html>