man/waffle_is_extension_in_string.3.xml

   1 <?xml version='1.0'?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4
   5 <!--
   6   Copyright Intel 2012
   7
   8   This manual page is licensed under the Creative Commons Attribution-ShareAlike 3.0 United States License (CC BY-SA 3.0
   9   US). To view a copy of this license, visit http://creativecommons.org.license/by-sa/3.0/us.
  10 -->
  11
  12 <refentry
  13     id="waffle_is_extension_in_string"
  14     xmlns:xi="http://www.w3.org/2001/XInclude">
  15
  16   <!-- See http://www.docbook.org/tdg/en/html/refentry.html. -->
  17
  18   <refmeta>
  19     <refentrytitle>waffle_is_extension_in_string</refentrytitle>
  20     <manvolnum>3</manvolnum>
  21   </refmeta>
  22
  23   <refnamediv>
  24     <refname>waffle_is_extension_in_string</refname>
  25     <refpurpose>Check if a name appears in an OpenGL-style extension string</refpurpose>
  26   </refnamediv>
  27
  28   <refentryinfo>
  29     <title>Waffle Manual</title>
  30     <productname>waffle</productname>
  31     <xi:include href="common/author-chad.versace.xml"/>
  32     <xi:include href="common/copyright.xml"/>
  33     <xi:include href="common/legalnotice.xml"/>
  34   </refentryinfo>
  35
  36   <refsynopsisdiv>
  37
  38     <funcsynopsis language="C">
  39
  40       <funcsynopsisinfo>
  41 #include &lt;waffle.h&gt;
  42       </funcsynopsisinfo>
  43
  44       <funcprototype>
  45         <funcdef>bool <function>waffle_is_extension_in_string</function></funcdef>
  46         <paramdef>const char * <parameter>extension_string</parameter></paramdef>
  47         <paramdef>const char * <parameter>extension_name</parameter></paramdef>
  48       </funcprototype>
  49
  50     </funcsynopsis>
  51   </refsynopsisdiv>
  52
  53   <refsect1>
  54     <title>Description</title>
  55
  56     <variablelist>
  57
  58       <varlistentry>
  59         <term><function>waffle_is_extension_in_string()</function></term>
  60         <listitem>
  61           <para>
  62             Check if an extension name appears in an OpenGL-style extension string.
  63           </para>
  64
  65           <para>
  66             The <parameter>extension_string</parameter> must be
  67
  68             in the format returned by <code>glGetString(GL_EXTENSIONS)</code>.
  69
  70             Note that this function is not restricted to the OpenGL extension string;
  71
  72             it can also be used on the WGL, GLX and EGL extension strings.
  73           </para>
  74
  75           <para>
  76             This function can be called before waffle has been successfully initialized with
  77
  78             <citerefentry><refentrytitle><function>waffle_init</function></refentrytitle><manvolnum>3</manvolnum></citerefentry>.
  79           </para>
  80         </listitem>
  81       </varlistentry>
  82
  83     </variablelist>
  84   </refsect1>
  85
  86   <refsect1>
  87     <title>Errors</title>
  88
  89     <para>
  90       This function sets the error code to <constant>WAFFLE_NO_ERROR</constant>.
  91     </para>
  92   </refsect1>
  93
  94   <xi:include href="common/issues.xml"/>
  95
  96   <refsect1>
  97     <title>See Also</title>
  98     <para>
  99       <citerefentry><refentrytitle>waffle</refentrytitle><manvolnum>7</manvolnum></citerefentry>
 100     </para>
 101   </refsect1>
 102
 103 </refentry>
 104
 105 <!--
 106 vim:tw=120 et ts=2 sw=2:
 107 -->