rename upstream-man-pages to upstream-doc

[clinton/guile-figl.git] / upstream-doc / man4 / glInvalidateTexImage.xml

<?xml version="1.0" encoding="UTF-8"?>\r
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"\r
              "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">\r
<refentry id="glInvalidateTexImage">\r
    <refmeta>\r
        <refmetainfo>\r
            <copyright>\r
                <year>2012</year>\r
                <holder>Khronos Group</holder>\r
            </copyright>\r
        </refmetainfo>\r
        <refentrytitle>glInvalidateTexImage</refentrytitle>\r
        <manvolnum>3G</manvolnum>\r
    </refmeta>\r
    <refnamediv>\r
        <refname>glInvalidateTexImage</refname>\r
        <refpurpose>invalidate the entirety a texture image</refpurpose>\r
    </refnamediv>\r
    <refsynopsisdiv><title>C Specification</title>\r
        <funcsynopsis>\r
            <funcprototype>\r
                <funcdef>void <function>glInvalidateTexImage</function></funcdef>\r
                <paramdef>GLuint <parameter>texture</parameter></paramdef>\r
                <paramdef>GLint <parameter>level</parameter></paramdef>\r
            </funcprototype>\r
        </funcsynopsis>\r
    </refsynopsisdiv>\r
    <refsect1 id="parameters"><title>Parameters</title>\r
        <variablelist>\r
        <varlistentry>\r
            <term><parameter>texture</parameter></term>\r
            <listitem>\r
                <para>\r
                    The name of a texture object to invalidate.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>level</parameter></term>\r
            <listitem>\r
                <para>\r
                    The level of detail of the texture object to invalidate.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        </variablelist>\r
    </refsect1>\r
    <refsect1 id="description"><title>Description</title>\r
        <para>\r
            <function>glInvalidateTexSubImage</function> invalidates all of\r
            a texture image. <parameter>texture</parameter> and <parameter>level</parameter> indicated\r
            which texture image is being invalidated. After this command, data in the texture image has undefined\r
            values.\r
        </para>\r
        <para>\r
            <parameter>level</parameter> must be greater than or equal to zero and be\r
            less than the base 2 logarithm of the maximum texture width, height, or depth.\r
        </para>\r
        <para>\r
            For textures of targets <constant>GL_TEXTURE_RECTANGLE</constant>, <constant>GL_TEXTURE_BUFFER</constant>, <constant>GL_TEXTURE_2D_MULTISAMPLE</constant>, or\r
            <constant>GL_TEXTURE_2D_MULTISAMPLE_ARRAY</constant>, level must be zero.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="errors"><title>Errors</title>\r
        <para>\r
            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>level</parameter> is\r
            less than zero or if it is greater or equal to the base 2 logarithm of the maximum texture width, height, or depth.\r
        </para>\r
        <para>\r
            <constant>GL_INVALID_VALUE</constant> is generated if the target of <parameter>texture</parameter>\r
            is any of <constant>GL_TEXTURE_RECTANGLE</constant>, <constant>GL_TEXTURE_BUFFER</constant>, <constant>GL_TEXTURE_2D_MULTISAMPLE</constant>, or\r
            <constant>GL_TEXTURE_2D_MULTISAMPLE_ARRAY</constant> and <parameter>level</parameter> is not zero.\r
        </para>\r
        <para>\r
            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>texture</parameter> is not the\r
            name of an existing texture object.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="associatedgets"><title>Associated Gets</title>\r
        <para>\r
            <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_MAX_TEXTURE_SIZE</constant>\r
        </para>\r
    </refsect1>\r
    <refsect1 id="seealso"><title>See Also</title>\r
        <para>\r
            <citerefentry><refentrytitle>glInvalidateTexSubImage</refentrytitle></citerefentry>,,\r
            <citerefentry><refentrytitle>glInvalidateBufferSubData</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glInvalidateBufferData</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glInvalidateFramebuffer</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glInvalidateSubFramebuffer</refentrytitle></citerefentry>.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="Copyright"><title>Copyright</title>\r
        <para>\r
            Copyright <trademark class="copyright"></trademark> 2012 Khronos Group. \r
            This material may be distributed subject to the terms and conditions set forth in \r
            the Open Publication License, v 1.0, 8 June 1999.\r
            <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
        </para>\r
    </refsect1>\r
</refentry>\r