libgwyddion20-doc 2.50-2 / usr / share / gtk-doc / html / libgwydraw / libgwydraw-gwypixfield.html

This file is indexed.

/usr/share/gtk-doc/html/libgwydraw/libgwydraw-gwypixfield.html is in libgwyddion20-doc 2.50-2.

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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gwypixfield: Gwyddion Drawing Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="Gwyddion Drawing Library Reference Manual">
<link rel="up" href="index.html" title="Gwyddion Drawing Library Reference Manual">
<link rel="prev" href="GwyGLMaterial.html" title="GwyGLMaterial">
<link rel="next" href="GwySelection.html" title="GwySelection">
<meta name="generator" content="GTK-Doc V1.19 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#libgwydraw-gwypixfield.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><img src="up-insensitive.png" width="16" height="16" border="0"></td>
<td><a accesskey="p" href="GwyGLMaterial.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GwySelection.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libgwydraw-gwypixfield"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgwydraw-gwypixfield.top_of_page"></a>gwypixfield</span></h2>
<p>gwypixfield — Draw GwyDataFields to GdkPixbufs</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libgwydraw-gwypixfield.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgwydraw-gwypixfield.html#gwy-pixbuf-draw-data-field" title="gwy_pixbuf_draw_data_field ()">gwy_pixbuf_draw_data_field</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgwydraw-gwypixfield.html#gwy-pixbuf-draw-data-field-with-range" title="gwy_pixbuf_draw_data_field_with_range ()">gwy_pixbuf_draw_data_field_with_range</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgwydraw-gwypixfield.html#gwy-pixbuf-draw-data-field-adaptive" title="gwy_pixbuf_draw_data_field_adaptive ()">gwy_pixbuf_draw_data_field_adaptive</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgwydraw-gwypixfield.html#gwy-draw-data-field-map-adaptive" title="gwy_draw_data_field_map_adaptive ()">gwy_draw_data_field_map_adaptive</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libgwydraw-gwypixfield.html#gwy-pixbuf-draw-data-field-as-mask" title="gwy_pixbuf_draw_data_field_as_mask ()">gwy_pixbuf_draw_data_field_as_mask</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libgwydraw-gwypixfield.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;libdraw/gwydraw.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="libgwydraw-gwypixfield.description"></a><h2>Description</h2>
<p>The simpliest method to render a <a href="../GwyDataField.html#GwyDataField-struct"><span class="type">GwyDataField</span></a> to a <a href="http://developer.gnome.org/doc/API/2.0/gtk/gdk-pixbufgdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf-struct"><span class="type">GdkPixbuf</span></a> with a
false color scale is <a class="link" href="libgwydraw-gwypixfield.html#gwy-pixbuf-draw-data-field" title="gwy_pixbuf_draw_data_field ()"><code class="function">gwy_pixbuf_draw_data_field()</code></a> which uniformly stretches
the color gradient from value minimum to maximum.  Functions
<a class="link" href="libgwydraw-gwypixfield.html#gwy-pixbuf-draw-data-field-with-range" title="gwy_pixbuf_draw_data_field_with_range ()"><code class="function">gwy_pixbuf_draw_data_field_with_range()</code></a> and
<a class="link" href="libgwydraw-gwypixfield.html#gwy-pixbuf-draw-data-field-adaptive" title="gwy_pixbuf_draw_data_field_adaptive ()"><code class="function">gwy_pixbuf_draw_data_field_adaptive()</code></a> offer other false color mapping
possibilities.  A bit different is
<a class="link" href="libgwydraw-gwypixfield.html#gwy-pixbuf-draw-data-field-as-mask" title="gwy_pixbuf_draw_data_field_as_mask ()"><code class="function">gwy_pixbuf_draw_data_field_as_mask()</code></a> which represents the values as
opacities of a signle color.</p>
</div>
<div class="refsect1">
<a name="libgwydraw-gwypixfield.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gwy-pixbuf-draw-data-field"></a><h3>gwy_pixbuf_draw_data_field ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_pixbuf_draw_data_field (<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gtk/gdk-pixbufgdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf-struct"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>,
                            <em class="parameter"><code><a href="../GwyDataField.html#GwyDataField-struct"><span class="type">GwyDataField</span></a> *data_field</code></em>,
                            <em class="parameter"><code><a class="link" href="GwyGradient.html" title="GwyGradient"><span class="type">GwyGradient</span></a> *gradient</code></em>);</pre>
<p>Paints a data field to a pixbuf with an auto-stretched color gradient.</p>
<p>Minimum data value is mapped to start of <em class="parameter"><code>gradient</code></em>
, maximum value to its
end, values between are mapped linearly to <em class="parameter"><code>gradient</code></em>
.</p>
<div class="refsect3">
<a name="gwy-pixbuf-draw-data-field.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>pixbuf</p></td>
<td class="parameter_description"><p>A Gdk pixbuf to draw to.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data_field</p></td>
<td class="parameter_description"><p>A data field to draw.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>gradient</p></td>
<td class="parameter_description"><p>A color gradient to draw with.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-pixbuf-draw-data-field-with-range"></a><h3>gwy_pixbuf_draw_data_field_with_range ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_pixbuf_draw_data_field_with_range (<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gtk/gdk-pixbufgdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf-struct"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>,
                                       <em class="parameter"><code><a href="../GwyDataField.html#GwyDataField-struct"><span class="type">GwyDataField</span></a> *data_field</code></em>,
                                       <em class="parameter"><code><a class="link" href="GwyGradient.html" title="GwyGradient"><span class="type">GwyGradient</span></a> *gradient</code></em>,
                                       <em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gtk/glibglib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> minimum</code></em>,
                                       <em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gtk/glibglib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> maximum</code></em>);</pre>
<p>Paints a data field to a pixbuf with an explicite color gradient range.</p>
<p><em class="parameter"><code>minimum</code></em>
 and all smaller values are mapped to start of <em class="parameter"><code>gradient</code></em>
, <em class="parameter"><code>maximum</code></em>

and all greater values to its end, values between are mapped linearly to
<em class="parameter"><code>gradient</code></em>
.</p>
<div class="refsect3">
<a name="gwy-pixbuf-draw-data-field-with-range.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>pixbuf</p></td>
<td class="parameter_description"><p>A Gdk pixbuf to draw to.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data_field</p></td>
<td class="parameter_description"><p>A data field to draw.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>gradient</p></td>
<td class="parameter_description"><p>A color gradient to draw with.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>minimum</p></td>
<td class="parameter_description"><p>The value corresponding to gradient start.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>maximum</p></td>
<td class="parameter_description"><p>The value corresponding to gradient end.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-pixbuf-draw-data-field-adaptive"></a><h3>gwy_pixbuf_draw_data_field_adaptive ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_pixbuf_draw_data_field_adaptive (<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gtk/gdk-pixbufgdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf-struct"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>,
                                     <em class="parameter"><code><a href="../GwyDataField.html#GwyDataField-struct"><span class="type">GwyDataField</span></a> *data_field</code></em>,
                                     <em class="parameter"><code><a class="link" href="GwyGradient.html" title="GwyGradient"><span class="type">GwyGradient</span></a> *gradient</code></em>);</pre>
<p>Paints a data field to a pixbuf with a color gradient adaptively.</p>
<p>The mapping from data field (minimum, maximum) range to gradient is
nonlinear, deformed using inverse function to height density cummulative
distribution.</p>
<div class="refsect3">
<a name="gwy-pixbuf-draw-data-field-adaptive.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>pixbuf</p></td>
<td class="parameter_description"><p>A Gdk pixbuf to draw to.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data_field</p></td>
<td class="parameter_description"><p>A data field to draw.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>gradient</p></td>
<td class="parameter_description"><p>A color gradient to draw with.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-draw-data-field-map-adaptive"></a><h3>gwy_draw_data_field_map_adaptive ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_draw_data_field_map_adaptive (<em class="parameter"><code><a href="../GwyDataField.html#GwyDataField-struct"><span class="type">GwyDataField</span></a> *data_field</code></em>,
                                  <em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/gtk/glibglib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *z</code></em>,
                                  <em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gtk/glibglib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> *mapped</code></em>,
                                  <em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gtk/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a> n</code></em>);</pre>
<p>Maps ordinate values to interval [0,1] as
<a class="link" href="libgwydraw-gwypixfield.html#gwy-pixbuf-draw-data-field-adaptive" title="gwy_pixbuf_draw_data_field_adaptive ()"><code class="function">gwy_pixbuf_draw_data_field_adaptive()</code></a> would do.</p>
<p>This is useful to find out which positions in the false colour gradient
correspond to specific values.</p>
<div class="refsect3">
<a name="gwy-draw-data-field-map-adaptive.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>data_field</p></td>
<td class="parameter_description"><p>A data field to draw.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>z</p></td>
<td class="parameter_description"><p>Array of <em class="parameter"><code>n</code></em>
data values to map.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>mapped</p></td>
<td class="parameter_description"><p>Output array of size <em class="parameter"><code>n</code></em>
where mapped <em class="parameter"><code>z</code></em>
values are to be stored.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n</p></td>
<td class="parameter_description"><p>Number of elements in <em class="parameter"><code>z</code></em>
and <em class="parameter"><code>mapped</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-2-39.html#api-index-2.39">2.39</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-pixbuf-draw-data-field-as-mask"></a><h3>gwy_pixbuf_draw_data_field_as_mask ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gwy_pixbuf_draw_data_field_as_mask (<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gtk/gdk-pixbufgdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf-struct"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>,
                                    <em class="parameter"><code><a href="../GwyDataField.html#GwyDataField-struct"><span class="type">GwyDataField</span></a> *data_field</code></em>,
                                    <em class="parameter"><code>const <a class="link" href="libgwydraw-GwyRGBA.html#GwyRGBA" title="GwyRGBA"><span class="type">GwyRGBA</span></a> *color</code></em>);</pre>
<p>Paints a data field to a pixbuf as a single-color mask with varying opacity.</p>
<p>Values equal or smaller to 0.0 are drawn as fully transparent, values
greater or equal to 1.0 as fully opaque, values between are linearly
mapped to pixel opacity.</p>
<div class="refsect3">
<a name="gwy-pixbuf-draw-data-field-as-mask.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>pixbuf</p></td>
<td class="parameter_description"><p>A Gdk pixbuf to draw to.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>data_field</p></td>
<td class="parameter_description"><p>A data field to draw.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>color</p></td>
<td class="parameter_description"><p>A color to use.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="libgwydraw-gwypixfield.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.19</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.