← Back to branch summary

~ubuntu-branches/ubuntu/wily/gtkglext/wily

« back to all changes in this revision

Viewing changes to docs/reference/gtkglext/xml/gtkglinit.xml

  • Committer: Bazaar Package Importer
  • Author(s): William Pitcock
  • Date: 2008-02-17 21:35:29 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20080217213529-qsgzig49g4nfv8g7
Tags: 1.2.0-1
http://bugs.debian.org/360854
http://bugs.debian.org/273500
http://bugs.debian.org/372143
http://bugs.debian.org/363395
http://bugs.debian.org/366944
* Acknowledge NMU. (Closes: #360854)
* Install devhelp file. (Closes: #273500)
* Fix dependencies for Modular X. (Closes: #372143)
* New upstream release. (Closes: #363395)
* Fix a crash bug related to the X Font Cache. (Closes: #366944)
* Build debug package, libgtkglext1-dbg.
* Hijack maintainership of package for various reasons, see
  http://lists.debian.org/debian-devel/2008/02/msg00745.html
  for rationale.
* Use new dpkg Homepage: field.
* No-change update to Standards-Version 3.7.3.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/gtkglext/xml/gtkglinit.xml
16
16
#include <gtk/gtkgl.h>
17
17
 
18
18
 
19
 
void        <link linkend="gtk-gl-init">gtk_gl_init</link>                     (int *argc,
20
 
                                             char ***argv);
21
 
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-gl-init-check">gtk_gl_init_check</link>               (int *argc,
22
 
                                             char ***argv);
23
 
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-gl-parse-args">gtk_gl_parse_args</link>               (int *argc,
24
 
                                             char ***argv);
 
19
<link linkend="void">void</link>        <link linkend="gtk-gl-init">gtk_gl_init</link>                     (<link linkend="int">int</link> *argc,
 
20
                                             <link linkend="char">char</link> ***argv);
 
21
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-gl-init-check">gtk_gl_init_check</link>               (<link linkend="int">int</link> *argc,
 
22
                                             <link linkend="char">char</link> ***argv);
 
23
<link linkend="gboolean">gboolean</link>    <link linkend="gtk-gl-parse-args">gtk_gl_parse_args</link>               (<link linkend="int">int</link> *argc,
 
24
                                             <link linkend="char">char</link> ***argv);
25
25
</synopsis>
26
26
</refsynopsisdiv>
27
27
 
31
31
 
32
32
 
33
33
 
 
34
 
 
35
 
34
36
<refsect1>
35
37
<title>Description</title>
36
38
<para>
42
44
<title>Details</title>
43
45
<refsect2>
44
46
<title><anchor id="gtk-gl-init"/>gtk_gl_init ()</title>
45
 
<programlisting>void        gtk_gl_init                     (int *argc,
46
 
                                             char ***argv);</programlisting>
 
47
<indexterm><primary>gtk_gl_init</primary></indexterm><programlisting><link linkend="void">void</link>        gtk_gl_init                     (<link linkend="int">int</link> *argc,
 
48
                                             <link linkend="char">char</link> ***argv);</programlisting>
47
49
<para>
48
50
Call this function before using any other GtkGLExt functions in your 
49
51
applications.  It will initialize everything needed to operate the library
55
57
<note><para>
56
58
This function will terminate your program if it was unable to initialize 
57
59
the library for some reason. If you want your program to fall back to a 
58
 
textual interface you want to call <link linkend="gtk-gl-init-check">gtk_gl_init_check</link>() instead.
 
60
textual interface you want to call <link linkend="gtk-gl-init-check"><function>gtk_gl_init_check()</function></link> instead.
59
61
</para></note></para>
60
62
<para>
61
63
 
62
64
</para><variablelist role="params">
63
65
<varlistentry><term><parameter>argc</parameter>&nbsp;:</term>
64
66
<listitem><simpara> Address of the <parameter>argc</parameter> parameter of your 
65
 
       <function><link linkend="main">main</link>()</function> function. Changed if any arguments
 
67
       <function><link linkend="main"><function>main()</function></link></function> function. Changed if any arguments
66
68
       were handled.
67
69
</simpara></listitem></varlistentry>
68
70
<varlistentry><term><parameter>argv</parameter>&nbsp;:</term>
69
71
<listitem><simpara> Address of the <parameter>argv</parameter> parameter of 
70
 
       <function><link linkend="main">main</link>()</function>. Any parameters understood by
71
 
       <link linkend="gtk-gl-init">gtk_gl_init</link>() are stripped before return.
 
72
       <function><link linkend="main"><function>main()</function></link></function>. Any parameters understood by
 
73
       <link linkend="gtk-gl-init"><function>gtk_gl_init()</function></link> are stripped before return.
72
74
</simpara></listitem></varlistentry>
73
75
</variablelist></refsect2>
74
76
<refsect2>
75
77
<title><anchor id="gtk-gl-init-check"/>gtk_gl_init_check ()</title>
76
 
<programlisting><link linkend="gboolean">gboolean</link>    gtk_gl_init_check               (int *argc,
77
 
                                             char ***argv);</programlisting>
 
78
<indexterm><primary>gtk_gl_init_check</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gtk_gl_init_check               (<link linkend="int">int</link> *argc,
 
79
                                             <link linkend="char">char</link> ***argv);</programlisting>
78
80
<para>
79
 
This function does the same work as <link linkend="gtk-gl-init">gtk_gl_init</link>() with only 
 
81
This function does the same work as <link linkend="gtk-gl-init"><function>gtk_gl_init()</function></link> with only 
80
82
a single change: It does not terminate the program if the library can't be 
81
83
initialized. Instead it returns <literal>FALSE</literal> on failure.
82
84
</para>
88
90
</para><variablelist role="params">
89
91
<varlistentry><term><parameter>argc</parameter>&nbsp;:</term>
90
92
<listitem><simpara> Address of the <parameter>argc</parameter> parameter of your 
91
 
       <function><link linkend="main">main</link>()</function> function. Changed if any arguments
 
93
       <function><link linkend="main"><function>main()</function></link></function> function. Changed if any arguments
92
94
       were handled.
93
95
</simpara></listitem></varlistentry>
94
96
<varlistentry><term><parameter>argv</parameter>&nbsp;:</term>
95
97
<listitem><simpara> Address of the <parameter>argv</parameter> parameter of 
96
 
       <function><link linkend="main">main</link>()</function>. Any parameters understood by
97
 
       <link linkend="gtk-gl-init">gtk_gl_init</link>() are stripped before return.
 
98
       <function><link linkend="main"><function>main()</function></link></function>. Any parameters understood by
 
99
       <link linkend="gtk-gl-init"><function>gtk_gl_init()</function></link> are stripped before return.
98
100
</simpara></listitem></varlistentry>
99
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <literal>TRUE</literal> if the GUI has been successfully initialized, 
 
101
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <literal>TRUE</literal> if the GUI has been successfully initialized, 
100
102
              <literal>FALSE</literal> otherwise.
101
103
</simpara></listitem></varlistentry>
102
104
</variablelist></refsect2>
103
105
<refsect2>
104
106
<title><anchor id="gtk-gl-parse-args"/>gtk_gl_parse_args ()</title>
105
 
<programlisting><link linkend="gboolean">gboolean</link>    gtk_gl_parse_args               (int *argc,
106
 
                                             char ***argv);</programlisting>
 
107
<indexterm><primary>gtk_gl_parse_args</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gtk_gl_parse_args               (<link linkend="int">int</link> *argc,
 
108
                                             <link linkend="char">char</link> ***argv);</programlisting>
107
109
<para>
108
110
Parses command line arguments, and initializes global
109
111
attributes of GtkGLExt.
114
116
</para>
115
117
<para>
116
118
You shouldn't call this function explicitely if you are using
117
 
<link linkend="gtk-gl-init">gtk_gl_init</link>(), or <link linkend="gtk-gl-init-check">gtk_gl_init_check</link>().</para>
 
119
<link linkend="gtk-gl-init"><function>gtk_gl_init()</function></link>, or <link linkend="gtk-gl-init-check"><function>gtk_gl_init_check()</function></link>.</para>
118
120
<para>
119
121
 
120
122
</para><variablelist role="params">
124
126
<varlistentry><term><parameter>argv</parameter>&nbsp;:</term>
125
127
<listitem><simpara> the array of command line arguments.
126
128
</simpara></listitem></varlistentry>
127
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <literal>TRUE</literal> if initialization succeeded, otherwise <literal>FALSE</literal>.
 
129
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <literal>TRUE</literal> if initialization succeeded, otherwise <literal>FALSE</literal>.
128
130
</simpara></listitem></varlistentry>
129
131
</variablelist></refsect2>
130
132