This file is indexed.

/usr/share/gtk-doc/html/pigment/pigment-PgmCommon.html is in libpigment0.3-dev 0.3.17-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
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>PgmCommon</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="PgmCanvas.html" title="PgmCanvas">
<link rel="next" href="PgmDrawable.html" title="PgmDrawable">
<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="PgmCanvas.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="PgmDrawable.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#pigment-PgmCommon.synopsis" class="shortcut">Top</a>
                 | 
                <a href="#pigment-PgmCommon.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" lang="en">
<a name="pigment-PgmCommon"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="pigment-PgmCommon.top_of_page"></a>PgmCommon</span></h2>
<p>PgmCommon — Various functions used for common tasks.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="pigment-PgmCommon.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">

#include &lt;pgm/pgm.h&gt;

#define             <a class="link" href="pigment-PgmCommon.html#PGM-DEGREES-TO-RADIANS--CAPS" title="PGM_DEGREES_TO_RADIANS()">PGM_DEGREES_TO_RADIANS</a>              (theta)
#define             <a class="link" href="pigment-PgmCommon.html#PGM-RADIANS-TO-DEGREES--CAPS" title="PGM_RADIANS_TO_DEGREES()">PGM_RADIANS_TO_DEGREES</a>              (theta)
#define             <a class="link" href="pigment-PgmCommon.html#PGM-SINCOS--CAPS" title="PGM_SINCOS()">PGM_SINCOS</a>                          (theta,s,c)
#define             <a class="link" href="pigment-PgmCommon.html#PGM-FABSF--CAPS" title="PGM_FABSF()">PGM_FABSF</a>                           (x)
<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"
>gint32</a>              <a class="link" href="pigment-PgmCommon.html#pgm-lrintf" title="pgm_lrintf ()">pgm_lrintf</a>                          (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"
>gfloat</a> x);
enum                <a class="link" href="pigment-PgmCommon.html#PgmError" title="enum PgmError">PgmError</a>;
</pre>
</div>
<div class="refsect1" lang="en">
<a name="pigment-PgmCommon.description"></a><h2>Description</h2>
<p>
Various functions used by Pigment for common tasks.
</p>
<p>
Last reviewed on 2009-05-07 (0.3.16)</p>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="pigment-PgmCommon.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="PGM-DEGREES-TO-RADIANS--CAPS"></a><h3>PGM_DEGREES_TO_RADIANS()</h3>
<pre class="programlisting">#define PGM_DEGREES_TO_RADIANS(theta) ((theta) * (G_PI / 180.0f))
</pre>
<p>
Converts from degrees to radians.</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>theta</code></em> :</span></p></td>
<td> an angle in degrees.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="PGM-RADIANS-TO-DEGREES--CAPS"></a><h3>PGM_RADIANS_TO_DEGREES()</h3>
<pre class="programlisting">#define PGM_RADIANS_TO_DEGREES(theta) ((theta) * (180.0f / G_PI))
</pre>
<p>
Converts from radians to degrees.</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>theta</code></em> :</span></p></td>
<td> an angle in radians.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="PGM-SINCOS--CAPS"></a><h3>PGM_SINCOS()</h3>
<pre class="programlisting">#define             PGM_SINCOS(theta,s,c)</pre>
<p>
Calculates sine and cosine of the angle <em class="parameter"><code>theta</code></em> simultaneously.</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>theta</code></em> :</span></p></td>
<td> a float representing an angle in radians.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>s</code></em> :</span></p></td>
<td> the address of the float where the sine value is going to be stored.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>c</code></em> :</span></p></td>
<td> the address of the float where the cosine value is going to be stored.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="PGM-FABSF--CAPS"></a><h3>PGM_FABSF()</h3>
<pre class="programlisting">#define             PGM_FABSF(x)</pre>
<p>
Calculates the absolute value of float.</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>x</code></em> :</span></p></td>
<td> the floating-point number.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="pgm-lrintf"></a><h3>pgm_lrintf ()</h3>
<pre class="programlisting"><a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint32"
>gint32</a>              pgm_lrintf                          (<a
href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"
>gfloat</a> x);</pre>
<p>
Round <em class="parameter"><code>x</code></em> to nearest integer using the current FPU rounding mode. On platforms
other than Windows where the C99 lrintf function is not available, the
function reverts to a float-to-int cast which uses the truncate FPU rounding
mode.</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>x</code></em> :</span></p></td>
<td> the input floating-point number.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the rounded nearest integer.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="PgmError"></a><h3>enum PgmError</h3>
<pre class="programlisting">typedef enum {
  PGM_ERROR_X,
  PGM_ERROR_OK
} PgmError;
</pre>
<p>
Every Pigment method returns an error code from that list.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="PGM-ERROR-X--CAPS"></a><span class="term"><code class="literal">PGM_ERROR_X</code></span></p></td>
<td> Generic error code.
</td>
</tr>
<tr>
<td><p><a name="PGM-ERROR-OK--CAPS"></a><span class="term"><code class="literal">PGM_ERROR_OK</code></span></p></td>
<td> No error occured.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.11</div>
</body>
</html>