/usr/share/gtk-doc/html/libgwydraw/libgwydraw-gwypixfield.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 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 | <!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</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<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.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="GwyGLMaterial.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td> </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 Drawing Library Reference Manual</th>
<td><a accesskey="n" href="GwySelection.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libgwydraw-gwypixfield.synopsis" class="shortcut">Top</a>
|
<a href="#libgwydraw-gwypixfield.description" class="shortcut">Description</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 <a href="./../libgwyprocess/libgwyprocess/GwyDataField.html"><span class="type">GwyDataField</span></a>s to <a href="http://developer.gnome.org/doc/API/2.0/gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a>s</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgwydraw-gwypixfield.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libdraw/gwydraw.h>
<span class="returnvalue">void</span> <a class="link" href="libgwydraw-gwypixfield.html#gwy-pixbuf-draw-data-field" title="gwy_pixbuf_draw_data_field ()">gwy_pixbuf_draw_data_field</a> (<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>,
<em class="parameter"><code><a href="./../libgwyprocess/libgwyprocess/GwyDataField.html"><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>);
<span class="returnvalue">void</span> <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> (<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>,
<em class="parameter"><code><a href="./../libgwyprocess/libgwyprocess/GwyDataField.html"><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>);
<span class="returnvalue">void</span> <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> (<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>,
<em class="parameter"><code><a href="./../libgwyprocess/libgwyprocess/GwyDataField.html"><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>);
<span class="returnvalue">void</span> <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>
(<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>,
<em class="parameter"><code><a href="./../libgwyprocess/libgwyprocess/GwyDataField.html"><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/glib/glib-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/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> maximum</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libgwydraw-gwypixfield.description"></a><h2>Description</h2>
<p>
The simpliest method to render a <a href="./../libgwyprocess/libgwyprocess/GwyDataField.html"><span class="type">GwyDataField</span></a> to a <a href="http://developer.gnome.org/doc/API/2.0/gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><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.details"></a><h2>Details</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/gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>,
<em class="parameter"><code><a href="./../libgwyprocess/libgwyprocess/GwyDataField.html"><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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pixbuf</code></em> :</span></p></td>
<td>A Gdk pixbuf to draw to.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_field</code></em> :</span></p></td>
<td>A data field to draw.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>gradient</code></em> :</span></p></td>
<td>A color gradient to draw with.</td>
</tr>
</tbody>
</table></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/gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>,
<em class="parameter"><code><a href="./../libgwyprocess/libgwyprocess/GwyDataField.html"><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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pixbuf</code></em> :</span></p></td>
<td>A Gdk pixbuf to draw to.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_field</code></em> :</span></p></td>
<td>A data field to draw.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>gradient</code></em> :</span></p></td>
<td>A color gradient to draw with.</td>
</tr>
</tbody>
</table></div>
</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/gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>,
<em class="parameter"><code><a href="./../libgwyprocess/libgwyprocess/GwyDataField.html"><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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pixbuf</code></em> :</span></p></td>
<td>A Gdk pixbuf to draw to.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_field</code></em> :</span></p></td>
<td>A data field to draw.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
<td>A color to use.</td>
</tr>
</tbody>
</table></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/gdk-pixbuf/gdk-pixbuf-The-GdkPixbuf-Structure.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> *pixbuf</code></em>,
<em class="parameter"><code><a href="./../libgwyprocess/libgwyprocess/GwyDataField.html"><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/glib/glib-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/glib/glib-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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pixbuf</code></em> :</span></p></td>
<td>A Gdk pixbuf to draw to.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_field</code></em> :</span></p></td>
<td>A data field to draw.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>gradient</code></em> :</span></p></td>
<td>A color gradient to draw with.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>minimum</code></em> :</span></p></td>
<td>The value corresponding to gradient start.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>maximum</code></em> :</span></p></td>
<td>The value corresponding to gradient end.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.8</div>
</body>
</html>
|