rename upstream-man-pages to upstream-doc
[clinton/guile-figl.git] / upstream-doc / man3 / glBindRenderbuffer.xml
CommitLineData
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="glBindRenderbuffer">\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>glBindRenderbuffer</refentrytitle>\r
13 <manvolnum>3G</manvolnum>\r
14 </refmeta>\r
15 <refnamediv>\r
16 <refname>glBindRenderbuffer</refname>\r
17 <refpurpose>bind a renderbuffer to a renderbuffer target</refpurpose>\r
18 </refnamediv>\r
19 <refsynopsisdiv><title>C Specification</title>\r
20 <funcsynopsis>\r
21 <funcprototype>\r
22 <funcdef>void <function>glBindRenderbuffer</function></funcdef>\r
23 <paramdef>GLenum <parameter>target</parameter></paramdef>\r
24 <paramdef>GLuint <parameter>renderbuffer</parameter></paramdef>\r
25 </funcprototype>\r
26 </funcsynopsis>\r
27 </refsynopsisdiv>\r
28 <refsect1 id="parameters"><title>Parameters</title>\r
29 <variablelist>\r
30 <varlistentry>\r
31 <term><parameter>target</parameter></term>\r
32 <listitem>\r
33 <para>\r
34 Specifies the renderbuffer target of the binding operation. <parameter>target</parameter> must be <constant>GL_RENDERBUFFER</constant>.\r
35 </para>\r
36 </listitem>\r
37 </varlistentry>\r
38 <varlistentry>\r
39 <term><parameter>renderbuffer</parameter></term>\r
40 <listitem>\r
41 <para>\r
42 Specifies the name of the renderbuffer object to bind.\r
43 </para>\r
44 </listitem>\r
45 </varlistentry>\r
46 </variablelist>\r
47 </refsect1>\r
48 <refsect1 id="description"><title>Description</title>\r
49 <para>\r
50 <function>glBindRenderbuffer</function> binds the renderbuffer object with name <parameter>renderbuffer</parameter> to the renderbuffer target specified\r
51 by <parameter>target</parameter>. <parameter>target</parameter> must be <constant>GL_RENDERBUFFER</constant>. <parameter>renderbuffer</parameter>\r
52 is the name of a renderbuffer object previously returned from a call to <citerefentry><refentrytitle>glGenRenderbuffers</refentrytitle></citerefentry>,\r
53 or zero to break the existing binding of a renderbuffer object to <parameter>target</parameter>.\r
54 </para>\r
55 </refsect1>\r
56 <refsect1 id="errors"><title>Errors</title>\r
57 <para>\r
58 <constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> is not <constant>GL_RENDERBUFFER</constant>.\r
59 </para>\r
60 <para>\r
61 <constant>GL_INVALID_OPERATION</constant> is generated if <parameter>renderbuffer</parameter> is not zero or the name of a renderbuffer\r
62 previously returned from a call to <citerefentry><refentrytitle>glGenRenderbuffers</refentrytitle></citerefentry>.\r
63 </para>\r
64 </refsect1>\r
65 <refsect1 id="seealso"><title>See Also</title>\r
66 <para>\r
67 <citerefentry><refentrytitle>glGenRenderbuffers</refentrytitle></citerefentry>,\r
68 <citerefentry><refentrytitle>glDeleteRenderbuffers</refentrytitle></citerefentry>,\r
69 <citerefentry><refentrytitle>glRenderbufferStorage</refentrytitle></citerefentry>,\r
70 <citerefentry><refentrytitle>glRenderbufferStorageMultisample</refentrytitle></citerefentry>,\r
71 <citerefentry><refentrytitle>glIsRenderbuffer</refentrytitle></citerefentry>\r
72 </para>\r
73 </refsect1>\r
74 <refsect1 id="Copyright"><title>Copyright</title>\r
75 <para>\r
76 Copyright <trademark class="copyright"></trademark> 2010 Khronos Group.\r
77 This material may be distributed subject to the terms and conditions set forth in\r
78 the Open Publication License, v 1.0, 8 June 1999.\r
79 <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
80 </para>\r
81 </refsect1>\r
82</refentry>\r