HCoop / clinton / guile-figl.git / blame
| Commit | Line | Data |
|---|---|---|
| 7faf1d71 AW |
1 | <?xml version="1.0" encoding="UTF-8"?>\r |
| 2 | <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"\r | |
| 3 | "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">\r | |
| 4 | <refentry id="glGetMultisample">\r | |
| 5 | <refmeta>\r | |
| 6 | <refmetainfo>\r | |
| 7 | <copyright>\r | |
| 8 | <year>2010</year>\r | |
| 9 | <holder>Khronos Group</holder>\r | |
| 10 | </copyright>\r | |
| 11 | </refmetainfo>\r | |
| 12 | <refentrytitle>glGetMultisamplefv</refentrytitle>\r | |
| 13 | <manvolnum>3G</manvolnum>\r | |
| 14 | </refmeta>\r | |
| 15 | <refnamediv>\r | |
| 16 | <refname>glGetMultisamplefv</refname>\r | |
| 17 | <refpurpose>retrieve the location of a sample</refpurpose>\r | |
| 18 | </refnamediv>\r | |
| 19 | <refsynopsisdiv><title>C Specification</title>\r | |
| 20 | <funcsynopsis>\r | |
| 21 | <funcprototype>\r | |
| 22 | <funcdef>void <function>glGetMultisamplefv</function></funcdef>\r | |
| 23 | <paramdef>GLenum <parameter>pname</parameter></paramdef>\r | |
| 24 | <paramdef>GLuint <parameter>index</parameter></paramdef>\r | |
| 25 | <paramdef>GLfloat *<parameter>val</parameter></paramdef>\r | |
| 26 | </funcprototype>\r | |
| 27 | </funcsynopsis>\r | |
| 28 | </refsynopsisdiv>\r | |
| 29 | <!-- eqn: ignoring delim $$ -->\r | |
| 30 | <refsect1 id="parameters"><title>Parameters</title>\r | |
| 31 | <variablelist>\r | |
| 32 | <varlistentry>\r | |
| 33 | <term><parameter>pname</parameter></term>\r | |
| 34 | <listitem>\r | |
| 35 | <para>\r | |
| 36 | Specifies the sample parameter name. <parameter>pname</parameter> must be <constant>GL_SAMPLE_POSITION</constant>.\r | |
| 37 | </para>\r | |
| 38 | </listitem>\r | |
| 39 | </varlistentry>\r | |
| 40 | <varlistentry>\r | |
| 41 | <term><parameter>index</parameter></term>\r | |
| 42 | <listitem>\r | |
| 43 | <para>\r | |
| 44 | Specifies the index of the sample whose position to query.\r | |
| 45 | </para>\r | |
| 46 | </listitem>\r | |
| 47 | </varlistentry>\r | |
| 48 | <varlistentry>\r | |
| 49 | <term><parameter>val</parameter></term>\r | |
| 50 | <listitem>\r | |
| 51 | <para>\r | |
| 52 | Specifies the address of an array to receive the position of the sample.\r | |
| 53 | </para>\r | |
| 54 | </listitem>\r | |
| 55 | </varlistentry>\r | |
| 56 | </variablelist>\r | |
| 57 | </refsect1>\r | |
| 58 | <refsect1 id="description"><title>Description</title>\r | |
| 59 | <para>\r | |
| 60 | <function>glGetMultisamplefv</function> queries the location of a given sample. <parameter>pname</parameter>\r | |
| 61 | specifies the sample parameter to retrieve and must be <constant>GL_SAMPLE_POSITION</constant>. <parameter>index</parameter>\r | |
| 62 | corresponds to the sample for which the location should be returned. The sample location is returned as two floating-point\r | |
| 63 | values in <parameter>val[0]</parameter> and <parameter>val[1]</parameter>, each between 0 and 1, corresponding to the <parameter>x</parameter>\r | |
| 64 | and <parameter>y</parameter> locations respectively in the GL pixel space of that sample. (0.5, 0.5) this corresponds to the\r | |
| 65 | pixel center. <parameter>index</parameter> must be between zero and the value of <constant>GL_SAMPLES</constant> - 1.\r | |
| 66 | </para>\r | |
| 67 | <para>\r | |
| 68 | If the multisample mode does not have fixed sample locations, the returned values may only reflect the locations of samples\r | |
| 69 | within some pixels.\r | |
| 70 | </para>\r | |
| 71 | </refsect1>\r | |
| 72 | <refsect1 id="errors"><title>Errors</title>\r | |
| 73 | <para>\r | |
| 74 | <constant>GL_INVALID_ENUM</constant> is generated if <parameter>pname</parameter> is not one <constant>GL_SAMPLE_POSITION</constant>.\r | |
| 75 | </para>\r | |
| 76 | <para>\r | |
| 77 | <constant>GL_INVALID_VALUE</constant> is generated if <parameter>index</parameter> is greater than or equal to the value of\r | |
| 78 | <constant>GL_SAMPLES</constant>.\r | |
| 79 | </para>\r | |
| 80 | </refsect1>\r | |
| 81 | <refsect1 id="seealso"><title>See Also</title>\r | |
| 82 | <para>\r | |
| 83 | <citerefentry><refentrytitle>glGenFramebuffers</refentrytitle></citerefentry>,\r | |
| 84 | <citerefentry><refentrytitle>glBindFramebuffer</refentrytitle></citerefentry>\r | |
| 85 | </para>\r | |
| 86 | </refsect1>\r | |
| 87 | <refsect1 id="Copyright"><title>Copyright</title>\r | |
| 88 | <para>\r | |
| 89 | Copyright <trademark class="copyright"></trademark> 2010 Khronos Group. \r | |
| 90 | This material may be distributed subject to the terms and conditions set forth in \r | |
| 91 | the Open Publication License, v 1.0, 8 June 1999.\r | |
| 92 | <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r | |
| 93 | </para>\r | |
| 94 | </refsect1>\r | |
| 95 | </refentry>\r |