upstream-man-pages/man4/glBindTransformFeedback.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
   3               "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
   4 <refentry id="glBindTransformFeedback">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>2010</year>
   9                 <holder>Khronos Group.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glBindTransformFeedback</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glBindTransformFeedback</refname>
  17         <refpurpose>bind a transform feedback object</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void <function>glBindTransformFeedback</function></funcdef>
  23                 <paramdef>GLenum <parameter>target</parameter></paramdef>
  24                 <paramdef>GLuint <parameter>id</parameter></paramdef>
  25             </funcprototype>
  26         </funcsynopsis>
  27     </refsynopsisdiv>
  28     <!-- eqn: ignoring delim $$ -->
  29     <refsect1 id="parameters"><title>Parameters</title>
  30         <variablelist>
  31         <varlistentry>
  32             <term><parameter>target</parameter></term>
  33             <listitem>
  34                 <para>
  35                     Specifies the target to which to bind the transform feedback object <parameter>id</parameter>. <parameter>target</parameter>
  36                     must be <constant>GL_TRANSFORM_FEEDBACK</constant>.
  37                 </para>
  38             </listitem>
  39         </varlistentry>
  40         <varlistentry>
  41             <term><parameter>id</parameter></term>
  42             <listitem>
  43                 <para>
  44                     Specifies the name of a transform feedback object reserved by <citerefentry><refentrytitle>glGenTransformFeedbacks</refentrytitle></citerefentry>.
  45                 </para>
  46             </listitem>
  47         </varlistentry>
  48         </variablelist>
  49     </refsect1>
  50     <refsect1 id="description"><title>Description</title>
  51         <para>
  52             <function>glBindTransformFeedback</function> binds the transform feedback object with name <parameter>id</parameter> to the current
  53             GL state. <parameter>id</parameter> must be a name previously returned from a call to
  54             <citerefentry><refentrytitle>glGenTransformFeedbacks</refentrytitle></citerefentry>. If <parameter>id</parameter> has not
  55             previously been bound, a new transform feedback object with name <parameter>id</parameter> and initialized with with the
  56             default transform state vector is created.
  57         </para>
  58         <para>
  59             In the initial state, a default transform feedback object is bound and treated as
  60             a transform feedback object with a name of zero. If the name zero is subsequently bound, the default
  61             transform feedback object is again bound to the GL state.
  62         </para>
  63         <para>
  64             While a transform feedback buffer object is bound, GL operations on the target
  65             to which it is bound affect the bound transform feedback object, and queries of the
  66             target to which a transform feedback object is bound return state from the bound
  67             object. When buffer objects are bound for transform feedback, they are attached to
  68             the currently bound transform feedback object. Buffer objects are used for trans-
  69             form feedback only if they are attached to the currently bound transform feedback
  70             object.
  71         </para>
  72     </refsect1>
  73     <refsect1 id="errors"><title>Errors</title>
  74         <para>
  75             <constant>GL_INVALID_ENUM</constant> is generated if <parameter>target</parameter> is not <constant>GL_TRANSFORM_FEEDBACK</constant>.
  76         </para>
  77         <para>
  78             <constant>GL_INVALID_OPERATION</constant> is generated if the transform feedback operation is
  79             active on the currently bound transform feedback object, and that operation is not paused.
  80         </para>
  81         <para>
  82             <constant>GL_INVALID_OPERATION</constant> is generated if <parameter>id</parameter> is not
  83             zero or the name of a transform feedback object returned from a previous call to
  84             <citerefentry><refentrytitle>glGenTransformFeedbacks</refentrytitle></citerefentry>, or
  85             if such a name has been deleted by <citerefentry><refentrytitle>glDeleteTransformFeedbacks</refentrytitle></citerefentry>.
  86         </para>
  87     </refsect1>
  88     <refsect1 id="associatedgets"><title>Associated Gets</title>
  89         <para>
  90             <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument <constant>GL_TRANSFORM_FEEDBACK_BINDING</constant>
  91         </para>
  92     </refsect1>
  93     <refsect1 id="seealso"><title>See Also</title>
  94         <para>
  95             <citerefentry><refentrytitle>glGenTransformFeedbacks</refentrytitle></citerefentry>,
  96             <citerefentry><refentrytitle>glDeleteTransformFeedbacks</refentrytitle></citerefentry>,
  97             <citerefentry><refentrytitle>glIsTransformFeedback</refentrytitle></citerefentry>,
  98             <citerefentry><refentrytitle>glBeginTransformFeedback</refentrytitle></citerefentry>,
  99             <citerefentry><refentrytitle>glPauseTransformFeedback</refentrytitle></citerefentry>,
 100             <citerefentry><refentrytitle>glResumeTransformFeedback</refentrytitle></citerefentry>,
 101             <citerefentry><refentrytitle>glEndTransformFeedback</refentrytitle></citerefentry>
 102         </para>
 103     </refsect1>
 104     <refsect1 id="Copyright"><title>Copyright</title>
 105         <para>
 106             Copyright <trademark class="copyright"></trademark> 2010 Khronos Group.
 107             This material may be distributed subject to the terms and conditions set forth in
 108             the Open Publication License, v 1.0, 8 June 1999.
 109             <ulink url="http://opencontent.org/openpub/">http://opencontent.org/openpub/</ulink>.
 110         </para>
 111     </refsect1>
 112 </refentry>