upstream-doc/man4/xhtml/glCopyTexImage1D.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "xhtml1-transitional.dtd">
   3 <!-- saved from url=(0013)about:internet -->
   4 <?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" /><link rel="stylesheet" type="text/css" href="opengl-man.css" /><title>glCopyTexImage1D - OpenGL 4 Reference Pages</title><meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /></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>
   5                     Specifies the target texture.
   6                     Must be <code class="constant">GL_TEXTURE_1D</code>.
   7                 </p></dd><dt><span class="term"><em class="parameter"><code>level</code></em></span></dt><dd><p>
   8                     Specifies the level-of-detail number.
   9                     Level 0 is the base image level.
  10                     Level <span class="emphasis"><em>n</em></span> is the <span class="emphasis"><em>n</em></span>th mipmap reduction image.
  11                 </p></dd><dt><span class="term"><em class="parameter"><code>internalformat</code></em></span></dt><dd><p>
  12                     Specifies the internal format of the texture.
  13                     Must be one of the following symbolic constants:
  14                     <code class="constant">GL_COMPRESSED_RED</code>,
  15                     <code class="constant">GL_COMPRESSED_RG</code>,
  16                     <code class="constant">GL_COMPRESSED_RGB</code>,
  17                     <code class="constant">GL_COMPRESSED_RGBA</code>.
  18                     <code class="constant">GL_COMPRESSED_SRGB</code>,
  19                     <code class="constant">GL_COMPRESSED_SRGB_ALPHA</code>.
  20                     <code class="constant">GL_DEPTH_COMPONENT</code>,
  21                     <code class="constant">GL_DEPTH_COMPONENT16</code>,
  22                     <code class="constant">GL_DEPTH_COMPONENT24</code>,
  23                     <code class="constant">GL_DEPTH_COMPONENT32</code>,
  24                     <code class="constant">GL_RED</code>,
  25                     <code class="constant">GL_RG</code>,
  26                     <code class="constant">GL_RGB</code>,
  27                     <code class="constant">GL_R3_G3_B2</code>,
  28                     <code class="constant">GL_RGB4</code>,
  29                     <code class="constant">GL_RGB5</code>,
  30                     <code class="constant">GL_RGB8</code>,
  31                     <code class="constant">GL_RGB10</code>,
  32                     <code class="constant">GL_RGB12</code>,
  33                     <code class="constant">GL_RGB16</code>,
  34                     <code class="constant">GL_RGBA</code>,
  35                     <code class="constant">GL_RGBA2</code>,
  36                     <code class="constant">GL_RGBA4</code>,
  37                     <code class="constant">GL_RGB5_A1</code>,
  38                     <code class="constant">GL_RGBA8</code>,
  39                     <code class="constant">GL_RGB10_A2</code>,
  40                     <code class="constant">GL_RGBA12</code>,
  41                     <code class="constant">GL_RGBA16</code>,
  42                     <code class="constant">GL_SRGB</code>,
  43                     <code class="constant">GL_SRGB8</code>,
  44                     <code class="constant">GL_SRGB_ALPHA</code>, or
  45                     <code class="constant">GL_SRGB8_ALPHA8</code>.
  46                 </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>
  47                     Specify the window coordinates of the left corner
  48                     of the row of pixels to be copied.
  49                 </p></dd><dt><span class="term"><em class="parameter"><code>width</code></em></span></dt><dd><p>
  50                     Specifies the width of the texture image.
  51                     The height of the texture image is 1.
  52                 </p></dd><dt><span class="term"><em class="parameter"><code>border</code></em></span></dt><dd><p>
  53                     Must be 0.
  54                 </p></dd></dl></div></div><div class="refsect1" lang="en" xml:lang="en"><a id="description"></a><h2>Description</h2><p>
  55             <code class="function">glCopyTexImage1D</code> defines a one-dimensional texture image with pixels from the current
  56             <code class="constant">GL_READ_BUFFER</code>.
  57         </p><p>
  58             The screen-aligned pixel row with left corner at
  59             <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
  60
  61                 <mml:mfenced open="(" close=")">
  62                     <mml:mi mathvariant="italic">x</mml:mi>
  63                     <mml:mi mathvariant="italic">y</mml:mi>
  64                 </mml:mfenced>
  65             </mml:math>
  66             and with a length of
  67             <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
  68                 <mml:mi mathvariant="italic">width</mml:mi>
  69             </mml:math>
  70             defines the texture array
  71             at the mipmap level specified by <em class="parameter"><code>level</code></em>.
  72             <em class="parameter"><code>internalformat</code></em> specifies the internal format of the texture array.
  73         </p><p>
  74             The pixels in the row are processed exactly as if
  75             <a href="glReadPixels.xml"><span class="citerefentry"><span class="refentrytitle">glReadPixels</span></span></a> had been called, but the process stops just before
  76             final conversion.
  77             At this point all pixel component values are clamped to the range
  78             <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
  79
  80                 <mml:mfenced open="[" close="]">
  81                     <mml:mn>0</mml:mn>
  82                     <mml:mn>1</mml:mn>
  83                 </mml:mfenced>
  84             </mml:math>
  85             and then converted to the texture's internal format for storage in the texel
  86             array.
  87         </p><p>
  88             Pixel ordering is such that lower
  89             <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">x</mml:mi></mml:math>
  90             screen coordinates correspond to
  91             lower texture coordinates.
  92         </p><p>
  93             If any of the pixels within the specified row of the current
  94             <code class="constant">GL_READ_BUFFER</code> are outside the window associated with the current
  95             rendering context, then the values obtained for those pixels are undefined.
  96         </p><p>
  97             <code class="function">glCopyTexImage1D</code> defines a one-dimensional texture image with pixels from the current
  98             <code class="constant">GL_READ_BUFFER</code>.
  99         </p><p>
 100             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.
 101         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
 102             1, 2, 3, and 4 are not accepted values for <em class="parameter"><code>internalformat</code></em>.
 103         </p><p>
 104             An image with 0 width indicates a NULL texture.
 105         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
 106             <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>target</code></em> is not one of the allowable values.
 107         </p><p>
 108             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>level</code></em> is less than 0.
 109         </p><p>
 110             <code class="constant">GL_INVALID_VALUE</code> may be generated if <em class="parameter"><code>level</code></em> is greater
 111             than
 112             <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
 113
 114                 <mml:mrow>
 115                     <mml:msub><mml:mi mathvariant="italic">log</mml:mi>
 116                     <mml:mn>2</mml:mn>
 117                     </mml:msub>
 118                     <mml:mo>⁢</mml:mo>
 119                     <mml:mi mathvariant="italic">max</mml:mi>
 120                 </mml:mrow>
 121             </mml:math>,
 122             where
 123             <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">max</mml:mi></mml:math>
 124             is the returned value of <code class="constant">GL_MAX_TEXTURE_SIZE</code>.
 125         </p><p>
 126             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>internalformat</code></em> is not an allowable value.
 127         </p><p>
 128             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>width</code></em> is less than 0 or greater than
 129             <code class="constant">GL_MAX_TEXTURE_SIZE</code>.
 130         </p><p>
 131             <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>border</code></em> is not 0.
 132         </p><p>
 133             <code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>internalformat</code></em> is
 134             <code class="constant">GL_DEPTH_COMPONENT</code>, <code class="constant">GL_DEPTH_COMPONENT16</code>,
 135             <code class="constant">GL_DEPTH_COMPONENT24</code>, or <code class="constant">GL_DEPTH_COMPONENT32</code> and there is no depth
 136             buffer.
 137         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
 138             <a href="glGetTexImage.xml"><span class="citerefentry"><span class="refentrytitle">glGetTexImage</span></span></a>
 139         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
 140             <a href="glCopyTexImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexImage2D</span></span></a>,
 141             <a href="glCopyTexSubImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexSubImage1D</span></span></a>,
 142             <a href="glCopyTexSubImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexSubImage2D</span></span></a>,
 143             <a href="glPixelStore.xml"><span class="citerefentry"><span class="refentrytitle">glPixelStore</span></span></a>,
 144             <a href="glTexImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage1D</span></span></a>,
 145             <a href="glTexImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage2D</span></span></a>,
 146             <a href="glTexSubImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glTexSubImage1D</span></span></a>,
 147             <a href="glTexSubImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glTexSubImage2D</span></span></a>,
 148             <a href="glTexParameter.xml"><span class="citerefentry"><span class="refentrytitle">glTexParameter</span></span></a>
 149         </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
 150             Copyright <span class="trademark"></span>© 1991-2006
 151             Silicon Graphics, Inc.
 152             Copyright <span class="trademark"></span>© 2012-2013 Khronos Group.
 153             This document is licensed under the SGI
 154             Free Software B License. For details, see
 155             <a href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>.
 156         </p></div></div></body></html>