mirror of
https://github.com/Ryujinx/Opentk.git
synced 2024-12-27 03:05:29 +00:00
163 lines
8.1 KiB
XML
163 lines
8.1 KiB
XML
|
<?xml version="1.0" encoding="UTF-8"?>
|
||
|
|
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
|
||
|
|
"http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
|
||
|
|
<refentry id="glDrawElements">
|
||
|
|
<refmeta>
|
||
|
|
<refmetainfo>
|
||
|
|
<copyright>
|
||
|
|
<year>1991-2006</year>
|
||
|
|
<holder>Silicon Graphics, Inc.</holder>
|
||
|
|
</copyright>
|
||
|
|
</refmetainfo>
|
||
|
|
<refentrytitle>glDrawElements</refentrytitle>
|
||
|
|
<manvolnum>3G</manvolnum>
|
||
|
|
</refmeta>
|
||
|
|
<refnamediv>
|
||
|
|
<refname>glDrawElements</refname>
|
||
|
|
<refpurpose>render primitives from array data</refpurpose>
|
||
|
|
</refnamediv>
|
||
|
|
<refsynopsisdiv><title>C Specification</title>
|
||
|
|
<funcsynopsis>
|
||
|
|
<funcprototype>
|
||
|
|
<funcdef>void <function>glDrawElements</function></funcdef>
|
||
|
|
<paramdef>GLenum <parameter>mode</parameter></paramdef>
|
||
|
|
<paramdef>GLsizei <parameter>count</parameter></paramdef>
|
||
|
|
<paramdef>GLenum <parameter>type</parameter></paramdef>
|
||
|
|
<paramdef>const GLvoid * <parameter>indices</parameter></paramdef>
|
||
|
|
</funcprototype>
|
||
|
|
</funcsynopsis>
|
||
|
|
</refsynopsisdiv>
|
||
|
|
<!-- eqn: ignoring delim $$ -->
|
||
|
|
<refsect1 id="parameters"><title>Parameters</title>
|
||
|
|
<variablelist>
|
||
|
|
<varlistentry>
|
||
|
|
<term><parameter>mode</parameter></term>
|
||
|
|
<listitem>
|
||
|
|
<para>
|
||
|
|
Specifies what kind of primitives to render.
|
||
|
|
Symbolic constants
|
||
|
|
<constant>GL_POINTS</constant>,
|
||
|
|
<constant>GL_LINE_STRIP</constant>,
|
||
|
|
<constant>GL_LINE_LOOP</constant>,
|
||
|
|
<constant>GL_LINES</constant>,
|
||
|
|
<constant>GL_TRIANGLE_STRIP</constant>,
|
||
|
|
<constant>GL_TRIANGLE_FAN</constant>,
|
||
|
|
<constant>GL_TRIANGLES</constant>,
|
||
|
|
<constant>GL_QUAD_STRIP</constant>,
|
||
|
|
<constant>GL_QUADS</constant>,
|
||
|
|
and <constant>GL_POLYGON</constant> are accepted.
|
||
|
|
</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
<varlistentry>
|
||
|
|
<term><parameter>count</parameter></term>
|
||
|
|
<listitem>
|
||
|
|
<para>
|
||
|
|
Specifies the number of elements to be rendered.
|
||
|
|
</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
<varlistentry>
|
||
|
|
<term><parameter>type</parameter></term>
|
||
|
|
<listitem>
|
||
|
|
<para>
|
||
|
|
Specifies the type of the values in <parameter>indices</parameter>. Must be one of
|
||
|
|
<constant>GL_UNSIGNED_BYTE</constant>, <constant>GL_UNSIGNED_SHORT</constant>, or
|
||
|
|
<constant>GL_UNSIGNED_INT</constant>.
|
||
|
|
</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
<varlistentry>
|
||
|
|
<term><parameter>indices</parameter></term>
|
||
|
|
<listitem>
|
||
|
|
<para>
|
||
|
|
Specifies a pointer to the location where the indices are stored.
|
||
|
|
</para>
|
||
|
|
</listitem>
|
||
|
|
</varlistentry>
|
||
|
|
</variablelist>
|
||
|
|
</refsect1>
|
||
|
|
<refsect1 id="description"><title>Description</title>
|
||
|
|
<para>
|
||
|
|
<function>glDrawElements</function> specifies multiple geometric primitives
|
||
|
|
with very few subroutine calls. Instead of calling a GL function
|
||
|
|
to pass each individual vertex, normal, texture coordinate, edge
|
||
|
|
flag, or color, you can prespecify
|
||
|
|
separate arrays of vertices, normals, and so on, and use them to
|
||
|
|
construct a sequence of primitives with a single
|
||
|
|
call to <function>glDrawElements</function>.
|
||
|
|
</para>
|
||
|
|
<para>
|
||
|
|
When <function>glDrawElements</function> is called, it uses <parameter>count</parameter> sequential elements from an
|
||
|
|
enabled array, starting at <parameter>indices</parameter> to construct a sequence of
|
||
|
|
geometric primitives. <parameter>mode</parameter> specifies what kind of primitives are
|
||
|
|
constructed and how the array elements construct these primitives. If
|
||
|
|
more than one array is enabled, each is used. If
|
||
|
|
<constant>GL_VERTEX_ARRAY</constant> is not enabled, no geometric primitives are
|
||
|
|
constructed.
|
||
|
|
</para>
|
||
|
|
<para>
|
||
|
|
Vertex attributes that are modified by <function>glDrawElements</function> have an
|
||
|
|
unspecified value after <function>glDrawElements</function> returns. For example, if
|
||
|
|
<constant>GL_COLOR_ARRAY</constant> is enabled, the value of the current color is
|
||
|
|
undefined after <function>glDrawElements</function> executes. Attributes that aren't
|
||
|
|
modified maintain their previous values.
|
||
|
|
</para>
|
||
|
|
</refsect1>
|
||
|
|
<refsect1 id="notes"><title>Notes</title>
|
||
|
|
<para>
|
||
|
|
<function>glDrawElements</function> is available only if the GL version is 1.1 or greater.
|
||
|
|
</para>
|
||
|
|
<para>
|
||
|
|
<function>glDrawElements</function> is included in display lists. If <function>glDrawElements</function> is entered into a
|
||
|
|
display list,
|
||
|
|
the necessary array data (determined by the array pointers and
|
||
|
|
enables) is also
|
||
|
|
entered into the display list. Because the array pointers and
|
||
|
|
enables are client-side state, their values affect display lists
|
||
|
|
when the lists are created, not when the lists are executed.
|
||
|
|
</para>
|
||
|
|
</refsect1>
|
||
|
|
<refsect1 id="errors"><title>Errors</title>
|
||
|
|
<para>
|
||
|
|
<constant>GL_INVALID_ENUM</constant> is generated if <parameter>mode</parameter> is not an accepted value.
|
||
|
|
</para>
|
||
|
|
<para>
|
||
|
|
<constant>GL_INVALID_VALUE</constant> is generated if <parameter>count</parameter> is negative.
|
||
|
|
</para>
|
||
|
|
<para>
|
||
|
|
<constant>GL_INVALID_OPERATION</constant> is generated if a non-zero buffer object name is bound to an
|
||
|
|
enabled array or the element array and the buffer object's data store is currently mapped.
|
||
|
|
</para>
|
||
|
|
<para>
|
||
|
|
<constant>GL_INVALID_OPERATION</constant> is generated if <function>glDrawElements</function> is executed between
|
||
|
|
the execution of <citerefentry><refentrytitle>glBegin</refentrytitle></citerefentry> and the corresponding <citerefentry><refentrytitle>glEnd</refentrytitle></citerefentry>.
|
||
|
|
</para>
|
||
|
|
</refsect1>
|
||
|
|
<refsect1 id="seealso"><title>See Also</title>
|
||
|
|
<para>
|
||
|
|
<citerefentry><refentrytitle>glArrayElement</refentrytitle></citerefentry>,
|
||
|
|
<citerefentry><refentrytitle>glColorPointer</refentrytitle></citerefentry>,
|
||
|
|
<citerefentry><refentrytitle>glDrawArrays</refentrytitle></citerefentry>,
|
||
|
|
<citerefentry><refentrytitle>glDrawRangeElements</refentrytitle></citerefentry>,
|
||
|
|
<citerefentry><refentrytitle>glEdgeFlagPointer</refentrytitle></citerefentry>,
|
||
|
|
<citerefentry><refentrytitle>glFogCoordPointer</refentrytitle></citerefentry>,
|
||
|
|
<citerefentry><refentrytitle>glGetPointerv</refentrytitle></citerefentry>,
|
||
|
|
<citerefentry><refentrytitle>glIndexPointer</refentrytitle></citerefentry>,
|
||
|
|
<citerefentry><refentrytitle>glInterleavedArrays</refentrytitle></citerefentry>,
|
||
|
|
<citerefentry><refentrytitle>glNormalPointer</refentrytitle></citerefentry>,
|
||
|
|
<citerefentry><refentrytitle>glSecondaryColorPointer</refentrytitle></citerefentry>,
|
||
|
|
<citerefentry><refentrytitle>glTexCoordPointer</refentrytitle></citerefentry>,
|
||
|
|
<citerefentry><refentrytitle>glVertexPointer</refentrytitle></citerefentry>
|
||
|
|
</para>
|
||
|
|
</refsect1>
|
||
|
|
<refsect1 id="Copyright"><title>Copyright</title>
|
||
|
|
<para>
|
||
|
|
Copyright <trademark class="copyright"></trademark> 1991-2006
|
||
|
|
Silicon Graphics, Inc. This document is licensed under the SGI
|
||
|
|
Free Software B License. For details, see
|
||
|
|
<ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
|
||
|
|
</para>
|
||
|
|
</refsect1>
|
||
|
|
</refentry>
|