[clinton/guile-figl.git] / upstream-doc / man3 / glCompressedTexSubImage1D.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
              "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
<refentry id="glCompressedTexSubImage1D">
    <refmeta>
        <refmetainfo>
            <copyright>
                <year>1991-2006</year>
                <holder>Silicon Graphics, Inc.</holder>
            </copyright>
        </refmetainfo>
        <refentrytitle>glCompressedTexSubImage1D</refentrytitle>
        <manvolnum>3G</manvolnum>
    </refmeta>
    <refnamediv>
        <refname>glCompressedTexSubImage1D</refname>
        <refpurpose>specify a one-dimensional texture subimage in a compressed format</refpurpose>
    </refnamediv>
    <refsynopsisdiv><title>C Specification</title>
        <funcsynopsis>
            <funcprototype>
                <funcdef>void <function>glCompressedTexSubImage1D</function></funcdef>
                <paramdef>GLenum <parameter>target</parameter></paramdef>
                <paramdef>GLint <parameter>level</parameter></paramdef>
                <paramdef>GLint <parameter>xoffset</parameter></paramdef>
                <paramdef>GLsizei <parameter>width</parameter></paramdef>
                <paramdef>GLenum <parameter>format</parameter></paramdef>
                <paramdef>GLsizei <parameter>imageSize</parameter></paramdef>
                <paramdef>const GLvoid * <parameter>data</parameter></paramdef>
            </funcprototype>
        </funcsynopsis>
    </refsynopsisdiv>
    <!-- eqn: ignoring delim $$ -->
    <refsect1 id="parameters"><title>Parameters</title>
        <variablelist>
        <varlistentry>
            <term><parameter>target</parameter></term>
            <listitem>
                <para>
                    Specifies the target texture.
                    Must be <constant>GL_TEXTURE_1D</constant>.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>level</parameter></term>
            <listitem>
                <para>
                    Specifies the level-of-detail number.
                    Level 0 is the base image level.
                    Level <emphasis>n</emphasis> is the <emphasis>n</emphasis>th mipmap reduction image.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>xoffset</parameter></term>
            <listitem>
                <para>
                    Specifies a texel offset in the x direction within the texture array.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>width</parameter></term>
            <listitem>
                <para>
                    Specifies the width of the texture subimage.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>format</parameter></term>
            <listitem>
                <para>
                    Specifies the format of the compressed image data stored at address <parameter>data</parameter>.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>imageSize</parameter></term>
            <listitem>
                <para>
                    Specifies the number of unsigned bytes of image data starting at the
                    address specified by <parameter>data</parameter>.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>data</parameter></term>
            <listitem>
                <para>
                    Specifies a pointer to the compressed image data in memory.
                </para>
            </listitem>
        </varlistentry>
        </variablelist>
    </refsect1>
    <refsect1 id="description"><title>Description</title>
        <para>
            Texturing allows elements of an image array to be read by shaders.
        </para>
        <para>
            <function>glCompressedTexSubImage1D</function> redefines a contiguous subregion of an existing one-dimensional
            texture image.  The texels referenced by <parameter>data</parameter> replace the portion of the
            existing texture array with x indices <parameter>xoffset</parameter> and 
            <inlineequation><mml:math>
                <!-- eqn: xoffset  +  width  -  1: -->
                <mml:mrow>
                    <mml:mi mathvariant="italic">xoffset</mml:mi>
                    <mml:mo>+</mml:mo>
                    <mml:mi mathvariant="italic">width</mml:mi>
                    <mml:mo>-</mml:mo>
                    <mml:mn>1</mml:mn>
                </mml:mrow>
            </mml:math></inlineequation>,
            inclusive.  This region may not include any texels
            outside the range of the texture array as it was originally specified.  It
            is not an error to specify a subtexture with width of 0, but such a
            specification has no effect.
        </para>
        <para>
            <parameter>internalformat</parameter> must be a known compressed image format (such as <constant>GL_RGTC</constant>)
            or an extension-specified compressed-texture format.
            The <parameter>format</parameter> of the compressed texture
            image is selected by the GL implementation that compressed it (see
            <citerefentry><refentrytitle>glTexImage1D</refentrytitle></citerefentry>), and should be queried at the time the texture was
            compressed with <citerefentry><refentrytitle>glGetTexLevelParameter</refentrytitle></citerefentry>.
        </para>
        <para>
            If a non-zero named buffer object is bound to the <constant>GL_PIXEL_UNPACK_BUFFER</constant> target 
            (see <citerefentry><refentrytitle>glBindBuffer</refentrytitle></citerefentry>) while a texture image is
            specified, <parameter>data</parameter> is treated as a byte offset into the buffer object's data store.
        </para>
    </refsect1>
    <refsect1 id="errors"><title>Errors</title>
        <para>
          <constant>GL_INVALID_ENUM</constant> is generated if <parameter>internalformat</parameter> is not one of the generic
          compressed internal formats:
          <constant>GL_COMPRESSED_RED</constant>,
          <constant>GL_COMPRESSED_RG</constant>,
          <constant>GL_COMPRESSED_RGB</constant>,
          <constant>GL_COMPRESSED_RGBA</constant>.
          <constant>GL_COMPRESSED_SRGB</constant>, or
          <constant>GL_COMPRESSED_SRGB_ALPHA</constant>.
        </para>
        <para>
            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>imageSize</parameter> is not consistent with
            the format, dimensions, and contents of the specified compressed image
            data.
        </para>
        <para>
            <constant>GL_INVALID_OPERATION</constant> is generated if parameter combinations are not
            supported by the specific compressed internal format as specified in the
            specific texture compression extension.
        </para>
        <para>
            <constant>GL_INVALID_OPERATION</constant> is generated if a non-zero buffer object name is bound to the
            <constant>GL_PIXEL_UNPACK_BUFFER</constant> target and the buffer object's data store is currently mapped.
        </para>
        <para>
            <constant>GL_INVALID_OPERATION</constant> is generated if a non-zero buffer object name is bound to the
            <constant>GL_PIXEL_UNPACK_BUFFER</constant> target and the data would be unpacked from the buffer 
            object such that the memory reads required would exceed the data store size.
        </para>
        <para>
            Undefined results, including abnormal program termination, are generated if
            <parameter>data</parameter> is not encoded in a manner consistent with the extension
            specification defining the internal compression format.
        </para>
    </refsect1>
    <refsect1 id="associatedgets"><title>Associated Gets</title>
        <para>
            <citerefentry><refentrytitle>glGetCompressedTexImage</refentrytitle></citerefentry>
        </para>
        <para>
            <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_TEXTURE_COMPRESSED</constant>
        </para>
        <para>
            <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_PIXEL_UNPACK_BUFFER_BINDING</constant>
        </para>
        <para>
            <citerefentry><refentrytitle>glGetTexLevelParameter</refentrytitle></citerefentry> with arguments <constant>GL_TEXTURE_INTERNAL_FORMAT</constant>
            and <constant>GL_TEXTURE_COMPRESSED_IMAGE_SIZE</constant>
        </para>
    </refsect1>
    <refsect1 id="seealso"><title>See Also</title>
        <para>
            <citerefentry><refentrytitle>glActiveTexture</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glCompressedTexImage1D</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glCompressedTexImage2D</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glCompressedTexImage3D</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glCompressedTexSubImage2D</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glCompressedTexSubImage3D</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glCopyTexImage1D</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glCopyTexImage2D</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glCopyTexSubImage1D</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glCopyTexSubImage2D</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glCopyTexSubImage3D</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glPixelStore</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glTexImage2D</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glTexImage3D</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glTexSubImage1D</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glTexSubImage2D</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glTexSubImage3D</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glTexParameter</refentrytitle></citerefentry>
        </para>
    </refsect1>
    <refsect1 id="Copyright"><title>Copyright</title>
        <para>
            Copyright <trademark class="copyright"></trademark> 1991-2006
            Silicon Graphics, Inc. This document is licensed under the SGI
            Free Software B License. For details, see
            <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
        </para>
    </refsect1>
</refentry>
Commit	Line	Data
7faf1d71 AW	1	<?xml version="1.0" encoding="UTF-8"?>
	2	<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
	3	"http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
	4	<refentry id="glCompressedTexSubImage1D">
	5	<refmeta>
	6	<refmetainfo>
	7	<copyright>
	8	<year>1991-2006</year>
	9	<holder>Silicon Graphics, Inc.</holder>
	10	</copyright>
	11	</refmetainfo>
	12	<refentrytitle>glCompressedTexSubImage1D</refentrytitle>
	13	<manvolnum>3G</manvolnum>
	14	</refmeta>
	15	<refnamediv>
	16	<refname>glCompressedTexSubImage1D</refname>
	17	<refpurpose>specify a one-dimensional texture subimage in a compressed format</refpurpose>
	18	</refnamediv>
	19	<refsynopsisdiv><title>C Specification</title>
	20	<funcsynopsis>
	21	<funcprototype>
	22	<funcdef>void <function>glCompressedTexSubImage1D</function></funcdef>
	23	<paramdef>GLenum <parameter>target</parameter></paramdef>
	24	<paramdef>GLint <parameter>level</parameter></paramdef>
	25	<paramdef>GLint <parameter>xoffset</parameter></paramdef>
	26	<paramdef>GLsizei <parameter>width</parameter></paramdef>
	27	<paramdef>GLenum <parameter>format</parameter></paramdef>
	28	<paramdef>GLsizei <parameter>imageSize</parameter></paramdef>
	29	<paramdef>const GLvoid * <parameter>data</parameter></paramdef>
	30	</funcprototype>
	31	</funcsynopsis>
	32	</refsynopsisdiv>
	33	<!-- eqn: ignoring delim $$ -->
	34	<refsect1 id="parameters"><title>Parameters</title>
	35	<variablelist>
	36	<varlistentry>
	37	<term><parameter>target</parameter></term>
	38	<listitem>
	39	<para>
	40	Specifies the target texture.
	41	Must be <constant>GL_TEXTURE_1D</constant>.
	42	</para>
	43	</listitem>
	44	</varlistentry>
	45	<varlistentry>
	46	<term><parameter>level</parameter></term>
	47	<listitem>
	48	<para>
	49	Specifies the level-of-detail number.
	50	Level 0 is the base image level.
	51	Level <emphasis>n</emphasis> is the <emphasis>n</emphasis>th mipmap reduction image.
	52	</para>
	53	</listitem>
	54	</varlistentry>
	55	<varlistentry>
	56	<term><parameter>xoffset</parameter></term>
	57	<listitem>
	58	<para>
	59	Specifies a texel offset in the x direction within the texture array.
	60	</para>
	61	</listitem>
	62	</varlistentry>
	63	<varlistentry>
	64	<term><parameter>width</parameter></term>
65	<listitem>
66	<para>
67	Specifies the width of the texture subimage.
68	</para>
69	</listitem>
70	</varlistentry>
71	<varlistentry>
72	<term><parameter>format</parameter></term>
73	<listitem>
74	<para>
75	Specifies the format of the compressed image data stored at address <parameter>data</parameter>.
76	</para>
77	</listitem>
78	</varlistentry>
79	<varlistentry>
80	<term><parameter>imageSize</parameter></term>
81	<listitem>
82	<para>
83	Specifies the number of unsigned bytes of image data starting at the
84	address specified by <parameter>data</parameter>.
85	</para>
86	</listitem>
87	</varlistentry>
88	<varlistentry>
89	<term><parameter>data</parameter></term>
90	<listitem>
91	<para>
92	Specifies a pointer to the compressed image data in memory.
93	</para>
94	</listitem>
95	</varlistentry>
96	</variablelist>
97	</refsect1>
98	<refsect1 id="description"><title>Description</title>
99	<para>
100	Texturing allows elements of an image array to be read by shaders.
101	</para>
102	<para>
103	<function>glCompressedTexSubImage1D</function> redefines a contiguous subregion of an existing one-dimensional
104	texture image. The texels referenced by <parameter>data</parameter> replace the portion of the
105	existing texture array with x indices <parameter>xoffset</parameter> and
106	<inlineequation><mml:math>
107	<!-- eqn: xoffset + width - 1: -->
108	<mml:mrow>
109	<mml:mi mathvariant="italic">xoffset</mml:mi>
110	<mml:mo>+</mml:mo>
111	<mml:mi mathvariant="italic">width</mml:mi>
112	<mml:mo>-</mml:mo>
113	<mml:mn>1</mml:mn>
114	</mml:mrow>
115	</mml:math></inlineequation>,
116	inclusive. This region may not include any texels
117	outside the range of the texture array as it was originally specified. It
118	is not an error to specify a subtexture with width of 0, but such a
119	specification has no effect.
120	</para>
121	<para>
122	<parameter>internalformat</parameter> must be a known compressed image format (such as <constant>GL_RGTC</constant>)
123	or an extension-specified compressed-texture format.
124	The <parameter>format</parameter> of the compressed texture
125	image is selected by the GL implementation that compressed it (see
126	<citerefentry><refentrytitle>glTexImage1D</refentrytitle></citerefentry>), and should be queried at the time the texture was
127	compressed with <citerefentry><refentrytitle>glGetTexLevelParameter</refentrytitle></citerefentry>.
128	</para>
129	<para>
130	If a non-zero named buffer object is bound to the <constant>GL_PIXEL_UNPACK_BUFFER</constant> target
131	(see <citerefentry><refentrytitle>glBindBuffer</refentrytitle></citerefentry>) while a texture image is
132	specified, <parameter>data</parameter> is treated as a byte offset into the buffer object's data store.
133	</para>
134	</refsect1>
135	<refsect1 id="errors"><title>Errors</title>
136	<para>
137	<constant>GL_INVALID_ENUM</constant> is generated if <parameter>internalformat</parameter> is not one of the generic
138	compressed internal formats:
139	<constant>GL_COMPRESSED_RED</constant>,
140	<constant>GL_COMPRESSED_RG</constant>,
141	<constant>GL_COMPRESSED_RGB</constant>,
142	<constant>GL_COMPRESSED_RGBA</constant>.
143	<constant>GL_COMPRESSED_SRGB</constant>, or
144	<constant>GL_COMPRESSED_SRGB_ALPHA</constant>.
145	</para>
146	<para>
147	<constant>GL_INVALID_VALUE</constant> is generated if <parameter>imageSize</parameter> is not consistent with
148	the format, dimensions, and contents of the specified compressed image
149	data.
150	</para>
151	<para>
152	<constant>GL_INVALID_OPERATION</constant> is generated if parameter combinations are not
153	supported by the specific compressed internal format as specified in the
154	specific texture compression extension.
155	</para>
156	<para>
157	<constant>GL_INVALID_OPERATION</constant> is generated if a non-zero buffer object name is bound to the
158	<constant>GL_PIXEL_UNPACK_BUFFER</constant> target and the buffer object's data store is currently mapped.
159	</para>
160	<para>
161	<constant>GL_INVALID_OPERATION</constant> is generated if a non-zero buffer object name is bound to the
162	<constant>GL_PIXEL_UNPACK_BUFFER</constant> target and the data would be unpacked from the buffer
163	object such that the memory reads required would exceed the data store size.
164	</para>
165	<para>
166	Undefined results, including abnormal program termination, are generated if
167	<parameter>data</parameter> is not encoded in a manner consistent with the extension
168	specification defining the internal compression format.
169	</para>
170	</refsect1>
171	<refsect1 id="associatedgets"><title>Associated Gets</title>
172	<para>
173	<citerefentry><refentrytitle>glGetCompressedTexImage</refentrytitle></citerefentry>
174	</para>
175	<para>
176	<citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_TEXTURE_COMPRESSED</constant>
177	</para>
178	<para>
179	<citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_PIXEL_UNPACK_BUFFER_BINDING</constant>
180	</para>
181	<para>
182	<citerefentry><refentrytitle>glGetTexLevelParameter</refentrytitle></citerefentry> with arguments <constant>GL_TEXTURE_INTERNAL_FORMAT</constant>
183	and <constant>GL_TEXTURE_COMPRESSED_IMAGE_SIZE</constant>
184	</para>
185	</refsect1>
186	<refsect1 id="seealso"><title>See Also</title>
187	<para>
188	<citerefentry><refentrytitle>glActiveTexture</refentrytitle></citerefentry>,
189	<citerefentry><refentrytitle>glCompressedTexImage1D</refentrytitle></citerefentry>,
190	<citerefentry><refentrytitle>glCompressedTexImage2D</refentrytitle></citerefentry>,
191	<citerefentry><refentrytitle>glCompressedTexImage3D</refentrytitle></citerefentry>,
192	<citerefentry><refentrytitle>glCompressedTexSubImage2D</refentrytitle></citerefentry>,
193	<citerefentry><refentrytitle>glCompressedTexSubImage3D</refentrytitle></citerefentry>,
194	<citerefentry><refentrytitle>glCopyTexImage1D</refentrytitle></citerefentry>,
195	<citerefentry><refentrytitle>glCopyTexImage2D</refentrytitle></citerefentry>,
196	<citerefentry><refentrytitle>glCopyTexSubImage1D</refentrytitle></citerefentry>,
197	<citerefentry><refentrytitle>glCopyTexSubImage2D</refentrytitle></citerefentry>,
198	<citerefentry><refentrytitle>glCopyTexSubImage3D</refentrytitle></citerefentry>,
199	<citerefentry><refentrytitle>glPixelStore</refentrytitle></citerefentry>,
200	<citerefentry><refentrytitle>glTexImage2D</refentrytitle></citerefentry>,
201	<citerefentry><refentrytitle>glTexImage3D</refentrytitle></citerefentry>,
202	<citerefentry><refentrytitle>glTexSubImage1D</refentrytitle></citerefentry>,
203	<citerefentry><refentrytitle>glTexSubImage2D</refentrytitle></citerefentry>,
204	<citerefentry><refentrytitle>glTexSubImage3D</refentrytitle></citerefentry>,
205	<citerefentry><refentrytitle>glTexParameter</refentrytitle></citerefentry>
206	</para>
207	</refsect1>
208	<refsect1 id="Copyright"><title>Copyright</title>
209	<para>
210	Copyright <trademark class="copyright"></trademark> 1991-2006
211	Silicon Graphics, Inc. This document is licensed under the SGI
212	Free Software B License. For details, see
213	<ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
214	</para>
215	</refsect1>
216	</refentry>