HCoop / clinton / guile-figl.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
update upstream sources
[clinton/guile-figl.git] / upstream-doc / man3 / xhtml / glCopyTexImage1D.xml
CommitLineData
7faf1d71
AW		 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 -->
c7b31271 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 3.3 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>
7faf1d71
AW		 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.
7faf1d71
AW		 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>
c7b31271 53 Must be 0.
7faf1d71
AW		 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
69 <mml:mrow>
70 <mml:mi mathvariant="italic">width</mml:mi>
7faf1d71
AW		 71 </mml:mrow>
72 </mml:math>
73 defines the texture array
74 at the mipmap level specified by <em class="parameter"><code>level</code></em>.
75 <em class="parameter"><code>internalformat</code></em> specifies the internal format of the texture array.
76 </p><p>
77 The pixels in the row are processed exactly as if
78 <a href="glReadPixels.xml"><span class="citerefentry"><span class="refentrytitle">glReadPixels</span></span></a> had been called, but the process stops just before
79 final conversion.
80 At this point all pixel component values are clamped to the range
81 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
82
83 <mml:mfenced open="[" close="]">
84 <mml:mn>0</mml:mn>
85 <mml:mn>1</mml:mn>
86 </mml:mfenced>
87 </mml:math>
88 and then converted to the texture's internal format for storage in the texel
89 array.
90 </p><p>
91 Pixel ordering is such that lower
92 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">x</mml:mi></mml:math>
93 screen coordinates correspond to
94 lower texture coordinates.
95 </p><p>
96 If any of the pixels within the specified row of the current
97 <code class="constant">GL_READ_BUFFER</code> are outside the window associated with the current
98 rendering context, then the values obtained for those pixels are undefined.
99 </p><p>
100 <code class="function">glCopyTexImage1D</code> defines a one-dimensional texture image with pixels from the current
101 <code class="constant">GL_READ_BUFFER</code>.
102 </p><p>
103 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.
104 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="notes"></a><h2>Notes</h2><p>
105 1, 2, 3, and 4 are not accepted values for <em class="parameter"><code>internalformat</code></em>.
106 </p><p>
107 An image with 0 width indicates a NULL texture.
108 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="errors"></a><h2>Errors</h2><p>
109 <code class="constant">GL_INVALID_ENUM</code> is generated if <em class="parameter"><code>target</code></em> is not one of the allowable values.
110 </p><p>
111 <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>level</code></em> is less than 0.
112 </p><p>
113 <code class="constant">GL_INVALID_VALUE</code> may be generated if <em class="parameter"><code>level</code></em> is greater
114 than
115 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll">
116
117 <mml:mrow>
118 <mml:msub><mml:mi mathvariant="italic">log</mml:mi>
119 <mml:mn>2</mml:mn>
120 </mml:msub>
121 <mml:mo>⁢</mml:mo>
122 <mml:mi mathvariant="italic">max</mml:mi>
123 </mml:mrow>
124 </mml:math>,
125 where
126 <mml:math xmlns:mml="http://www.w3.org/1998/Math/MathML" overflow="scroll"><mml:mi mathvariant="italic">max</mml:mi></mml:math>
127 is the returned value of <code class="constant">GL_MAX_TEXTURE_SIZE</code>.
128 </p><p>
129 <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>internalformat</code></em> is not an allowable value.
130 </p><p>
131 <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>width</code></em> is less than 0 or greater than
132 <code class="constant">GL_MAX_TEXTURE_SIZE</code>.
133 </p><p>
c7b31271 134 <code class="constant">GL_INVALID_VALUE</code> is generated if <em class="parameter"><code>border</code></em> is not 0.
7faf1d71
AW		 135 </p><p>
136 <code class="constant">GL_INVALID_OPERATION</code> is generated if <em class="parameter"><code>internalformat</code></em> is
137 <code class="constant">GL_DEPTH_COMPONENT</code>, <code class="constant">GL_DEPTH_COMPONENT16</code>,
138 <code class="constant">GL_DEPTH_COMPONENT24</code>, or <code class="constant">GL_DEPTH_COMPONENT32</code> and there is no depth
139 buffer.
140 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="associatedgets"></a><h2>Associated Gets</h2><p>
141 <a href="glGetTexImage.xml"><span class="citerefentry"><span class="refentrytitle">glGetTexImage</span></span></a>
142 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="seealso"></a><h2>See Also</h2><p>
143 <a href="glCopyTexImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexImage2D</span></span></a>,
144 <a href="glCopyTexSubImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexSubImage1D</span></span></a>,
145 <a href="glCopyTexSubImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glCopyTexSubImage2D</span></span></a>,
146 <a href="glPixelStore.xml"><span class="citerefentry"><span class="refentrytitle">glPixelStore</span></span></a>,
147 <a href="glTexImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage1D</span></span></a>,
148 <a href="glTexImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glTexImage2D</span></span></a>,
149 <a href="glTexSubImage1D.xml"><span class="citerefentry"><span class="refentrytitle">glTexSubImage1D</span></span></a>,
150 <a href="glTexSubImage2D.xml"><span class="citerefentry"><span class="refentrytitle">glTexSubImage2D</span></span></a>,
151 <a href="glTexParameter.xml"><span class="citerefentry"><span class="refentrytitle">glTexParameter</span></span></a>
152 </p></div><div class="refsect1" lang="en" xml:lang="en"><a id="Copyright"></a><h2>Copyright</h2><p>
153 Copyright <span class="trademark"></span>© 1991-2006
154 Silicon Graphics, Inc. This document is licensed under the SGI
155 Free Software B License. For details, see
156 <a href="http://oss.sgi.com/projects/FreeB/" target="_top">http://oss.sgi.com/projects/FreeB/</a>.
157 </p></div></div></body></html>
Unnamed repository; edit this file 'description' to name the repository.