[clinton/guile-figl.git] / upstream-doc / man3 / glFramebufferRenderbuffer.xml

<?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="glFramebufferRenderbuffer">\r
    <refmeta>\r
        <refmetainfo>\r
            <copyright>\r
                <year>2010</year>\r
                <holder>Khronos Group</holder>\r
            </copyright>\r
        </refmetainfo>\r
        <refentrytitle>glFramebufferRenderbuffer</refentrytitle>\r
        <manvolnum>3G</manvolnum>\r
    </refmeta>\r
    <refnamediv>\r
        <refname>glFramebufferRenderbuffer</refname>\r
        <refpurpose>attach a renderbuffer as a logical buffer to the currently bound framebuffer object</refpurpose>\r
    </refnamediv>\r
    <refsynopsisdiv><title>C Specification</title>\r
        <funcsynopsis>\r
            <funcprototype>\r
                <funcdef>void <function>glFramebufferRenderbuffer</function></funcdef>\r
                <paramdef>GLenum <parameter>target</parameter></paramdef>\r
                <paramdef>GLenum <parameter>attachment</parameter></paramdef>\r
                <paramdef>GLenum <parameter>renderbuffertarget</parameter></paramdef>\r
                <paramdef>GLuint <parameter>renderbuffer</parameter></paramdef>\r
            </funcprototype>\r
        </funcsynopsis>\r
    </refsynopsisdiv>\r
    <!-- eqn: ignoring delim $$ -->\r
    <refsect1 id="parameters"><title>Parameters</title>\r
        <variablelist>\r
        <varlistentry>\r
            <term><parameter>target</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the framebuffer target. <parameter>target</parameter> must be <constant>GL_DRAW_FRAMEBUFFER</constant>,\r
                    <constant>GL_READ_FRAMEBUFFER</constant>, or <constant>GL_FRAMEBUFFER</constant>. <constant>GL_FRAMEBUFFER</constant>\r
                    is equivalent to <constant>GL_DRAW_FRAMEBUFFER</constant>.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>attachment</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the attachment point of the framebuffer.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>renderbuffertarget</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the renderbuffer target and must be <constant>GL_RENDERBUFFER</constant>.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        <varlistentry>\r
            <term><parameter>renderbuffer</parameter></term>\r
            <listitem>\r
                <para>\r
                    Specifies the name of an existing renderbuffer object of type <parameter>renderbuffertarget</parameter> to attach.\r
                </para>\r
            </listitem>\r
        </varlistentry>\r
        </variablelist>\r
    </refsect1>\r
    <refsect1 id="description"><title>Description</title>\r
        <para>\r
            <function>glFramebufferRenderbuffer</function> attaches a renderbuffer as one of the logical buffers of the\r
            currently bound framebuffer object. <parameter>renderbuffer</parameter> is the name of the renderbuffer object\r
            to attach and must be either zero, or the name of an existing renderbuffer object of type <parameter>renderbuffertarget</parameter>.\r
            If <parameter>renderbuffer</parameter> is not zero and if <function>glFramebufferRenderbuffer</function> is\r
            successful, then the renderbuffer name <parameter>renderbuffer</parameter> will be used as the logical buffer\r
            identified by <parameter>attachment</parameter> of the framebuffer currently bound to <parameter>target</parameter>.\r
        </para>\r
        <para>\r
            The value of <constant>GL_FRAMEBUFFER_ATTACHMENT_OBJECT_TYPE</constant> for the specified attachment point is\r
            set to <constant>GL_RENDERBUFFER</constant> and the value of <constant>GL_FRAMEBUFFER_ATTACHMENT_OBJECT_NAME</constant>\r
            is set to <parameter>renderbuffer</parameter>. All other state values of the attachment point specified by\r
            <parameter>attachment</parameter> are set to their default values. No change is made to the state of the renderbuuffer\r
            object and any previous attachment to the <parameter>attachment</parameter> logical buffer of the framebuffer\r
            <parameter>target</parameter> is broken.\r
        </para>\r
        <para>\r
            Calling <function>glFramebufferRenderbuffer</function> with the renderbuffer name zero will detach the image, if any,\r
            identified by <parameter>attachment</parameter>, in the framebuffer currently bound to <parameter>target</parameter>.\r
            All state values of the attachment point specified by attachment in the object bound to target are set to their default values.\r
        </para>\r
        <para>\r
            Setting <parameter>attachment</parameter> to the value <constant>GL_DEPTH_STENCIL_ATTACHMENT</constant> is a special\r
            case causing both the depth and stencil attachments of the framebuffer object to be set to <parameter>renderbuffer</parameter>,\r
            which should have the base internal format <constant>GL_DEPTH_STENCIL</constant>.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="errors"><title>Errors</title>\r
        <para>\r
            <constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> is not one of the accepted tokens.\r
        </para>\r
        <para>\r
            <constant>GL_INVALID_ENUM</constant> is generated if <parameter>renderbuffertarget</parameter> is not <constant>GL_RENDERBUFFER</constant>.\r
        </para>\r
        <para>\r
            <constant>GL_INVALID_OPERATION</constant> is generated if zero is bound to <parameter>target</parameter>.\r
        </para>\r
    </refsect1>\r
    <refsect1 id="seealso"><title>See Also</title>\r
        <para>\r
            <citerefentry><refentrytitle>glGenFramebuffers</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glBindFramebuffer</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glGenRenderbuffers</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glFramebufferTexture</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glFramebufferTexture1D</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glFramebufferTexture2D</refentrytitle></citerefentry>,\r
            <citerefentry><refentrytitle>glFramebufferTexture3D</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
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="glFramebufferRenderbuffer">\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>glFramebufferRenderbuffer</refentrytitle>\r
	13	<manvolnum>3G</manvolnum>\r
	14	</refmeta>\r
	15	<refnamediv>\r
	16	<refname>glFramebufferRenderbuffer</refname>\r
	17	<refpurpose>attach a renderbuffer as a logical buffer to the currently bound framebuffer object</refpurpose>\r
	18	</refnamediv>\r
	19	<refsynopsisdiv><title>C Specification</title>\r
	20	<funcsynopsis>\r
	21	<funcprototype>\r
	22	<funcdef>void <function>glFramebufferRenderbuffer</function></funcdef>\r
	23	<paramdef>GLenum <parameter>target</parameter></paramdef>\r
	24	<paramdef>GLenum <parameter>attachment</parameter></paramdef>\r
	25	<paramdef>GLenum <parameter>renderbuffertarget</parameter></paramdef>\r
	26	<paramdef>GLuint <parameter>renderbuffer</parameter></paramdef>\r
	27	</funcprototype>\r
	28	</funcsynopsis>\r
	29	</refsynopsisdiv>\r
	30	<!-- eqn: ignoring delim $$ -->\r
	31	<refsect1 id="parameters"><title>Parameters</title>\r
	32	<variablelist>\r
	33	<varlistentry>\r
	34	<term><parameter>target</parameter></term>\r
	35	<listitem>\r
	36	<para>\r
	37	Specifies the framebuffer target. <parameter>target</parameter> must be <constant>GL_DRAW_FRAMEBUFFER</constant>,\r
	38	<constant>GL_READ_FRAMEBUFFER</constant>, or <constant>GL_FRAMEBUFFER</constant>. <constant>GL_FRAMEBUFFER</constant>\r
	39	is equivalent to <constant>GL_DRAW_FRAMEBUFFER</constant>.\r
	40	</para>\r
	41	</listitem>\r
	42	</varlistentry>\r
	43	<varlistentry>\r
	44	<term><parameter>attachment</parameter></term>\r
	45	<listitem>\r
	46	<para>\r
	47	Specifies the attachment point of the framebuffer.\r
	48	</para>\r
	49	</listitem>\r
	50	</varlistentry>\r
	51	<varlistentry>\r
	52	<term><parameter>renderbuffertarget</parameter></term>\r
	53	<listitem>\r
	54	<para>\r
	55	Specifies the renderbuffer target and must be <constant>GL_RENDERBUFFER</constant>.\r
	56	</para>\r
	57	</listitem>\r
	58	</varlistentry>\r
	59	<varlistentry>\r
	60	<term><parameter>renderbuffer</parameter></term>\r
	61	<listitem>\r
	62	<para>\r
	63	Specifies the name of an existing renderbuffer object of type <parameter>renderbuffertarget</parameter> to attach.\r
	64	</para>\r
65	</listitem>\r
66	</varlistentry>\r
67	</variablelist>\r
68	</refsect1>\r
69	<refsect1 id="description"><title>Description</title>\r
70	<para>\r
71	<function>glFramebufferRenderbuffer</function> attaches a renderbuffer as one of the logical buffers of the\r
72	currently bound framebuffer object. <parameter>renderbuffer</parameter> is the name of the renderbuffer object\r
73	to attach and must be either zero, or the name of an existing renderbuffer object of type <parameter>renderbuffertarget</parameter>.\r
74	If <parameter>renderbuffer</parameter> is not zero and if <function>glFramebufferRenderbuffer</function> is\r
75	successful, then the renderbuffer name <parameter>renderbuffer</parameter> will be used as the logical buffer\r
76	identified by <parameter>attachment</parameter> of the framebuffer currently bound to <parameter>target</parameter>.\r
77	</para>\r
78	<para>\r
79	The value of <constant>GL_FRAMEBUFFER_ATTACHMENT_OBJECT_TYPE</constant> for the specified attachment point is\r
80	set to <constant>GL_RENDERBUFFER</constant> and the value of <constant>GL_FRAMEBUFFER_ATTACHMENT_OBJECT_NAME</constant>\r
81	is set to <parameter>renderbuffer</parameter>. All other state values of the attachment point specified by\r
82	<parameter>attachment</parameter> are set to their default values. No change is made to the state of the renderbuuffer\r
83	object and any previous attachment to the <parameter>attachment</parameter> logical buffer of the framebuffer\r
84	<parameter>target</parameter> is broken.\r
85	</para>\r
86	<para>\r
87	Calling <function>glFramebufferRenderbuffer</function> with the renderbuffer name zero will detach the image, if any,\r
88	identified by <parameter>attachment</parameter>, in the framebuffer currently bound to <parameter>target</parameter>.\r
89	All state values of the attachment point specified by attachment in the object bound to target are set to their default values.\r
90	</para>\r
91	<para>\r
92	Setting <parameter>attachment</parameter> to the value <constant>GL_DEPTH_STENCIL_ATTACHMENT</constant> is a special\r
93	case causing both the depth and stencil attachments of the framebuffer object to be set to <parameter>renderbuffer</parameter>,\r
94	which should have the base internal format <constant>GL_DEPTH_STENCIL</constant>.\r
95	</para>\r
96	</refsect1>\r
97	<refsect1 id="errors"><title>Errors</title>\r
98	<para>\r
99	<constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> is not one of the accepted tokens.\r
100	</para>\r
101	<para>\r
102	<constant>GL_INVALID_ENUM</constant> is generated if <parameter>renderbuffertarget</parameter> is not <constant>GL_RENDERBUFFER</constant>.\r
103	</para>\r
104	<para>\r
105	<constant>GL_INVALID_OPERATION</constant> is generated if zero is bound to <parameter>target</parameter>.\r
106	</para>\r
107	</refsect1>\r
108	<refsect1 id="seealso"><title>See Also</title>\r
109	<para>\r
110	<citerefentry><refentrytitle>glGenFramebuffers</refentrytitle></citerefentry>,\r
111	<citerefentry><refentrytitle>glBindFramebuffer</refentrytitle></citerefentry>,\r
112	<citerefentry><refentrytitle>glGenRenderbuffers</refentrytitle></citerefentry>,\r
113	<citerefentry><refentrytitle>glFramebufferTexture</refentrytitle></citerefentry>,\r
114	<citerefentry><refentrytitle>glFramebufferTexture1D</refentrytitle></citerefentry>,\r
115	<citerefentry><refentrytitle>glFramebufferTexture2D</refentrytitle></citerefentry>,\r
116	<citerefentry><refentrytitle>glFramebufferTexture3D</refentrytitle></citerefentry>\r
117	</para>\r
118	</refsect1>\r
119	<refsect1 id="Copyright"><title>Copyright</title>\r
120	<para>\r
121	Copyright <trademark class="copyright"></trademark> 2010 Khronos Group. \r
122	This material may be distributed subject to the terms and conditions set forth in \r
123	the Open Publication License, v 1.0, 8 June 1999.\r
124	<ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.\r
125	</para>\r
126	</refsect1>\r
127	</refentry>\r