| 1 | <?xml version="1.0" encoding="UTF-8"?> |
| 2 | <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN" |
| 3 | "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd"> |
| 4 | <refentry id="glPixelTransfer"> |
| 5 | <refmeta> |
| 6 | <refmetainfo> |
| 7 | <copyright> |
| 8 | <year>1991-2006</year> |
| 9 | <holder>Silicon Graphics, Inc.</holder> |
| 10 | </copyright> |
| 11 | </refmetainfo> |
| 12 | <refentrytitle>glPixelTransfer</refentrytitle> |
| 13 | <manvolnum>3G</manvolnum> |
| 14 | </refmeta> |
| 15 | <refnamediv> |
| 16 | <refname>glPixelTransfer</refname> |
| 17 | <refpurpose>set pixel transfer modes</refpurpose> |
| 18 | </refnamediv> |
| 19 | <refsynopsisdiv><title>C Specification</title> |
| 20 | <funcsynopsis> |
| 21 | <funcprototype> |
| 22 | <funcdef>void <function>glPixelTransferf</function></funcdef> |
| 23 | <paramdef>GLenum <parameter>pname</parameter></paramdef> |
| 24 | <paramdef>GLfloat <parameter>param</parameter></paramdef> |
| 25 | </funcprototype> |
| 26 | </funcsynopsis> |
| 27 | <funcsynopsis> |
| 28 | <funcprototype> |
| 29 | <funcdef>void <function>glPixelTransferi</function></funcdef> |
| 30 | <paramdef>GLenum <parameter>pname</parameter></paramdef> |
| 31 | <paramdef>GLint <parameter>param</parameter></paramdef> |
| 32 | </funcprototype> |
| 33 | </funcsynopsis> |
| 34 | </refsynopsisdiv> |
| 35 | <!-- eqn: ignoring delim $$ --> |
| 36 | <refsect1 id="parameters"><title>Parameters</title> |
| 37 | <variablelist> |
| 38 | <varlistentry> |
| 39 | <term><parameter>pname</parameter></term> |
| 40 | <listitem> |
| 41 | <para> |
| 42 | Specifies the symbolic name of the pixel transfer parameter to be set. |
| 43 | Must be one of the following: |
| 44 | <constant>GL_MAP_COLOR</constant>, |
| 45 | <constant>GL_MAP_STENCIL</constant>, |
| 46 | <constant>GL_INDEX_SHIFT</constant>, |
| 47 | <constant>GL_INDEX_OFFSET</constant>, |
| 48 | <constant>GL_RED_SCALE</constant>, |
| 49 | <constant>GL_RED_BIAS</constant>, |
| 50 | <constant>GL_GREEN_SCALE</constant>, |
| 51 | <constant>GL_GREEN_BIAS</constant>, |
| 52 | <constant>GL_BLUE_SCALE</constant>, |
| 53 | <constant>GL_BLUE_BIAS</constant>, |
| 54 | <constant>GL_ALPHA_SCALE</constant>, |
| 55 | <constant>GL_ALPHA_BIAS</constant>, |
| 56 | <constant>GL_DEPTH_SCALE</constant>, or |
| 57 | <constant>GL_DEPTH_BIAS</constant>. |
| 58 | </para> |
| 59 | <para> |
| 60 | Additionally, if the <code>ARB_imaging</code> extension is supported, the |
| 61 | following symbolic names are accepted: |
| 62 | <constant>GL_POST_COLOR_MATRIX_RED_SCALE</constant>, |
| 63 | <constant>GL_POST_COLOR_MATRIX_GREEN_SCALE</constant>, |
| 64 | <constant>GL_POST_COLOR_MATRIX_BLUE_SCALE</constant>, |
| 65 | <constant>GL_POST_COLOR_MATRIX_ALPHA_SCALE</constant>, |
| 66 | <constant>GL_POST_COLOR_MATRIX_RED_BIAS</constant>, |
| 67 | <constant>GL_POST_COLOR_MATRIX_GREEN_BIAS</constant>, |
| 68 | <constant>GL_POST_COLOR_MATRIX_BLUE_BIAS</constant>, |
| 69 | <constant>GL_POST_COLOR_MATRIX_ALPHA_BIAS</constant>, |
| 70 | <constant>GL_POST_CONVOLUTION_RED_SCALE</constant>, |
| 71 | <constant>GL_POST_CONVOLUTION_GREEN_SCALE</constant>, |
| 72 | <constant>GL_POST_CONVOLUTION_BLUE_SCALE</constant>, |
| 73 | <constant>GL_POST_CONVOLUTION_ALPHA_SCALE</constant>, |
| 74 | <constant>GL_POST_CONVOLUTION_RED_BIAS</constant>, |
| 75 | <constant>GL_POST_CONVOLUTION_GREEN_BIAS</constant>, |
| 76 | <constant>GL_POST_CONVOLUTION_BLUE_BIAS</constant>, and |
| 77 | <constant>GL_POST_CONVOLUTION_ALPHA_BIAS</constant>. |
| 78 | </para> |
| 79 | </listitem> |
| 80 | </varlistentry> |
| 81 | <varlistentry> |
| 82 | <term><parameter>param</parameter></term> |
| 83 | <listitem> |
| 84 | <para> |
| 85 | Specifies the value that <parameter>pname</parameter> is set to. |
| 86 | </para> |
| 87 | </listitem> |
| 88 | </varlistentry> |
| 89 | </variablelist> |
| 90 | </refsect1> |
| 91 | <refsect1 id="description"><title>Description</title> |
| 92 | <para> |
| 93 | <function>glPixelTransfer</function> sets pixel transfer modes that affect the operation of subsequent |
| 94 | <citerefentry><refentrytitle>glCopyPixels</refentrytitle></citerefentry>, |
| 95 | <citerefentry><refentrytitle>glCopyTexImage1D</refentrytitle></citerefentry>, |
| 96 | <citerefentry><refentrytitle>glCopyTexImage2D</refentrytitle></citerefentry>, |
| 97 | <citerefentry><refentrytitle>glCopyTexSubImage1D</refentrytitle></citerefentry>, |
| 98 | <citerefentry><refentrytitle>glCopyTexSubImage2D</refentrytitle></citerefentry>, |
| 99 | <citerefentry><refentrytitle>glCopyTexSubImage3D</refentrytitle></citerefentry>, |
| 100 | <citerefentry><refentrytitle>glDrawPixels</refentrytitle></citerefentry>, |
| 101 | <citerefentry><refentrytitle>glReadPixels</refentrytitle></citerefentry>, |
| 102 | <citerefentry><refentrytitle>glTexImage1D</refentrytitle></citerefentry>, |
| 103 | <citerefentry><refentrytitle>glTexImage2D</refentrytitle></citerefentry>, |
| 104 | <citerefentry><refentrytitle>glTexImage3D</refentrytitle></citerefentry>, |
| 105 | <citerefentry><refentrytitle>glTexSubImage1D</refentrytitle></citerefentry>, |
| 106 | <citerefentry><refentrytitle>glTexSubImage2D</refentrytitle></citerefentry>, and |
| 107 | <citerefentry><refentrytitle>glTexSubImage3D</refentrytitle></citerefentry> commands. |
| 108 | Additionally, if the <code>ARB_imaging</code> subset is supported, the |
| 109 | routines |
| 110 | <citerefentry><refentrytitle>glColorTable</refentrytitle></citerefentry>, |
| 111 | <citerefentry><refentrytitle>glColorSubTable</refentrytitle></citerefentry>, |
| 112 | <citerefentry><refentrytitle>glConvolutionFilter1D</refentrytitle></citerefentry>, |
| 113 | <citerefentry><refentrytitle>glConvolutionFilter2D</refentrytitle></citerefentry>, |
| 114 | <citerefentry><refentrytitle>glHistogram</refentrytitle></citerefentry>, |
| 115 | <citerefentry><refentrytitle>glMinmax</refentrytitle></citerefentry>, and |
| 116 | <citerefentry><refentrytitle>glSeparableFilter2D</refentrytitle></citerefentry> are also affected. |
| 117 | The algorithms that are specified by pixel transfer modes operate on |
| 118 | pixels after they are read from the frame buffer |
| 119 | (<citerefentry><refentrytitle>glCopyPixels</refentrytitle></citerefentry> |
| 120 | <citerefentry><refentrytitle>glCopyTexImage1D</refentrytitle></citerefentry>, |
| 121 | <citerefentry><refentrytitle>glCopyTexImage2D</refentrytitle></citerefentry>, |
| 122 | <citerefentry><refentrytitle>glCopyTexSubImage1D</refentrytitle></citerefentry>, |
| 123 | <citerefentry><refentrytitle>glCopyTexSubImage2D</refentrytitle></citerefentry>, |
| 124 | <citerefentry><refentrytitle>glCopyTexSubImage3D</refentrytitle></citerefentry>, and |
| 125 | <citerefentry><refentrytitle>glReadPixels</refentrytitle></citerefentry>), |
| 126 | or unpacked from client memory |
| 127 | (<citerefentry><refentrytitle>glDrawPixels</refentrytitle></citerefentry>, <citerefentry><refentrytitle>glTexImage1D</refentrytitle></citerefentry>, <citerefentry><refentrytitle>glTexImage2D</refentrytitle></citerefentry>, <citerefentry><refentrytitle>glTexImage3D</refentrytitle></citerefentry>, |
| 128 | <citerefentry><refentrytitle>glTexSubImage1D</refentrytitle></citerefentry>, <citerefentry><refentrytitle>glTexSubImage2D</refentrytitle></citerefentry>, and <citerefentry><refentrytitle>glTexSubImage3D</refentrytitle></citerefentry>). |
| 129 | Pixel transfer operations happen in the same order, |
| 130 | and in the same manner, |
| 131 | regardless of the command that resulted in the pixel operation. |
| 132 | Pixel storage modes |
| 133 | (see <citerefentry><refentrytitle>glPixelStore</refentrytitle></citerefentry>) |
| 134 | control the unpacking of pixels being read from client memory |
| 135 | and the packing of pixels being written back into client memory. |
| 136 | </para> |
| 137 | <para> |
| 138 | Pixel transfer operations handle four fundamental pixel types: |
| 139 | <emphasis>color</emphasis>, |
| 140 | <emphasis>color index</emphasis>, |
| 141 | <emphasis>depth</emphasis>, and |
| 142 | <emphasis>stencil</emphasis>. |
| 143 | <emphasis>Color</emphasis> pixels consist of four floating-point values |
| 144 | with unspecified mantissa and exponent sizes, |
| 145 | scaled such that 0 represents zero intensity |
| 146 | and 1 represents full intensity. |
| 147 | <emphasis>Color indices</emphasis> comprise a single fixed-point value, |
| 148 | with unspecified precision to the right of the binary point. |
| 149 | <emphasis>Depth</emphasis> pixels comprise a single floating-point value, |
| 150 | with unspecified mantissa and exponent sizes, |
| 151 | scaled such that 0.0 represents the minimum depth buffer value, |
| 152 | and 1.0 represents the maximum depth buffer value. |
| 153 | Finally, |
| 154 | <emphasis>stencil</emphasis> pixels comprise a single fixed-point value, |
| 155 | with unspecified precision to the right of the binary point. |
| 156 | </para> |
| 157 | <para> |
| 158 | The pixel transfer operations performed on the four basic pixel types are |
| 159 | as follows: |
| 160 | </para> |
| 161 | <variablelist> |
| 162 | <varlistentry> |
| 163 | <term><emphasis>Color</emphasis></term> |
| 164 | <listitem> |
| 165 | <para> |
| 166 | Each of the four color components is multiplied by a scale factor, |
| 167 | then added to a bias factor. |
| 168 | That is, |
| 169 | the red component is multiplied by <constant>GL_RED_SCALE</constant>, |
| 170 | then added to <constant>GL_RED_BIAS</constant>; |
| 171 | the green component is multiplied by <constant>GL_GREEN_SCALE</constant>, |
| 172 | then added to <constant>GL_GREEN_BIAS</constant>; |
| 173 | the blue component is multiplied by <constant>GL_BLUE_SCALE</constant>, |
| 174 | then added to <constant>GL_BLUE_BIAS</constant>; and |
| 175 | the alpha component is multiplied by <constant>GL_ALPHA_SCALE</constant>, |
| 176 | then added to <constant>GL_ALPHA_BIAS</constant>. |
| 177 | After all four color components are scaled and biased, |
| 178 | each is clamped to the range |
| 179 | <inlineequation><mml:math> |
| 180 | <!-- eqn: [0,1]:--> |
| 181 | <mml:mfenced open="[" close="]"> |
| 182 | <mml:mn>0</mml:mn> |
| 183 | <mml:mn>1</mml:mn> |
| 184 | </mml:mfenced> |
| 185 | </mml:math></inlineequation>. |
| 186 | All color, scale, and bias values are specified with <function>glPixelTransfer</function>. |
| 187 | </para> |
| 188 | <para> |
| 189 | If <constant>GL_MAP_COLOR</constant> is true, |
| 190 | each color component is scaled by the size of the corresponding |
| 191 | color-to-color map, |
| 192 | then replaced by the contents of that map indexed by the scaled component. |
| 193 | That is, |
| 194 | the red component is scaled by <constant>GL_PIXEL_MAP_R_TO_R_SIZE</constant>, |
| 195 | then replaced by the contents of <constant>GL_PIXEL_MAP_R_TO_R</constant> indexed by itself. |
| 196 | The green component is scaled by <constant>GL_PIXEL_MAP_G_TO_G_SIZE</constant>, |
| 197 | then replaced by the contents of <constant>GL_PIXEL_MAP_G_TO_G</constant> indexed by itself. |
| 198 | The blue component is scaled by <constant>GL_PIXEL_MAP_B_TO_B_SIZE</constant>, |
| 199 | then replaced by the contents of <constant>GL_PIXEL_MAP_B_TO_B</constant> indexed by itself. |
| 200 | And |
| 201 | the alpha component is scaled by <constant>GL_PIXEL_MAP_A_TO_A_SIZE</constant>, |
| 202 | then replaced by the contents of <constant>GL_PIXEL_MAP_A_TO_A</constant> indexed by itself. |
| 203 | All components taken from the maps are then clamped to the range |
| 204 | <inlineequation><mml:math> |
| 205 | <!-- eqn: [0,1]:--> |
| 206 | <mml:mfenced open="[" close="]"> |
| 207 | <mml:mn>0</mml:mn> |
| 208 | <mml:mn>1</mml:mn> |
| 209 | </mml:mfenced> |
| 210 | </mml:math></inlineequation>. |
| 211 | <constant>GL_MAP_COLOR</constant> is specified with <function>glPixelTransfer</function>. |
| 212 | The contents of the various maps are specified with <citerefentry><refentrytitle>glPixelMap</refentrytitle></citerefentry>. |
| 213 | </para> |
| 214 | <para> |
| 215 | If the <code>ARB_imaging</code> extension is supported, each of the four |
| 216 | color components may be scaled and biased after transformation by the |
| 217 | color matrix. |
| 218 | That is, |
| 219 | the red component is multiplied by <constant>GL_POST_COLOR_MATRIX_RED_SCALE</constant>, |
| 220 | then added to <constant>GL_POST_COLOR_MATRIX_RED_BIAS</constant>; |
| 221 | the green component is multiplied by <constant>GL_POST_COLOR_MATRIX_GREEN_SCALE</constant>, |
| 222 | then added to <constant>GL_POST_COLOR_MATRIX_GREEN_BIAS</constant>; |
| 223 | the blue component is multiplied by <constant>GL_POST_COLOR_MATRIX_BLUE_SCALE</constant>, |
| 224 | then added to <constant>GL_POST_COLOR_MATRIX_BLUE_BIAS</constant>; and |
| 225 | the alpha component is multiplied by <constant>GL_POST_COLOR_MATRIX_ALPHA_SCALE</constant>, |
| 226 | then added to <constant>GL_POST_COLOR_MATRIX_ALPHA_BIAS</constant>. |
| 227 | After all four color components are scaled and biased, |
| 228 | each is clamped to the range |
| 229 | <inlineequation><mml:math> |
| 230 | <!-- eqn: [0,1]:--> |
| 231 | <mml:mfenced open="[" close="]"> |
| 232 | <mml:mn>0</mml:mn> |
| 233 | <mml:mn>1</mml:mn> |
| 234 | </mml:mfenced> |
| 235 | </mml:math></inlineequation>. |
| 236 | </para> |
| 237 | <para> |
| 238 | Similarly, if the <code>ARB_imaging</code> extension is supported, each of |
| 239 | the four color components may be scaled and biased after processing by |
| 240 | the enabled convolution filter. |
| 241 | That is, |
| 242 | the red component is multiplied by <constant>GL_POST_CONVOLUTION_RED_SCALE</constant>, |
| 243 | then added to <constant>GL_POST_CONVOLUTION_RED_BIAS</constant>; |
| 244 | the green component is multiplied by <constant>GL_POST_CONVOLUTION_GREEN_SCALE</constant>, |
| 245 | then added to <constant>GL_POST_CONVOLUTION_GREEN_BIAS</constant>; |
| 246 | the blue component is multiplied by <constant>GL_POST_CONVOLUTION_BLUE_SCALE</constant>, |
| 247 | then added to <constant>GL_POST_CONVOLUTION_BLUE_BIAS</constant>; and |
| 248 | the alpha component is multiplied by <constant>GL_POST_CONVOLUTION_ALPHA_SCALE</constant>, |
| 249 | then added to <constant>GL_POST_CONVOLUTION_ALPHA_BIAS</constant>. |
| 250 | After all four color components are scaled and biased, |
| 251 | each is clamped to the range |
| 252 | <inlineequation><mml:math> |
| 253 | <!-- eqn: [0,1]:--> |
| 254 | <mml:mfenced open="[" close="]"> |
| 255 | <mml:mn>0</mml:mn> |
| 256 | <mml:mn>1</mml:mn> |
| 257 | </mml:mfenced> |
| 258 | </mml:math></inlineequation>. |
| 259 | </para> |
| 260 | </listitem> |
| 261 | </varlistentry> |
| 262 | <varlistentry> |
| 263 | <term><emphasis>Color index</emphasis></term> |
| 264 | <listitem> |
| 265 | <para> |
| 266 | Each color index is shifted left by <constant>GL_INDEX_SHIFT</constant> bits; any bits |
| 267 | beyond the number of fraction bits carried |
| 268 | by the fixed-point index are filled with zeros. |
| 269 | If <constant>GL_INDEX_SHIFT</constant> is negative, |
| 270 | the shift is to the right, |
| 271 | again zero filled. |
| 272 | Then <constant>GL_INDEX_OFFSET</constant> is added to the index. |
| 273 | <constant>GL_INDEX_SHIFT</constant> and <constant>GL_INDEX_OFFSET</constant> are specified with |
| 274 | <function>glPixelTransfer</function>. |
| 275 | </para> |
| 276 | <para> |
| 277 | From this point, operation diverges depending on the required format of |
| 278 | the resulting pixels. |
| 279 | If the resulting pixels are to be written to a color index buffer, |
| 280 | or if they are being read back to client memory in <constant>GL_COLOR_INDEX</constant> format, |
| 281 | the pixels continue to be treated as indices. |
| 282 | If <constant>GL_MAP_COLOR</constant> is true, |
| 283 | each index is masked by |
| 284 | <inlineequation><mml:math> |
| 285 | <!-- eqn: 2 sup n - 1:--> |
| 286 | <mml:mrow> |
| 287 | <mml:msup><mml:mn>2</mml:mn> |
| 288 | <mml:mi mathvariant="italic">n</mml:mi> |
| 289 | </mml:msup> |
| 290 | <mml:mo>-</mml:mo> |
| 291 | <mml:mn>1</mml:mn> |
| 292 | </mml:mrow> |
| 293 | </mml:math></inlineequation>, |
| 294 | where |
| 295 | <inlineequation><mml:math><mml:mi mathvariant="italic">n</mml:mi></mml:math></inlineequation> |
| 296 | is <constant>GL_PIXEL_MAP_I_TO_I_SIZE</constant>, |
| 297 | then replaced by the contents of <constant>GL_PIXEL_MAP_I_TO_I</constant> indexed by the |
| 298 | masked value. |
| 299 | <constant>GL_MAP_COLOR</constant> is specified with <function>glPixelTransfer</function>. |
| 300 | The contents of the index map is specified with <citerefentry><refentrytitle>glPixelMap</refentrytitle></citerefentry>. |
| 301 | </para> |
| 302 | <para> |
| 303 | If the resulting pixels are to be written to an RGBA color buffer, |
| 304 | or if they are read back to client memory in a format other than |
| 305 | <constant>GL_COLOR_INDEX</constant>, |
| 306 | the pixels are converted from indices to colors by referencing the |
| 307 | four maps |
| 308 | <constant>GL_PIXEL_MAP_I_TO_R</constant>, |
| 309 | <constant>GL_PIXEL_MAP_I_TO_G</constant>, |
| 310 | <constant>GL_PIXEL_MAP_I_TO_B</constant>, and |
| 311 | <constant>GL_PIXEL_MAP_I_TO_A</constant>. |
| 312 | Before being dereferenced, |
| 313 | the index is masked by |
| 314 | <inlineequation><mml:math> |
| 315 | <!-- eqn: 2 sup n - 1:--> |
| 316 | <mml:mrow> |
| 317 | <mml:msup><mml:mn>2</mml:mn> |
| 318 | <mml:mi mathvariant="italic">n</mml:mi> |
| 319 | </mml:msup> |
| 320 | <mml:mo>-</mml:mo> |
| 321 | <mml:mn>1</mml:mn> |
| 322 | </mml:mrow> |
| 323 | </mml:math></inlineequation>, |
| 324 | where |
| 325 | <inlineequation><mml:math><mml:mi mathvariant="italic">n</mml:mi></mml:math></inlineequation> |
| 326 | is |
| 327 | <constant>GL_PIXEL_MAP_I_TO_R_SIZE</constant> for the red map, |
| 328 | <constant>GL_PIXEL_MAP_I_TO_G_SIZE</constant> for the green map, |
| 329 | <constant>GL_PIXEL_MAP_I_TO_B_SIZE</constant> for the blue map, and |
| 330 | <constant>GL_PIXEL_MAP_I_TO_A_SIZE</constant> for the alpha map. |
| 331 | All components taken from the maps are then clamped to the range |
| 332 | <inlineequation><mml:math> |
| 333 | <!-- eqn: [0,1]:--> |
| 334 | <mml:mfenced open="[" close="]"> |
| 335 | <mml:mn>0</mml:mn> |
| 336 | <mml:mn>1</mml:mn> |
| 337 | </mml:mfenced> |
| 338 | </mml:math></inlineequation>. |
| 339 | The contents of the four maps is specified with <citerefentry><refentrytitle>glPixelMap</refentrytitle></citerefentry>. |
| 340 | </para> |
| 341 | </listitem> |
| 342 | </varlistentry> |
| 343 | <varlistentry> |
| 344 | <term><emphasis>Depth</emphasis></term> |
| 345 | <listitem> |
| 346 | <para> |
| 347 | Each depth value is multiplied by <constant>GL_DEPTH_SCALE</constant>, |
| 348 | added to <constant>GL_DEPTH_BIAS</constant>, |
| 349 | then clamped to the range |
| 350 | <inlineequation><mml:math> |
| 351 | <!-- eqn: [0,1]:--> |
| 352 | <mml:mfenced open="[" close="]"> |
| 353 | <mml:mn>0</mml:mn> |
| 354 | <mml:mn>1</mml:mn> |
| 355 | </mml:mfenced> |
| 356 | </mml:math></inlineequation>. |
| 357 | </para> |
| 358 | </listitem> |
| 359 | </varlistentry> |
| 360 | <varlistentry> |
| 361 | <term><emphasis>Stencil</emphasis></term> |
| 362 | <listitem> |
| 363 | <para> |
| 364 | Each index is shifted <constant>GL_INDEX_SHIFT</constant> bits just as a color index is, |
| 365 | then added to <constant>GL_INDEX_OFFSET</constant>. |
| 366 | If <constant>GL_MAP_STENCIL</constant> is true, |
| 367 | each index is masked by |
| 368 | <inlineequation><mml:math> |
| 369 | <!-- eqn: 2 sup n - 1:--> |
| 370 | <mml:mrow> |
| 371 | <mml:msup><mml:mn>2</mml:mn> |
| 372 | <mml:mi mathvariant="italic">n</mml:mi> |
| 373 | </mml:msup> |
| 374 | <mml:mo>-</mml:mo> |
| 375 | <mml:mn>1</mml:mn> |
| 376 | </mml:mrow> |
| 377 | </mml:math></inlineequation>, |
| 378 | where |
| 379 | <inlineequation><mml:math><mml:mi mathvariant="italic">n</mml:mi></mml:math></inlineequation> |
| 380 | is <constant>GL_PIXEL_MAP_S_TO_S_SIZE</constant>, |
| 381 | then replaced by the contents of <constant>GL_PIXEL_MAP_S_TO_S</constant> indexed by the |
| 382 | masked value. |
| 383 | </para> |
| 384 | </listitem> |
| 385 | </varlistentry> |
| 386 | </variablelist> |
| 387 | <para> |
| 388 | The following table gives the type, |
| 389 | initial value, |
| 390 | and range of valid values for each of the pixel transfer parameters |
| 391 | that are set with <function>glPixelTransfer</function>. |
| 392 | </para> |
| 393 | <para> |
| 394 | </para> |
| 395 | <informaltable frame="topbot"> |
| 396 | <tgroup cols="4" align="left"> |
| 397 | <colspec colwidth="4*" /> |
| 398 | <colspec colwidth="1*" align="center"/> |
| 399 | <colspec colwidth="1*" align="center"/> |
| 400 | <colspec colwidth="2*" align="center"/> |
| 401 | <thead> |
| 402 | <row> |
| 403 | <entry rowsep="1" align="left"><emphasis role="bold"> |
| 404 | <parameter>pname</parameter> |
| 405 | </emphasis></entry> |
| 406 | <entry rowsep="1" align="center"><emphasis role="bold"> |
| 407 | Type |
| 408 | </emphasis></entry> |
| 409 | <entry rowsep="1" align="center"><emphasis role="bold"> |
| 410 | Initial Value |
| 411 | </emphasis></entry> |
| 412 | <entry rowsep="1" align="center"><emphasis role="bold"> |
| 413 | Valid Range |
| 414 | </emphasis></entry> |
| 415 | </row> |
| 416 | </thead> |
| 417 | <tbody> |
| 418 | <row> |
| 419 | <entry align="left"> |
| 420 | <constant>GL_MAP_COLOR</constant> |
| 421 | </entry> |
| 422 | <entry align="center"> |
| 423 | boolean |
| 424 | </entry> |
| 425 | <entry align="center"> |
| 426 | false |
| 427 | </entry> |
| 428 | <entry align="center"> |
| 429 | true/false |
| 430 | </entry> |
| 431 | </row> |
| 432 | <row> |
| 433 | <entry align="left"> |
| 434 | <constant>GL_MAP_STENCIL</constant> |
| 435 | </entry> |
| 436 | <entry align="center"> |
| 437 | boolean |
| 438 | </entry> |
| 439 | <entry align="center"> |
| 440 | false |
| 441 | </entry> |
| 442 | <entry align="center"> |
| 443 | true/false |
| 444 | </entry> |
| 445 | </row> |
| 446 | <row> |
| 447 | <entry align="left"> |
| 448 | <constant>GL_INDEX_SHIFT</constant> |
| 449 | </entry> |
| 450 | <entry align="center"> |
| 451 | integer |
| 452 | </entry> |
| 453 | <entry align="center"> |
| 454 | 0 |
| 455 | </entry> |
| 456 | <entry align="center"> |
| 457 | <inlineequation><mml:math> |
| 458 | <!-- eqn: left ( -\(if, \(if right ):--> |
| 459 | <mml:mfenced open="(" close=")"> |
| 460 | <mml:mrow> |
| 461 | <mml:mo>-</mml:mo> |
| 462 | <mml:infinity/> |
| 463 | </mml:mrow> |
| 464 | <mml:infinity/> |
| 465 | </mml:mfenced> |
| 466 | </mml:math></inlineequation> |
| 467 | </entry> |
| 468 | </row> |
| 469 | <row> |
| 470 | <entry align="left"> |
| 471 | <constant>GL_INDEX_OFFSET</constant> |
| 472 | </entry> |
| 473 | <entry align="center"> |
| 474 | integer |
| 475 | </entry> |
| 476 | <entry align="center"> |
| 477 | 0 |
| 478 | </entry> |
| 479 | <entry align="center"> |
| 480 | <inlineequation><mml:math> |
| 481 | <!-- eqn: left ( -\(if, \(if right ):--> |
| 482 | <mml:mfenced open="(" close=")"> |
| 483 | <mml:mrow> |
| 484 | <mml:mo>-</mml:mo> |
| 485 | <mml:infinity/> |
| 486 | </mml:mrow> |
| 487 | <mml:infinity/> |
| 488 | </mml:mfenced> |
| 489 | </mml:math></inlineequation> |
| 490 | </entry> |
| 491 | </row> |
| 492 | <row> |
| 493 | <entry align="left"> |
| 494 | <constant>GL_RED_SCALE</constant> |
| 495 | </entry> |
| 496 | <entry align="center"> |
| 497 | float |
| 498 | </entry> |
| 499 | <entry align="center"> |
| 500 | 1 |
| 501 | </entry> |
| 502 | <entry align="center"> |
| 503 | <inlineequation><mml:math> |
| 504 | <!-- eqn: left ( -\(if, \(if right ):--> |
| 505 | <mml:mfenced open="(" close=")"> |
| 506 | <mml:mrow> |
| 507 | <mml:mo>-</mml:mo> |
| 508 | <mml:infinity/> |
| 509 | </mml:mrow> |
| 510 | <mml:infinity/> |
| 511 | </mml:mfenced> |
| 512 | </mml:math></inlineequation> |
| 513 | </entry> |
| 514 | </row> |
| 515 | <row> |
| 516 | <entry align="left"> |
| 517 | <constant>GL_GREEN_SCALE</constant> |
| 518 | </entry> |
| 519 | <entry align="center"> |
| 520 | float |
| 521 | </entry> |
| 522 | <entry align="center"> |
| 523 | 1 |
| 524 | </entry> |
| 525 | <entry align="center"> |
| 526 | <inlineequation><mml:math> |
| 527 | <!-- eqn: left ( -\(if, \(if right ):--> |
| 528 | <mml:mfenced open="(" close=")"> |
| 529 | <mml:mrow> |
| 530 | <mml:mo>-</mml:mo> |
| 531 | <mml:infinity/> |
| 532 | </mml:mrow> |
| 533 | <mml:infinity/> |
| 534 | </mml:mfenced> |
| 535 | </mml:math></inlineequation> |
| 536 | </entry> |
| 537 | </row> |
| 538 | <row> |
| 539 | <entry align="left"> |
| 540 | <constant>GL_BLUE_SCALE</constant> |
| 541 | </entry> |
| 542 | <entry align="center"> |
| 543 | float |
| 544 | </entry> |
| 545 | <entry align="center"> |
| 546 | 1 |
| 547 | </entry> |
| 548 | <entry align="center"> |
| 549 | <inlineequation><mml:math> |
| 550 | <!-- eqn: left ( -\(if, \(if right ):--> |
| 551 | <mml:mfenced open="(" close=")"> |
| 552 | <mml:mrow> |
| 553 | <mml:mo>-</mml:mo> |
| 554 | <mml:infinity/> |
| 555 | </mml:mrow> |
| 556 | <mml:infinity/> |
| 557 | </mml:mfenced> |
| 558 | </mml:math></inlineequation> |
| 559 | </entry> |
| 560 | </row> |
| 561 | <row> |
| 562 | <entry align="left"> |
| 563 | <constant>GL_ALPHA_SCALE</constant> |
| 564 | </entry> |
| 565 | <entry align="center"> |
| 566 | float |
| 567 | </entry> |
| 568 | <entry align="center"> |
| 569 | 1 |
| 570 | </entry> |
| 571 | <entry align="center"> |
| 572 | <inlineequation><mml:math> |
| 573 | <!-- eqn: left ( -\(if, \(if right ):--> |
| 574 | <mml:mfenced open="(" close=")"> |
| 575 | <mml:mrow> |
| 576 | <mml:mo>-</mml:mo> |
| 577 | <mml:infinity/> |
| 578 | </mml:mrow> |
| 579 | <mml:infinity/> |
| 580 | </mml:mfenced> |
| 581 | </mml:math></inlineequation> |
| 582 | </entry> |
| 583 | </row> |
| 584 | <row> |
| 585 | <entry align="left"> |
| 586 | <constant>GL_DEPTH_SCALE</constant> |
| 587 | </entry> |
| 588 | <entry align="center"> |
| 589 | float |
| 590 | </entry> |
| 591 | <entry align="center"> |
| 592 | 1 |
| 593 | </entry> |
| 594 | <entry align="center"> |
| 595 | <inlineequation><mml:math> |
| 596 | <!-- eqn: left ( -\(if, \(if right ):--> |
| 597 | <mml:mfenced open="(" close=")"> |
| 598 | <mml:mrow> |
| 599 | <mml:mo>-</mml:mo> |
| 600 | <mml:infinity/> |
| 601 | </mml:mrow> |
| 602 | <mml:infinity/> |
| 603 | </mml:mfenced> |
| 604 | </mml:math></inlineequation> |
| 605 | </entry> |
| 606 | </row> |
| 607 | <row> |
| 608 | <entry align="left"> |
| 609 | <constant>GL_RED_BIAS</constant> |
| 610 | </entry> |
| 611 | <entry align="center"> |
| 612 | float |
| 613 | </entry> |
| 614 | <entry align="center"> |
| 615 | 0 |
| 616 | </entry> |
| 617 | <entry align="center"> |
| 618 | <inlineequation><mml:math> |
| 619 | <!-- eqn: left ( -\(if, \(if right ):--> |
| 620 | <mml:mfenced open="(" close=")"> |
| 621 | <mml:mrow> |
| 622 | <mml:mo>-</mml:mo> |
| 623 | <mml:infinity/> |
| 624 | </mml:mrow> |
| 625 | <mml:infinity/> |
| 626 | </mml:mfenced> |
| 627 | </mml:math></inlineequation> |
| 628 | </entry> |
| 629 | </row> |
| 630 | <row> |
| 631 | <entry align="left"> |
| 632 | <constant>GL_GREEN_BIAS</constant> |
| 633 | </entry> |
| 634 | <entry align="center"> |
| 635 | float |
| 636 | </entry> |
| 637 | <entry align="center"> |
| 638 | 0 |
| 639 | </entry> |
| 640 | <entry align="center"> |
| 641 | <inlineequation><mml:math> |
| 642 | <!-- eqn: left ( -\(if, \(if right ):--> |
| 643 | <mml:mfenced open="(" close=")"> |
| 644 | <mml:mrow> |
| 645 | <mml:mo>-</mml:mo> |
| 646 | <mml:infinity/> |
| 647 | </mml:mrow> |
| 648 | <mml:infinity/> |
| 649 | </mml:mfenced> |
| 650 | </mml:math></inlineequation> |
| 651 | </entry> |
| 652 | </row> |
| 653 | <row> |
| 654 | <entry align="left"> |
| 655 | <constant>GL_BLUE_BIAS</constant> |
| 656 | </entry> |
| 657 | <entry align="center"> |
| 658 | float |
| 659 | </entry> |
| 660 | <entry align="center"> |
| 661 | 0 |
| 662 | </entry> |
| 663 | <entry align="center"> |
| 664 | <inlineequation><mml:math> |
| 665 | <!-- eqn: left ( -\(if, \(if right ):--> |
| 666 | <mml:mfenced open="(" close=")"> |
| 667 | <mml:mrow> |
| 668 | <mml:mo>-</mml:mo> |
| 669 | <mml:infinity/> |
| 670 | </mml:mrow> |
| 671 | <mml:infinity/> |
| 672 | </mml:mfenced> |
| 673 | </mml:math></inlineequation> |
| 674 | </entry> |
| 675 | </row> |
| 676 | <row> |
| 677 | <entry align="left"> |
| 678 | <constant>GL_ALPHA_BIAS</constant> |
| 679 | </entry> |
| 680 | <entry align="center"> |
| 681 | float |
| 682 | </entry> |
| 683 | <entry align="center"> |
| 684 | 0 |
| 685 | </entry> |
| 686 | <entry align="center"> |
| 687 | <inlineequation><mml:math> |
| 688 | <!-- eqn: left ( -\(if, \(if right ):--> |
| 689 | <mml:mfenced open="(" close=")"> |
| 690 | <mml:mrow> |
| 691 | <mml:mo>-</mml:mo> |
| 692 | <mml:infinity/> |
| 693 | </mml:mrow> |
| 694 | <mml:infinity/> |
| 695 | </mml:mfenced> |
| 696 | </mml:math></inlineequation> |
| 697 | </entry> |
| 698 | </row> |
| 699 | <row> |
| 700 | <entry align="left"> |
| 701 | <constant>GL_DEPTH_BIAS</constant> |
| 702 | </entry> |
| 703 | <entry align="center"> |
| 704 | float |
| 705 | </entry> |
| 706 | <entry align="center"> |
| 707 | 0 |
| 708 | </entry> |
| 709 | <entry align="center"> |
| 710 | <inlineequation><mml:math> |
| 711 | <!-- eqn: left ( -\(if, \(if right ):--> |
| 712 | <mml:mfenced open="(" close=")"> |
| 713 | <mml:mrow> |
| 714 | <mml:mo>-</mml:mo> |
| 715 | <mml:infinity/> |
| 716 | </mml:mrow> |
| 717 | <mml:infinity/> |
| 718 | </mml:mfenced> |
| 719 | </mml:math></inlineequation> |
| 720 | </entry> |
| 721 | </row> |
| 722 | <row> |
| 723 | <entry align="left"> |
| 724 | <constant>GL_POST_COLOR_MATRIX_RED_SCALE</constant> |
| 725 | </entry> |
| 726 | <entry align="center"> |
| 727 | float |
| 728 | </entry> |
| 729 | <entry align="center"> |
| 730 | 1 |
| 731 | </entry> |
| 732 | <entry align="center"> |
| 733 | <inlineequation><mml:math> |
| 734 | <!-- eqn: left ( -\(if, \(if right ):--> |
| 735 | <mml:mfenced open="(" close=")"> |
| 736 | <mml:mrow> |
| 737 | <mml:mo>-</mml:mo> |
| 738 | <mml:infinity/> |
| 739 | </mml:mrow> |
| 740 | <mml:infinity/> |
| 741 | </mml:mfenced> |
| 742 | </mml:math></inlineequation> |
| 743 | </entry> |
| 744 | </row> |
| 745 | <row> |
| 746 | <entry align="left"> |
| 747 | <constant>GL_POST_COLOR_MATRIX_GREEN_SCALE</constant> |
| 748 | </entry> |
| 749 | <entry align="center"> |
| 750 | float |
| 751 | </entry> |
| 752 | <entry align="center"> |
| 753 | 1 |
| 754 | </entry> |
| 755 | <entry align="center"> |
| 756 | <inlineequation><mml:math> |
| 757 | <!-- eqn: left ( -\(if, \(if right ):--> |
| 758 | <mml:mfenced open="(" close=")"> |
| 759 | <mml:mrow> |
| 760 | <mml:mo>-</mml:mo> |
| 761 | <mml:infinity/> |
| 762 | </mml:mrow> |
| 763 | <mml:infinity/> |
| 764 | </mml:mfenced> |
| 765 | </mml:math></inlineequation> |
| 766 | </entry> |
| 767 | </row> |
| 768 | <row> |
| 769 | <entry align="left"> |
| 770 | <constant>GL_POST_COLOR_MATRIX_BLUE_SCALE</constant> |
| 771 | </entry> |
| 772 | <entry align="center"> |
| 773 | float |
| 774 | </entry> |
| 775 | <entry align="center"> |
| 776 | 1 |
| 777 | </entry> |
| 778 | <entry align="center"> |
| 779 | <inlineequation><mml:math> |
| 780 | <!-- eqn: left ( -\(if, \(if right ):--> |
| 781 | <mml:mfenced open="(" close=")"> |
| 782 | <mml:mrow> |
| 783 | <mml:mo>-</mml:mo> |
| 784 | <mml:infinity/> |
| 785 | </mml:mrow> |
| 786 | <mml:infinity/> |
| 787 | </mml:mfenced> |
| 788 | </mml:math></inlineequation> |
| 789 | </entry> |
| 790 | </row> |
| 791 | <row> |
| 792 | <entry align="left"> |
| 793 | <constant>GL_POST_COLOR_MATRIX_ALPHA_SCALE</constant> |
| 794 | </entry> |
| 795 | <entry align="center"> |
| 796 | float |
| 797 | </entry> |
| 798 | <entry align="center"> |
| 799 | 1 |
| 800 | </entry> |
| 801 | <entry align="center"> |
| 802 | <inlineequation><mml:math> |
| 803 | <!-- eqn: left ( -\(if, \(if right ):--> |
| 804 | <mml:mfenced open="(" close=")"> |
| 805 | <mml:mrow> |
| 806 | <mml:mo>-</mml:mo> |
| 807 | <mml:infinity/> |
| 808 | </mml:mrow> |
| 809 | <mml:infinity/> |
| 810 | </mml:mfenced> |
| 811 | </mml:math></inlineequation> |
| 812 | </entry> |
| 813 | </row> |
| 814 | <row> |
| 815 | <entry align="left"> |
| 816 | <constant>GL_POST_COLOR_MATRIX_RED_BIAS</constant> |
| 817 | </entry> |
| 818 | <entry align="center"> |
| 819 | float |
| 820 | </entry> |
| 821 | <entry align="center"> |
| 822 | 0 |
| 823 | </entry> |
| 824 | <entry align="center"> |
| 825 | <inlineequation><mml:math> |
| 826 | <!-- eqn: left ( -\(if, \(if right ):--> |
| 827 | <mml:mfenced open="(" close=")"> |
| 828 | <mml:mrow> |
| 829 | <mml:mo>-</mml:mo> |
| 830 | <mml:infinity/> |
| 831 | </mml:mrow> |
| 832 | <mml:infinity/> |
| 833 | </mml:mfenced> |
| 834 | </mml:math></inlineequation> |
| 835 | </entry> |
| 836 | </row> |
| 837 | <row> |
| 838 | <entry align="left"> |
| 839 | <constant>GL_POST_COLOR_MATRIX_GREEN_BIAS</constant> |
| 840 | </entry> |
| 841 | <entry align="center"> |
| 842 | float |
| 843 | </entry> |
| 844 | <entry align="center"> |
| 845 | 0 |
| 846 | </entry> |
| 847 | <entry align="center"> |
| 848 | <inlineequation><mml:math> |
| 849 | <!-- eqn: left ( -\(if, \(if right ):--> |
| 850 | <mml:mfenced open="(" close=")"> |
| 851 | <mml:mrow> |
| 852 | <mml:mo>-</mml:mo> |
| 853 | <mml:infinity/> |
| 854 | </mml:mrow> |
| 855 | <mml:infinity/> |
| 856 | </mml:mfenced> |
| 857 | </mml:math></inlineequation> |
| 858 | </entry> |
| 859 | </row> |
| 860 | <row> |
| 861 | <entry align="left"> |
| 862 | <constant>GL_POST_COLOR_MATRIX_BLUE_BIAS</constant> |
| 863 | </entry> |
| 864 | <entry align="center"> |
| 865 | float |
| 866 | </entry> |
| 867 | <entry align="center"> |
| 868 | 0 |
| 869 | </entry> |
| 870 | <entry align="center"> |
| 871 | <inlineequation><mml:math> |
| 872 | <!-- eqn: left ( -\(if, \(if right ):--> |
| 873 | <mml:mfenced open="(" close=")"> |
| 874 | <mml:mrow> |
| 875 | <mml:mo>-</mml:mo> |
| 876 | <mml:infinity/> |
| 877 | </mml:mrow> |
| 878 | <mml:infinity/> |
| 879 | </mml:mfenced> |
| 880 | </mml:math></inlineequation> |
| 881 | </entry> |
| 882 | </row> |
| 883 | <row> |
| 884 | <entry align="left"> |
| 885 | <constant>GL_POST_COLOR_MATRIX_ALPHA_BIAS</constant> |
| 886 | </entry> |
| 887 | <entry align="center"> |
| 888 | float |
| 889 | </entry> |
| 890 | <entry align="center"> |
| 891 | 0 |
| 892 | </entry> |
| 893 | <entry align="center"> |
| 894 | <inlineequation><mml:math> |
| 895 | <!-- eqn: left ( -\(if, \(if right ):--> |
| 896 | <mml:mfenced open="(" close=")"> |
| 897 | <mml:mrow> |
| 898 | <mml:mo>-</mml:mo> |
| 899 | <mml:infinity/> |
| 900 | </mml:mrow> |
| 901 | <mml:infinity/> |
| 902 | </mml:mfenced> |
| 903 | </mml:math></inlineequation> |
| 904 | </entry> |
| 905 | </row> |
| 906 | <row> |
| 907 | <entry align="left"> |
| 908 | <constant>GL_POST_CONVOLUTION_RED_SCALE</constant> |
| 909 | </entry> |
| 910 | <entry align="center"> |
| 911 | float |
| 912 | </entry> |
| 913 | <entry align="center"> |
| 914 | 1 |
| 915 | </entry> |
| 916 | <entry align="center"> |
| 917 | <inlineequation><mml:math> |
| 918 | <!-- eqn: left ( -\(if, \(if right ):--> |
| 919 | <mml:mfenced open="(" close=")"> |
| 920 | <mml:mrow> |
| 921 | <mml:mo>-</mml:mo> |
| 922 | <mml:infinity/> |
| 923 | </mml:mrow> |
| 924 | <mml:infinity/> |
| 925 | </mml:mfenced> |
| 926 | </mml:math></inlineequation> |
| 927 | </entry> |
| 928 | </row> |
| 929 | <row> |
| 930 | <entry align="left"> |
| 931 | <constant>GL_POST_CONVOLUTION_GREEN_SCALE</constant> |
| 932 | </entry> |
| 933 | <entry align="center"> |
| 934 | float |
| 935 | </entry> |
| 936 | <entry align="center"> |
| 937 | 1 |
| 938 | </entry> |
| 939 | <entry align="center"> |
| 940 | <inlineequation><mml:math> |
| 941 | <!-- eqn: left ( -\(if, \(if right ):--> |
| 942 | <mml:mfenced open="(" close=")"> |
| 943 | <mml:mrow> |
| 944 | <mml:mo>-</mml:mo> |
| 945 | <mml:infinity/> |
| 946 | </mml:mrow> |
| 947 | <mml:infinity/> |
| 948 | </mml:mfenced> |
| 949 | </mml:math></inlineequation> |
| 950 | </entry> |
| 951 | </row> |
| 952 | <row> |
| 953 | <entry align="left"> |
| 954 | <constant>GL_POST_CONVOLUTION_BLUE_SCALE</constant> |
| 955 | </entry> |
| 956 | <entry align="center"> |
| 957 | float |
| 958 | </entry> |
| 959 | <entry align="center"> |
| 960 | 1 |
| 961 | </entry> |
| 962 | <entry align="center"> |
| 963 | <inlineequation><mml:math> |
| 964 | <!-- eqn: left ( -\(if, \(if right ):--> |
| 965 | <mml:mfenced open="(" close=")"> |
| 966 | <mml:mrow> |
| 967 | <mml:mo>-</mml:mo> |
| 968 | <mml:infinity/> |
| 969 | </mml:mrow> |
| 970 | <mml:infinity/> |
| 971 | </mml:mfenced> |
| 972 | </mml:math></inlineequation> |
| 973 | </entry> |
| 974 | </row> |
| 975 | <row> |
| 976 | <entry align="left"> |
| 977 | <constant>GL_POST_CONVOLUTION_ALPHA_SCALE</constant> |
| 978 | </entry> |
| 979 | <entry align="center"> |
| 980 | float |
| 981 | </entry> |
| 982 | <entry align="center"> |
| 983 | 1 |
| 984 | </entry> |
| 985 | <entry align="center"> |
| 986 | <inlineequation><mml:math> |
| 987 | <!-- eqn: left ( -\(if, \(if right ):--> |
| 988 | <mml:mfenced open="(" close=")"> |
| 989 | <mml:mrow> |
| 990 | <mml:mo>-</mml:mo> |
| 991 | <mml:infinity/> |
| 992 | </mml:mrow> |
| 993 | <mml:infinity/> |
| 994 | </mml:mfenced> |
| 995 | </mml:math></inlineequation> |
| 996 | </entry> |
| 997 | </row> |
| 998 | <row> |
| 999 | <entry align="left"> |
| 1000 | <constant>GL_POST_CONVOLUTION_RED_BIAS</constant> |
| 1001 | </entry> |
| 1002 | <entry align="center"> |
| 1003 | float |
| 1004 | </entry> |
| 1005 | <entry align="center"> |
| 1006 | 0 |
| 1007 | </entry> |
| 1008 | <entry align="center"> |
| 1009 | <inlineequation><mml:math> |
| 1010 | <!-- eqn: left ( -\(if, \(if right ):--> |
| 1011 | <mml:mfenced open="(" close=")"> |
| 1012 | <mml:mrow> |
| 1013 | <mml:mo>-</mml:mo> |
| 1014 | <mml:infinity/> |
| 1015 | </mml:mrow> |
| 1016 | <mml:infinity/> |
| 1017 | </mml:mfenced> |
| 1018 | </mml:math></inlineequation> |
| 1019 | </entry> |
| 1020 | </row> |
| 1021 | <row> |
| 1022 | <entry align="left"> |
| 1023 | <constant>GL_POST_CONVOLUTION_GREEN_BIAS</constant> |
| 1024 | </entry> |
| 1025 | <entry align="center"> |
| 1026 | float |
| 1027 | </entry> |
| 1028 | <entry align="center"> |
| 1029 | 0 |
| 1030 | </entry> |
| 1031 | <entry align="center"> |
| 1032 | <inlineequation><mml:math> |
| 1033 | <!-- eqn: left ( -\(if, \(if right ):--> |
| 1034 | <mml:mfenced open="(" close=")"> |
| 1035 | <mml:mrow> |
| 1036 | <mml:mo>-</mml:mo> |
| 1037 | <mml:infinity/> |
| 1038 | </mml:mrow> |
| 1039 | <mml:infinity/> |
| 1040 | </mml:mfenced> |
| 1041 | </mml:math></inlineequation> |
| 1042 | </entry> |
| 1043 | </row> |
| 1044 | <row> |
| 1045 | <entry align="left"> |
| 1046 | <constant>GL_POST_CONVOLUTION_BLUE_BIAS</constant> |
| 1047 | </entry> |
| 1048 | <entry align="center"> |
| 1049 | float |
| 1050 | </entry> |
| 1051 | <entry align="center"> |
| 1052 | 0 |
| 1053 | </entry> |
| 1054 | <entry align="center"> |
| 1055 | <inlineequation><mml:math> |
| 1056 | <!-- eqn: left ( -\(if, \(if right ):--> |
| 1057 | <mml:mfenced open="(" close=")"> |
| 1058 | <mml:mrow> |
| 1059 | <mml:mo>-</mml:mo> |
| 1060 | <mml:infinity/> |
| 1061 | </mml:mrow> |
| 1062 | <mml:infinity/> |
| 1063 | </mml:mfenced> |
| 1064 | </mml:math></inlineequation> |
| 1065 | </entry> |
| 1066 | </row> |
| 1067 | <row> |
| 1068 | <entry align="left"> |
| 1069 | <constant>GL_POST_CONVOLUTION_ALPHA_BIAS</constant> |
| 1070 | </entry> |
| 1071 | <entry align="center"> |
| 1072 | float |
| 1073 | </entry> |
| 1074 | <entry align="center"> |
| 1075 | 0 |
| 1076 | </entry> |
| 1077 | <entry align="center"> |
| 1078 | <inlineequation><mml:math> |
| 1079 | <!-- eqn: left ( -\(if, \(if right ):--> |
| 1080 | <mml:mfenced open="(" close=")"> |
| 1081 | <mml:mrow> |
| 1082 | <mml:mo>-</mml:mo> |
| 1083 | <mml:infinity/> |
| 1084 | </mml:mrow> |
| 1085 | <mml:infinity/> |
| 1086 | </mml:mfenced> |
| 1087 | </mml:math></inlineequation> |
| 1088 | </entry> |
| 1089 | </row> |
| 1090 | </tbody> |
| 1091 | </tgroup> |
| 1092 | </informaltable> |
| 1093 | <para> |
| 1094 | <function>glPixelTransferf</function> can be used to set any pixel transfer parameter. |
| 1095 | If the parameter type is boolean, |
| 1096 | 0 implies false and any other value implies true. |
| 1097 | If <parameter>pname</parameter> is an integer parameter, |
| 1098 | <parameter>param</parameter> is rounded to the nearest integer. |
| 1099 | </para> |
| 1100 | <para> |
| 1101 | Likewise, |
| 1102 | <function>glPixelTransferi</function> can be used to set any of the |
| 1103 | pixel transfer parameters. |
| 1104 | Boolean parameters are set to false if <parameter>param</parameter> is 0 and to true otherwise. |
| 1105 | <parameter>param</parameter> is converted to floating point before being assigned to real-valued parameters. |
| 1106 | </para> |
| 1107 | </refsect1> |
| 1108 | <refsect1 id="notes"><title>Notes</title> |
| 1109 | <para> |
| 1110 | If a |
| 1111 | <citerefentry><refentrytitle>glColorTable</refentrytitle></citerefentry>, |
| 1112 | <citerefentry><refentrytitle>glColorSubTable</refentrytitle></citerefentry>, |
| 1113 | <citerefentry><refentrytitle>glConvolutionFilter1D</refentrytitle></citerefentry>, |
| 1114 | <citerefentry><refentrytitle>glConvolutionFilter2D</refentrytitle></citerefentry>, |
| 1115 | <citerefentry><refentrytitle>glCopyPixels</refentrytitle></citerefentry>, |
| 1116 | <citerefentry><refentrytitle>glCopyTexImage1D</refentrytitle></citerefentry>, |
| 1117 | <citerefentry><refentrytitle>glCopyTexImage2D</refentrytitle></citerefentry>, |
| 1118 | <citerefentry><refentrytitle>glCopyTexSubImage1D</refentrytitle></citerefentry>, |
| 1119 | <citerefentry><refentrytitle>glCopyTexSubImage2D</refentrytitle></citerefentry>, |
| 1120 | <citerefentry><refentrytitle>glCopyTexSubImage3D</refentrytitle></citerefentry>, |
| 1121 | <citerefentry><refentrytitle>glDrawPixels</refentrytitle></citerefentry>, |
| 1122 | <citerefentry><refentrytitle>glReadPixels</refentrytitle></citerefentry>, |
| 1123 | <citerefentry><refentrytitle>glSeparableFilter2D</refentrytitle></citerefentry>, |
| 1124 | <citerefentry><refentrytitle>glTexImage1D</refentrytitle></citerefentry>, |
| 1125 | <citerefentry><refentrytitle>glTexImage2D</refentrytitle></citerefentry>, |
| 1126 | <citerefentry><refentrytitle>glTexImage3D</refentrytitle></citerefentry>, |
| 1127 | <citerefentry><refentrytitle>glTexSubImage1D</refentrytitle></citerefentry>, |
| 1128 | <citerefentry><refentrytitle>glTexSubImage2D</refentrytitle></citerefentry>, or |
| 1129 | <citerefentry><refentrytitle>glTexSubImage3D</refentrytitle></citerefentry> |
| 1130 | command is placed in a display list |
| 1131 | (see <citerefentry><refentrytitle>glNewList</refentrytitle></citerefentry> and <citerefentry><refentrytitle>glCallList</refentrytitle></citerefentry>), |
| 1132 | the pixel transfer mode settings in effect when the display list is |
| 1133 | <emphasis>executed</emphasis> |
| 1134 | are the ones that are used. |
| 1135 | They may be different from the settings when the command was compiled |
| 1136 | into the display list. |
| 1137 | </para> |
| 1138 | </refsect1> |
| 1139 | <refsect1 id="errors"><title>Errors</title> |
| 1140 | <para> |
| 1141 | <constant>GL_INVALID_ENUM</constant> is generated if <parameter>pname</parameter> is not an accepted value. |
| 1142 | </para> |
| 1143 | <para> |
| 1144 | <constant>GL_INVALID_OPERATION</constant> is generated if <function>glPixelTransfer</function> |
| 1145 | is executed between the execution of <citerefentry><refentrytitle>glBegin</refentrytitle></citerefentry> |
| 1146 | and the corresponding execution of <citerefentry><refentrytitle>glEnd</refentrytitle></citerefentry>. |
| 1147 | </para> |
| 1148 | </refsect1> |
| 1149 | <refsect1 id="associatedgets"><title>Associated Gets</title> |
| 1150 | <para> |
| 1151 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_MAP_COLOR</constant> |
| 1152 | </para> |
| 1153 | <para> |
| 1154 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_MAP_STENCIL</constant> |
| 1155 | </para> |
| 1156 | <para> |
| 1157 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_INDEX_SHIFT</constant> |
| 1158 | </para> |
| 1159 | <para> |
| 1160 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_INDEX_OFFSET</constant> |
| 1161 | </para> |
| 1162 | <para> |
| 1163 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_RED_SCALE</constant> |
| 1164 | </para> |
| 1165 | <para> |
| 1166 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_RED_BIAS</constant> |
| 1167 | </para> |
| 1168 | <para> |
| 1169 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_GREEN_SCALE</constant> |
| 1170 | </para> |
| 1171 | <para> |
| 1172 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_GREEN_BIAS</constant> |
| 1173 | </para> |
| 1174 | <para> |
| 1175 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_BLUE_SCALE</constant> |
| 1176 | </para> |
| 1177 | <para> |
| 1178 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_BLUE_BIAS</constant> |
| 1179 | </para> |
| 1180 | <para> |
| 1181 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_ALPHA_SCALE</constant> |
| 1182 | </para> |
| 1183 | <para> |
| 1184 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_ALPHA_BIAS</constant> |
| 1185 | </para> |
| 1186 | <para> |
| 1187 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_DEPTH_SCALE</constant> |
| 1188 | </para> |
| 1189 | <para> |
| 1190 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_DEPTH_BIAS</constant> |
| 1191 | </para> |
| 1192 | <para> |
| 1193 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_POST_COLOR_MATRIX_RED_SCALE</constant> |
| 1194 | </para> |
| 1195 | <para> |
| 1196 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_POST_COLOR_MATRIX_RED_BIAS</constant> |
| 1197 | </para> |
| 1198 | <para> |
| 1199 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_POST_COLOR_MATRIX_GREEN_SCALE</constant> |
| 1200 | </para> |
| 1201 | <para> |
| 1202 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_POST_COLOR_MATRIX_GREEN_BIAS</constant> |
| 1203 | </para> |
| 1204 | <para> |
| 1205 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_POST_COLOR_MATRIX_BLUE_SCALE</constant> |
| 1206 | </para> |
| 1207 | <para> |
| 1208 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_POST_COLOR_MATRIX_BLUE_BIAS</constant> |
| 1209 | </para> |
| 1210 | <para> |
| 1211 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_POST_COLOR_MATRIX_ALPHA_SCALE</constant> |
| 1212 | </para> |
| 1213 | <para> |
| 1214 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_POST_COLOR_MATRIX_ALPHA_BIAS</constant> |
| 1215 | </para> |
| 1216 | <para> |
| 1217 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_POST_CONVOLUTION_RED_SCALE</constant> |
| 1218 | </para> |
| 1219 | <para> |
| 1220 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_POST_CONVOLUTION_RED_BIAS</constant> |
| 1221 | </para> |
| 1222 | <para> |
| 1223 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_POST_CONVOLUTION_GREEN_SCALE</constant> |
| 1224 | </para> |
| 1225 | <para> |
| 1226 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_POST_CONVOLUTION_GREEN_BIAS</constant> |
| 1227 | </para> |
| 1228 | <para> |
| 1229 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_POST_CONVOLUTION_BLUE_SCALE</constant> |
| 1230 | </para> |
| 1231 | <para> |
| 1232 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_POST_CONVOLUTION_BLUE_BIAS</constant> |
| 1233 | </para> |
| 1234 | <para> |
| 1235 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_POST_CONVOLUTION_ALPHA_SCALE</constant> |
| 1236 | </para> |
| 1237 | <para> |
| 1238 | <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_POST_CONVOLUTION_ALPHA_BIAS</constant> |
| 1239 | </para> |
| 1240 | </refsect1> |
| 1241 | <refsect1 id="seealso"><title>See Also</title> |
| 1242 | <para> |
| 1243 | <citerefentry><refentrytitle>glCallList</refentrytitle></citerefentry>, |
| 1244 | <citerefentry><refentrytitle>glColorTable</refentrytitle></citerefentry>, |
| 1245 | <citerefentry><refentrytitle>glColorSubTable</refentrytitle></citerefentry>, |
| 1246 | <citerefentry><refentrytitle>glConvolutionFilter1D</refentrytitle></citerefentry>, |
| 1247 | <citerefentry><refentrytitle>glConvolutionFilter2D</refentrytitle></citerefentry>, |
| 1248 | <citerefentry><refentrytitle>glCopyPixels</refentrytitle></citerefentry>, |
| 1249 | <citerefentry><refentrytitle>glCopyTexImage1D</refentrytitle></citerefentry>, |
| 1250 | <citerefentry><refentrytitle>glCopyTexImage2D</refentrytitle></citerefentry>, |
| 1251 | <citerefentry><refentrytitle>glCopyTexSubImage1D</refentrytitle></citerefentry>, |
| 1252 | <citerefentry><refentrytitle>glCopyTexSubImage2D</refentrytitle></citerefentry>, |
| 1253 | <citerefentry><refentrytitle>glCopyTexSubImage3D</refentrytitle></citerefentry>, |
| 1254 | <citerefentry><refentrytitle>glDrawPixels</refentrytitle></citerefentry>, |
| 1255 | <citerefentry><refentrytitle>glNewList</refentrytitle></citerefentry>, |
| 1256 | <citerefentry><refentrytitle>glPixelMap</refentrytitle></citerefentry>, |
| 1257 | <citerefentry><refentrytitle>glPixelStore</refentrytitle></citerefentry>, |
| 1258 | <citerefentry><refentrytitle>glPixelZoom</refentrytitle></citerefentry>, |
| 1259 | <citerefentry><refentrytitle>glReadPixels</refentrytitle></citerefentry>, |
| 1260 | <citerefentry><refentrytitle>glTexImage1D</refentrytitle></citerefentry>, |
| 1261 | <citerefentry><refentrytitle>glTexImage2D</refentrytitle></citerefentry>, |
| 1262 | <citerefentry><refentrytitle>glTexImage3D</refentrytitle></citerefentry>, |
| 1263 | <citerefentry><refentrytitle>glTexSubImage1D</refentrytitle></citerefentry>, |
| 1264 | <citerefentry><refentrytitle>glTexSubImage2D</refentrytitle></citerefentry>, |
| 1265 | <citerefentry><refentrytitle>glTexSubImage3D</refentrytitle></citerefentry> |
| 1266 | </para> |
| 1267 | </refsect1> |
| 1268 | <refsect1 id="Copyright"><title>Copyright</title> |
| 1269 | <para> |
| 1270 | Copyright <trademark class="copyright"></trademark> 1991-2006 |
| 1271 | Silicon Graphics, Inc. This document is licensed under the SGI |
| 1272 | Free Software B License. For details, see |
| 1273 | <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>. |
| 1274 | </para> |
| 1275 | </refsect1> |
| 1276 | </refentry> |