<?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="glTexStorage3D">
    <refmeta>
        <refmetainfo>
            <copyright>
                <year>2011</year>
                <holder>Khronos Group</holder>
            </copyright>
        </refmetainfo>
        <refentrytitle>glTexStorage3D</refentrytitle>
        <manvolnum>3G</manvolnum>
    </refmeta>
    <refnamediv>
        <refname>glTexStorage3D</refname>
        <refpurpose>simultaneously specify storage for all levels of a three-dimensional, two-dimensional array or cube-map array texture</refpurpose>
    </refnamediv>
    <refsynopsisdiv><title>C Specification</title>
        <funcsynopsis>
            <funcprototype>
                <funcdef>void <function>glTexStorage3D</function></funcdef>
                <paramdef>GLenum <parameter>target</parameter></paramdef>
                <paramdef>GLsizei <parameter>levels</parameter></paramdef>
                <paramdef>GLenum <parameter>internalformat</parameter></paramdef>
                <paramdef>GLsizei <parameter>width</parameter></paramdef>
                <paramdef>GLsizei <parameter>height</parameter></paramdef>
                <paramdef>GLsizei <parameter>depth</parameter></paramdef>
            </funcprototype>
        </funcsynopsis>
    </refsynopsisdiv>
    <refsect1 id="parameters"><title>Parameters</title>
        <variablelist>
        <varlistentry>
            <term><parameter>target</parameter></term>
            <listitem>
                <para>
                    Specify the target of the operation. <parameter>target</parameter> must be
                    one of <constant>GL_TEXTURE_3D</constant>, <constant>GL_PROXY_TEXTURE_3D</constant>,
                    <constant>GL_TEXTURE_2D_ARRAY</constant>, <constant>GL_PROXY_TEXTURE_2D_ARRAY</constant>,
                    <constant>GL_TEXTURE_CUBE_ARRAY</constant>, or <constant>GL_PROXY_TEXTURE_CUBE_ARRAY</constant>.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>levels</parameter></term>
            <listitem>
                <para>
                    Specify the number of texture levels.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>internalformat</parameter></term>
            <listitem>
                <para>
                    Specifies the sized internal format to be used to store texture image data.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>width</parameter></term>
            <listitem>
                <para>
                    Specifies the width of the texture, in texels.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>height</parameter></term>
            <listitem>
                <para>
                    Specifies the height of the texture, in texels.
                </para>
            </listitem>
        </varlistentry>
        <varlistentry>
            <term><parameter>depth</parameter></term>
            <listitem>
                <para>
                    Specifies the depth of the texture, in texels.
                </para>
            </listitem>
        </varlistentry>
        </variablelist>
    </refsect1>
    <refsect1 id="description"><title>Description</title>
        <para>
            <function>glTexStorage3D</function> specifies the storage requirements for all levels
            of a three-dimensional, two-dimensional array or cube-map array texture simultaneously. Once a texture is specified with this
            command, the format and dimensions of all levels become immutable unless it is a proxy
            texture. The contents of the image may still be modified, however, its storage requirements
            may not change. Such a texture is referred to as an <emphasis>immutable-format</emphasis>
            texture.
        </para>
        <para>
            The behavior of <function>glTexStorage3D</function> depends on the <parameter>target</parameter> parameter.
            When <parameter>target</parameter> is <constant>GL_TEXTURE_3D</constant>, or <constant>GL_PROXY_TEXTURE_3D</constant>,
            calling <function>glTexStorage3D</function> is equivalent, assuming no errors are generated,
            to executing the following pseudo-code:
        </para>
<programlisting><![CDATA[    for (i = 0; i < levels; i++)
    {
        glTexImage3D(target, i, internalformat, width, height, depth, 0, format, type, NULL);
        width = max(1, (width / 2));
        height = max(1, (height / 2));
        depth = max(1, (depth / 2));
    }]]></programlisting>
        <para>
            When <parameter>target</parameter> is <constant>GL_TEXTURE_2D_ARRAY</constant>, <constant>GL_PROXY_TEXTURE_2D_ARRAY</constant>,
            <constant>GL_TEXTURE_CUBE_MAP_ARRAY</constant>, or <constant>GL_PROXY_TEXTURE_CUBE_MAP_ARRAY</constant>, <function>glTexStorage3D</function>
            is equivalent to:
        </para>
<programlisting><![CDATA[    for (i = 0; i < levels; i++)
    {
        glTexImage3D(target, i, internalformat, width, height, depth, 0, format, type, NULL);
        width = max(1, (width / 2));
        height = max(1, (height / 2));
    }]]></programlisting>
        <para>
            Since no texture data is actually provided, the values used in the pseudo-code
            for <parameter>format</parameter> and <parameter>type</parameter> are
            irrelevant and may be considered to be any values that are legal for the
            chosen <parameter>internalformat</parameter> enumerant. <parameter>internalformat</parameter>
            must be one of the sized internal formats given in Table 1 below, one of the sized depth-component
            formats <constant>GL_DEPTH_COMPONENT32F</constant>, <constant>GL_DEPTH_COMPONENT24</constant>, or
            <constant>GL_DEPTH_COMPONENT16</constant>, one of the combined depth-stencil formats,
            <constant>GL_DEPTH32F_STENCIL8</constant>, or <constant>GL_DEPTH24_STENCIL8</constant>, or the
            stencil-only format, <constant>GL_STENCIL_INDEX8</constant>. Upon success,
            the value of <constant>GL_TEXTURE_IMMUTABLE_FORMAT</constant> becomes
            <constant>GL_TRUE</constant>. The value of <constant>GL_TEXTURE_IMMUTABLE_FORMAT</constant>
            may be discovered by calling <citerefentry><refentrytitle>glGetTexParameter</refentrytitle></citerefentry>
            with <parameter>pname</parameter> set to <constant>GL_TEXTURE_IMMUTABLE_FORMAT</constant>.
            No further changes to the dimensions or format of the texture object may be
            made. Using any command that might alter the dimensions or format of the
            texture object (such as <citerefentry><refentrytitle>glTexImage3D</refentrytitle></citerefentry> or
            another call to <function>glTexStorage3D</function>) will result in the
            generation of a <constant>GL_INVALID_OPERATION</constant> error, even if it
            would not, in fact, alter the dimensions or format of the object.
        </para>
        <para>
            <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="internalformattable.xml" />
        </para>
    </refsect1>
    <refsect1 id="notes"><title>Notes</title>
        <para>
            <constant>GL_STENCIL_INDEX8</constant> is accepted for <parameter>internalformat</parameter>
            only if the GL version is 4.4 or higher.
        </para>
    </refsect1>
    <refsect1 id="errors"><title>Errors</title>
        <para>
            <constant>GL_INVALID_ENUM</constant> is generated if <parameter>internalformat</parameter> is not a
            valid sized internal format.
        </para>
        <para>
            <constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> is not
            one of the accepted target enumerants.
        </para>
        <para>
            <constant>GL_INVALID_VALUE</constant> is generated if <parameter>width</parameter> or <parameter>levels</parameter>
            are less than 1.
        </para>
        <para>
            <constant>GL_INVALID_OPERATION</constant> is generated if <parameter>target</parameter> is <constant>GL_TEXTURE_3D</constant>
            or <constant>GL_PROXY_TEXTURE_3D</constant> and <parameter>levels</parameter> is greater than <mml:math>
  <mml:mrow>
    <mml:mfenced open = '&lfloor;' close = '&rfloor;'>
      <mml:mrow>
        <mml:msub>
          <mml:mi>log</mml:mi>
          <mml:mn>2</mml:mn>
        </mml:msub>
        <mml:mfenced open = '(' close = ')'>
          <mml:mrow>
            <mml:mi>max</mml:mi>
            <mml:mfenced open = '(' close = ')'>
              <mml:mrow>
                <mml:mi>width</mml:mi>
                <mml:mo>,</mml:mo>
                <mml:mtext fontfamily='Times New Roman'>&nbsp;</mml:mtext>
                <mml:mi>height</mml:mi>
                <mml:mo>,</mml:mo>
                <mml:mtext fontfamily='Times New Roman'>&nbsp;</mml:mtext>
                <mml:mi>depth</mml:mi>
              </mml:mrow>
            </mml:mfenced>
          </mml:mrow>
        </mml:mfenced>
      </mml:mrow>
    </mml:mfenced>
    <mml:mo>+</mml:mo>
    <mml:mn>1</mml:mn>
  </mml:mrow>
</mml:math>.
        </para>
        <para>
            <constant>GL_INVALID_OPERATION</constant> is generated if <parameter>target</parameter> is <constant>GL_TEXTURE_2D_ARRAY</constant>,
            <constant>GL_PROXY_TEXTURE_2D_ARRAY</constant>, <constant>GL_TEXURE_CUBE_ARRAY</constant>, or <constant>GL_PROXY_TEXTURE_CUBE_MAP_ARRAY</constant>
            and <parameter>levels</parameter> is greater than <mml:math>
  <mml:mrow>
    <mml:mfenced open = '&lfloor;' close = '&rfloor;'>
      <mml:mrow>
        <mml:msub>
          <mml:mi>log</mml:mi>
          <mml:mn>2</mml:mn>
        </mml:msub>
        <mml:mfenced open = '(' close = ')'>
          <mml:mrow>
            <mml:mi>max</mml:mi>
            <mml:mfenced open = '(' close = ')'>
              <mml:mrow>
                <mml:mi>width</mml:mi>
                <mml:mo>,</mml:mo>
                <mml:mtext fontfamily='Times New Roman'>&nbsp;</mml:mtext>
                <mml:mi>height</mml:mi>
              </mml:mrow>
            </mml:mfenced>
          </mml:mrow>
        </mml:mfenced>
      </mml:mrow>
    </mml:mfenced>
    <mml:mo>+</mml:mo>
    <mml:mn>1</mml:mn>
  </mml:mrow>
</mml:math>.
    </para>
    </refsect1>
    <refsect1 id="seealso"><title>See Also</title>
        <para>
            <citerefentry><refentrytitle>glTexImage3D</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glTexStorage1D</refentrytitle></citerefentry>,
            <citerefentry><refentrytitle>glTexStorage2D</refentrytitle></citerefentry>.
        </para>
    </refsect1>
    <refsect1 id="Copyright"><title>Copyright</title>
        <para>
            Copyright <trademark class="copyright"></trademark> 2011 Khronos Group. 
            This material may be distributed subject to the terms and conditions set forth in 
            the Open Publication License, v 1.0, 8 June 1999.
            <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
        </para>
    </refsect1>
</refentry>
