← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/reference/gtkglext/xml/gdkglcontext.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/gdkglcontext.xml
16
16
#include <gdk/gdkgl.h>
17
17
 
18
18
 
19
 
struct      <link linkend="GdkGLContext-struct">GdkGLContext</link>;
 
19
            <link linkend="GdkGLContext-struct">GdkGLContext</link>;
20
20
<link linkend="GdkGLContext">GdkGLContext</link>* <link linkend="gdk-gl-context-new">gdk_gl_context_new</link>            (<link linkend="GdkGLDrawable">GdkGLDrawable</link> *gldrawable,
21
21
                                             <link linkend="GdkGLContext">GdkGLContext</link> *share_list,
22
22
                                             <link linkend="gboolean">gboolean</link> direct,
23
 
                                             int render_type);
24
 
void        <link linkend="gdk-gl-context-destroy">gdk_gl_context_destroy</link>          (<link linkend="GdkGLContext">GdkGLContext</link> *glcontext);
 
23
                                             <link linkend="int">int</link> render_type);
 
24
<link linkend="void">void</link>        <link linkend="gdk-gl-context-destroy">gdk_gl_context_destroy</link>          (<link linkend="GdkGLContext">GdkGLContext</link> *glcontext);
25
25
<link linkend="gboolean">gboolean</link>    <link linkend="gdk-gl-context-copy">gdk_gl_context_copy</link>             (<link linkend="GdkGLContext">GdkGLContext</link> *glcontext,
26
26
                                             <link linkend="GdkGLContext">GdkGLContext</link> *src,
27
27
                                             unsigned <link linkend="long--mask">long  mask</link>);
30
30
<link linkend="GdkGLConfig">GdkGLConfig</link>* <link linkend="gdk-gl-context-get-gl-config">gdk_gl_context_get_gl_config</link>   (<link linkend="GdkGLContext">GdkGLContext</link> *glcontext);
31
31
<link linkend="GdkGLContext">GdkGLContext</link>* <link linkend="gdk-gl-context-get-share-list">gdk_gl_context_get_share_list</link> (<link linkend="GdkGLContext">GdkGLContext</link> *glcontext);
32
32
<link linkend="gboolean">gboolean</link>    <link linkend="gdk-gl-context-is-direct">gdk_gl_context_is_direct</link>        (<link linkend="GdkGLContext">GdkGLContext</link> *glcontext);
33
 
int         <link linkend="gdk-gl-context-get-render-type">gdk_gl_context_get_render_type</link>  (<link linkend="GdkGLContext">GdkGLContext</link> *glcontext);
 
33
<link linkend="int">int</link>         <link linkend="gdk-gl-context-get-render-type">gdk_gl_context_get_render_type</link>  (<link linkend="GdkGLContext">GdkGLContext</link> *glcontext);
34
34
<link linkend="GdkGLContext">GdkGLContext</link>* <link linkend="gdk-gl-context-get-current">gdk_gl_context_get_current</link>    (void);
35
35
 
36
36
 
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="GdkGLContext-struct"/>struct GdkGLContext</title>
66
 
<programlisting>struct GdkGLContext;</programlisting>
 
67
<title><anchor id="GdkGLContext-struct"/>GdkGLContext</title>
 
68
<indexterm><primary>GdkGLContext</primary></indexterm><programlisting>typedef struct _GdkGLContext GdkGLContext;</programlisting>
67
69
<para>
68
70
 
69
71
</para></refsect2>
70
72
<refsect2>
71
73
<title><anchor id="gdk-gl-context-new"/>gdk_gl_context_new ()</title>
72
 
<programlisting><link linkend="GdkGLContext">GdkGLContext</link>* gdk_gl_context_new            (<link linkend="GdkGLDrawable">GdkGLDrawable</link> *gldrawable,
 
74
<indexterm><primary>gdk_gl_context_new</primary></indexterm><programlisting><link linkend="GdkGLContext">GdkGLContext</link>* gdk_gl_context_new            (<link linkend="GdkGLDrawable">GdkGLDrawable</link> *gldrawable,
73
75
                                             <link linkend="GdkGLContext">GdkGLContext</link> *share_list,
74
76
                                             <link linkend="gboolean">gboolean</link> direct,
75
 
                                             int render_type);</programlisting>
 
77
                                             <link linkend="int">int</link> render_type);</programlisting>
76
78
<para>
77
79
Creates a new OpenGL rendering context.</para>
78
80
<para>
79
81
 
80
82
</para><variablelist role="params">
81
83
<varlistentry><term><parameter>gldrawable</parameter>&nbsp;:</term>
82
 
<listitem><simpara> a <link linkend="GdkGLDrawable">GdkGLDrawable</link>.
 
84
<listitem><simpara> a <link linkend="GdkGLDrawable"><type>GdkGLDrawable</type></link>.
83
85
</simpara></listitem></varlistentry>
84
86
<varlistentry><term><parameter>share_list</parameter>&nbsp;:</term>
85
 
<listitem><simpara> the <link linkend="GdkGLContext">GdkGLContext</link> with which to share display lists and texture
 
87
<listitem><simpara> the <link linkend="GdkGLContext"><type>GdkGLContext</type></link> with which to share display lists and texture
86
88
             objects. NULL indicates that no sharing is to take place.
87
89
</simpara></listitem></varlistentry>
88
90
<varlistentry><term><parameter>direct</parameter>&nbsp;:</term>
93
95
<listitem><simpara> GDK_GL_RGBA_TYPE or GDK_GL_COLOR_INDEX_TYPE (currently not
94
96
              used).
95
97
</simpara></listitem></varlistentry>
96
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the new <link linkend="GdkGLContext">GdkGLContext</link>.
 
98
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the new <link linkend="GdkGLContext"><type>GdkGLContext</type></link>.
97
99
</simpara></listitem></varlistentry>
98
100
</variablelist></refsect2>
99
101
<refsect2>
100
102
<title><anchor id="gdk-gl-context-destroy"/>gdk_gl_context_destroy ()</title>
101
 
<programlisting>void        gdk_gl_context_destroy          (<link linkend="GdkGLContext">GdkGLContext</link> *glcontext);</programlisting>
 
103
<indexterm><primary>gdk_gl_context_destroy</primary></indexterm><programlisting><link linkend="void">void</link>        gdk_gl_context_destroy          (<link linkend="GdkGLContext">GdkGLContext</link> *glcontext);</programlisting>
102
104
<para>
103
105
Destroys the OpenGL resources associated with <parameter>glcontext</parameter> and
104
106
decrements <parameter>glcontext</parameter>'s reference count.</para>
106
108
 
107
109
</para><variablelist role="params">
108
110
<varlistentry><term><parameter>glcontext</parameter>&nbsp;:</term>
109
 
<listitem><simpara> a <link linkend="GdkGLContext">GdkGLContext</link>.
 
111
<listitem><simpara> a <link linkend="GdkGLContext"><type>GdkGLContext</type></link>.
110
112
</simpara></listitem></varlistentry>
111
113
</variablelist></refsect2>
112
114
<refsect2>
113
115
<title><anchor id="gdk-gl-context-copy"/>gdk_gl_context_copy ()</title>
114
 
<programlisting><link linkend="gboolean">gboolean</link>    gdk_gl_context_copy             (<link linkend="GdkGLContext">GdkGLContext</link> *glcontext,
 
116
<indexterm><primary>gdk_gl_context_copy</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gdk_gl_context_copy             (<link linkend="GdkGLContext">GdkGLContext</link> *glcontext,
115
117
                                             <link linkend="GdkGLContext">GdkGLContext</link> *src,
116
118
                                             unsigned <link linkend="long--mask">long  mask</link>);</programlisting>
117
119
<para>
119
121
</para>
120
122
<para>
121
123
<parameter>mask</parameter> contains the bitwise-OR of the same symbolic names that are passed to
122
 
the <link linkend="glPushAttrib">glPushAttrib</link>() function. You can use GL_ALL_ATTRIB_BITS to copy all the
 
124
the <link linkend="glPushAttrib"><function>glPushAttrib()</function></link> function. You can use GL_ALL_ATTRIB_BITS to copy all the
123
125
rendering state information.</para>
124
126
<para>
125
127
 
126
128
</para><variablelist role="params">
127
129
<varlistentry><term><parameter>glcontext</parameter>&nbsp;:</term>
128
 
<listitem><simpara> a <link linkend="GdkGLContext">GdkGLContext</link>.
 
130
<listitem><simpara> a <link linkend="GdkGLContext"><type>GdkGLContext</type></link>.
129
131
</simpara></listitem></varlistentry>
130
132
<varlistentry><term><parameter>src</parameter>&nbsp;:</term>
131
133
<listitem><simpara> the source context.
133
135
<varlistentry><term><parameter>Param3</parameter>&nbsp;:</term>
134
136
<listitem><simpara>
135
137
</simpara></listitem></varlistentry>
136
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> FALSE if it fails, TRUE otherwise.
 
138
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> FALSE if it fails, TRUE otherwise.
137
139
</simpara></listitem></varlistentry>
138
140
</variablelist></refsect2>
139
141
<refsect2>
140
142
<title><anchor id="gdk-gl-context-get-gl-drawable"/>gdk_gl_context_get_gl_drawable ()</title>
141
 
<programlisting><link linkend="GdkGLDrawable">GdkGLDrawable</link>* gdk_gl_context_get_gl_drawable
 
143
<indexterm><primary>gdk_gl_context_get_gl_drawable</primary></indexterm><programlisting><link linkend="GdkGLDrawable">GdkGLDrawable</link>* gdk_gl_context_get_gl_drawable
142
144
                                            (<link linkend="GdkGLContext">GdkGLContext</link> *glcontext);</programlisting>
143
145
<para>
144
 
Gets <link linkend="GdkGLDrawable">GdkGLDrawable</link> to which the <parameter>glcontext</parameter> is bound.</para>
 
146
Gets <link linkend="GdkGLDrawable"><type>GdkGLDrawable</type></link> to which the <parameter>glcontext</parameter> is bound.</para>
145
147
<para>
146
148
 
147
149
</para><variablelist role="params">
148
150
<varlistentry><term><parameter>glcontext</parameter>&nbsp;:</term>
149
 
<listitem><simpara> a <link linkend="GdkGLContext">GdkGLContext</link>.
 
151
<listitem><simpara> a <link linkend="GdkGLContext"><type>GdkGLContext</type></link>.
150
152
</simpara></listitem></varlistentry>
151
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the <link linkend="GdkGLDrawable">GdkGLDrawable</link> or NULL if no <link linkend="GdkGLDrawable">GdkGLDrawable</link> is bound.
 
153
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the <link linkend="GdkGLDrawable"><type>GdkGLDrawable</type></link> or NULL if no <link linkend="GdkGLDrawable"><type>GdkGLDrawable</type></link> is bound.
152
154
</simpara></listitem></varlistentry>
153
155
</variablelist></refsect2>
154
156
<refsect2>
155
157
<title><anchor id="gdk-gl-context-get-gl-config"/>gdk_gl_context_get_gl_config ()</title>
156
 
<programlisting><link linkend="GdkGLConfig">GdkGLConfig</link>* gdk_gl_context_get_gl_config   (<link linkend="GdkGLContext">GdkGLContext</link> *glcontext);</programlisting>
 
158
<indexterm><primary>gdk_gl_context_get_gl_config</primary></indexterm><programlisting><link linkend="GdkGLConfig">GdkGLConfig</link>* gdk_gl_context_get_gl_config   (<link linkend="GdkGLContext">GdkGLContext</link> *glcontext);</programlisting>
157
159
<para>
158
 
Gets <link linkend="GdkGLConfig">GdkGLConfig</link> with which the <parameter>glcontext</parameter> is configured.</para>
 
160
Gets <link linkend="GdkGLConfig"><type>GdkGLConfig</type></link> with which the <parameter>glcontext</parameter> is configured.</para>
159
161
<para>
160
162
 
161
163
</para><variablelist role="params">
162
164
<varlistentry><term><parameter>glcontext</parameter>&nbsp;:</term>
163
 
<listitem><simpara> a <link linkend="GdkGLContext">GdkGLContext</link>.
 
165
<listitem><simpara> a <link linkend="GdkGLContext"><type>GdkGLContext</type></link>.
164
166
</simpara></listitem></varlistentry>
165
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the <link linkend="GdkGLConfig">GdkGLConfig</link>.
 
167
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the <link linkend="GdkGLConfig"><type>GdkGLConfig</type></link>.
166
168
</simpara></listitem></varlistentry>
167
169
</variablelist></refsect2>
168
170
<refsect2>
169
171
<title><anchor id="gdk-gl-context-get-share-list"/>gdk_gl_context_get_share_list ()</title>
170
 
<programlisting><link linkend="GdkGLContext">GdkGLContext</link>* gdk_gl_context_get_share_list (<link linkend="GdkGLContext">GdkGLContext</link> *glcontext);</programlisting>
 
172
<indexterm><primary>gdk_gl_context_get_share_list</primary></indexterm><programlisting><link linkend="GdkGLContext">GdkGLContext</link>* gdk_gl_context_get_share_list (<link linkend="GdkGLContext">GdkGLContext</link> *glcontext);</programlisting>
171
173
<para>
172
 
Gets <link linkend="GdkGLContext">GdkGLContext</link> with which the <parameter>glcontext</parameter> shares the display lists and
 
174
Gets <link linkend="GdkGLContext"><type>GdkGLContext</type></link> with which the <parameter>glcontext</parameter> shares the display lists and
173
175
texture objects.</para>
174
176
<para>
175
177
 
176
178
</para><variablelist role="params">
177
179
<varlistentry><term><parameter>glcontext</parameter>&nbsp;:</term>
178
 
<listitem><simpara> a <link linkend="GdkGLContext">GdkGLContext</link>.
 
180
<listitem><simpara> a <link linkend="GdkGLContext"><type>GdkGLContext</type></link>.
179
181
</simpara></listitem></varlistentry>
180
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the <link linkend="GdkGLContext">GdkGLContext</link>.
 
182
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the <link linkend="GdkGLContext"><type>GdkGLContext</type></link>.
181
183
</simpara></listitem></varlistentry>
182
184
</variablelist></refsect2>
183
185
<refsect2>
184
186
<title><anchor id="gdk-gl-context-is-direct"/>gdk_gl_context_is_direct ()</title>
185
 
<programlisting><link linkend="gboolean">gboolean</link>    gdk_gl_context_is_direct        (<link linkend="GdkGLContext">GdkGLContext</link> *glcontext);</programlisting>
 
187
<indexterm><primary>gdk_gl_context_is_direct</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gdk_gl_context_is_direct        (<link linkend="GdkGLContext">GdkGLContext</link> *glcontext);</programlisting>
186
188
<para>
187
189
Returns whether the <parameter>glcontext</parameter> is a direct rendering context.</para>
188
190
<para>
189
191
 
190
192
</para><variablelist role="params">
191
193
<varlistentry><term><parameter>glcontext</parameter>&nbsp;:</term>
192
 
<listitem><simpara> a <link linkend="GdkGLContext">GdkGLContext</link>.
 
194
<listitem><simpara> a <link linkend="GdkGLContext"><type>GdkGLContext</type></link>.
193
195
</simpara></listitem></varlistentry>
194
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if the <parameter>glcontext</parameter> is a direct rendering contest.
 
196
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE if the <parameter>glcontext</parameter> is a direct rendering contest.
195
197
</simpara></listitem></varlistentry>
196
198
</variablelist></refsect2>
197
199
<refsect2>
198
200
<title><anchor id="gdk-gl-context-get-render-type"/>gdk_gl_context_get_render_type ()</title>
199
 
<programlisting>int         gdk_gl_context_get_render_type  (<link linkend="GdkGLContext">GdkGLContext</link> *glcontext);</programlisting>
 
201
<indexterm><primary>gdk_gl_context_get_render_type</primary></indexterm><programlisting><link linkend="int">int</link>         gdk_gl_context_get_render_type  (<link linkend="GdkGLContext">GdkGLContext</link> *glcontext);</programlisting>
200
202
<para>
201
203
Gets render_type of the <parameter>glcontext</parameter>.</para>
202
204
<para>
203
205
 
204
206
</para><variablelist role="params">
205
207
<varlistentry><term><parameter>glcontext</parameter>&nbsp;:</term>
206
 
<listitem><simpara> a <link linkend="GdkGLContext">GdkGLContext</link>.
 
208
<listitem><simpara> a <link linkend="GdkGLContext"><type>GdkGLContext</type></link>.
207
209
</simpara></listitem></varlistentry>
208
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> GDK_GL_RGBA_TYPE or GDK_GL_COLOR_INDEX_TYPE.
 
210
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> GDK_GL_RGBA_TYPE or GDK_GL_COLOR_INDEX_TYPE.
209
211
</simpara></listitem></varlistentry>
210
212
</variablelist></refsect2>
211
213
<refsect2>
212
214
<title><anchor id="gdk-gl-context-get-current"/>gdk_gl_context_get_current ()</title>
213
 
<programlisting><link linkend="GdkGLContext">GdkGLContext</link>* gdk_gl_context_get_current    (void);</programlisting>
 
215
<indexterm><primary>gdk_gl_context_get_current</primary></indexterm><programlisting><link linkend="GdkGLContext">GdkGLContext</link>* gdk_gl_context_get_current    (void);</programlisting>
214
216
<para>
215
 
Returns the current <link linkend="GdkGLContext">GdkGLContext</link>.</para>
 
217
Returns the current <link linkend="GdkGLContext"><type>GdkGLContext</type></link>.</para>
216
218
<para>
217
219
 
218
220
</para><variablelist role="params">
219
 
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the current <link linkend="GdkGLContext">GdkGLContext</link> or NULL if there is no current
 
221
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the current <link linkend="GdkGLContext"><type>GdkGLContext</type></link> or NULL if there is no current
220
222
              context.
221
223
</simpara></listitem></varlistentry>
222
224
</variablelist></refsect2>