upstream-man-pages/man4/glTexStorage2DMultisample.xml

   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="glTexStorage2DMultisample">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2012</year>
   9                 <holder>Khronos Group</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glTexStorage2DMultisample</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glTexStorage2DMultisample</refname>
  17         <refpurpose>specify storage for a two-dimensional multisample texture</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glTexStorage2DMultisample</function></funcdef>
  23                 <paramdef>GLenum <parameter>target</parameter></paramdef>
  24                 <paramdef>GLsizei <parameter>samples</parameter></paramdef>
  25                 <paramdef>GLenum <parameter>internalformat</parameter></paramdef>
  26                 <paramdef>GLsizei <parameter>width</parameter></paramdef>
  27                 <paramdef>GLsizei <parameter>height</parameter></paramdef>
  28                 <paramdef>GLboolean <parameter>fixedsamplelocations</parameter></paramdef>
  29             </funcprototype>
  30         </funcsynopsis>
  31     </refsynopsisdiv>
  32     <refsect1 id="parameters"><title>Parameters</title>
  33         <variablelist>
  34         <varlistentry>
  35             <term><parameter>target</parameter></term>
  36             <listitem>
  37                 <para>
  38                     Specify the target of the operation. <parameter>target</parameter> must be
  39                     <constant>GL_TEXTURE_2D_MULTISAMPLE</constant> or <constant>GL_PROXY_TEXTURE_2D_MULTISAMPLE</constant>.
  40                 </para>
  41             </listitem>
  42         </varlistentry>
  43         <varlistentry>
  44             <term><parameter>samples</parameter></term>
  45             <listitem>
  46                 <para>
  47                     Specify the number of samples in the texture.
  48                 </para>
  49             </listitem>
  50         </varlistentry>
  51         <varlistentry>
  52             <term><parameter>internalformat</parameter></term>
  53             <listitem>
  54                 <para>
  55                     Specifies the sized internal format to be used to store texture image data.
  56                 </para>
  57             </listitem>
  58         </varlistentry>
  59         <varlistentry>
  60             <term><parameter>width</parameter></term>
  61             <listitem>
  62                 <para>
  63                     Specifies the width of the texture, in texels.
  64                 </para>
  65             </listitem>
  66         </varlistentry>
  67         <varlistentry>
  68             <term><parameter>height</parameter></term>
  69             <listitem>
  70                 <para>
  71                     Specifies the height of the texture, in texels.
  72                 </para>
  73             </listitem>
  74         </varlistentry>
  75         <varlistentry>
  76             <term><parameter>fixedsamplelocations</parameter></term>
  77             <listitem>
  78                 <para>
  79                     Specifies whether the image will use identical sample locations and the same number of samples for all texels in the image, and the sample locations will not
  80                     depend on the internal format or size of the image.
  81                 </para>
  82             </listitem>
  83         </varlistentry>
  84         </variablelist>
  85     </refsect1>
  86     <refsect1 id="description"><title>Description</title>
  87         <para>
  88             <function>glTexStorage2DMultisample</function> specifies the storage requirements for
  89             a two-dimensional multisample texture. Once a texture is specified with this
  90             command, its format and dimensions become immutable unless it is a proxy
  91             texture. The contents of the image may still be modified, however, its storage requirements
  92             may not change. Such a texture is referred to as an <emphasis>immutable-format</emphasis>
  93             texture.
  94         </para>
  95         <para>
  96             <parameter>samples</parameter> specifies the number of samples to be used for the texture
  97             and must be greater than zero and less than or equal to the value of <constant>GL_MAX_SAMPLES</constant>.
  98             <parameter>internalformat</parameter> must be a color-renderable, depth-renderable, or stencil-renderable format.
  99             <parameter>width</parameter> and <parameter>height</parameter> specify the width and height,
 100             respectively, of the texture. If <parameter>fixedsamplelocations</parameter> is <constant>GL_TRUE</constant>,
 101             the image will use identical sample locations and the same number of samples for all texels in the image,
 102             and the sample locations will not depend on the internal format or size of the image.
 103         </para>
 104         <para>
 105             <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="internalformattable.xml" />
 106         </para>
 107     </refsect1>
 108     <refsect1 id="errors"><title>Errors</title>
 109         <para>
 110             <constant>GL_INVALID_ENUM</constant> is generated if <parameter>internalformat</parameter> is not a
 111             valid color-renderable, depth-renderable or stencil-renderable format.
 112         </para>
 113         <para>
 114             <constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> is not
 115             one of the accepted target enumerants.
 116         </para>
 117         <para>
 118             <constant>GL_INVALID_VALUE</constant> is generated if <parameter>width</parameter> or <parameter>height</parameter>
 119             are less than 1 or greater than the value of <constant>GL_MAX_TEXTURE_SIZE</constant>.
 120         </para>
 121         <para>
 122             <constant>GL_INVALID_VALUE</constant> is generated if <parameter>samples</parameter> is greater than the
 123             value of <constant>GL_MAX_SAMPLES</constant>.
 124         </para>
 125         <para>
 126             <constant>GL_INVALID_OPERATION</constant> is generated if the value of <constant>GL_TEXTURE_IMMUTABLE_FORMAT</constant>
 127             for the texture bound to <parameter>target</parameter> is not <constant>GL_FALSE</constant>.
 128         </para>
 129     </refsect1>
 130     <refsect1 id="seealso"><title>See Also</title>
 131         <para>
 132             <citerefentry><refentrytitle>glTexImage2D</refentrytitle></citerefentry>,
 133             <citerefentry><refentrytitle>glTexImage2DMultisample</refentrytitle></citerefentry>,
 134             <citerefentry><refentrytitle>glTexStorage1D</refentrytitle></citerefentry>,
 135             <citerefentry><refentrytitle>glTexStorage3D</refentrytitle></citerefentry>.
 136         </para>
 137     </refsect1>
 138     <refsect1 id="Copyright"><title>Copyright</title>
 139         <para>
 140             Copyright <trademark class="copyright"></trademark> 2012 Khronos Group.
 141             This material may be distributed subject to the terms and conditions set forth in
 142             the Open Publication License, v 1.0, 8 June 1999.
 143             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
 144         </para>
 145     </refsect1>
 146 </refentry>