/usr/share/gtk-doc/html/libgwydgets/libgwydgets-gwydgets.html is in libgwyddion20-doc 2.26-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gwydgets</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Gwyddion Widgets Library Reference Manual">
<link rel="up" href="WidgetUtilities.html" title="Widget Utilities">
<link rel="prev" href="WidgetUtilities.html" title="Widget Utilities">
<link rel="next" href="libgwydgets-gwydgetenums.html" title="gwydgetenums">
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="WidgetUtilities.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="WidgetUtilities.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Gwyddion Widgets Library Reference Manual</th>
<td><a accesskey="n" href="libgwydgets-gwydgetenums.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libgwydgets-gwydgets.synopsis" class="shortcut">Top</a>
|
<a href="#libgwydgets-gwydgets.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libgwydgets-gwydgets"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgwydgets-gwydgets.top_of_page"></a>gwydgets</span></h2>
<p>gwydgets — Base functions</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgwydgets-gwydgets.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libgwydgets/gwydgets.h>
typedef <a class="link" href="libgwydgets-gwydgets.html#GdkGLConfig" title="GdkGLConfig">GdkGLConfig</a>;
<a class="link" href="libgwydgets-gwydgets.html#GdkGLConfig" title="GdkGLConfig"><span class="returnvalue">GdkGLConfig</span></a> * <a class="link" href="libgwydgets-gwydgets.html#gwy-widgets-get-gl-config" title="gwy_widgets_get_gl_config ()">gwy_widgets_get_gl_config</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="libgwydgets-gwydgets.html#gwy-widgets-gl-init" title="gwy_widgets_gl_init ()">gwy_widgets_gl_init</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="libgwydgets-gwydgets.html#gwy-widgets-type-init" title="gwy_widgets_type_init ()">gwy_widgets_type_init</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libgwydgets-gwydgets.description"></a><h2>Description</h2>
<p>
Gwyddion classes has to be initialized before they can be safely
deserialized. The function <a href="./../libgwyddion/libgwyddion/libgwyddion-gwyddion.html#gwy-type-init"><code class="function">gwy_type_init()</code></a> performs this initialization.
</p>
<p>
Before 3D widgets (<a class="link" href="Gwy3DView.html" title="Gwy3DView"><span class="type">Gwy3DView</span></a>) can be used, OpenGL must be initialized with
<a class="link" href="libgwydgets-gwydgets.html#gwy-widgets-gl-init" title="gwy_widgets_gl_init ()"><code class="function">gwy_widgets_gl_init()</code></a>.
</p>
</div>
<div class="refsect1">
<a name="libgwydgets-gwydgets.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GdkGLConfig"></a><h3>GdkGLConfig</h3>
<pre class="programlisting">typedef void GdkGLConfig;
</pre>
<p>
Placeholder typedef.
</p>
<p>
If Gwyddion is compiled with OpenGL (i.e., GtkGLExt) this is the real
<span class="type">GdkGLConfig</span>. However, if Gwyddion is compiled without OpenGL
this type is typedefed as <span class="type">void</span>.
</p>
<p>
Since one cannot actually use any of the Gwyddion OpenGL widgets if they
are not enabled, this usually works well. However, it can break in the
unlikely case one compiles with wibgwydgets that have OpenGL disabled and
at the same time he uses GtkGLExt directly. In such case
<span class="type">GdkGLConfig</span> is defined twice. The only known fix is not
to include <code class="filename">gwydgets.h</code> and GtkGLExt headers in the same
source file.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-widgets-get-gl-config"></a><h3>gwy_widgets_get_gl_config ()</h3>
<pre class="programlisting"><a class="link" href="libgwydgets-gwydgets.html#GdkGLConfig" title="GdkGLConfig"><span class="returnvalue">GdkGLConfig</span></a> * gwy_widgets_get_gl_config (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Returns OpenGL framebuffer configuration for 3D widgets.
</p>
<p>
Call <a class="link" href="libgwydgets-gwydgets.html#gwy-widgets-gl-init" title="gwy_widgets_gl_init ()"><code class="function">gwy_widgets_gl_init()</code></a> first.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The OpenGL framebuffer configuration, <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if OpenGL
initialization was not successfull.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-widgets-gl-init"></a><h3>gwy_widgets_gl_init ()</h3>
<pre class="programlisting"><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gwy_widgets_gl_init (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Configures an OpenGL-capable visual for 3D widgets.
</p>
<p>
Use <a class="link" href="libgwydgets-gwydgets.html#gwy-widgets-get-gl-config" title="gwy_widgets_get_gl_config ()"><code class="function">gwy_widgets_get_gl_config()</code></a> to get the framebuffer configuration.
</p>
<p>
This function must be called before OpenGL widgets can be used.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if an appropriate visual was found. If Gwyddion was compiled
without OpenGL support, it always returns <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-widgets-type-init"></a><h3>gwy_widgets_type_init ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_widgets_type_init (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Makes libgwydgets types safe for deserialization and performs other
initialization. You have to call this function before using widgets and
objects from libgwydgets.
</p>
<p>
Calls <a href="./../libgwydraw/libgwydraw/libgwydraw-gwydraw.html#gwy-draw-type-init"><code class="function">gwy_draw_type_init()</code></a> first to make sure libgwydraw is initialized.
</p>
<p>
It is safe to call this function more than once, subsequent calls are no-op.
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.8</div>
</body>
</html>
|