Commit | Line | Data |
---|---|---|
7faf1d71 AW |
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="glGetPointerv"> | |
5 | <refmeta> | |
6 | <refmetainfo> | |
7 | <copyright> | |
8 | <year>1991-2006</year> | |
9 | <holder>Silicon Graphics, Inc.</holder> | |
10 | </copyright> | |
11 | </refmetainfo> | |
12 | <refentrytitle>glGetPointerv</refentrytitle> | |
13 | <manvolnum>3G</manvolnum> | |
14 | </refmeta> | |
15 | <refnamediv> | |
16 | <refname>glGetPointerv</refname> | |
17 | <refpurpose>return the address of the specified pointer</refpurpose> | |
18 | </refnamediv> | |
19 | <refsynopsisdiv><title>C Specification</title> | |
20 | <funcsynopsis> | |
21 | <funcprototype> | |
22 | <funcdef>void <function>glGetPointerv</function></funcdef> | |
23 | <paramdef>GLenum <parameter>pname</parameter></paramdef> | |
24 | <paramdef>GLvoid ** <parameter>params</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>pname</parameter></term> | |
33 | <listitem> | |
34 | <para> | |
35 | Specifies the array or buffer pointer to be returned. | |
36 | Symbolic constants | |
37 | <constant>GL_COLOR_ARRAY_POINTER</constant>, | |
38 | <constant>GL_EDGE_FLAG_ARRAY_POINTER</constant>, | |
39 | <constant>GL_FOG_COORD_ARRAY_POINTER</constant>, | |
40 | <constant>GL_FEEDBACK_BUFFER_POINTER</constant>, | |
41 | <constant>GL_INDEX_ARRAY_POINTER</constant>, | |
42 | <constant>GL_NORMAL_ARRAY_POINTER</constant>, | |
43 | <constant>GL_SECONDARY_COLOR_ARRAY_POINTER</constant>, | |
44 | <constant>GL_SELECTION_BUFFER_POINTER</constant>, | |
45 | <constant>GL_TEXTURE_COORD_ARRAY_POINTER</constant>, | |
46 | or | |
47 | <constant>GL_VERTEX_ARRAY_POINTER</constant> | |
48 | are accepted. | |
49 | </para> | |
50 | </listitem> | |
51 | </varlistentry> | |
52 | <varlistentry> | |
53 | <term><parameter>params</parameter></term> | |
54 | <listitem> | |
55 | <para> | |
56 | Returns the pointer value specified by <parameter>pname</parameter>. | |
57 | </para> | |
58 | </listitem> | |
59 | </varlistentry> | |
60 | </variablelist> | |
61 | </refsect1> | |
62 | <refsect1 id="description"><title>Description</title> | |
63 | <para> | |
64 | <function>glGetPointerv</function> returns pointer information. <parameter>pname</parameter> is a symbolic constant | |
65 | indicating the pointer to be returned, and <parameter>params</parameter> is a pointer to a | |
66 | location in which to place the returned data. | |
67 | </para> | |
68 | <para> | |
69 | For all <parameter>pname</parameter> arguments except <constant>GL_FEEDBACK_BUFFER_POINTER</constant> and <constant>GL_SELECTION_BUFFER_POINTER</constant>, | |
70 | if a non-zero named buffer object was bound to the <constant>GL_ARRAY_BUFFER</constant> target | |
71 | (see <citerefentry><refentrytitle>glBindBuffer</refentrytitle></citerefentry>) when the desired pointer was previously | |
72 | specified, the pointer returned is a byte offset into the buffer object's data store. | |
73 | Buffer objects are only available in OpenGL versions 1.5 and greater. | |
74 | </para> | |
75 | </refsect1> | |
76 | <refsect1 id="notes"><title>Notes</title> | |
77 | <para> | |
78 | <function>glGetPointerv</function> is available only if the GL version is 1.1 or greater. | |
79 | </para> | |
80 | <para> | |
81 | <constant>GL_FOG_COORD_ARRAY_POINTER</constant> and <constant>GL_SECONDARY_COLOR_ARRAY_POINTER</constant> | |
82 | are available only if the GL version is 1.4 or greater. | |
83 | </para> | |
84 | <para> | |
85 | The pointers are all client-side state. | |
86 | </para> | |
87 | <para> | |
88 | The initial value for each pointer is 0. | |
89 | </para> | |
90 | <para> | |
91 | For OpenGL versions 1.3 and greater, or when the <code>ARB_multitexture</code> | |
92 | extension is supported, querying the <constant>GL_TEXTURE_COORD_ARRAY_POINTER</constant> | |
93 | returns the value for the active client texture unit. | |
94 | </para> | |
95 | </refsect1> | |
96 | <refsect1 id="errors"><title>Errors</title> | |
97 | <para> | |
98 | <constant>GL_INVALID_ENUM</constant> is generated if <parameter>pname</parameter> is not an accepted value. | |
99 | </para> | |
100 | </refsect1> | |
101 | <refsect1 id="seealso"><title>See Also</title> | |
102 | <para> | |
103 | <citerefentry><refentrytitle>glBindBuffer</refentrytitle></citerefentry>, | |
104 | <citerefentry><refentrytitle>glClientActiveTexture</refentrytitle></citerefentry>, | |
105 | <citerefentry><refentrytitle>glColorPointer</refentrytitle></citerefentry>, | |
106 | <citerefentry><refentrytitle>glEdgeFlagPointer</refentrytitle></citerefentry>, | |
107 | <citerefentry><refentrytitle>glFogCoordPointer</refentrytitle></citerefentry>, | |
108 | <citerefentry><refentrytitle>glFeedbackBuffer</refentrytitle></citerefentry>, | |
109 | <citerefentry><refentrytitle>glGetVertexAttribPointerv</refentrytitle></citerefentry>, | |
110 | <citerefentry><refentrytitle>glIndexPointer</refentrytitle></citerefentry>, | |
111 | <citerefentry><refentrytitle>glNormalPointer</refentrytitle></citerefentry>, | |
112 | <citerefentry><refentrytitle>glSecondaryColorPointer</refentrytitle></citerefentry>, | |
113 | <citerefentry><refentrytitle>glSelectBuffer</refentrytitle></citerefentry>, | |
114 | <citerefentry><refentrytitle>glTexCoordPointer</refentrytitle></citerefentry>, | |
115 | <citerefentry><refentrytitle>glVertexAttribPointer</refentrytitle></citerefentry>, | |
116 | <citerefentry><refentrytitle>glVertexPointer</refentrytitle></citerefentry> | |
117 | </para> | |
118 | </refsect1> | |
119 | <refsect1 id="Copyright"><title>Copyright</title> | |
120 | <para> | |
121 | Copyright <trademark class="copyright"></trademark> 1991-2006 | |
122 | Silicon Graphics, Inc. This document is licensed under the SGI | |
123 | Free Software B License. For details, see | |
124 | <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>. | |
125 | </para> | |
126 | </refsect1> | |
127 | </refentry> |