← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/reference/gtkglext/xml/gdkgldrawable.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/gdkgldrawable.xml
16
16
#include <gdk/gdkgl.h>
17
17
 
18
18
 
19
 
struct      <link linkend="GdkGLDrawable-struct">GdkGLDrawable</link>;
 
19
            <link linkend="GdkGLDrawable-struct">GdkGLDrawable</link>;
20
20
<link linkend="gboolean">gboolean</link>    <link linkend="gdk-gl-drawable-make-current">gdk_gl_drawable_make_current</link>    (<link linkend="GdkGLDrawable">GdkGLDrawable</link> *gldrawable,
21
21
                                             <link linkend="GdkGLContext">GdkGLContext</link> *glcontext);
22
22
<link linkend="gboolean">gboolean</link>    <link linkend="gdk-gl-drawable-is-double-buffered">gdk_gl_drawable_is_double_buffered</link>
23
23
                                            (<link linkend="GdkGLDrawable">GdkGLDrawable</link> *gldrawable);
24
 
void        <link linkend="gdk-gl-drawable-swap-buffers">gdk_gl_drawable_swap_buffers</link>    (<link linkend="GdkGLDrawable">GdkGLDrawable</link> *gldrawable);
25
 
void        <link linkend="gdk-gl-drawable-wait-gl">gdk_gl_drawable_wait_gl</link>         (<link linkend="GdkGLDrawable">GdkGLDrawable</link> *gldrawable);
26
 
void        <link linkend="gdk-gl-drawable-wait-gdk">gdk_gl_drawable_wait_gdk</link>        (<link linkend="GdkGLDrawable">GdkGLDrawable</link> *gldrawable);
 
24
<link linkend="void">void</link>        <link linkend="gdk-gl-drawable-swap-buffers">gdk_gl_drawable_swap_buffers</link>    (<link linkend="GdkGLDrawable">GdkGLDrawable</link> *gldrawable);
 
25
<link linkend="void">void</link>        <link linkend="gdk-gl-drawable-wait-gl">gdk_gl_drawable_wait_gl</link>         (<link linkend="GdkGLDrawable">GdkGLDrawable</link> *gldrawable);
 
26
<link linkend="void">void</link>        <link linkend="gdk-gl-drawable-wait-gdk">gdk_gl_drawable_wait_gdk</link>        (<link linkend="GdkGLDrawable">GdkGLDrawable</link> *gldrawable);
27
27
<link linkend="gboolean">gboolean</link>    <link linkend="gdk-gl-drawable-gl-begin">gdk_gl_drawable_gl_begin</link>        (<link linkend="GdkGLDrawable">GdkGLDrawable</link> *gldrawable,
28
28
                                             <link linkend="GdkGLContext">GdkGLContext</link> *glcontext);
29
 
void        <link linkend="gdk-gl-drawable-gl-end">gdk_gl_drawable_gl_end</link>          (<link linkend="GdkGLDrawable">GdkGLDrawable</link> *gldrawable);
 
29
<link linkend="void">void</link>        <link linkend="gdk-gl-drawable-gl-end">gdk_gl_drawable_gl_end</link>          (<link linkend="GdkGLDrawable">GdkGLDrawable</link> *gldrawable);
30
30
<link linkend="GdkGLConfig">GdkGLConfig</link>* <link linkend="gdk-gl-drawable-get-gl-config">gdk_gl_drawable_get_gl_config</link>  (<link linkend="GdkGLDrawable">GdkGLDrawable</link> *gldrawable);
31
 
void        <link linkend="gdk-gl-drawable-get-size">gdk_gl_drawable_get_size</link>        (<link linkend="GdkGLDrawable">GdkGLDrawable</link> *gldrawable,
 
31
<link linkend="void">void</link>        <link linkend="gdk-gl-drawable-get-size">gdk_gl_drawable_get_size</link>        (<link linkend="GdkGLDrawable">GdkGLDrawable</link> *gldrawable,
32
32
                                             <link linkend="gint">gint</link> *width,
33
33
                                             <link linkend="gint">gint</link> *height);
34
34
<link linkend="GdkGLDrawable">GdkGLDrawable</link>* <link linkend="gdk-gl-drawable-get-current">gdk_gl_drawable_get_current</link>  (void);
52
52
 
53
53
 
54
54
 
 
55
 
 
56
 
55
57
<refsect1>
56
58
<title>Description</title>
57
59
<para>
62
64
<refsect1>
63
65
<title>Details</title>
64
66
<refsect2>
65
 
<title><anchor id="GdkGLDrawable-struct"/>struct GdkGLDrawable</title>
66
 
<programlisting>struct GdkGLDrawable;</programlisting>
 
67
<title><anchor id="GdkGLDrawable-struct"/>GdkGLDrawable</title>
 
68
<indexterm><primary>GdkGLDrawable</primary></indexterm><programlisting>typedef struct _GdkGLDrawable GdkGLDrawable;</programlisting>
67
69
<para>
68
70
 
69
71
</para></refsect2>
70
72
<refsect2>
71
73
<title><anchor id="gdk-gl-drawable-make-current"/>gdk_gl_drawable_make_current ()</title>
72
 
<programlisting><link linkend="gboolean">gboolean</link>    gdk_gl_drawable_make_current    (<link linkend="GdkGLDrawable">GdkGLDrawable</link> *gldrawable,
 
74
<indexterm><primary>gdk_gl_drawable_make_current</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gdk_gl_drawable_make_current    (<link linkend="GdkGLDrawable">GdkGLDrawable</link> *gldrawable,
73
75
                                             <link linkend="GdkGLContext">GdkGLContext</link> *glcontext);</programlisting>
74
76
<para>
75
77
Attach an OpenGL rendering context to a <parameter>gldrawable</parameter>.</para>
77
79
 
78
80
</para><variablelist role="params">
79
81
<varlistentry><term><parameter>gldrawable</parameter>&nbsp;:</term>
80
 
<listitem><simpara> a <link linkend="GdkGLDrawable">GdkGLDrawable</link>.
 
82
<listitem><simpara> a <link linkend="GdkGLDrawable"><type>GdkGLDrawable</type></link>.
81
83
</simpara></listitem></varlistentry>
82
84
<varlistentry><term><parameter>glcontext</parameter>&nbsp;:</term>
83
 
<listitem><simpara> a <link linkend="GdkGLContext">GdkGLContext</link>.
 
85
<listitem><simpara> a <link linkend="GdkGLContext"><type>GdkGLContext</type></link>.
84
86
</simpara></listitem></varlistentry>
85
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if it is successful, FALSE otherwise.
 
87
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE if it is successful, FALSE otherwise.
86
88
</simpara></listitem></varlistentry>
87
89
</variablelist></refsect2>
88
90
<refsect2>
89
91
<title><anchor id="gdk-gl-drawable-is-double-buffered"/>gdk_gl_drawable_is_double_buffered ()</title>
90
 
<programlisting><link linkend="gboolean">gboolean</link>    gdk_gl_drawable_is_double_buffered
 
92
<indexterm><primary>gdk_gl_drawable_is_double_buffered</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gdk_gl_drawable_is_double_buffered
91
93
                                            (<link linkend="GdkGLDrawable">GdkGLDrawable</link> *gldrawable);</programlisting>
92
94
<para>
93
95
Returns whether the <parameter>gldrawable</parameter> supports the double-buffered visual.</para>
95
97
 
96
98
</para><variablelist role="params">
97
99
<varlistentry><term><parameter>gldrawable</parameter>&nbsp;:</term>
98
 
<listitem><simpara> a <link linkend="GdkGLDrawable">GdkGLDrawable</link>.
 
100
<listitem><simpara> a <link linkend="GdkGLDrawable"><type>GdkGLDrawable</type></link>.
99
101
</simpara></listitem></varlistentry>
100
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if the double-buffered visual is supported,
 
102
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE if the double-buffered visual is supported,
101
103
              FALSE otherwise.
102
104
</simpara></listitem></varlistentry>
103
105
</variablelist></refsect2>
104
106
<refsect2>
105
107
<title><anchor id="gdk-gl-drawable-swap-buffers"/>gdk_gl_drawable_swap_buffers ()</title>
106
 
<programlisting>void        gdk_gl_drawable_swap_buffers    (<link linkend="GdkGLDrawable">GdkGLDrawable</link> *gldrawable);</programlisting>
 
108
<indexterm><primary>gdk_gl_drawable_swap_buffers</primary></indexterm><programlisting><link linkend="void">void</link>        gdk_gl_drawable_swap_buffers    (<link linkend="GdkGLDrawable">GdkGLDrawable</link> *gldrawable);</programlisting>
107
109
<para>
108
110
Exchange front and back buffers.</para>
109
111
<para>
110
112
 
111
113
</para><variablelist role="params">
112
114
<varlistentry><term><parameter>gldrawable</parameter>&nbsp;:</term>
113
 
<listitem><simpara> a <link linkend="GdkGLDrawable">GdkGLDrawable</link>.
 
115
<listitem><simpara> a <link linkend="GdkGLDrawable"><type>GdkGLDrawable</type></link>.
114
116
</simpara></listitem></varlistentry>
115
117
</variablelist></refsect2>
116
118
<refsect2>
117
119
<title><anchor id="gdk-gl-drawable-wait-gl"/>gdk_gl_drawable_wait_gl ()</title>
118
 
<programlisting>void        gdk_gl_drawable_wait_gl         (<link linkend="GdkGLDrawable">GdkGLDrawable</link> *gldrawable);</programlisting>
 
120
<indexterm><primary>gdk_gl_drawable_wait_gl</primary></indexterm><programlisting><link linkend="void">void</link>        gdk_gl_drawable_wait_gl         (<link linkend="GdkGLDrawable">GdkGLDrawable</link> *gldrawable);</programlisting>
119
121
<para>
120
122
Complete OpenGL execution prior to subsequent GDK drawing calls.</para>
121
123
<para>
122
124
 
123
125
</para><variablelist role="params">
124
126
<varlistentry><term><parameter>gldrawable</parameter>&nbsp;:</term>
125
 
<listitem><simpara> a <link linkend="GdkGLDrawable">GdkGLDrawable</link>.
 
127
<listitem><simpara> a <link linkend="GdkGLDrawable"><type>GdkGLDrawable</type></link>.
126
128
</simpara></listitem></varlistentry>
127
129
</variablelist></refsect2>
128
130
<refsect2>
129
131
<title><anchor id="gdk-gl-drawable-wait-gdk"/>gdk_gl_drawable_wait_gdk ()</title>
130
 
<programlisting>void        gdk_gl_drawable_wait_gdk        (<link linkend="GdkGLDrawable">GdkGLDrawable</link> *gldrawable);</programlisting>
 
132
<indexterm><primary>gdk_gl_drawable_wait_gdk</primary></indexterm><programlisting><link linkend="void">void</link>        gdk_gl_drawable_wait_gdk        (<link linkend="GdkGLDrawable">GdkGLDrawable</link> *gldrawable);</programlisting>
131
133
<para>
132
134
Complete GDK drawing execution prior to subsequent OpenGL calls.</para>
133
135
<para>
134
136
 
135
137
</para><variablelist role="params">
136
138
<varlistentry><term><parameter>gldrawable</parameter>&nbsp;:</term>
137
 
<listitem><simpara> a <link linkend="GdkGLDrawable">GdkGLDrawable</link>.
 
139
<listitem><simpara> a <link linkend="GdkGLDrawable"><type>GdkGLDrawable</type></link>.
138
140
</simpara></listitem></varlistentry>
139
141
</variablelist></refsect2>
140
142
<refsect2>
141
143
<title><anchor id="gdk-gl-drawable-gl-begin"/>gdk_gl_drawable_gl_begin ()</title>
142
 
<programlisting><link linkend="gboolean">gboolean</link>    gdk_gl_drawable_gl_begin        (<link linkend="GdkGLDrawable">GdkGLDrawable</link> *gldrawable,
 
144
<indexterm><primary>gdk_gl_drawable_gl_begin</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gdk_gl_drawable_gl_begin        (<link linkend="GdkGLDrawable">GdkGLDrawable</link> *gldrawable,
143
145
                                             <link linkend="GdkGLContext">GdkGLContext</link> *glcontext);</programlisting>
144
146
<para>
145
147
Delimits the begining of the OpenGL execution.</para>
147
149
 
148
150
</para><variablelist role="params">
149
151
<varlistentry><term><parameter>gldrawable</parameter>&nbsp;:</term>
150
 
<listitem><simpara> a <link linkend="GdkGLDrawable">GdkGLDrawable</link>.
 
152
<listitem><simpara> a <link linkend="GdkGLDrawable"><type>GdkGLDrawable</type></link>.
151
153
</simpara></listitem></varlistentry>
152
154
<varlistentry><term><parameter>glcontext</parameter>&nbsp;:</term>
153
 
<listitem><simpara> a <link linkend="GdkGLContext">GdkGLContext</link>.
 
155
<listitem><simpara> a <link linkend="GdkGLContext"><type>GdkGLContext</type></link>.
154
156
</simpara></listitem></varlistentry>
155
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if it is successful, FALSE otherwise.
 
157
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE if it is successful, FALSE otherwise.
156
158
</simpara></listitem></varlistentry>
157
159
</variablelist></refsect2>
158
160
<refsect2>
159
161
<title><anchor id="gdk-gl-drawable-gl-end"/>gdk_gl_drawable_gl_end ()</title>
160
 
<programlisting>void        gdk_gl_drawable_gl_end          (<link linkend="GdkGLDrawable">GdkGLDrawable</link> *gldrawable);</programlisting>
 
162
<indexterm><primary>gdk_gl_drawable_gl_end</primary></indexterm><programlisting><link linkend="void">void</link>        gdk_gl_drawable_gl_end          (<link linkend="GdkGLDrawable">GdkGLDrawable</link> *gldrawable);</programlisting>
161
163
<para>
162
164
Delimits the end of the OpenGL execution.</para>
163
165
<para>
164
166
 
165
167
</para><variablelist role="params">
166
168
<varlistentry><term><parameter>gldrawable</parameter>&nbsp;:</term>
167
 
<listitem><simpara> a <link linkend="GdkGLDrawable">GdkGLDrawable</link>.
 
169
<listitem><simpara> a <link linkend="GdkGLDrawable"><type>GdkGLDrawable</type></link>.
168
170
</simpara></listitem></varlistentry>
169
171
</variablelist></refsect2>
170
172
<refsect2>
171
173
<title><anchor id="gdk-gl-drawable-get-gl-config"/>gdk_gl_drawable_get_gl_config ()</title>
172
 
<programlisting><link linkend="GdkGLConfig">GdkGLConfig</link>* gdk_gl_drawable_get_gl_config  (<link linkend="GdkGLDrawable">GdkGLDrawable</link> *gldrawable);</programlisting>
 
174
<indexterm><primary>gdk_gl_drawable_get_gl_config</primary></indexterm><programlisting><link linkend="GdkGLConfig">GdkGLConfig</link>* gdk_gl_drawable_get_gl_config  (<link linkend="GdkGLDrawable">GdkGLDrawable</link> *gldrawable);</programlisting>
173
175
<para>
174
 
Gets <link linkend="GdkGLConfig">GdkGLConfig</link> with which the <parameter>gldrawable</parameter> is configured.</para>
 
176
Gets <link linkend="GdkGLConfig"><type>GdkGLConfig</type></link> with which the <parameter>gldrawable</parameter> is configured.</para>
175
177
<para>
176
178
 
177
179
</para><variablelist role="params">
178
180
<varlistentry><term><parameter>gldrawable</parameter>&nbsp;:</term>
179
 
<listitem><simpara> a <link linkend="GdkGLDrawable">GdkGLDrawable</link>.
 
181
<listitem><simpara> a <link linkend="GdkGLDrawable"><type>GdkGLDrawable</type></link>.
180
182
</simpara></listitem></varlistentry>
181
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the <link linkend="GdkGLConfig">GdkGLConfig</link>.
 
183
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the <link linkend="GdkGLConfig"><type>GdkGLConfig</type></link>.
182
184
</simpara></listitem></varlistentry>
183
185
</variablelist></refsect2>
184
186
<refsect2>
185
187
<title><anchor id="gdk-gl-drawable-get-size"/>gdk_gl_drawable_get_size ()</title>
186
 
<programlisting>void        gdk_gl_drawable_get_size        (<link linkend="GdkGLDrawable">GdkGLDrawable</link> *gldrawable,
 
188
<indexterm><primary>gdk_gl_drawable_get_size</primary></indexterm><programlisting><link linkend="void">void</link>        gdk_gl_drawable_get_size        (<link linkend="GdkGLDrawable">GdkGLDrawable</link> *gldrawable,
187
189
                                             <link linkend="gint">gint</link> *width,
188
190
                                             <link linkend="gint">gint</link> *height);</programlisting>
189
191
<para>
193
195
 
194
196
</para><variablelist role="params">
195
197
<varlistentry><term><parameter>gldrawable</parameter>&nbsp;:</term>
196
 
<listitem><simpara> a <link linkend="GdkGLDrawable">GdkGLDrawable</link>.
 
198
<listitem><simpara> a <link linkend="GdkGLDrawable"><type>GdkGLDrawable</type></link>.
197
199
</simpara></listitem></varlistentry>
198
200
<varlistentry><term><parameter>width</parameter>&nbsp;:</term>
199
201
<listitem><simpara> location to store drawable's width, or NULL.
204
206
</variablelist></refsect2>
205
207
<refsect2>
206
208
<title><anchor id="gdk-gl-drawable-get-current"/>gdk_gl_drawable_get_current ()</title>
207
 
<programlisting><link linkend="GdkGLDrawable">GdkGLDrawable</link>* gdk_gl_drawable_get_current  (void);</programlisting>
 
209
<indexterm><primary>gdk_gl_drawable_get_current</primary></indexterm><programlisting><link linkend="GdkGLDrawable">GdkGLDrawable</link>* gdk_gl_drawable_get_current  (void);</programlisting>
208
210
<para>
209
 
Returns the current <link linkend="GdkGLDrawable">GdkGLDrawable</link>.</para>
 
211
Returns the current <link linkend="GdkGLDrawable"><type>GdkGLDrawable</type></link>.</para>
210
212
<para>
211
213
 
212
214
</para><variablelist role="params">
213
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the current <link linkend="GdkGLDrawable">GdkGLDrawable</link> or NULL if there is no current drawable.
 
215
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the current <link linkend="GdkGLDrawable"><type>GdkGLDrawable</type></link> or NULL if there is no current drawable.
214
216
</simpara></listitem></varlistentry>
215
217
</variablelist></refsect2>
216
218