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 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
|
<!DOCTYPE refentry [ <!ENTITY % mathent SYSTEM "math.ent"> %mathent; ]>
<!-- Converted by db4-upgrade version 1.1 -->
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="glHint">
<info>
<copyright>
<year>1991-2006</year>
<holder>Silicon Graphics, Inc.</holder>
</copyright>
<copyright>
<year>2010-2014</year>
<holder>Khronos Group</holder>
</copyright>
</info>
<refmeta>
<refentrytitle>glHint</refentrytitle>
<manvolnum>3G</manvolnum>
</refmeta>
<refnamediv>
<refname>glHint</refname>
<refpurpose>specify implementation-specific hints</refpurpose>
</refnamediv>
<refsynopsisdiv><title>C Specification</title>
<funcsynopsis>
<funcprototype>
<funcdef>void <function>glHint</function></funcdef>
<paramdef>GLenum <parameter>target</parameter></paramdef>
<paramdef>GLenum <parameter>mode</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 xml:id="parameters"><title>Parameters</title>
<variablelist>
<varlistentry>
<term><parameter>target</parameter></term>
<listitem>
<para>
Specifies a symbolic constant indicating the behavior to be controlled.
<constant>GL_LINE_SMOOTH_HINT</constant>,
<constant>GL_POLYGON_SMOOTH_HINT</constant>,
<constant>GL_TEXTURE_COMPRESSION_HINT</constant>, and
<constant>GL_FRAGMENT_SHADER_DERIVATIVE_HINT</constant>
are accepted.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
<para>
Specifies a symbolic constant indicating the desired behavior.
<constant>GL_FASTEST</constant>,
<constant>GL_NICEST</constant>, and
<constant>GL_DONT_CARE</constant> are accepted.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 xml:id="description"><title>Description</title>
<para>
Certain aspects of GL behavior,
when there is room for interpretation,
can be controlled with hints.
A hint is specified with two arguments.
<parameter>target</parameter> is a symbolic
constant indicating the behavior to be controlled,
and <parameter>mode</parameter> is another symbolic constant indicating the desired
behavior. The initial value for each <parameter>target</parameter> is <constant>GL_DONT_CARE</constant>.
<parameter>mode</parameter> can be one of the following:
</para>
<variablelist>
<varlistentry>
<term><constant>GL_FASTEST</constant></term>
<listitem>
<para>
</para>
<para>
The most efficient option should be chosen.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GL_NICEST</constant></term>
<listitem>
<para>
</para>
<para>
The most correct,
or highest quality,
option should be chosen.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GL_DONT_CARE</constant></term>
<listitem>
<para>
</para>
<para>
No preference.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
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 <parameter>target</parameter>,
along with suggested semantics,
are as follows:
</para>
<variablelist>
<varlistentry>
<term><constant>GL_FRAGMENT_SHADER_DERIVATIVE_HINT</constant></term>
<listitem>
<para>
</para>
<para>
Indicates the accuracy of the derivative calculation for the GL shading language fragment processing built-in functions:
<constant>dFdx</constant>, <constant>dFdy</constant>, and <constant>fwidth</constant>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GL_LINE_SMOOTH_HINT</constant></term>
<listitem>
<para>
</para>
<para>
Indicates the sampling quality of antialiased lines.
If a larger filter function is applied, hinting <constant>GL_NICEST</constant> can
result in more pixel fragments being generated during rasterization.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GL_POLYGON_SMOOTH_HINT</constant></term>
<listitem>
<para>
</para>
<para>
Indicates the sampling quality of antialiased polygons.
Hinting <constant>GL_NICEST</constant> can result in more pixel fragments being generated
during rasterization,
if a larger filter function is applied.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><constant>GL_TEXTURE_COMPRESSION_HINT</constant></term>
<listitem>
<para>
</para>
<para>
Indicates the quality and performance of the compressing texture images.
Hinting <constant>GL_FASTEST</constant> indicates that texture images should be compressed
as quickly as possible, while <constant>GL_NICEST</constant> indicates that texture images
should be compressed with as little image quality loss as possible.
<constant>GL_NICEST</constant> should be selected if the texture is to be retrieved by
<citerefentry><refentrytitle>glGetCompressedTexImage</refentrytitle></citerefentry> for reuse.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 xml:id="notes"><title>Notes</title>
<para>
The interpretation of hints depends on the implementation.
Some implementations ignore <function>glHint</function> settings.
</para>
</refsect1>
<refsect1 xml:id="errors"><title>Errors</title>
<para>
<constant>GL_INVALID_ENUM</constant> is generated if either <parameter>target</parameter> or <parameter>mode</parameter> is not
an accepted value.
</para>
</refsect1>
<refsect1 xml:id="versions"><title>Version Support</title>
<informaltable>
<tgroup cols="13" align="left">
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apifunchead.xml" xpointer="xpointer(/*/*)"/>
<tbody>
<row>
<entry><function>glHint</function></entry>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apiversion.xml" xpointer="xpointer(/*/*[@role='20']/*)"/>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 xml:id="seealso"><title>See Also</title>
<!-- TBD -->
</refsect1>
<refsect1 xml:id="Copyright"><title>Copyright</title>
<para>
Copyright <trademark class="copyright"/> 1991-2006 Silicon Graphics, Inc.
Copyright <trademark class="copyright"/> 2010-2014 Khronos Group.
This document is licensed under the SGI Free Software B License.
For details, see
<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</link>.
</para>
</refsect1>
</refentry>
|