[clinton/guile-figl.git] / upstream-doc / man4 / glCopyTexImage1D.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="glCopyTexImage1D">
    <refmeta>
        <refmetainfo>
            <copyright>
                <year>2013</year>
                <holder>Khronos Group</holder>
            </copyright>
        </refmetainfo>
        <refentrytitle>glCopyTexImage1D</refentrytitle>
        <manvolnum>3G</manvolnum>
    </refmeta>
    <refnamediv>
        <refname>glCopyTexImage1D</refname>
        <refpurpose>copy pixels into a 1D texture image</refpurpose>
    </refnamediv>
    <refsynopsisdiv><title>C Specification</title>
        <funcsynopsis>
            <funcprototype>
                <funcdef>void <function>glCopyTexImage1D</function></funcdef>
                <paramdef>GLenum <parameter>target</parameter></paramdef>
                <paramdef>GLint <parameter>level</parameter></paramdef>
                <paramdef>GLenum <parameter>internalformat</parameter></paramdef>
                <paramdef>GLint <parameter>x</parameter></paramdef>
                <paramdef>GLint <parameter>y</parameter></paramdef>
                <paramdef>GLsizei <parameter>width</parameter></paramdef>
                <paramdef>GLint <parameter>border</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>internalformat</parameter></term>
            <listitem>
                <para>
                    Specifies the internal format of the texture.
                    Must be one of the following symbolic constants:
                    <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>,
                    <constant>GL_COMPRESSED_SRGB_ALPHA</constant>.
                    <constant>GL_DEPTH_COMPONENT</constant>,
                    <constant>GL_DEPTH_COMPONENT16</constant>,
                    <constant>GL_DEPTH_COMPONENT24</constant>,
                    <constant>GL_DEPTH_COMPONENT32</constant>,
                    <constant>GL_RED</constant>,
                    <constant>GL_RG</constant>,
                    <constant>GL_RGB</constant>,
                    <constant>GL_R3_G3_B2</constant>,
                    <constant>GL_RGB4</constant>,
                    <constant>GL_RGB5</constant>,
                    <constant>GL_RGB8</constant>,
                    <constant>GL_RGB10</constant>,
                    <constant>GL_RGB12</constant>,
                    <constant>GL_RGB16</constant>,
                    <constant>GL_RGBA</constant>,
                    <constant>GL_RGBA2</constant>,
                    <constant>GL_RGBA4</constant>,
                    <constant>GL_RGB5_A1</constant>,
                    <constant>GL_RGBA8</constant>,
                    <constant>GL_RGB10_A2</constant>,
                    <constant>GL_RGBA12</constant>,
                    <constant>GL_RGBA16</constant>,
                    <constant>GL_SRGB</constant>,
                    <constant>GL_SRGB8</constant>,
                    <constant>GL_SRGB_ALPHA</constant>, or 
                    <constant>GL_SRGB8_ALPHA8</constant>.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>x</parameter></term>
            <term><parameter>y</parameter></term>
            <listitem>
                <para>
                    Specify the window coordinates of the left corner
                    of the row of pixels to be copied.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>width</parameter></term>
            <listitem>
                <para>
                    Specifies the width of the texture image.
                    The height of the texture image is 1.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>border</parameter></term>
            <listitem>
                <para>
                    Must be 0.
                </para>
            </listitem>
        </varlistentry>
        </variablelist>
    </refsect1>
    <refsect1 id="description"><title>Description</title>
        <para>
            <function>glCopyTexImage1D</function> defines a one-dimensional texture image with pixels from the current
            <constant>GL_READ_BUFFER</constant>.
        </para>
        <para>
            The screen-aligned pixel row with left corner at 
            <inlineequation><mml:math>
                <!-- eqn: (x, y): -->
                <mml:mfenced open="(" close=")">
                    <mml:mi mathvariant="italic">x</mml:mi>
                    <mml:mi mathvariant="italic">y</mml:mi>
                </mml:mfenced>
            </mml:math></inlineequation>
            and with a length of 
            <inlineequation><mml:math>
                <mml:mi mathvariant="italic">width</mml:mi>
            </mml:math></inlineequation>
            defines the texture array
            at the mipmap level specified by <parameter>level</parameter>.
            <parameter>internalformat</parameter> specifies the internal format of the texture array.
        </para>
        <para>
            The pixels in the row are processed exactly as if
            <citerefentry><refentrytitle>glReadPixels</refentrytitle></citerefentry> had been called, but the process stops just before
            final conversion.
            At this point all pixel component values are clamped to the range 
            <inlineequation><mml:math>
                <!-- eqn: [0,1]: -->
                <mml:mfenced open="[" close="]">
                    <mml:mn>0</mml:mn>
                    <mml:mn>1</mml:mn>
                </mml:mfenced>
            </mml:math></inlineequation>
            and then converted to the texture's internal format for storage in the texel
            array.
        </para>
        <para>
            Pixel ordering is such that lower 
            <inlineequation><mml:math><mml:mi mathvariant="italic">x</mml:mi></mml:math></inlineequation>
            screen coordinates correspond to
            lower texture coordinates.
        </para>
        <para>
            If any of the pixels within the specified row of the current
            <constant>GL_READ_BUFFER</constant> are outside the window associated with the current
            rendering context, then the values obtained for those pixels are undefined.
        </para>
        <para>
            <function>glCopyTexImage1D</function> defines a one-dimensional texture image with pixels from the current
            <constant>GL_READ_BUFFER</constant>.
        </para>
        <para>
            When <parameter>internalformat</parameter> is one of the sRGB  types, the GL does not automatically convert the source pixels to the sRGB color space.  In this case, the <function>glPixelMap</function> function can be used to accomplish the conversion.
        </para>
    </refsect1>
    <refsect1 id="notes"><title>Notes</title>
        <para>
            1, 2, 3, and 4 are not accepted values for <parameter>internalformat</parameter>.
        </para>
        <para>
            An image with 0 width indicates a NULL texture.
        </para>
    </refsect1>
    <refsect1 id="errors"><title>Errors</title>
        <para>
            <constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> is not one of the allowable values.
        </para>
        <para>
            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>level</parameter> is less than 0.
        </para>
        <para>
            <constant>GL_INVALID_VALUE</constant> may be generated if <parameter>level</parameter> is greater
            than 
            <inlineequation><mml:math>
                <!-- eqn: log sub 2 max: -->
                <mml:mrow>
                    <mml:msub><mml:mi mathvariant="italic">log</mml:mi>
                    <mml:mn>2</mml:mn>
                    </mml:msub>
                    <mml:mo>&it;</mml:mo>
                    <mml:mi mathvariant="italic">max</mml:mi>
                </mml:mrow>
            </mml:math></inlineequation>,
            where
            <inlineequation><mml:math><mml:mi mathvariant="italic">max</mml:mi></mml:math></inlineequation>
            is the returned value of <constant>GL_MAX_TEXTURE_SIZE</constant>.
        </para>
        <para>
            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>internalformat</parameter> is not an allowable value.
        </para>
        <para>
            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>width</parameter> is less than 0 or greater than
            <constant>GL_MAX_TEXTURE_SIZE</constant>.
        </para>
        <para>
            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>border</parameter> is not 0.
        </para>
        <para>
            <constant>GL_INVALID_OPERATION</constant> is generated if <parameter>internalformat</parameter> is
            <constant>GL_DEPTH_COMPONENT</constant>, <constant>GL_DEPTH_COMPONENT16</constant>,
            <constant>GL_DEPTH_COMPONENT24</constant>, or <constant>GL_DEPTH_COMPONENT32</constant> and there is no depth
            buffer.
        </para>
    </refsect1>
    <refsect1 id="associatedgets"><title>Associated Gets</title>
        <para>
            <citerefentry><refentrytitle>glGetTexImage</refentrytitle></citerefentry>
        </para>
    </refsect1>
    <refsect1 id="seealso"><title>See Also</title>
        <para>
            <citerefentry><refentrytitle>glCopyTexImage2D</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glCopyTexSubImage1D</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glCopyTexSubImage2D</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glPixelStore</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glTexImage1D</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glTexImage2D</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glTexSubImage1D</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glTexSubImage2D</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.
            Copyright <trademark class="copyright"></trademark> 2012-2013 Khronos Group.
            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="glCopyTexImage1D">
	5	<refmeta>
	6	<refmetainfo>
	7	<copyright>
c7b31271 DH	8	<year>2013</year>
c7b31271 DH	9	<holder>Khronos Group</holder>
7faf1d71 AW	10	</copyright>
	11	</refmetainfo>
	12	<refentrytitle>glCopyTexImage1D</refentrytitle>
	13	<manvolnum>3G</manvolnum>
	14	</refmeta>
	15	<refnamediv>
	16	<refname>glCopyTexImage1D</refname>
	17	<refpurpose>copy pixels into a 1D texture image</refpurpose>
	18	</refnamediv>
	19	<refsynopsisdiv><title>C Specification</title>
	20	<funcsynopsis>
	21	<funcprototype>
	22	<funcdef>void <function>glCopyTexImage1D</function></funcdef>
	23	<paramdef>GLenum <parameter>target</parameter></paramdef>
	24	<paramdef>GLint <parameter>level</parameter></paramdef>
	25	<paramdef>GLenum <parameter>internalformat</parameter></paramdef>
	26	<paramdef>GLint <parameter>x</parameter></paramdef>
	27	<paramdef>GLint <parameter>y</parameter></paramdef>
	28	<paramdef>GLsizei <parameter>width</parameter></paramdef>
	29	<paramdef>GLint <parameter>border</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>internalformat</parameter></term>
	57	<listitem>
	58	<para>
	59	Specifies the internal format of the texture.
	60	Must be one of the following symbolic constants:
	61	<constant>GL_COMPRESSED_RED</constant>,
	62	<constant>GL_COMPRESSED_RG</constant>,
	63	<constant>GL_COMPRESSED_RGB</constant>,
	64	<constant>GL_COMPRESSED_RGBA</constant>.
	65	<constant>GL_COMPRESSED_SRGB</constant>,
	66	<constant>GL_COMPRESSED_SRGB_ALPHA</constant>.
	67	<constant>GL_DEPTH_COMPONENT</constant>,
	68	<constant>GL_DEPTH_COMPONENT16</constant>,
	69	<constant>GL_DEPTH_COMPONENT24</constant>,
	70	<constant>GL_DEPTH_COMPONENT32</constant>,
	71	<constant>GL_RED</constant>,
	72	<constant>GL_RG</constant>,
	73	<constant>GL_RGB</constant>,
74	<constant>GL_R3_G3_B2</constant>,
75	<constant>GL_RGB4</constant>,
76	<constant>GL_RGB5</constant>,
77	<constant>GL_RGB8</constant>,
78	<constant>GL_RGB10</constant>,
79	<constant>GL_RGB12</constant>,
80	<constant>GL_RGB16</constant>,
81	<constant>GL_RGBA</constant>,
82	<constant>GL_RGBA2</constant>,
83	<constant>GL_RGBA4</constant>,
84	<constant>GL_RGB5_A1</constant>,
85	<constant>GL_RGBA8</constant>,
86	<constant>GL_RGB10_A2</constant>,
87	<constant>GL_RGBA12</constant>,
88	<constant>GL_RGBA16</constant>,
89	<constant>GL_SRGB</constant>,
90	<constant>GL_SRGB8</constant>,
91	<constant>GL_SRGB_ALPHA</constant>, or
92	<constant>GL_SRGB8_ALPHA8</constant>.
93	</para>
94	</listitem>
95	</varlistentry>
96	<varlistentry>
97	<term><parameter>x</parameter></term>
98	<term><parameter>y</parameter></term>
99	<listitem>
100	<para>
101	Specify the window coordinates of the left corner
102	of the row of pixels to be copied.
103	</para>
104	</listitem>
105	</varlistentry>
106	<varlistentry>
107	<term><parameter>width</parameter></term>
108	<listitem>
109	<para>
110	Specifies the width of the texture image.
7faf1d71 AW	111	The height of the texture image is 1.
	112	</para>
	113	</listitem>
	114	</varlistentry>
	115	<varlistentry>
	116	<term><parameter>border</parameter></term>
	117	<listitem>
	118	<para>
c7b31271	119	Must be 0.
7faf1d71 AW	120	</para>
	121	</listitem>
	122	</varlistentry>
	123	</variablelist>
	124	</refsect1>
	125	<refsect1 id="description"><title>Description</title>
	126	<para>
	127	<function>glCopyTexImage1D</function> defines a one-dimensional texture image with pixels from the current
	128	<constant>GL_READ_BUFFER</constant>.
	129	</para>
	130	<para>
	131	The screen-aligned pixel row with left corner at
	132	<inlineequation><mml:math>
	133	<!-- eqn: (x, y): -->
	134	<mml:mfenced open="(" close=")">
	135	<mml:mi mathvariant="italic">x</mml:mi>
	136	<mml:mi mathvariant="italic">y</mml:mi>
	137	</mml:mfenced>
	138	</mml:math></inlineequation>
	139	and with a length of
	140	<inlineequation><mml:math>
c7b31271	141	<mml:mi mathvariant="italic">width</mml:mi>
7faf1d71 AW	142	</mml:math></inlineequation>
	143	defines the texture array
	144	at the mipmap level specified by <parameter>level</parameter>.
	145	<parameter>internalformat</parameter> specifies the internal format of the texture array.
	146	</para>
	147	<para>
	148	The pixels in the row are processed exactly as if
	149	<citerefentry><refentrytitle>glReadPixels</refentrytitle></citerefentry> had been called, but the process stops just before
	150	final conversion.
	151	At this point all pixel component values are clamped to the range
	152	<inlineequation><mml:math>
	153	<!-- eqn: [0,1]: -->
	154	<mml:mfenced open="[" close="]">
	155	<mml:mn>0</mml:mn>
	156	<mml:mn>1</mml:mn>
	157	</mml:mfenced>
	158	</mml:math></inlineequation>
	159	and then converted to the texture's internal format for storage in the texel
	160	array.
	161	</para>
	162	<para>
	163	Pixel ordering is such that lower
	164	<inlineequation><mml:math><mml:mi mathvariant="italic">x</mml:mi></mml:math></inlineequation>
	165	screen coordinates correspond to
	166	lower texture coordinates.
	167	</para>
	168	<para>
	169	If any of the pixels within the specified row of the current
	170	<constant>GL_READ_BUFFER</constant> are outside the window associated with the current
	171	rendering context, then the values obtained for those pixels are undefined.
	172	</para>
	173	<para>
	174	<function>glCopyTexImage1D</function> defines a one-dimensional texture image with pixels from the current
	175	<constant>GL_READ_BUFFER</constant>.
	176	</para>
	177	<para>
	178	When <parameter>internalformat</parameter> is one of the sRGB types, the GL does not automatically convert the source pixels to the sRGB color space. In this case, the <function>glPixelMap</function> function can be used to accomplish the conversion.
	179	</para>
	180	</refsect1>
	181	<refsect1 id="notes"><title>Notes</title>
	182	<para>
	183	1, 2, 3, and 4 are not accepted values for <parameter>internalformat</parameter>.
	184	</para>
	185	<para>
	186	An image with 0 width indicates a NULL texture.
	187	</para>
	188	</refsect1>
	189	<refsect1 id="errors"><title>Errors</title>
	190	<para>
	191	<constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> is not one of the allowable values.
	192	</para>
	193	<para>
	194	<constant>GL_INVALID_VALUE</constant> is generated if <parameter>level</parameter> is less than 0.
	195	</para>
	196	<para>
	197	<constant>GL_INVALID_VALUE</constant> may be generated if <parameter>level</parameter> is greater
	198	than
	199	<inlineequation><mml:math>
	200	<!-- eqn: log sub 2 max: -->
	201	<mml:mrow>
	202	<mml:msub><mml:mi mathvariant="italic">log</mml:mi>
	203	<mml:mn>2</mml:mn>
	204	</mml:msub>
	205	<mml:mo>⁢</mml:mo>
206	<mml:mi mathvariant="italic">max</mml:mi>
207	</mml:mrow>
208	</mml:math></inlineequation>,
209	where
210	<inlineequation><mml:math><mml:mi mathvariant="italic">max</mml:mi></mml:math></inlineequation>
211	is the returned value of <constant>GL_MAX_TEXTURE_SIZE</constant>.
212	</para>
213	<para>
214	<constant>GL_INVALID_VALUE</constant> is generated if <parameter>internalformat</parameter> is not an allowable value.
215	</para>
216	<para>
217	<constant>GL_INVALID_VALUE</constant> is generated if <parameter>width</parameter> is less than 0 or greater than
218	<constant>GL_MAX_TEXTURE_SIZE</constant>.
219	</para>
220	<para>
c7b31271	221	<constant>GL_INVALID_VALUE</constant> is generated if <parameter>border</parameter> is not 0.
7faf1d71 AW	222	</para>
	223	<para>
	224	<constant>GL_INVALID_OPERATION</constant> is generated if <parameter>internalformat</parameter> is
	225	<constant>GL_DEPTH_COMPONENT</constant>, <constant>GL_DEPTH_COMPONENT16</constant>,
	226	<constant>GL_DEPTH_COMPONENT24</constant>, or <constant>GL_DEPTH_COMPONENT32</constant> and there is no depth
	227	buffer.
	228	</para>
	229	</refsect1>
	230	<refsect1 id="associatedgets"><title>Associated Gets</title>
	231	<para>
	232	<citerefentry><refentrytitle>glGetTexImage</refentrytitle></citerefentry>
	233	</para>
	234	</refsect1>
	235	<refsect1 id="seealso"><title>See Also</title>
	236	<para>
	237	<citerefentry><refentrytitle>glCopyTexImage2D</refentrytitle></citerefentry>,
	238	<citerefentry><refentrytitle>glCopyTexSubImage1D</refentrytitle></citerefentry>,
	239	<citerefentry><refentrytitle>glCopyTexSubImage2D</refentrytitle></citerefentry>,
	240	<citerefentry><refentrytitle>glPixelStore</refentrytitle></citerefentry>,
	241	<citerefentry><refentrytitle>glTexImage1D</refentrytitle></citerefentry>,
	242	<citerefentry><refentrytitle>glTexImage2D</refentrytitle></citerefentry>,
	243	<citerefentry><refentrytitle>glTexSubImage1D</refentrytitle></citerefentry>,
	244	<citerefentry><refentrytitle>glTexSubImage2D</refentrytitle></citerefentry>,
	245	<citerefentry><refentrytitle>glTexParameter</refentrytitle></citerefentry>
	246	</para>
	247	</refsect1>
	248	<refsect1 id="Copyright"><title>Copyright</title>
	249	<para>
	250	Copyright <trademark class="copyright"></trademark> 1991-2006
c7b31271 DH	251	Silicon Graphics, Inc.
	252	Copyright <trademark class="copyright"></trademark> 2012-2013 Khronos Group.
	253	This document is licensed under the SGI
7faf1d71 AW	254	Free Software B License. For details, see
	255	<ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
	256	</para>
	257	</refsect1>
	258	</refentry>