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>glCompressedTexImage1D
</title><meta name=
"generator" content=
"DocBook XSL Stylesheets V1.69.1" /></head><body><div class=
"refentry" lang=
"en" xml:
lang=
"en"><a id=
"glCompressedTexImage1D"></a><div class=
"titlepage"></div><div class=
"refnamediv"><h2>Name
</h2><p>glCompressedTexImage1D — specify a one-dimensional texture image in a compressed format
</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">glCompressedTexImage1D
</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>GLsizei
</td><td><var class=
"pdparam">width
</var>,
</td></tr><tr><td> </td><td>GLint
</td><td><var class=
"pdparam">border
</var>,
</td></tr><tr><td> </td><td>GLsizei
</td><td><var class=
"pdparam">imageSize
</var>,
</td></tr><tr><td> </td><td>const GLvoid *
</td><td><var class=
"pdparam">data
</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> or
<code class=
"constant">GL_PROXY_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 format of the compressed image data stored at address
<em class=
"parameter"><code>data
</code></em>.
13 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>width
</code></em></span></dt><dd><p>
14 Specifies the width of the texture image.
15 All implementations support texture images that are at least
64 texels wide. The height of the
1D texture image is
1.
16 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>border
</code></em></span></dt><dd><p>
18 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>imageSize
</code></em></span></dt><dd><p>
19 Specifies the number of unsigned bytes of image data starting at the address specified by
<em class=
"parameter"><code>data
</code></em>.
20 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>data
</code></em></span></dt><dd><p>
21 Specifies a pointer to the compressed image data in memory.
22 </p></dd></dl></div></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"description"></a><h2>Description
</h2><p>
23 Texturing allows elements of an image array to be read by shaders.
25 <code class=
"function">glCompressedTexImage1D
</code> loads a previously defined, and retrieved, compressed
26 one-dimensional texture image if
<em class=
"parameter"><code>target
</code></em> is
<code class=
"constant">GL_TEXTURE_1D
</code>
27 (see
<a href=
"glTexImage1D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glTexImage1D
</span></span></a>).
29 If
<em class=
"parameter"><code>target
</code></em> is
<code class=
"constant">GL_PROXY_TEXTURE_1D
</code>, no data is read from
<em class=
"parameter"><code>data
</code></em>, but
30 all of the texture image state is recalculated, checked for consistency, and checked against the implementation's capabilities. If the implementation cannot handle a texture of the requested texture size, it sets all of the image state to
0, but does not generate an error (see
<a href=
"glGetError.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGetError
</span></span></a>). To query for an entire mipmap array, use an image array level greater than or equal to
1.
32 <em class=
"parameter"><code>internalformat
</code></em> must be an extension-specified compressed-texture format.
33 When a texture is loaded with
34 <a href=
"glTexImage1D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glTexImage1D
</span></span></a> using a generic compressed texture format
35 (e.g.,
<code class=
"constant">GL_COMPRESSED_RGB
</code>) the GL selects from one of
36 its extensions supporting compressed textures. In order to load the
37 compressed texture image using
<code class=
"function">glCompressedTexImage1D
</code>, query the compressed texture image's size and
38 format using
<a href=
"glGetTexLevelParameter.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGetTexLevelParameter
</span></span></a>.
40 If a non-zero named buffer object is bound to the
<code class=
"constant">GL_PIXEL_UNPACK_BUFFER
</code> target
41 (see
<a href=
"glBindBuffer.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glBindBuffer
</span></span></a>) while a texture image is
42 specified,
<em class=
"parameter"><code>data
</code></em> is treated as a byte offset into the buffer object's data store.
43 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"errors"></a><h2>Errors
</h2><p>
44 <code class=
"constant">GL_INVALID_ENUM
</code> is generated if
<em class=
"parameter"><code>internalformat
</code></em> is not
45 a supported specific compressed internal formats, or is one of the generic
46 compressed internal formats:
47 <code class=
"constant">GL_COMPRESSED_RED
</code>,
48 <code class=
"constant">GL_COMPRESSED_RG
</code>,
49 <code class=
"constant">GL_COMPRESSED_RGB
</code>,
50 <code class=
"constant">GL_COMPRESSED_RGBA
</code>.
51 <code class=
"constant">GL_COMPRESSED_SRGB
</code>, or
52 <code class=
"constant">GL_COMPRESSED_SRGB_ALPHA
</code>.
54 <code class=
"constant">GL_INVALID_VALUE
</code> is generated if
<em class=
"parameter"><code>imageSize
</code></em> is not consistent with
55 the format, dimensions, and contents of the specified compressed image data.
57 <code class=
"constant">GL_INVALID_VALUE
</code> is generated if
<em class=
"parameter"><code>border
</code></em> is not
0.
59 <code class=
"constant">GL_INVALID_OPERATION
</code> is generated if parameter combinations are not
60 supported by the specific compressed internal format as specified in the
61 specific texture compression extension.
63 <code class=
"constant">GL_INVALID_OPERATION
</code> is generated if a non-zero buffer object name is bound to the
64 <code class=
"constant">GL_PIXEL_UNPACK_BUFFER
</code> target and the buffer object's data store is currently mapped.
66 <code class=
"constant">GL_INVALID_OPERATION
</code> is generated if a non-zero buffer object name is bound to the
67 <code class=
"constant">GL_PIXEL_UNPACK_BUFFER
</code> target and the data would be unpacked from the buffer
68 object such that the memory reads required would exceed the data store size.
70 Undefined results, including abnormal program termination, are generated if
71 <em class=
"parameter"><code>data
</code></em> is not encoded in a manner consistent with the extension
72 specification defining the internal compression format.
73 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"associatedgets"></a><h2>Associated Gets
</h2><p>
74 <a href=
"glGetCompressedTexImage.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGetCompressedTexImage
</span></span></a>
76 <a href=
"glGet.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGet
</span></span></a> with argument
<code class=
"constant">GL_TEXTURE_COMPRESSED
</code>
78 <a href=
"glGet.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGet
</span></span></a> with argument
<code class=
"constant">GL_NUM_COMPRESSED_TEXTURE_FORMATS
</code>
80 <a href=
"glGet.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGet
</span></span></a> with argument
<code class=
"constant">GL_COMPRESSED_TEXTURE_FORMATS
</code>
82 <a href=
"glGet.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGet
</span></span></a> with argument
<code class=
"constant">GL_PIXEL_UNPACK_BUFFER_BINDING
</code>
84 <a href=
"glGetTexLevelParameter.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGetTexLevelParameter
</span></span></a> with arguments
<code class=
"constant">GL_TEXTURE_INTERNAL_FORMAT
</code>
85 and
<code class=
"constant">GL_TEXTURE_COMPRESSED_IMAGE_SIZE
</code>
86 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"seealso"></a><h2>See Also
</h2><p>
87 <a href=
"glActiveTexture.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glActiveTexture
</span></span></a>,
88 <a href=
"glCompressedTexImage2D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glCompressedTexImage2D
</span></span></a>,
89 <a href=
"glCompressedTexImage3D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glCompressedTexImage3D
</span></span></a>,
90 <a href=
"glCompressedTexSubImage1D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glCompressedTexSubImage1D
</span></span></a>,
91 <a href=
"glCompressedTexSubImage2D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glCompressedTexSubImage2D
</span></span></a>,
92 <a href=
"glCompressedTexSubImage3D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glCompressedTexSubImage3D
</span></span></a>,
93 <a href=
"glCopyTexImage1D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glCopyTexImage1D
</span></span></a>,
94 <a href=
"glCopyTexImage2D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glCopyTexImage2D
</span></span></a>,
95 <a href=
"glCopyTexSubImage1D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glCopyTexSubImage1D
</span></span></a>,
96 <a href=
"glCopyTexSubImage2D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glCopyTexSubImage2D
</span></span></a>,
97 <a href=
"glCopyTexSubImage3D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glCopyTexSubImage3D
</span></span></a>,
98 <a href=
"glPixelStore.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glPixelStore
</span></span></a>,
99 <a href=
"glTexImage2D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glTexImage2D
</span></span></a>,
100 <a href=
"glTexImage3D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glTexImage3D
</span></span></a>,
101 <a href=
"glTexSubImage1D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glTexSubImage1D
</span></span></a>,
102 <a href=
"glTexSubImage2D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glTexSubImage2D
</span></span></a>,
103 <a href=
"glTexSubImage3D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glTexSubImage3D
</span></span></a>,
104 <a href=
"glTexParameter.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glTexParameter
</span></span></a>
105 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"Copyright"></a><h2>Copyright
</h2><p>
106 Copyright
<span class=
"trademark"></span>©
1991-
2006
107 Silicon Graphics, Inc. This document is licensed under the SGI
108 Free Software B License. For details, see
109 <a href=
"http://oss.sgi.com/projects/FreeB/" target=
"_top">http://oss.sgi.com/projects/FreeB/
</a>.
110 </p></div></div></body></html>