127 lines
6.3 KiB
XML
127 lines
6.3 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="glGetPointerv">
|
|
<refmeta>
|
|
<refmetainfo>
|
|
<copyright>
|
|
<year>1991-2006</year>
|
|
<holder>Silicon Graphics, Inc.</holder>
|
|
</copyright>
|
|
</refmetainfo>
|
|
<refentrytitle>glGetPointerv</refentrytitle>
|
|
<manvolnum>3G</manvolnum>
|
|
</refmeta>
|
|
<refnamediv>
|
|
<refname>glGetPointerv</refname>
|
|
<refpurpose>return the address of the specified pointer</refpurpose>
|
|
</refnamediv>
|
|
<refsynopsisdiv><title>C Specification</title>
|
|
<funcsynopsis>
|
|
<funcprototype>
|
|
<funcdef>void <function>glGetPointerv</function></funcdef>
|
|
<paramdef>GLenum <parameter>pname</parameter></paramdef>
|
|
<paramdef>GLvoid ** <parameter>params</parameter></paramdef>
|
|
</funcprototype>
|
|
</funcsynopsis>
|
|
</refsynopsisdiv>
|
|
<!-- eqn: ignoring delim $$ -->
|
|
<refsect1 id="parameters"><title>Parameters</title>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>pname</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Specifies the array or buffer pointer to be returned.
|
|
Symbolic constants
|
|
<constant>GL_COLOR_ARRAY_POINTER</constant>,
|
|
<constant>GL_EDGE_FLAG_ARRAY_POINTER</constant>,
|
|
<constant>GL_FOG_COORD_ARRAY_POINTER</constant>,
|
|
<constant>GL_FEEDBACK_BUFFER_POINTER</constant>,
|
|
<constant>GL_INDEX_ARRAY_POINTER</constant>,
|
|
<constant>GL_NORMAL_ARRAY_POINTER</constant>,
|
|
<constant>GL_SECONDARY_COLOR_ARRAY_POINTER</constant>,
|
|
<constant>GL_SELECTION_BUFFER_POINTER</constant>,
|
|
<constant>GL_TEXTURE_COORD_ARRAY_POINTER</constant>,
|
|
or
|
|
<constant>GL_VERTEX_ARRAY_POINTER</constant>
|
|
are accepted.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>params</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Returns the pointer value specified by <parameter>pname</parameter>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
<refsect1 id="description"><title>Description</title>
|
|
<para>
|
|
<function>glGetPointerv</function> returns pointer information. <parameter>pname</parameter> is a symbolic constant
|
|
indicating the pointer to be returned, and <parameter>params</parameter> is a pointer to a
|
|
location in which to place the returned data.
|
|
</para>
|
|
<para>
|
|
For all <parameter>pname</parameter> arguments except <constant>GL_FEEDBACK_BUFFER_POINTER</constant> and <constant>GL_SELECTION_BUFFER_POINTER</constant>,
|
|
if a non-zero named buffer object was bound to the <constant>GL_ARRAY_BUFFER</constant> target
|
|
(see <citerefentry><refentrytitle>glBindBuffer</refentrytitle></citerefentry>) when the desired pointer was previously
|
|
specified, the pointer returned is a byte offset into the buffer object's data store.
|
|
Buffer objects are only available in OpenGL versions 1.5 and greater.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 id="notes"><title>Notes</title>
|
|
<para>
|
|
<function>glGetPointerv</function> is available only if the GL version is 1.1 or greater.
|
|
</para>
|
|
<para>
|
|
<constant>GL_FOG_COORD_ARRAY_POINTER</constant> and <constant>GL_SECONDARY_COLOR_ARRAY_POINTER</constant>
|
|
are available only if the GL version is 1.4 or greater.
|
|
</para>
|
|
<para>
|
|
The pointers are all client-side state.
|
|
</para>
|
|
<para>
|
|
The initial value for each pointer is 0.
|
|
</para>
|
|
<para>
|
|
For OpenGL versions 1.3 and greater, or when the <code>ARB_multitexture</code>
|
|
extension is supported, querying the <constant>GL_TEXTURE_COORD_ARRAY_POINTER</constant>
|
|
returns the value for the active client texture unit.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 id="errors"><title>Errors</title>
|
|
<para>
|
|
<constant>GL_INVALID_ENUM</constant> is generated if <parameter>pname</parameter> is not an accepted value.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 id="seealso"><title>See Also</title>
|
|
<para>
|
|
<citerefentry><refentrytitle>glBindBuffer</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glClientActiveTexture</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glColorPointer</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glEdgeFlagPointer</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glFogCoordPointer</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glFeedbackBuffer</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glGetVertexAttribPointerv</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glIndexPointer</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glNormalPointer</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glSecondaryColorPointer</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glSelectBuffer</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glTexCoordPointer</refentrytitle></citerefentry>,
|
|
<citerefentry><refentrytitle>glVertexAttribPointer</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>
|