--- /dev/null
+<?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="glTexImage2DMultisample">\r
+ <refmeta>\r
+ <refmetainfo>\r
+ <copyright>\r
+ <year>2010</year>\r
+ <holder>Khronos Group</holder>\r
+ </copyright>\r
+ </refmetainfo>\r
+ <refentrytitle>glTexImage2DMultisample</refentrytitle>\r
+ <manvolnum>3G</manvolnum>\r
+ </refmeta>\r
+ <refnamediv>\r
+ <refname>glTexImage2DMultisample</refname>\r
+ <refpurpose>establish the data storage, format, dimensions, and number of samples of a multisample texture's image</refpurpose>\r
+ </refnamediv>\r
+ <refsynopsisdiv><title>C Specification</title>\r
+ <funcsynopsis>\r
+ <funcprototype>\r
+ <funcdef>void <function>glTexImage2DMultisample</function></funcdef>\r
+ <paramdef>GLenum <parameter>target</parameter></paramdef>\r
+ <paramdef>GLsizei <parameter>samples</parameter></paramdef>\r
+ <paramdef>GLint <parameter>internalformat</parameter></paramdef>\r
+ <paramdef>GLsizei <parameter>width</parameter></paramdef>\r
+ <paramdef>GLsizei <parameter>height</parameter></paramdef>\r
+ <paramdef>GLboolean <parameter>fixedsamplelocations</parameter></paramdef>\r
+ </funcprototype>\r
+ </funcsynopsis>\r
+ </refsynopsisdiv>\r
+ <refsect1 id="parameters"><title>Parameters</title>\r
+ <variablelist>\r
+ <varlistentry>\r
+ <term><parameter>target</parameter></term>\r
+ <listitem>\r
+ <para>\r
+ Specifies the target of the operation. <parameter>target</parameter> must be <constant>GL_TEXTURE_2D_MULTISAMPLE</constant> or <constant>GL_PROXY_TEXTURE_2D_MULTISAMPLE</constant>.\r
+ </para>\r
+ </listitem>\r
+ </varlistentry>\r
+ <varlistentry>\r
+ <term><parameter>samples</parameter></term>\r
+ <listitem>\r
+ <para>\r
+ The number of samples in the multisample texture's image.\r
+ </para>\r
+ </listitem>\r
+ </varlistentry>\r
+ <varlistentry>\r
+ <term><parameter>internalformat</parameter></term>\r
+ <listitem>\r
+ <para>\r
+ The internal format to be used to store the multisample texture's image. <parameter>internalformat</parameter> must specify a color-renderable, depth-renderable, or stencil-renderable format.\r
+ </para>\r
+ </listitem>\r
+ </varlistentry>\r
+ <varlistentry>\r
+ <term><parameter>width</parameter></term>\r
+ <listitem>\r
+ <para>\r
+ The width of the multisample texture's image, in texels.\r
+ </para>\r
+ </listitem>\r
+ </varlistentry>\r
+ <varlistentry>\r
+ <term><parameter>height</parameter></term>\r
+ <listitem>\r
+ <para>\r
+ The height of the multisample texture's image, in texels.\r
+ </para>\r
+ </listitem>\r
+ </varlistentry>\r
+ <varlistentry>\r
+ <term><parameter>fixedsamplelocations</parameter></term>\r
+ <listitem>\r
+ <para>\r
+ 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\r
+ depend on the internal format or size of the image.\r
+ </para>\r
+ </listitem>\r
+ </varlistentry>\r
+ </variablelist>\r
+ </refsect1>\r
+ <refsect1 id="description"><title>Description</title>\r
+ <para>\r
+ <function>glTexImage2DMultisample</function> establishes the data storage, format, dimensions and number of samples of a multisample texture's image.\r
+ </para>\r
+ <para>\r
+ <parameter>target</parameter> must be <constant>GL_TEXTURE_2D_MULTISAMPLE</constant> or <constant>GL_PROXY_TEXTURE_2D_MULTISAMPLE</constant>.\r
+ <parameter>width</parameter> and <parameter>height</parameter> are the dimensions in texels of the texture, and must be in the range zero\r
+ to <constant>GL_MAX_TEXTURE_SIZE</constant> - 1. <parameter>samples</parameter> specifies the number of samples in the image and must be\r
+ in the range zero to <constant>GL_MAX_SAMPLES</constant> - 1.\r
+ </para>\r
+ <para>\r
+ <parameter>internalformat</parameter> must be a color-renderable, depth-renderable, or stencil-renderable format.\r
+ </para>\r
+ <para>\r
+ If <parameter>fixedsamplelocations</parameter> is <constant>GL_TRUE</constant>, the image will use identical sample locations and the same\r
+ number of samples for all texels in the image, and the sample locations will not depend on the internal format or size of the image.\r
+ </para>\r
+ <para>\r
+ When a multisample texture is accessed in a shader, the access takes one vector of integers describing which texel to fetch and an integer\r
+ corresponding to the sample numbers describing which sample within the texel to fetch. No standard sampling instructions are allowed on the\r
+ multisample texture targets.\r
+ </para>\r
+ </refsect1>\r
+ <refsect1 id="notes"><title>Notes</title>\r
+ <para>\r
+ <function>glTexImage2DMultisample</function> is available only if the GL version is 3.2 or greater.\r
+ </para>\r
+ </refsect1>\r
+ <refsect1 id="errors"><title>Errors</title>\r
+ <para>\r
+ <constant>GL_INVALID_OPERATION</constant> is generated if <parameter>internalformat</parameter> is a depth- or stencil-renderable format and <parameter>samples</parameter>\r
+ is greater than the value of <constant>GL_MAX_DEPTH_TEXTURE_SAMPLES</constant>.\r
+ </para>\r
+ <para>\r
+ <constant>GL_INVALID_OPERATION</constant> is generated if <parameter>internalformat</parameter> is a color-renderable format and <parameter>samples</parameter> is\r
+ greater than the value of <constant>GL_MAX_COLOR_TEXTURE_SAMPLES</constant>.\r
+ </para>\r
+ <para>\r
+ <constant>GL_INVALID_OPERATION</constant> is generated if <parameter>internalformat</parameter> is a signed or unsigned integer format and <parameter>samples</parameter>\r
+ is greater than the value of <constant>GL_MAX_INTEGER_SAMPLES</constant>.\r
+ </para>\r
+ <para>\r
+ <constant>GL_INVALID_VALUE</constant> is generated if either <parameter>width</parameter> or <parameter>height</parameter> negative or is greater than <constant>GL_MAX_TEXTURE_SIZE</constant>.\r
+ </para>\r
+ <para>\r
+ <constant>GL_INVALID_VALUE</constant> is generated if <parameter>samples</parameter> is greater than <constant>GL_MAX_SAMPLES</constant>.\r
+ </para>\r
+ </refsect1>\r
+ <refsect1 id="seealso"><title>See Also</title>\r
+ <para>\r
+ <citerefentry><refentrytitle>glTexImage3D</refentrytitle></citerefentry>,\r
+ <citerefentry><refentrytitle>glTexImage2DMultisample</refentrytitle></citerefentry>\r
+ </para>\r
+ </refsect1>\r
+ <refsect1 id="Copyright"><title>Copyright</title>\r
+ <para>\r
+ Copyright <trademark class="copyright"></trademark> 2010 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
HCoop / clinton / guile-figl.git / blobdiff