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>glCompressedTexSubImage1D
</title><meta name=
"generator" content=
"DocBook XSL Stylesheets V1.69.1" /></head><body><div class=
"refentry" lang=
"en" xml:
lang=
"en"><a id=
"glCompressedTexSubImage1D"></a><div class=
"titlepage"></div><div class=
"refnamediv"><h2>Name
</h2><p>glCompressedTexSubImage1D — specify a one-dimensional texture subimage 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">glCompressedTexSubImage1D
</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>GLint
</td><td><var class=
"pdparam">xoffset
</var>,
</td></tr><tr><td> </td><td>GLsizei
</td><td><var class=
"pdparam">width
</var>,
</td></tr><tr><td> </td><td>GLenum
</td><td><var class=
"pdparam">format
</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>.
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>xoffset
</code></em></span></dt><dd><p>
12 Specifies a texel offset in the x direction within the texture array.
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 subimage.
15 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>format
</code></em></span></dt><dd><p>
16 Specifies the format of the compressed image data stored at address
<em class=
"parameter"><code>data
</code></em>.
17 </p></dd><dt><span class=
"term"><em class=
"parameter"><code>imageSize
</code></em></span></dt><dd><p>
18 Specifies the number of unsigned bytes of image data starting at the
19 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">glCompressedTexSubImage1D
</code> redefines a contiguous subregion of an existing one-dimensional
26 texture image. The texels referenced by
<em class=
"parameter"><code>data
</code></em> replace the portion of the
27 existing texture array with x indices
<em class=
"parameter"><code>xoffset
</code></em> and
28 <mml:math xmlns:
mml=
"http://www.w3.org/1998/Math/MathML" overflow=
"scroll">
31 <mml:mi mathvariant=
"italic">xoffset
</mml:mi>
33 <mml:mi mathvariant=
"italic">width
</mml:mi>
38 inclusive. This region may not include any texels
39 outside the range of the texture array as it was originally specified. It
40 is not an error to specify a subtexture with width of
0, but such a
41 specification has no effect.
43 <em class=
"parameter"><code>internalformat
</code></em> must be a known compressed image format (such as
<code class=
"constant">GL_RGTC
</code>)
44 or an extension-specified compressed-texture format.
45 The
<em class=
"parameter"><code>format
</code></em> of the compressed texture
46 image is selected by the GL implementation that compressed it (see
47 <a href=
"glTexImage1D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glTexImage1D
</span></span></a>), and should be queried at the time the texture was
48 compressed with
<a href=
"glGetTexLevelParameter.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGetTexLevelParameter
</span></span></a>.
50 If a non-zero named buffer object is bound to the
<code class=
"constant">GL_PIXEL_UNPACK_BUFFER
</code> target
51 (see
<a href=
"glBindBuffer.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glBindBuffer
</span></span></a>) while a texture image is
52 specified,
<em class=
"parameter"><code>data
</code></em> is treated as a byte offset into the buffer object's data store.
53 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"errors"></a><h2>Errors
</h2><p>
54 <code class=
"constant">GL_INVALID_ENUM
</code> is generated if
<em class=
"parameter"><code>internalformat
</code></em> is not one of the generic
55 compressed internal formats:
56 <code class=
"constant">GL_COMPRESSED_RED
</code>,
57 <code class=
"constant">GL_COMPRESSED_RG
</code>,
58 <code class=
"constant">GL_COMPRESSED_RGB
</code>,
59 <code class=
"constant">GL_COMPRESSED_RGBA
</code>.
60 <code class=
"constant">GL_COMPRESSED_SRGB
</code>, or
61 <code class=
"constant">GL_COMPRESSED_SRGB_ALPHA
</code>.
63 <code class=
"constant">GL_INVALID_VALUE
</code> is generated if
<em class=
"parameter"><code>imageSize
</code></em> is not consistent with
64 the format, dimensions, and contents of the specified compressed image
67 <code class=
"constant">GL_INVALID_OPERATION
</code> is generated if parameter combinations are not
68 supported by the specific compressed internal format as specified in the
69 specific texture compression extension.
71 <code class=
"constant">GL_INVALID_OPERATION
</code> is generated if a non-zero buffer object name is bound to the
72 <code class=
"constant">GL_PIXEL_UNPACK_BUFFER
</code> target and the buffer object's data store is currently mapped.
74 <code class=
"constant">GL_INVALID_OPERATION
</code> is generated if a non-zero buffer object name is bound to the
75 <code class=
"constant">GL_PIXEL_UNPACK_BUFFER
</code> target and the data would be unpacked from the buffer
76 object such that the memory reads required would exceed the data store size.
78 Undefined results, including abnormal program termination, are generated if
79 <em class=
"parameter"><code>data
</code></em> is not encoded in a manner consistent with the extension
80 specification defining the internal compression format.
81 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"associatedgets"></a><h2>Associated Gets
</h2><p>
82 <a href=
"glGetCompressedTexImage.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGetCompressedTexImage
</span></span></a>
84 <a href=
"glGet.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGet
</span></span></a> with argument
<code class=
"constant">GL_TEXTURE_COMPRESSED
</code>
86 <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>
88 <a href=
"glGetTexLevelParameter.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glGetTexLevelParameter
</span></span></a> with arguments
<code class=
"constant">GL_TEXTURE_INTERNAL_FORMAT
</code>
89 and
<code class=
"constant">GL_TEXTURE_COMPRESSED_IMAGE_SIZE
</code>
90 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"seealso"></a><h2>See Also
</h2><p>
91 <a href=
"glActiveTexture.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glActiveTexture
</span></span></a>,
92 <a href=
"glCompressedTexImage1D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glCompressedTexImage1D
</span></span></a>,
93 <a href=
"glCompressedTexImage2D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glCompressedTexImage2D
</span></span></a>,
94 <a href=
"glCompressedTexImage3D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glCompressedTexImage3D
</span></span></a>,
95 <a href=
"glCompressedTexSubImage2D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glCompressedTexSubImage2D
</span></span></a>,
96 <a href=
"glCompressedTexSubImage3D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glCompressedTexSubImage3D
</span></span></a>,
97 <a href=
"glCopyTexImage1D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glCopyTexImage1D
</span></span></a>,
98 <a href=
"glCopyTexImage2D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glCopyTexImage2D
</span></span></a>,
99 <a href=
"glCopyTexSubImage1D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glCopyTexSubImage1D
</span></span></a>,
100 <a href=
"glCopyTexSubImage2D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glCopyTexSubImage2D
</span></span></a>,
101 <a href=
"glCopyTexSubImage3D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glCopyTexSubImage3D
</span></span></a>,
102 <a href=
"glPixelStore.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glPixelStore
</span></span></a>,
103 <a href=
"glTexImage2D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glTexImage2D
</span></span></a>,
104 <a href=
"glTexImage3D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glTexImage3D
</span></span></a>,
105 <a href=
"glTexSubImage1D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glTexSubImage1D
</span></span></a>,
106 <a href=
"glTexSubImage2D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glTexSubImage2D
</span></span></a>,
107 <a href=
"glTexSubImage3D.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glTexSubImage3D
</span></span></a>,
108 <a href=
"glTexParameter.xml"><span class=
"citerefentry"><span class=
"refentrytitle">glTexParameter
</span></span></a>
109 </p></div><div class=
"refsect1" lang=
"en" xml:
lang=
"en"><a id=
"Copyright"></a><h2>Copyright
</h2><p>
110 Copyright
<span class=
"trademark"></span>©
1991-
2006
111 Silicon Graphics, Inc. This document is licensed under the SGI
112 Free Software B License. For details, see
113 <a href=
"http://oss.sgi.com/projects/FreeB/" target=
"_top">http://oss.sgi.com/projects/FreeB/
</a>.
114 </p></div></div></body></html>