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="glGenFramebuffers">\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>glGenFramebuffers</refentrytitle>\r | |
| 13 | <manvolnum>3G</manvolnum>\r | |
| 14 | </refmeta>\r | |
| 15 | <refnamediv>\r | |
| 16 | <refname>glGenFramebuffers</refname>\r | |
| 17 | <refpurpose>generate framebuffer object names</refpurpose>\r | |
| 18 | </refnamediv>\r | |
| 19 | <refsynopsisdiv><title>C Specification</title>\r | |
| 20 | <funcsynopsis>\r | |
| 21 | <funcprototype>\r | |
| 22 | <funcdef>void <function>glGenFramebuffers</function></funcdef>\r | |
| 23 | <paramdef>GLsizei <parameter>n</parameter></paramdef>\r | |
| 24 | <paramdef>GLuint *<parameter>ids</parameter></paramdef>\r | |
| 25 | </funcprototype>\r | |
| 26 | </funcsynopsis>\r | |
| 27 | </refsynopsisdiv>\r | |
| 28 | <!-- eqn: ignoring delim $$ -->\r | |
| 29 | <refsect1 id="parameters"><title>Parameters</title>\r | |
| 30 | <variablelist>\r | |
| 31 | <varlistentry>\r | |
| 32 | <term><parameter>n</parameter></term>\r | |
| 33 | <listitem>\r | |
| 34 | <para>\r | |
| 35 | Specifies the number of framebuffer object names to generate.\r | |
| 36 | </para>\r | |
| 37 | </listitem>\r | |
| 38 | </varlistentry>\r | |
| 39 | <varlistentry>\r | |
| 40 | <term><parameter>ids</parameter></term>\r | |
| 41 | <listitem>\r | |
| 42 | <para>\r | |
| 43 | Specifies an array in which the generated framebuffer object names are stored.\r | |
| 44 | </para>\r | |
| 45 | </listitem>\r | |
| 46 | </varlistentry>\r | |
| 47 | </variablelist>\r | |
| 48 | </refsect1>\r | |
| 49 | <refsect1 id="description"><title>Description</title>\r | |
| 50 | <para>\r | |
| 51 | <function>glGenFramebuffers</function> returns <parameter>n</parameter> framebuffer object names in <parameter>ids</parameter>.\r | |
| 52 | There is no guarantee that the names form a contiguous set of integers; however, it is guaranteed that none of the returned names\r | |
| 53 | was in use immediately before the call to <function>glGenFramebuffers</function>.\r | |
| 54 | </para>\r | |
| 55 | <para>\r | |
| 56 | Framebuffer object names returned by a call to <function>glGenFramebuffers</function> are not returned by subsequent calls, unless\r | |
| 57 | they are first deleted with <citerefentry><refentrytitle>glDeleteFramebuffers</refentrytitle></citerefentry>.\r | |
| 58 | </para>\r | |
| 59 | <para>\r | |
| 60 | The names returned in <parameter>ids</parameter> are marked as used, for the purposes of <function>glGenFramebuffers</function> only,\r | |
| 61 | but they acquire state and type only when they are first bound.\r | |
| 62 | </para>\r | |
| 63 | </refsect1>\r | |
| 64 | <refsect1 id="errors"><title>Errors</title>\r | |
| 65 | <para>\r | |
| 66 | <constant>GL_INVALID_VALUE</constant> is generated if <parameter>n</parameter> is negative.\r | |
| 67 | </para>\r | |
| 68 | </refsect1>\r | |
| 69 | <refsect1 id="seealso"><title>See Also</title>\r | |
| 70 | <para>\r | |
| 71 | <citerefentry><refentrytitle>glBindFramebuffer</refentrytitle></citerefentry>,\r | |
| 72 | <citerefentry><refentrytitle>glDeleteFramebuffers</refentrytitle></citerefentry>\r | |
| 73 | </para>\r | |
| 74 | </refsect1>\r | |
| 75 | <refsect1 id="Copyright"><title>Copyright</title>\r | |
| 76 | <para>\r | |
| 77 | Copyright <trademark class="copyright"></trademark> 2010 Khronos Group. \r | |
| 78 | This material may be distributed subject to the terms and conditions set forth in \r | |
| 79 | the Open Publication License, v 1.0, 8 June 1999.\r | |
| 80 | <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r | |
| 81 | </para>\r | |
| 82 | </refsect1>\r | |
| 83 | </refentry>\r |