File: glGetHistogramParameter.3G.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 (35 lines) | stat: -rw-r--r-- 7,103 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
 
<?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>glGetHistogramParameter</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-GL.xml" title="GL"/><link rel="previous" href="glGetHistogram.3G.xml" title="glGetHistogram"/><link rel="next" href="glGetLight.3G.xml" title="glGetLight"/></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">glGetHistogramParameter</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="glGetHistogram.3G.xml">Prev</a></td><th width="60%" align="center">GL</th><td width="20%" align="right"><a accesskey="n" href="glGetLight.3G.xml">Next</a></td></tr></table><hr/></div><div class="refentry" lang="en"><a name="glGetHistogramParameter.3G"/><div class="titlepage"/><div class="refnamediv"><a name="glGetHistogramParameter.3G-name"/><h2>Name</h2><p>glGetHistogramParameterfv, glGetHistogramParameteriv &#8212; get histogram parameters</p></div><div class="refsynopsisdiv"><a name="glGetHistogramParameter.3G-c_spec"/><h2>C Specification</h2><table class="funcprototype" border="0" cellpadding="0" cellspacing="0"><tr><td valign="top"><code>void<tt>glGetHistogramParameterfv</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code>GLenum<i><tt>target</tt></i>, GLenum<i><tt>pname</tt></i>, GLfloat*<i><tt>params</tt></i>);</code></td></tr><tr><td valign="top"><code>void<tt>glGetHistogramParameteriv</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code>GLenum<i><tt>target</tt></i>, GLenum<i><tt>pname</tt></i>, GLint*<i><tt>params</tt></i>);</code></td></tr></table></div><div class="refsynopsisdiv"><a name="glGetHistogramParameter.3G-python_spec"/><h2>Python Specification</h2><table class="funcprototype" border="0" cellpadding="0" cellspacing="0"><tr><td valign="top"><code><tt>glGetHistogramParameterfv</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code><i><tt>target</tt></i>, <i><tt>pname</tt></i>) &#8594;<i><tt>params</tt></i></code></td></tr><tr><td valign="top"><code><tt>glGetHistogramParameteriv</tt></code></td><td valign="top"><code>(</code></td><td valign="top"><code><i><tt>target</tt></i>, <i><tt>pname</tt></i>) &#8594;<i><tt>params</tt></i></code></td></tr></table></div><div class="refsect1" lang="en"><a name="glGetHistogramParameter.3G-parameters"/><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><i><tt>target</tt></i></span></dt><dd>
						Must be one of <tt>GL_HISTOGRAM</tt> or <tt>GL_PROXY_HISTOGRAM</tt>.
					</dd><dt><span class="term"><i><tt>pname</tt></i></span></dt><dd>
						The name of the parameter to be retrieved. Must be one of <tt>GL_HISTOGRAM_WIDTH</tt>,
						<tt>GL_HISTOGRAM_FORMAT</tt>, <tt>GL_HISTOGRAM_RED_SIZE</tt>,
						<tt>GL_HISTOGRAM_GREEN_SIZE</tt>, <tt>GL_HISTOGRAM_BLUE_SIZE</tt>,
						<tt>GL_HISTOGRAM_ALPHA_SIZE</tt>, <tt>GL_HISTOGRAM_LUMINANCE_SIZE</tt>, or
						<tt>GL_HISTOGRAM_SINK</tt>.
					</dd><dt><span class="term"><i><tt>params</tt></i></span></dt><dd>
						Pointer to storage for the returned values.
					</dd></dl></div></div><div class="refsect1" lang="en"><a name="glGetHistogramParameter.3G-description"/><h2>Description</h2><p>
			<tt>glGetHistogramParameter</tt> is used to query parameter values for the current
			histogram or for a proxy. The histogram state information may be queried by calling <tt>glGetHistogramParameter</tt> with a <i><tt>target</tt></i> of
			<tt>GL_HISTOGRAM</tt> (to obtain information for the current histogram table) or
			<tt>GL_PROXY_HISTOGRAM</tt> (to obtain information from the most recent proxy request) and one of the
			following values for the <i><tt>pname</tt></i> argument:
		</p><div class="informaltable"><table border="1"><colgroup><col/><col/></colgroup><tbody><tr><td><span class="bold"><b>Parameter</b></span></td><td><span class="bold"><b>Description</b></span></td></tr><tr><td><tt>GL_HISTOGRAM_WIDTH</tt></td><td>Histogram table width</td></tr><tr><td><tt>GL_HISTOGRAM_FORMAT</tt></td><td>Internal</td></tr><tr><td><tt>GL_HISTOGRAM_RED_SIZE</tt></td><td>Red component counter size, in bits</td></tr><tr><td><tt>GL_HISTOGRAM_GREEN_SIZE</tt></td><td>Green component counter size, in bits</td></tr></tbody></table></div><div class="informaltable"><table border="1"><colgroup><col/><col/></colgroup><tbody><tr><td><span class="bold"><b>Parameter</b></span></td><td><span class="bold"><b>Description</b></span></td></tr><tr><td><tt>GL_HISTOGRAM_BLUE_SIZE</tt></td><td>Blue component counter size, in bits</td></tr><tr><td><tt>GL_HISTOGRAM_ALPHA_SIZE</tt></td><td>Alpha component counter size, in bits</td></tr><tr><td><tt>GL_HISTOGRAM_LUMINANCE_SIZE</tt></td><td>Luminance component counter size, in bits</td></tr><tr><td><tt>GL_HISTOGRAM_SINK</tt></td><td>Value of the <i><tt>sink</tt></i> parameter</td></tr></tbody></table></div></div><div class="refsect1" lang="en"><a name="glGetHistogramParameter.3G-notes"/><h2>Notes</h2><p>
			<tt>glGetHistogramParameter</tt> is present only if <tt>GL_ARB_imaging</tt>
			is returned when <a href="glGetString.3G.xml"><tt>glGetString</tt></a> is called with an argument of
			<tt>GL_EXTENSIONS</tt>.
		</p></div><div class="refsect1" lang="en"><a name="glGetHistogramParameter.3G-errors"/><h2>Errors</h2><p>
			<tt>GL_INVALID_ENUM</tt> is generated if <i><tt>target</tt></i> is not one of the allowable values.
		</p><p>
			<tt>GL_INVALID_ENUM</tt> is generated if <i><tt>pname</tt></i> is not one of the allowable values.
		</p><p>
			<tt>GL_INVALID_OPERATION</tt> is generated if <tt>glGetHistogramParameter</tt> is executed between the execution of <a href="glBegin.3G.xml"><tt>glBegin</tt></a> and the corresponding execution of <a href="glBegin.3G.xml"><tt>glEnd</tt></a>.
		</p></div><div class="refsect1" lang="en"><a name="glGetHistogramParameter.3G-see_also"/><h2>See Also</h2><p>
			<span class="simplelist"><a href="glGetHistogram.3G.xml">glGetHistogram</a>, <a href="glHistogram.3G.xml">glHistogram</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="glGetHistogram.3G.xml">Prev</a></td><td width="20%" align="center"><a accesskey="u" href="reference-GL.xml">Up</a></td><td width="40%" align="right"><a accesskey="n" href="glGetLight.3G.xml">Next</a></td></tr><tr><td width="40%" align="left" valign="top">glGetHistogram</td><td width="20%" align="center"><a accesskey="h" href="index.xml">Home</a></td><td width="40%" align="right" valign="top">glGetLight</td></tr></table></div></body></html>