upstream-man-pages/man2/glXGetProcAddress.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="glXGetProcAddress">
   5     <refmeta>
   6         <refmetainfo>
   7             <copyright>
   8                 <year>1991-2006</year>
   9                 <holder>Silicon Graphics, Inc.</holder>
  10             </copyright>
  11         </refmetainfo>
  12         <refentrytitle>glXGetProcAddress</refentrytitle>
  13         <manvolnum>3G</manvolnum>
  14     </refmeta>
  15     <refnamediv>
  16         <refname>glXGetProcAddress</refname>
  17         <refpurpose>obtain a pointer to an OpenGL or GLX function</refpurpose>
  18     </refnamediv>
  19     <refsynopsisdiv><title>C Specification</title>
  20         <funcsynopsis>
  21             <funcprototype>
  22                 <funcdef>void(*)() <function>glXGetProcAddress</function></funcdef>
  23                 <paramdef>const GLubyte * <parameter>procName</parameter></paramdef>
  24             </funcprototype>
  25         </funcsynopsis>
  26     </refsynopsisdiv>
  27     <!-- eqn: ignoring delim $$ -->
  28     <refsect1 id="parameters"><title>Parameters</title>
  29         <variablelist>
  30         <varlistentry>
  31             <term><parameter>procName</parameter></term>
  32             <listitem>
  33                 <para>
  34                     Specifies the name of the OpenGL or GLX function whose address is to be returned.
  35                 </para>
  36             </listitem>
  37         </varlistentry>
  38         </variablelist>
  39     </refsect1>
  40     <refsect1 id="description"><title>Description</title>
  41         <para>
  42             <function>glXGetProcAddress</function> returns the address of the function specified in <parameter>procName</parameter>.  This is
  43             necessary in environments where the OpenGL link library exports a different
  44             set of functions than the runtime library.
  45         </para>
  46     </refsect1>
  47     <refsect1 id="notes"><title>Notes</title>
  48         <para>
  49             A <constant>NULL</constant> pointer is returned if function requested is not suported
  50             in the implementation being queried.
  51         </para>
  52         <para>
  53             GLU functions are not queryable due to the fact that the library may not be
  54             loaded at the time of the query.
  55         </para>
  56     </refsect1>
  57     <refsect1 id="Copyright"><title>Copyright</title>
  58         <para>
  59             Copyright <trademark class="copyright"></trademark> 1991-2006
  60             Silicon Graphics, Inc. This document is licensed under the SGI
  61             Free Software B License. For details, see
  62             <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
  63         </para>
  64     </refsect1>
  65 </refentry>