-
Notifications
You must be signed in to change notification settings - Fork 94
/
Copy pathglHint.xhtml
49 lines (49 loc) · 4.67 KB
/
glHint.xhtml
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
41
42
43
44
45
46
47
48
49
<div class="refentry"><a id="glHint"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glHint — specify implementation-specific hints</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table class="funcprototype-table" style="cellspacing: 0; cellpadding: 0;"><tr><td><code class="funcdef">void <strong class="fsfunc">glHint</strong>(</code></td><td>GLenum <var class="pdparam">target</var>, </td></tr><tr><td> </td><td>GLenum <var class="pdparam">mode</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>target</code></em></span></dt><dd><p>
Specifies a symbolic constant indicating the behavior to be controlled.
<code class="constant">GL_GENERATE_MIPMAP_HINT</code> is accepted.
</p></dd><dt><span class="term"><em class="parameter"><code>mode</code></em></span></dt><dd><p>
Specifies a symbolic constant indicating the desired behavior.
<code class="constant">GL_FASTEST</code>,
<code class="constant">GL_NICEST</code>, and
<code class="constant">GL_DONT_CARE</code> are accepted.
</p></dd></dl></div></div><div class="refsect1"><a id="description"></a><h2>Description</h2><p>
Certain aspects of GL behavior,
when there is room for interpretation,
can be controlled with hints.
A hint is specified with two arguments.
<em class="parameter"><code>target</code></em> is a symbolic
constant indicating the behavior to be controlled,
and <em class="parameter"><code>mode</code></em> is another symbolic constant indicating the desired
behavior. The initial value for each <em class="parameter"><code>target</code></em> is <code class="constant">GL_DONT_CARE</code>.
<em class="parameter"><code>mode</code></em> can be one of the following:
</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="constant">GL_FASTEST</code></span></dt><dd><p>
The most efficient option should be chosen.
</p></dd><dt><span class="term"><code class="constant">GL_NICEST</code></span></dt><dd><p>
The most correct,
or highest quality,
option should be chosen.
</p></dd><dt><span class="term"><code class="constant">GL_DONT_CARE</code></span></dt><dd><p>
No preference.
</p></dd></dl></div><p>
Though the implementation aspects that can be hinted are well defined,
the interpretation of the hints depends on the implementation.
The hint aspects that can be specified with <em class="parameter"><code>target</code></em>,
along with suggested semantics,
are as follows:
</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="constant">GL_GENERATE_MIPMAP_HINT</code></span></dt><dd><p>
Indicates the quality of filtering when generating mipmap images with
<a class="citerefentry" href="glGenerateMipmap"><span class="citerefentry"><span class="refentrytitle">glGenerateMipmap</span></span></a>.
</p></dd></dl></div></div><div class="refsect1"><a id="notes"></a><h2>Notes</h2><p>
The interpretation of hints depends on the implementation.
Some implementations ignore <code class="function">glHint</code> settings.
</p></div><div class="refsect1"><a id="errors"></a><h2>Errors</h2><p>
<code class="constant">GL_INVALID_ENUM</code> is generated if either <em class="parameter"><code>target</code></em> or <em class="parameter"><code>mode</code></em> is not
an accepted value.
</p></div>
{$pipelinestall}{$examples}
<div class="refsect1"><a id="seealso"></a><h2>See Also</h2><p><a class="citerefentry" href="glGenerateMipmap"><span class="citerefentry"><span class="refentrytitle">glGenerateMipmap</span></span></a></p></div><div class="refsect1"><div id="Copyright"><h2>Copyright</h2><p>
Copyright © 1991-2006
Silicon Graphics, Inc. This document is licensed under the SGI
Free Software B License. For details, see
<a class="ulink" href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>.
</p></div></div></div>