| 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd"> |
| 2 | <!-- saved from url=(0013)about:internet --> |
| 3 | <?xml-stylesheet type="text/xsl" href="mathml.xsl"?><html xmlns="http://www.w3.org/1999/xhtml" xmlns:pref="http://www.w3.org/2002/Math/preference" pref:renderer="mathplayer-dl"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>glCopyTexImage1D</title><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /></head><body><div class="refentry" lang="en" xml:lang="en"><a id="glCopyTexImage1D"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>glCopyTexImage1D — copy pixels into a 1D texture image</p></div><div class="refsynopsisdiv"><h2>C Specification</h2><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"><tr><td><code class="funcdef">void <b class="fsfunc">glCopyTexImage1D</b>(</code></td><td>GLenum </td><td><var class="pdparam">target</var>, </td></tr><tr><td> </td><td>GLint </td><td><var class="pdparam">level</var>, </td></tr><tr><td> </td><td>GLenum </td><td><var class="pdparam">internalformat</var>, </td></tr><tr><td> </td><td>GLint </td><td><var class="pdparam">x</var>, </td></tr><tr><td> </td><td>GLint </td><td><var class="pdparam">y</var>, </td></tr><tr><td> </td><td>GLsizei </td><td><var class="pdparam">width</var>, </td></tr><tr><td> </td><td>GLint </td><td><var class="pdparam">border</var><code>)</code>;</td></tr></table></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="parameters"></a><h2>Parameters</h2><div class="variablelist"><dl><dt><span class="term"><em class="parameter"><code>target</code></em></span></dt><dd><p> |
| 4 | Specifies the target texture. |
| 5 | Must be <code class="constant">GL_TEXTURE_1D</code>. |
| 6 | </p></dd><dt><span class="term"><em class="parameter"><code>level</code></em></span></dt><dd><p> |
| 7 | Specifies the level-of-detail number. |
| 8 | Level 0 is the base image level. |
| 9 | Level <span class="emphasis"><em>n</em></span> is the <span class="emphasis"><em>n</em></span>th mipmap reduction image. |
| 10 | </p></dd><dt><span class="term"><em class="parameter"><code>internalformat</code></em></span></dt><dd><p> |
| 11 | Specifies the internal format of the texture. |
| 12 | Must be one of the following symbolic constants: |
| 13 | <code class="constant">GL_ALPHA</code>, |
| 14 | <code class="constant">GL_ALPHA4</code>, |
| 15 | <code class="constant">GL_ALPHA8</code>, |
| 16 | <code class="constant">GL_ALPHA12</code>, |
| 17 | <code class="constant">GL_ALPHA16</code>, |
| 18 | <code class="constant">GL_COMPRESSED_ALPHA</code>, |
| 19 | <code class="constant">GL_COMPRESSED_LUMINANCE</code>, |
| 20 | <code class="constant">GL_COMPRESSED_LUMINANCE_ALPHA</code>, |
| 21 | <code class="constant">GL_COMPRESSED_INTENSITY</code>, |
| 22 | <code class="constant">GL_COMPRESSED_RGB</code>, |
| 23 | <code class="constant">GL_COMPRESSED_RGBA</code>, |
| 24 | <code class="constant">GL_DEPTH_COMPONENT</code>, |
| 25 | <code class="constant">GL_DEPTH_COMPONENT16</code>, |
| 26 | <code class="constant">GL_DEPTH_COMPONENT24</code>, |
| 27 | <code class="constant">GL_DEPTH_COMPONENT32</code>, |
| 28 | <code class="constant">GL_LUMINANCE</code>, |
| 29 | <code class="constant">GL_LUMINANCE4</code>, |
| 30 | <code class="constant">GL_LUMINANCE8</code>, |
| 31 | <code class="constant">GL_LUMINANCE12</code>, |
| 32 | <code class="constant">GL_LUMINANCE16</code>, |
| 33 | <code class="constant">GL_LUMINANCE_ALPHA</code>, |
| 34 | <code class="constant">GL_LUMINANCE4_ALPHA4</code>, |
| 35 | <code class="constant">GL_LUMINANCE6_ALPHA2</code>, |
| 36 | <code class="constant">GL_LUMINANCE8_ALPHA8</code>, |
| 37 | <code class="constant">GL_LUMINANCE12_ALPHA4</code>, |
| 38 | <code class="constant">GL_LUMINANCE12_ALPHA12</code>, |
| 39 | <code class="constant">GL_LUMINANCE16_ALPHA16</code>, |
| 40 | <code class="constant">GL_INTENSITY</code>, |
| 41 | <code class="constant">GL_INTENSITY4</code>, |
| 42 | <code class="constant">GL_INTENSITY8</code>, |
| 43 | <code class="constant">GL_INTENSITY12</code>, |
| 44 | <code class="constant">GL_INTENSITY16</code>, |
| 45 | <code class="constant">GL_RGB</code>, |
| 46 | <code class="constant">GL_R3_G3_B2</code>, |
| 47 | <code class="constant">GL_RGB4</code>, |
| 48 | <code class="constant">GL_RGB5</code>, |
| 49 | <code class="constant">GL_RGB8</code>, |
| 50 | <code class="constant">GL_RGB10</code>, |
| 51 | <code class="constant">GL_RGB12</code>, |
| 52 | <code class="constant">GL_RGB16</code>, |
| 53 | <code class="constant">GL_RGBA</code>, |
| 54 | <code class="constant">GL_RGBA2</code>, |
| 55 | <code class="constant">GL_RGBA4</code>, |
| 56 | <code class="constant">GL_RGB5_A1</code>, |
| 57 | <code class="constant">GL_RGBA8</code>, |
| 58 | <code class="constant">GL_RGB10_A2</code>, |
| 59 | <code class="constant">GL_RGBA12</code>, |
| 60 | <code class="constant">GL_RGBA16</code>, |
| 61 | <code class="constant">GL_SLUMINANCE</code>, |
| 62 | <code class="constant">GL_SLUMINANCE8</code>, |
| 63 | <code class="constant">GL_SLUMINANCE_ALPHA</code>, |
| 64 | <code class="constant">GL_SLUMINANCE8_ALPHA8</code>, |
| 65 | <code class="constant">GL_SRGB</code>, |
| 66 | <code class="constant">GL_SRGB8</code>, |
| 67 | <code class="constant">GL_SRGB_ALPHA</code>, or |
| 68 | <code class="constant">GL_SRGB8_ALPHA8</code>. |
| 69 | </p></dd><dt><span class="term"><em class="parameter"><code>x</code></em>, </span><span class="term"><em class="parameter"><code>y</code></em></span></dt><dd><p> |
| 70 | Specify the window coordinates of the left corner |
| 71 | of the row of pixels to be copied. |
| 72 | </p></dd><dt><span class="term"><em class="parameter"><code>width</code></em></span></dt><dd><p> |
| 73 | Specifies the width of the texture image. |
| 74 | Must be 0 or |
| 75 | <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"> |
| 76 | |
| 77 | <mml:mrow> |
| 78 | <mml:msup><mml:mn>2</mml:mn> |
| 79 | <mml:mi mathvariant="italic">n</mml:mi> |
| 80 | </mml:msup> |
| 81 | <mml:mo>+</mml:mo> |
| 82 | <mml:mrow> |
| 83 | <mml:mn>2</mml:mn> |
| 84 | <mml:mo></mml:mo> |
| 85 | <mml:mfenced open="(" close=")"> |
| 86 | <mml:mi mathvariant="italic">border</mml:mi> |
| 87 | </mml:mfenced> |
| 88 | </mml:mrow> |
| 89 | </mml:mrow> |
| 90 | </mml:math> |
| 91 | for some integer |
| 92 | <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">n</mml:mi></mml:math>. |
| 93 | The height of the texture image is 1. |
| 94 | </p></dd><dt><span class="term"><em class="parameter"><code>border</code></em></span></dt><dd><p> |
| 95 | Specifies the width of the border. |
| 96 | Must be either 0 or 1. |
| 97 | </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p> |
| 98 | <code class="function">glCopyTexImage1D</code> defines a one-dimensional texture image with pixels from the current |
| 99 | <code class="constant">GL_READ_BUFFER</code>. |
| 100 | </p><p> |
| 101 | The screen-aligned pixel row with left corner at |
| 102 | <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"> |
| 103 | |
| 104 | <mml:mfenced open="(" close=")"> |
| 105 | <mml:mi mathvariant="italic">x</mml:mi> |
| 106 | <mml:mi mathvariant="italic">y</mml:mi> |
| 107 | </mml:mfenced> |
| 108 | </mml:math> |
| 109 | and with a length of |
| 110 | <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"> |
| 111 | |
| 112 | <mml:mrow> |
| 113 | <mml:mi mathvariant="italic">width</mml:mi> |
| 114 | <mml:mo>+</mml:mo> |
| 115 | <mml:mrow> |
| 116 | <mml:mn>2</mml:mn> |
| 117 | <mml:mo></mml:mo> |
| 118 | <mml:mfenced open="(" close=")"> |
| 119 | <mml:mi mathvariant="italic">border</mml:mi> |
| 120 | </mml:mfenced> |
| 121 | </mml:mrow> |
| 122 | </mml:mrow> |
| 123 | </mml:math> |
| 124 | defines the texture array |
| 125 | at the mipmap level specified by <em class="parameter"><code>level</code></em>. |
| 126 | <em class="parameter"><code>internalformat</code></em> specifies the internal format of the texture array. |
| 127 | </p><p> |
| 128 | The pixels in the row are processed exactly as if |
| 129 | <a class="citerefentry" href="glCopyPixels.xml"><span class="citerefentry"><span class="refentrytitle">glCopyPixels</span></span></a> had been called, but the process stops just before |
| 130 | final conversion. |
| 131 | At this point all pixel component values are clamped to the range |
| 132 | <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"> |
| 133 | |
| 134 | <mml:mfenced open="[" close="]"> |
| 135 | <mml:mn>0</mml:mn> |
| 136 | <mml:mn>1</mml:mn> |
| 137 | </mml:mfenced> |
| 138 | </mml:math> |
| 139 | and then converted to the texture's internal format for storage in the texel |
| 140 | array. |
| 141 | </p><p> |
| 142 | Pixel ordering is such that lower |
| 143 | <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">x</mml:mi></mml:math> |
| 144 | screen coordinates correspond to |
| 145 | lower texture coordinates. |
| 146 | </p><p> |
| 147 | If any of the pixels within the specified row of the current |
| 148 | <code class="constant">GL_READ_BUFFER</code> are outside the window associated with the current |
| 149 | rendering context, then the values obtained for those pixels are undefined. |
| 150 | </p><p> |
| 151 | <code class="function">glCopyTexImage1D</code> defines a one-dimensional texture image with pixels from the current |
| 152 | <code class="constant">GL_READ_BUFFER</code>. |
| 153 | </p><p> |
| 154 | When <em class="parameter"><code>internalformat</code></em> is one of the sRGB types, the GL does not automatically convert the source pixels to the sRGB color space. In this case, the <code class="function">glPixelMap</code> function can be used to accomplish the conversion. |
| 155 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p> |
| 156 | <code class="function">glCopyTexImage1D</code> is available only if the GL version is 1.1 or greater. |
| 157 | </p><p> |
| 158 | Texturing has no effect in color index mode. |
| 159 | </p><p> |
| 160 | 1, 2, 3, and 4 are not accepted values for <em class="parameter"><code>internalformat</code></em>. |
| 161 | </p><p> |
| 162 | An image with 0 width indicates a NULL texture. |
| 163 | </p><p> |
| 164 | When the <code class="code">ARB_imaging</code> extension is supported, the RGBA components copied from the framebuffer may be processed by the imaging pipeline. See <a class="citerefentry" href="glTexImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage1D</span></span></a> for specific details. |
| 165 | </p><p> |
| 166 | <code class="constant">GL_DEPTH_COMPONENT</code>, <code class="constant">GL_DEPTH_COMPONENT16</code>, |
| 167 | <code class="constant">GL_DEPTH_COMPONENT24</code>, and <code class="constant">GL_DEPTH_COMPONENT32</code> are available only |
| 168 | if the GL version is 1.4 or greater. |
| 169 | </p><p> |
| 170 | Non-power-of-two textures are supported if the GL version is 2.0 or greater, or if the implementation exports the <code class="constant">GL_ARB_texture_non_power_of_two</code> extension. |
| 171 | </p><p> |
| 172 | The |
| 173 | <code class="constant">GL_SRGB</code>, |
| 174 | <code class="constant">GL_SRGB8</code>, |
| 175 | <code class="constant">GL_SRGB_ALPHA</code>, |
| 176 | <code class="constant">GL_SRGB8_ALPHA8</code>, |
| 177 | <code class="constant">GL_SLUMINANCE</code>, |
| 178 | <code class="constant">GL_SLUMINANCE8</code>, |
| 179 | <code class="constant">GL_SLUMINANCE_ALPHA</code>, and |
| 180 | <code class="constant">GL_SLUMINANCE8_ALPHA8</code> |
| 181 | internal formats are only available if the GL version is 2.1 or greater. See <a class="citerefentry" href="glTexImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage1D</span></span></a> for specific details about sRGB conversion. |
| 182 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p> |
| 183 | <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>target</code></em> is not one of the allowable values. |
| 184 | </p><p> |
| 185 | <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>level</code></em> is less than 0. |
| 186 | </p><p> |
| 187 | <code class="constant">GL_INVALID_VALUE</code> may be generated if <em class="parameter"><code>level</code></em> is greater |
| 188 | than |
| 189 | <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"> |
| 190 | |
| 191 | <mml:mrow> |
| 192 | <mml:msub><mml:mi mathvariant="italic">log</mml:mi> |
| 193 | <mml:mn>2</mml:mn> |
| 194 | </mml:msub> |
| 195 | <mml:mo></mml:mo> |
| 196 | <mml:mi mathvariant="italic">max</mml:mi> |
| 197 | </mml:mrow> |
| 198 | </mml:math>, |
| 199 | where |
| 200 | <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">max</mml:mi></mml:math> |
| 201 | is the returned value of <code class="constant">GL_MAX_TEXTURE_SIZE</code>. |
| 202 | </p><p> |
| 203 | <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>internalformat</code></em> is not an allowable value. |
| 204 | </p><p> |
| 205 | <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>width</code></em> is less than 0 or greater than |
| 206 | 2 + <code class="constant">GL_MAX_TEXTURE_SIZE</code>. |
| 207 | </p><p> |
| 208 | <code class="constant">GL_INVALID_VALUE</code> is generated if non-power-of-two textures are not supported and the <em class="parameter"><code>width</code></em> cannot be represented as |
| 209 | <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"> |
| 210 | |
| 211 | <mml:mrow> |
| 212 | <mml:msup><mml:mn>2</mml:mn> |
| 213 | <mml:mi mathvariant="italic">n</mml:mi> |
| 214 | </mml:msup> |
| 215 | <mml:mo>+</mml:mo> |
| 216 | <mml:mrow> |
| 217 | <mml:mn>2</mml:mn> |
| 218 | <mml:mo></mml:mo> |
| 219 | <mml:mfenced open="(" close=")"> |
| 220 | <mml:mi mathvariant="italic">border</mml:mi> |
| 221 | </mml:mfenced> |
| 222 | </mml:mrow> |
| 223 | </mml:mrow> |
| 224 | </mml:math> |
| 225 | for some integer value of <span class="emphasis"><em>n</em></span>. |
| 226 | </p><p> |
| 227 | <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>border</code></em> is not 0 or 1. |
| 228 | </p><p> |
| 229 | <code class="constant">GL_INVALID_OPERATION</code> is generated if <code class="function">glCopyTexImage1D</code> is executed between the execution of <a class="citerefentry" href="glBegin.xml"><span class="citerefentry"><span class="refentrytitle">glBegin</span></span></a> and the corresponding execution of <a class="citerefentry" href="glEnd.xml"><span class="citerefentry"><span class="refentrytitle">glEnd</span></span></a>. |
| 230 | </p><p> |
| 231 | <code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>internalformat</code></em> is |
| 232 | <code class="constant">GL_DEPTH_COMPONENT</code>, <code class="constant">GL_DEPTH_COMPONENT16</code>, |
| 233 | <code class="constant">GL_DEPTH_COMPONENT24</code>, or <code class="constant">GL_DEPTH_COMPONENT32</code> and there is no depth |
| 234 | buffer. |
| 235 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p> |
| 236 | <a class="citerefentry" href="glGetTexImage.xml"><span class="citerefentry"><span class="refentrytitle">glGetTexImage</span></span></a> |
| 237 | </p><p> |
| 238 | <a class="citerefentry" href="glIsEnabled.xml"><span class="citerefentry"><span class="refentrytitle">glIsEnabled</span></span></a> with argument <code class="constant">GL_TEXTURE_1D</code> |
| 239 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p> |
| 240 | <a class="citerefentry" href="glCopyPixels.xml"><span class="citerefentry"><span class="refentrytitle">glCopyPixels</span></span></a>, |
| 241 | <a class="citerefentry" href="glCopyTexImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexImage2D</span></span></a>, |
| 242 | <a class="citerefentry" href="glCopyTexSubImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexSubImage1D</span></span></a>, |
| 243 | <a class="citerefentry" href="glCopyTexSubImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexSubImage2D</span></span></a>, |
| 244 | <a class="citerefentry" href="glPixelStore.xml"><span class="citerefentry"><span class="refentrytitle">glPixelStore</span></span></a>, |
| 245 | <a class="citerefentry" href="glPixelTransfer.xml"><span class="citerefentry"><span class="refentrytitle">glPixelTransfer</span></span></a>, |
| 246 | <a class="citerefentry" href="glTexEnv.xml"><span class="citerefentry"><span class="refentrytitle">glTexEnv</span></span></a>, |
| 247 | <a class="citerefentry" href="glTexGen.xml"><span class="citerefentry"><span class="refentrytitle">glTexGen</span></span></a>, |
| 248 | <a class="citerefentry" href="glTexImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage1D</span></span></a>, |
| 249 | <a class="citerefentry" href="glTexImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage2D</span></span></a>, |
| 250 | <a class="citerefentry" href="glTexSubImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glTexSubImage1D</span></span></a>, |
| 251 | <a class="citerefentry" href="glTexSubImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glTexSubImage2D</span></span></a>, |
| 252 | <a class="citerefentry" href="glTexParameter.xml"><span class="citerefentry"><span class="refentrytitle">glTexParameter</span></span></a> |
| 253 | </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p> |
| 254 | Copyright <span class="trademark"></span>© 1991-2006 |
| 255 | Silicon Graphics, Inc. This document is licensed under the SGI |
| 256 | Free Software B License. For details, see |
| 257 | <a class="ulink" href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>. |
| 258 | </p></div></div></body></html> |