/usr/share/gtk-doc/html/pigment/PgmViewportFactory.html is in libpigment0.3-dev 0.3.17-1.
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 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>PgmViewportFactory</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="Pigment 0.3 Reference Manual">
<link rel="up" href="pigment-core.html" title="Part II. Pigment Core Reference">
<link rel="prev" href="PgmViewport.html" title="PgmViewport">
<link rel="next" href="pigment-library.html" title="Part III. Pigment Library Reference">
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="preface" href="introduction.html" title="Introduction">
<link rel="part" href="pigment-overview.html" title="Part I. Pigment Overview">
<link rel="part" href="pigment-core.html" title="Part II. Pigment Core Reference">
<link rel="part" href="pigment-library.html" title="Part III. Pigment Library Reference">
<link rel="index" href="pigment-hierarchy.html" title="Object Hierarchy">
<link rel="index" href="api-index.html" title="Index">
</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="PgmViewport.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="pigment-core.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">Pigment 0.3
Reference Manual</th>
<td><a accesskey="n" href="pigment-library.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#PgmViewportFactory.synopsis" class="shortcut">Top</a>
|
<a href="#PgmViewportFactory.description" class="shortcut">Description</a>
|
<a href="#PgmViewportFactory.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry" lang="en">
<a name="PgmViewportFactory"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="PgmViewportFactory.top_of_page"></a>PgmViewportFactory</span></h2>
<p>PgmViewportFactory — A factory creating viewports.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="PgmViewportFactory.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <pgm/pgm.h>
<a class="link" href="PgmViewportFactory.html#PgmViewportFactory-struct" title="PgmViewportFactory">PgmViewportFactory</a>;
<a class="link" href="PgmViewportFactory.html" title="PgmViewportFactory">PgmViewportFactory</a> * <a class="link" href="PgmViewportFactory.html#pgm-viewport-factory-new" title="pgm_viewport_factory_new ()">pgm_viewport_factory_new</a> (const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *name);
<a class="link" href="pigment-PgmCommon.html#PgmError" title="enum PgmError">PgmError</a> <a class="link" href="PgmViewportFactory.html#pgm-viewport-factory-get-description" title="pgm_viewport_factory_get_description ()">pgm_viewport_factory_get_description</a>
(<a class="link" href="PgmViewportFactory.html" title="PgmViewportFactory">PgmViewportFactory</a> *factory,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> **description);
<a class="link" href="pigment-PgmCommon.html#PgmError" title="enum PgmError">PgmError</a> <a class="link" href="PgmViewportFactory.html#pgm-viewport-factory-get-license" title="pgm_viewport_factory_get_license ()">pgm_viewport_factory_get_license</a> (<a class="link" href="PgmViewportFactory.html" title="PgmViewportFactory">PgmViewportFactory</a> *factory,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> **license);
<a class="link" href="pigment-PgmCommon.html#PgmError" title="enum PgmError">PgmError</a> <a class="link" href="PgmViewportFactory.html#pgm-viewport-factory-get-origin" title="pgm_viewport_factory_get_origin ()">pgm_viewport_factory_get_origin</a> (<a class="link" href="PgmViewportFactory.html" title="PgmViewportFactory">PgmViewportFactory</a> *factory,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> **origin);
<a class="link" href="pigment-PgmCommon.html#PgmError" title="enum PgmError">PgmError</a> <a class="link" href="PgmViewportFactory.html#pgm-viewport-factory-get-author" title="pgm_viewport_factory_get_author ()">pgm_viewport_factory_get_author</a> (<a class="link" href="PgmViewportFactory.html" title="PgmViewportFactory">PgmViewportFactory</a> *factory,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> **author);
<a class="link" href="pigment-PgmCommon.html#PgmError" title="enum PgmError">PgmError</a> <a class="link" href="PgmViewportFactory.html#pgm-viewport-factory-create" title="pgm_viewport_factory_create ()">pgm_viewport_factory_create</a> (<a class="link" href="PgmViewportFactory.html" title="PgmViewportFactory">PgmViewportFactory</a> *factory,
<a class="link" href="PgmViewport.html" title="PgmViewport">PgmViewport</a> **viewport);
<a class="link" href="pigment-PgmCommon.html#PgmError" title="enum PgmError">PgmError</a> <a class="link" href="PgmViewportFactory.html#pgm-viewport-factory-make" title="pgm_viewport_factory_make ()">pgm_viewport_factory_make</a> (const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *name,
<a class="link" href="PgmViewport.html" title="PgmViewport">PgmViewport</a> **viewport);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="PgmViewportFactory.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----GstObject
+----PgmViewportFactory
</pre>
</div>
<div class="refsect1" lang="en">
<a name="PgmViewportFactory.description"></a><h2>Description</h2>
<p>
<a class="link" href="PgmViewportFactory.html" title="PgmViewportFactory"><span class="type">PgmViewportFactory</span></a> is used to create instances of <a class="link" href="PgmViewport.html" title="PgmViewport"><span class="type">PgmViewport</span></a>.
</p>
<p>
Use the <a class="link" href="PgmViewportFactory.html#pgm-viewport-factory-new" title="pgm_viewport_factory_new ()"><code class="function">pgm_viewport_factory_new()</code></a> and <a class="link" href="PgmViewportFactory.html#pgm-viewport-factory-create" title="pgm_viewport_factory_create ()"><code class="function">pgm_viewport_factory_create()</code></a>
functions to create viewport instances or use <a class="link" href="PgmViewportFactory.html#pgm-viewport-factory-make" title="pgm_viewport_factory_make ()"><code class="function">pgm_viewport_factory_make()</code></a>
as a convenient shortcut.
</p>
<p>
The following code example shows you how to create an OpenGL based viewport.
</p>
<p>
</p>
<div class="example">
<a name="pigment-factory-creation"></a><p class="title"><b>Example 5. Using a viewport factory</b></p>
<div class="example-contents"><pre class="programlisting">
PgmViewportFactory *factory;
PgmViewport *viewport;
pgm_init (&argc, &argv);
factory = pgm_viewport_factory_new ("opengl");
pgm_viewport_factory_create (factory, &viewport);
</pre></div>
</div>
<p><br class="example-break">
</p>
<p>
Last reviewed on 2007-04-12 (0.1.5)</p>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="PgmViewportFactory.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="PgmViewportFactory-struct"></a><h3>PgmViewportFactory</h3>
<pre class="programlisting">typedef struct _PgmViewportFactory PgmViewportFactory;</pre>
<p>
The <a class="link" href="PgmViewportFactory.html" title="PgmViewportFactory"><span class="type">PgmViewportFactory</span></a> opaque structure.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="pgm-viewport-factory-new"></a><h3>pgm_viewport_factory_new ()</h3>
<pre class="programlisting"><a class="link" href="PgmViewportFactory.html" title="PgmViewportFactory">PgmViewportFactory</a> * pgm_viewport_factory_new (const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *name);</pre>
<p>
Creates a new <a class="link" href="PgmViewportFactory.html" title="PgmViewportFactory"><span class="type">PgmViewportFactory</span></a> instance of the given <em class="parameter"><code>name</code></em>.
<a class="link" href="PgmViewportFactory.html" title="PgmViewportFactory"><span class="type">PgmViewportFactory</span></a> is a singleton, if a factory of the given name has
already been created, this constructor returns that one with a incremented
refcount.
This function does not detect if the name passed as argument is an invalid
name (i.e. if there is no plugin of that name). Such an error will only be
detected when trying to use the factory (e.g. with
<a class="link" href="PgmViewportFactory.html#pgm-viewport-factory-create" title="pgm_viewport_factory_create ()"><code class="function">pgm_viewport_factory_create()</code></a> or with one of the pgm_viewport_factory_get*()
functions.
</p>
<p>
MT safe.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td> the name of the factory to create.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a <a class="link" href="PgmViewportFactory.html" title="PgmViewportFactory"><span class="type">PgmViewportFactory</span></a> instance or NULL if an error occurred.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="pgm-viewport-factory-get-description"></a><h3>pgm_viewport_factory_get_description ()</h3>
<pre class="programlisting"><a class="link" href="pigment-PgmCommon.html#PgmError" title="enum PgmError">PgmError</a> pgm_viewport_factory_get_description
(<a class="link" href="PgmViewportFactory.html" title="PgmViewportFactory">PgmViewportFactory</a> *factory,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> **description);</pre>
<p>
Retrieves the description of the viewports managed by <em class="parameter"><code>factory</code></em> in
<em class="parameter"><code>description</code></em>.
</p>
<p>
MT safe.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>factory</code></em> :</span></p></td>
<td> a <a class="link" href="PgmViewportFactory.html" title="PgmViewportFactory"><span class="type">PgmViewportFactory</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>description</code></em> :</span></p></td>
<td> a pointer to a pointer to a <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
><span class="type">gchar</span></a> where the description
string is going to be be stored. <a
href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"
><code class="function">g_free()</code></a> after use.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a <a class="link" href="pigment-PgmCommon.html#PgmError" title="enum PgmError"><span class="type">PgmError</span></a> indicating success/failure.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="pgm-viewport-factory-get-license"></a><h3>pgm_viewport_factory_get_license ()</h3>
<pre class="programlisting"><a class="link" href="pigment-PgmCommon.html#PgmError" title="enum PgmError">PgmError</a> pgm_viewport_factory_get_license (<a class="link" href="PgmViewportFactory.html" title="PgmViewportFactory">PgmViewportFactory</a> *factory,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> **license);</pre>
<p>
Retrieves the license of the viewports managed by <em class="parameter"><code>factory</code></em> in <em class="parameter"><code>license</code></em>.
</p>
<p>
MT safe.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>factory</code></em> :</span></p></td>
<td> a <a class="link" href="PgmViewportFactory.html" title="PgmViewportFactory"><span class="type">PgmViewportFactory</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>license</code></em> :</span></p></td>
<td> a pointer to a pointer to a <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
><span class="type">gchar</span></a> where the license string is
going to be be stored. <a
href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"
><code class="function">g_free()</code></a> after use.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a <a class="link" href="pigment-PgmCommon.html#PgmError" title="enum PgmError"><span class="type">PgmError</span></a> indicating success/failure.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="pgm-viewport-factory-get-origin"></a><h3>pgm_viewport_factory_get_origin ()</h3>
<pre class="programlisting"><a class="link" href="pigment-PgmCommon.html#PgmError" title="enum PgmError">PgmError</a> pgm_viewport_factory_get_origin (<a class="link" href="PgmViewportFactory.html" title="PgmViewportFactory">PgmViewportFactory</a> *factory,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> **origin);</pre>
<p>
Retrieves the origin of the viewports managed by <em class="parameter"><code>factory</code></em> in <em class="parameter"><code>origin</code></em>.
</p>
<p>
MT safe.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>factory</code></em> :</span></p></td>
<td> a <a class="link" href="PgmViewportFactory.html" title="PgmViewportFactory"><span class="type">PgmViewportFactory</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>origin</code></em> :</span></p></td>
<td> a pointer to a pointer to a <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
><span class="type">gchar</span></a> where the origin string is
going to be be stored. <a
href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"
><code class="function">g_free()</code></a> after use.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a <a class="link" href="pigment-PgmCommon.html#PgmError" title="enum PgmError"><span class="type">PgmError</span></a> indicating success/failure.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="pgm-viewport-factory-get-author"></a><h3>pgm_viewport_factory_get_author ()</h3>
<pre class="programlisting"><a class="link" href="pigment-PgmCommon.html#PgmError" title="enum PgmError">PgmError</a> pgm_viewport_factory_get_author (<a class="link" href="PgmViewportFactory.html" title="PgmViewportFactory">PgmViewportFactory</a> *factory,
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> **author);</pre>
<p>
Retrieves the author of the viewports managed by <em class="parameter"><code>factory</code></em> in <em class="parameter"><code>author</code></em>.
</p>
<p>
MT safe.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>factory</code></em> :</span></p></td>
<td> a <a class="link" href="PgmViewportFactory.html" title="PgmViewportFactory"><span class="type">PgmViewportFactory</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>author</code></em> :</span></p></td>
<td> a pointer to a pointer to a <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
><span class="type">gchar</span></a> where the author string is
going to be be stored. <a
href="http://library.gnome.org/devel/glib/unstable/glib-Memory-Allocation.html#g-free"
><code class="function">g_free()</code></a> after use.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a <a class="link" href="pigment-PgmCommon.html#PgmError" title="enum PgmError"><span class="type">PgmError</span></a> indicating success/failure.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="pgm-viewport-factory-create"></a><h3>pgm_viewport_factory_create ()</h3>
<pre class="programlisting"><a class="link" href="pigment-PgmCommon.html#PgmError" title="enum PgmError">PgmError</a> pgm_viewport_factory_create (<a class="link" href="PgmViewportFactory.html" title="PgmViewportFactory">PgmViewportFactory</a> *factory,
<a class="link" href="PgmViewport.html" title="PgmViewport">PgmViewport</a> **viewport);</pre>
<p>
Creates a new viewport of the type defined by <em class="parameter"><code>factory</code></em> in <em class="parameter"><code>viewport</code></em>.
</p>
<p>
MT safe.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>factory</code></em> :</span></p></td>
<td> a <a class="link" href="PgmViewportFactory.html" title="PgmViewportFactory"><span class="type">PgmViewportFactory</span></a> object.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>viewport</code></em> :</span></p></td>
<td> a pointer to a <a class="link" href="PgmViewport.html" title="PgmViewport"><span class="type">PgmViewport</span></a>'s pointer where the created viewport
is going to be be stored.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a <a class="link" href="pigment-PgmCommon.html#PgmError" title="enum PgmError"><span class="type">PgmError</span></a> indicating success/failure.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="pgm-viewport-factory-make"></a><h3>pgm_viewport_factory_make ()</h3>
<pre class="programlisting"><a class="link" href="pigment-PgmCommon.html#PgmError" title="enum PgmError">PgmError</a> pgm_viewport_factory_make (const <a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *name,
<a class="link" href="PgmViewport.html" title="PgmViewport">PgmViewport</a> **viewport);</pre>
<p>
Creates a new viewport of the given <em class="parameter"><code>name</code></em> in <em class="parameter"><code>viewport</code></em>.
</p>
<p>
MT safe.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td> the name of the viewport to make.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>viewport</code></em> :</span></p></td>
<td> a pointer to a <a class="link" href="PgmViewport.html" title="PgmViewport"><span class="type">PgmViewport</span></a>'s pointer where the created viewport
is going to be be stored.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a <a class="link" href="pigment-PgmCommon.html#PgmError" title="enum PgmError"><span class="type">PgmError</span></a> indicating success/failure.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="PgmViewportFactory.see-also"></a><h2>See Also</h2>
#PgmViewport.
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.11</div>
</body>
</html>
|