File: glEnableVertexAttribArray.xml

package info (click to toggle)
khronos-opengl-man4 1.0~svn33624-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid
  • size: 6,344 kB
  • sloc: xml: 93,066; makefile: 730; python: 627; sh: 50; php: 4
file content (215 lines) | stat: -rw-r--r-- 8,636 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
<!DOCTYPE refentry [ <!ENTITY % mathent SYSTEM "math.ent"> %mathent; ]>

<!-- Converted by db4-upgrade version 1.1 -->

<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="glEnableVertexAttribArray">
  <info>
    <copyright>
      <year>2003-2005</year>

      <holder>3Dlabs Inc. Ltd.</holder>
    </copyright>

    <copyright>
      <year>2010-2014</year>

      <holder>Khronos Group</holder>
    </copyright>
  </info>

  <refmeta>
    <refentrytitle>glEnableVertexAttribArray</refentrytitle>

    <manvolnum>3G</manvolnum>
  </refmeta>

  <refnamediv>
    <refdescriptor>glEnableVertexAttribArray</refdescriptor>

    <refname>glEnableVertexAttribArray</refname>

    <refname>glDisableVertexAttribArray</refname>

    <refname>glEnableVertexArrayAttrib</refname>

    <refname>glDisableVertexArrayAttrib</refname>

    <refpurpose>Enable or disable a generic vertex attribute
    array</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <title>C Specification</title>

    <funcsynopsis>
      <funcprototype>
        <funcdef>void <function>glEnableVertexAttribArray</function></funcdef>

        <paramdef>GLuint <parameter>index</parameter></paramdef>
      </funcprototype>

      <funcprototype>
        <funcdef>void <function>glDisableVertexAttribArray</function></funcdef>

        <paramdef>GLuint <parameter>index</parameter></paramdef>
      </funcprototype>

      <!-- DSA commands -->

      <funcprototype>
        <funcdef>void <function>glEnableVertexArrayAttrib</function></funcdef>

        <paramdef>GLuint <parameter>vaobj</parameter></paramdef>

        <paramdef>GLuint <parameter>index</parameter></paramdef>
      </funcprototype>

      <funcprototype>
        <funcdef>void <function>glDisableVertexArrayAttrib</function></funcdef>

        <paramdef>GLuint <parameter>vaobj</parameter></paramdef>

        <paramdef>GLuint <parameter>index</parameter></paramdef>
      </funcprototype>
    </funcsynopsis>
  </refsynopsisdiv>

  <refsect1 xml:id="parameters">
    <title>Parameters</title>

    <variablelist>
      <varlistentry>
        <term><parameter>vaobj</parameter></term>

        <listitem>
          <para>Specifies the name of the vertex array object for
          <function>glDisableVertexArrayAttrib</function> and
          <function>glEnableVertexArrayAttrib</function> functions.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><parameter>index</parameter></term>

        <listitem>
          <para>Specifies the index of the generic vertex attribute to be
          enabled or disabled.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1 xml:id="description">
    <title>Description</title>

    <para><function>glEnableVertexAttribArray</function> and
    <function>glEnableVertexArrayAttrib</function> enable the generic vertex
    attribute array specified by <parameter>index</parameter>.
    <function>glEnableVertexAttribArray</function> uses currently bound vertex
    array object for the operation, whereas
    <function>glEnableVertexArrayAttrib</function> updates state of the vertex
    array object with ID <parameter>vaobj</parameter>.</para>

    <para><function>glDisableVertexAttribArray</function> and
    <function>glDisableVertexArrayAttrib</function> disable the generic vertex
    attribute array specified by <parameter>index</parameter>.
    <function>glDisableVertexAttribArray</function> uses currently bound
    vertex array object for the operation, whereas
    <function>glDisableVertexArrayAttrib</function> updates state of the
    vertex array object with ID <parameter>vaobj</parameter>.</para>

    <para>
        By default, all client-side capabilities are disabled, including all
        generic vertex attribute arrays. If enabled, the values in the generic
        vertex attribute array will be accessed and used for rendering when calls
        are made to vertex array commands such as
        <citerefentry><refentrytitle>glDrawArrays</refentrytitle></citerefentry>,
        <citerefentry><refentrytitle>glDrawElements</refentrytitle></citerefentry>,
        <citerefentry><refentrytitle>glDrawRangeElements</refentrytitle></citerefentry>,
        <citerefentry><refentrytitle>glMultiDrawElements</refentrytitle></citerefentry>, or
        <citerefentry><refentrytitle>glMultiDrawArrays</refentrytitle></citerefentry>.
    </para>
  </refsect1>

  <refsect1 xml:id="errors">
    <title>Errors</title>

    <para><constant>GL_INVALID_OPERATION</constant> is generated by
    <function>glEnableVertexAttribArray</function> and
    <function>glDisableVertexAttribArray</function> if no vertex array object
    is bound.</para>

    <para><constant>GL_INVALID_OPERATION</constant> is generated by
    <function>glEnableVertexArrayAttrib</function> and
    <function>glDisableVertexArrayAttrib</function> if
    <parameter>vaobj</parameter> is not the name of an existing vertex array
    object.</para>

    <para><constant>GL_INVALID_VALUE</constant> is generated if
    <parameter>index</parameter> is greater than or equal to
    <constant>GL_MAX_VERTEX_ATTRIBS</constant>.</para>
  </refsect1>

  <refsect1 xml:id="associatedgets">
    <title>Associated Gets</title>

    <para>
        <citerefentry><refentrytitle>glGet</refentrytitle></citerefentry> with argument
        <constant>GL_MAX_VERTEX_ATTRIBS</constant>
    </para>

    <para><citerefentry><refentrytitle>glGetVertexAttrib</refentrytitle></citerefentry> with arguments <parameter>index</parameter> and
        <constant>GL_VERTEX_ATTRIB_ARRAY_ENABLED</constant> <parameter/>
    </para>

    <para>
        <citerefentry><refentrytitle>glGetVertexAttribPointerv</refentrytitle></citerefentry> with arguments <parameter>index</parameter> and
        <constant>GL_VERTEX_ATTRIB_ARRAY_POINTER</constant>
    </para>
  </refsect1>
    <refsect1 xml:id="versions"><title>Version Support</title>
        <informaltable>
            <tgroup cols="13" align="left">
                <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apifunchead.xml" xpointer="xpointer(/*/*)"/>
                <tbody>
                    <row>
                        <entry><function>glDisableVertexArrayAttrib</function></entry>
                        <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apiversion.xml" xpointer="xpointer(/*/*[@role='45']/*)"/>
                    </row>
                    <row>
                        <entry><function>glDisableVertexAttribArray</function></entry>
                        <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apiversion.xml" xpointer="xpointer(/*/*[@role='20']/*)"/>
                    </row>
                    <row>
                        <entry><function>glEnableVertexArrayAttrib</function></entry>
                        <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apiversion.xml" xpointer="xpointer(/*/*[@role='45']/*)"/>
                    </row>
                    <row>
                        <entry><function>glEnableVertexAttribArray</function></entry>
                        <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="apiversion.xml" xpointer="xpointer(/*/*[@role='20']/*)"/>
                    </row>
                </tbody>
            </tgroup>
        </informaltable>
    </refsect1>
    <refsect1 xml:id="seealso"><title>See Also</title>
    <para>
    <citerefentry><refentrytitle>glBindAttribLocation</refentrytitle></citerefentry>,
    <citerefentry><refentrytitle>glDrawArrays</refentrytitle></citerefentry>,
    <citerefentry><refentrytitle>glDrawElements</refentrytitle></citerefentry>,
    <citerefentry><refentrytitle>glDrawRangeElements</refentrytitle></citerefentry>,
    <citerefentry><refentrytitle>glMultiDrawElements</refentrytitle></citerefentry>,
    <citerefentry><refentrytitle>glVertexAttrib</refentrytitle></citerefentry>,
    <citerefentry><refentrytitle>glVertexAttribPointer</refentrytitle></citerefentry>
    </para>
    </refsect1>
    <refsect1 xml:id="Copyright"><title>Copyright</title>
        <para>
            Copyright <trademark class="copyright"/> 2003-2005 3Dlabs Inc. Ltd.
            Copyright <trademark class="copyright"/> 2010-2014 Khronos Group.
            This material may be distributed subject to the terms and conditions set forth in
            the Open Publication License, v 1.0, 8 June 1999.
            <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://opencontent.org/openpub/">http://opencontent.org/openpub/</link>.
        </para>
    </refsect1>
</refentry>