File: glutIgnoreKeyRepeat.3GLUT.xml

package info (click to toggle)
pyopengl 2.0.1.08-5.1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 19,484 kB
  • ctags: 9,036
  • sloc: pascal: 64,950; xml: 28,088; ansic: 20,696; python: 19,761; tcl: 668; makefile: 240; sh: 25
file content (26 lines) | stat: -rw-r--r-- 5,447 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
<?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>glutIgnoreKeyRepeat</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="glutIdleFunc.3GLUT.xml" title="glutIdleFunc"/><link rel="next" href="glutInit.3GLUT.xml" title="glutInit"/></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">glutIgnoreKeyRepeat</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="glutIdleFunc.3GLUT.xml">Prev</a></td><th width="60%" align="center">GLUT</th><td width="20%" align="right"><a accesskey="n" href="glutInit.3GLUT.xml">Next</a></td></tr></table><hr/></div><div class="refentry" lang="en"><a name="glutIgnoreKeyRepeat.3GLUT"/><div class="titlepage"/><div class="refnamediv"><a name="glutIgnoreKeyRepeat.3GLUT-name"/><h2>Name</h2><p>glutIgnoreKeyRepeat &#8212; determines if auto repeat keystrokes are reported to the current window</p></div><div class="refsynopsisdiv"><a name="glutIgnoreKeyRepeat.3GLUT-c_spec"/><h2>C Specification</h2><table class="funcprototype" border="0" cellpadding="0" cellspacing="0"><tr><td valign="top"><code>void<tt>glutIgnoreKeyRepeat</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code>int<i><tt>ignore</tt></i>);</code></td></tr></table></div><div class="refsynopsisdiv"><a name="glutIgnoreKeyRepeat.3GLUT-python_spec"/><h2>Python Specification</h2><table class="funcprototype" border="0" cellpadding="0" cellspacing="0"><tr><td valign="top"><code><tt>glutIgnoreKeyRepeat</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code><i><tt>ignore</tt></i>) &#8594;<tt>None</tt></code></td></tr></table></div><div class="refsect1" lang="en"><a name="glutIgnoreKeyRepeat.3GLUT-parameters"/><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><i><tt>ignore</tt></i></span></dt><dd>
						Non-zero indicates auto repeat keystrokes should not be reported by the keyboard and special callbacks;
						zero indicates that auto repeat keystrokes will be reported.
					</dd></dl></div></div><div class="refsect1" lang="en"><a name="glutIgnoreKeyRepeat.3GLUT-description"/><h2>Description</h2><p>
			<tt>glutIgnoreKeyRepeat</tt> determines if auto repeat keystrokes are reported to the current window. The
			ignore auto repeat state of a window can be queried with <tt>glutDeviceGet(GLUT_DEVICE_IGNORE_KEY_REPEAT)</tt>.
		</p><p>
			Ignoring auto repeated keystrokes is generally done in conjunction with using the <a href="glutKeyboardUpFunc.3GLUT.xml"><tt>glutKeyboardUpFunc</tt></a> and <a href="glutSpecialUpFunc.3GLUT.xml"><tt>glutSpecialUpFunc</tt></a>
			callbacks to repeat key releases. If you do not ignore auto repeated keystrokes, your GLUT application will experience
			repeated release/press callbacks. Games using the keyboard will typically want to ignore key repeat.
		</p></div><div class="refsect1" lang="en"><a name="glutIgnoreKeyRepeat.3GLUT-glut_implementation_notes_for_x11"/><h2>Glut Implementation Notes For X11</h2><p>
			X11 sends KeyPress events repeatedly when the window system's global auto repeat is enabled.
			<tt>glutIgnoreKeyRepeat</tt> can prevent these auto repeated keystrokes from being reported as keyboard or
			special callbacks, but there is still some minimal overhead by the X server to continually stream KeyPress events to
			the GLUT application. The <a href="glutSetKeyRepeat.3GLUT.xml"><tt>glutSetKeyRepeat</tt></a> routine can be used to actually
			disable the global sending of auto repeated KeyPress events. Note that <a href="glutSetKeyRepeat.3GLUT.xml"><tt>glutSetKeyRepeat</tt></a> affects the global window system auto repeat state so other
			applications will not auto repeat if you disable auto repeat globally through <a href="glutSetKeyRepeat.3GLUT.xml"><tt>glutSetKeyRepeat</tt></a>.
		</p></div><div class="refsect1" lang="en"><a name="glutIgnoreKeyRepeat.3GLUT-see_also"/><h2>See Also</h2><p>
			<span class="simplelist"><a href="glutSetKeyRepeat.3GLUT.xml">glutSetKeyRepeat</a>, <a href="glutDeviceGet.3GLUT.xml">glutDeviceGet</a>, <a href="glutKeyboardFunc.3GLUT.xml">glutKeyboardFunc</a>, <a href="glutKeyboardUpFunc.3GLUT.xml">glutKeyboardUpFunc</a>, <a href="glutSpecialFunc.3GLUT.xml">glutSpecialFunc</a>, <a href="glutSpecialUpFunc.3GLUT.xml">glutSpecialUpFunc</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="glutIdleFunc.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="glutInit.3GLUT.xml">Next</a></td></tr><tr><td width="40%" align="left" valign="top">glutIdleFunc</td><td width="20%" align="center"><a accesskey="h" href="index.xml">Home</a></td><td width="40%" align="right" valign="top">glutInit</td></tr></table></div></body></html>