File: glutWindowStatusFunc.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 (40 lines) | stat: -rw-r--r-- 5,728 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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
<?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>glutWindowStatusFunc</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="glutWarpPointer.3GLUT.xml" title="glutWarpPointer"/><link rel="next" href="reference-GLE.xml" title="GLE"/></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">glutWindowStatusFunc</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="glutWarpPointer.3GLUT.xml">Prev</a></td><th width="60%" align="center">GLUT</th><td width="20%" align="right"><a accesskey="n" href="reference-GLE.xml">Next</a></td></tr></table><hr/></div><div class="refentry" lang="en"><a name="glutWindowStatusFunc.3GLUT"/><div class="titlepage"/><div class="refnamediv"><a name="glutWindowStatusFunc.3GLUT-name"/><h2>Name</h2><p>glutWindowStatusFunc &#8212; sets the window status callback for the current window.</p></div><div class="refsynopsisdiv"><a name="glutWindowStatusFunc.3GLUT-c_spec"/><h2>C Specification</h2><table class="funcprototype" border="0" cellpadding="0" cellspacing="0"><tr><td valign="top"><code>void<tt>glutWindowStatusFunc</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code>void(*<i><tt>func</tt></i>)(intstate));</code></td></tr></table></div><div class="refsynopsisdiv"><a name="glutWindowStatusFunc.3GLUT-python_spec"/><h2>Python Specification</h2><table class="funcprototype" border="0" cellpadding="0" cellspacing="0"><tr><td valign="top"><code><tt>glutWindowStatusFunc</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code><i><tt>func</tt></i>) &#8594;<tt>None</tt></code></td></tr></table></div><div class="refsect1" lang="en"><a name="glutWindowStatusFunc.3GLUT-parameters"/><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><i><tt>func</tt></i></span></dt><dd>
						The new window status callback function.
					</dd></dl></div></div><div class="refsect1" lang="en"><a name="glutWindowStatusFunc.3GLUT-description"/><h2>Description</h2><p>
			<tt>glutWindowStatusFunc</tt> sets the window status callback for the current window. The window status
			callback for a window is called when the window status (visibility) of a window changes. The
			<i><tt>state</tt></i> callback parameter is one of <tt>GLUT_HIDDEN</tt>,
			<tt>GLUT_FULLY_RETAINED</tt>, <tt>GLUT_PARTIALLY_RETAINED</tt>, or
			<tt>GLUT_FULLY_COVERED</tt> depending on the current window status of the window.
			<tt>GLUT_HIDDEN</tt> means that the window is either not shown (often meaning that the window is
			iconified). <tt>GLUT_FULLY_RETAINED</tt> means that the window is fully retained (no pixels belonging to
			the window are covered by other windows). <tt>GLUT_PARTIALLY_RETAINED</tt> means that the window is
			partially retained (some but not all pixels belonging to the window are covered by other windows).
			<tt>GLUT_FULLY_COVERED</tt> means the window is shown but no part of the window is visible, i.e., until the
			window's status changes, all further rendering to the window is discarded.
		</p><p>
			GLUT considers a window visible if any pixel of the window is visible or any pixel of any descendant window is visible
			on the screen.
		</p><p>
			GLUT applications are encouraged to disable rendering and/or animation when windows have a status of either
			<tt>GLUT_HIDDEN</tt> or <tt>GLUT_FULLY_COVERED</tt>.
		</p><p>
			Passing <tt>NULL</tt> to <tt>glutWindowStatusFunc</tt> disables the generation of the window
			status callback.
		</p><p>
			If the window status callback for a window is disabled and later re-enabled, the window status of the window is
			undefined; any change in window window status will be reported, that is if you disable a window status callback and
			re-enable the callback, you are guaranteed the next window status change will be reported.
		</p><p>
			Setting the window status callback for a window disables the visibility callback set for the window (and vice versa).
			The visibility callback is set with <a href="glutVisibilityFunc.3GLUT.xml"><tt>glutVisibilityFunc</tt></a>. <a href="glutVisibilityFunc.3GLUT.xml"><tt>glutVisibilityFunc</tt></a> is deprecated in favor of the more informative
			<tt>glutWindowStatusFunc</tt>.
		</p></div><div class="refsect1" lang="en"><a name="glutWindowStatusFunc.3GLUT-see_also"/><h2>See Also</h2><p>
			<span class="simplelist"><a href="glutCreateWindow.3GLUT.xml">glutCreateWindow</a>, <a href="glutPopWindow.3GLUT.xml">glutPopWindow</a>, <a href="glutVisibilityFunc.3GLUT.xml">glutVisibilityFunc</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="glutWarpPointer.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="reference-GLE.xml">Next</a></td></tr><tr><td width="40%" align="left" valign="top">glutWarpPointer</td><td width="20%" align="center"><a accesskey="h" href="index.xml">Home</a></td><td width="40%" align="right" valign="top">GLE</td></tr></table></div></body></html>