871 lines
35 KiB
HTML
871 lines
35 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
|
|
<title>GimpPreviewArea</title>
|
|
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
|
|
<link rel="start" href="index.html" title="GIMP Widgets Library Reference Manual">
|
|
<link rel="up" href="libgimpwidgets-widgets.html" title="Part I. GIMP Widgets">
|
|
<link rel="prev" href="GimpPixmap.html" title="GimpPixmap">
|
|
<link rel="next" href="GimpPreview.html" title="GimpPreview">
|
|
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
|
|
<link rel="stylesheet" href="style.css" type="text/css">
|
|
<link rel="part" href="libgimpwidgets-widgets.html" title="Part I. GIMP Widgets">
|
|
<link rel="chapter" href="libgimpwidgets-hierarchy.html" title="Object Hierarchy">
|
|
<link rel="chapter" href="libgimpwidgets-gallery.html" title="Widget Gallery">
|
|
<link rel="chapter" href="libgimpwidgets-cell-renderers.html" title="Cell Renderers for GtkTreeView">
|
|
<link rel="part" href="libgimpwidgets-colordisplay.html" title="Part II. GIMP Display Filters">
|
|
<link rel="part" href="libgimpwidgets-colorselector.html" title="Part III. GIMP Color Selectors">
|
|
<link rel="part" href="libgimpwidgets-controller.html" title="Part IV. GIMP Controllers">
|
|
<link rel="part" href="libgimpwidgets-utils.html" title="Part V. GIMP Widgets Utilities">
|
|
<link rel="part" href="libgimpwidgets-deprecated.html" title="Part VI. Deprecated API">
|
|
<link rel="index" href="libgimpwidgets-index.html" title="Index">
|
|
<link rel="index" href="libgimpwidgets-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
|
|
<link rel="index" href="libgimpwidgets-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
|
|
<link rel="index" href="libgimpwidgets-index-deprecated.html" title="Index of deprecated symbols">
|
|
</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="GimpPixmap.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
|
|
<td><a accesskey="u" href="libgimpwidgets-widgets.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">GIMP Widgets Library Reference Manual</th>
|
|
<td><a accesskey="n" href="GimpPreview.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
|
|
</tr>
|
|
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2592950" class="shortcut">Top</a>
|
|
 | 
|
|
<a href="#id2640987" class="shortcut">Description</a>
|
|
 | 
|
|
<a href="#id2635701" class="shortcut">Object Hierarchy</a>
|
|
 | 
|
|
<a href="#id2635750" class="shortcut">Implemented Interfaces</a>
|
|
 | 
|
|
<a href="#id2635778" class="shortcut">Properties</a></nobr></td></tr>
|
|
</table>
|
|
<div class="refentry" lang="en">
|
|
<a name="GimpPreviewArea"></a><div class="titlepage"></div>
|
|
<div class="refnamediv"><table width="100%"><tr>
|
|
<td valign="top">
|
|
<h2>
|
|
<a name="id2592950"></a><span class="refentrytitle">GimpPreviewArea</span>
|
|
</h2>
|
|
<p>GimpPreviewArea — A general purpose preview widget which caches its pixel data.</p>
|
|
</td>
|
|
<td valign="top" align="right"><img src="gimp-preview-area.png"></td>
|
|
</tr></table></div>
|
|
<div class="refsynopsisdiv">
|
|
<h2>Synopsis</h2>
|
|
<pre class="synopsis">
|
|
|
|
|
|
|
|
<a class="link" href="GimpPreviewArea.html#GimpPreviewArea-struct">GimpPreviewArea</a>;
|
|
<a
|
|
href="../gtk/GtkWidget.html"
|
|
>GtkWidget</a>* <a class="link" href="GimpPreviewArea.html#gimp-preview-area-new">gimp_preview_area_new</a> (void);
|
|
void <a class="link" href="GimpPreviewArea.html#gimp-preview-area-draw">gimp_preview_area_draw</a> (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> x,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> y,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> width,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> height,
|
|
<a
|
|
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageType"
|
|
>GimpImageType</a> type,
|
|
const <a
|
|
href="../glib/glib-Basic-Types.html#guchar"
|
|
>guchar</a> *buf,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> rowstride);
|
|
void <a class="link" href="GimpPreviewArea.html#gimp-preview-area-fill">gimp_preview_area_fill</a> (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> x,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> y,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> width,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> height,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#guchar"
|
|
>guchar</a> red,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#guchar"
|
|
>guchar</a> green,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#guchar"
|
|
>guchar</a> blue);
|
|
void <a class="link" href="GimpPreviewArea.html#gimp-preview-area-blend">gimp_preview_area_blend</a> (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> x,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> y,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> width,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> height,
|
|
<a
|
|
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageType"
|
|
>GimpImageType</a> type,
|
|
const <a
|
|
href="../glib/glib-Basic-Types.html#guchar"
|
|
>guchar</a> *buf1,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> rowstride1,
|
|
const <a
|
|
href="../glib/glib-Basic-Types.html#guchar"
|
|
>guchar</a> *buf2,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> rowstride2,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#guchar"
|
|
>guchar</a> opacity);
|
|
void <a class="link" href="GimpPreviewArea.html#gimp-preview-area-mask">gimp_preview_area_mask</a> (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> x,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> y,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> width,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> height,
|
|
<a
|
|
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageType"
|
|
>GimpImageType</a> type,
|
|
const <a
|
|
href="../glib/glib-Basic-Types.html#guchar"
|
|
>guchar</a> *buf1,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> rowstride1,
|
|
const <a
|
|
href="../glib/glib-Basic-Types.html#guchar"
|
|
>guchar</a> *buf2,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> rowstride2,
|
|
const <a
|
|
href="../glib/glib-Basic-Types.html#guchar"
|
|
>guchar</a> *mask,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> rowstride_mask);
|
|
void <a class="link" href="GimpPreviewArea.html#gimp-preview-area-set-offsets">gimp_preview_area_set_offsets</a> (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> x,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> y);
|
|
void <a class="link" href="GimpPreviewArea.html#gimp-preview-area-set-colormap">gimp_preview_area_set_colormap</a> (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
|
|
const <a
|
|
href="../glib/glib-Basic-Types.html#guchar"
|
|
>guchar</a> *colormap,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> num_colors);
|
|
void <a class="link" href="GimpPreviewArea.html#gimp-preview-area-set-max-size">gimp_preview_area_set_max_size</a> (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> width,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> height);
|
|
void <a class="link" href="GimpPreviewArea.html#gimp-preview-area-menu-popup">gimp_preview_area_menu_popup</a> (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
|
|
<a
|
|
href="../gdk/gdk-Event-Structures.html#GdkEventButton"
|
|
>GdkEventButton</a> *event);
|
|
|
|
</pre>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2635701"></a><h2>Object Hierarchy</h2>
|
|
<pre class="synopsis">
|
|
|
|
<a
|
|
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
|
|
>GObject</a>
|
|
+----<a
|
|
href="../gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
|
|
>GInitiallyUnowned</a>
|
|
+----<a
|
|
href="../gtk/GtkObject.html"
|
|
>GtkObject</a>
|
|
+----<a
|
|
href="../gtk/GtkWidget.html"
|
|
>GtkWidget</a>
|
|
+----<a
|
|
href="../gtk/GtkDrawingArea.html"
|
|
>GtkDrawingArea</a>
|
|
+----GimpPreviewArea
|
|
</pre>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2635750"></a><h2>Implemented Interfaces</h2>
|
|
<p>
|
|
GimpPreviewArea implements
|
|
AtkImplementorIface and GtkBuildable.</p>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2635778"></a><h2>Properties</h2>
|
|
<pre class="synopsis">
|
|
|
|
"<a class="link" href="GimpPreviewArea.html#GimpPreviewArea--check-size">check-size</a>" <a
|
|
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpCheckSize"
|
|
>GimpCheckSize</a> : Read / Write
|
|
"<a class="link" href="GimpPreviewArea.html#GimpPreviewArea--check-type">check-type</a>" <a
|
|
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpCheckType"
|
|
>GimpCheckType</a> : Read / Write
|
|
</pre>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2640987"></a><h2>Description</h2>
|
|
<p>
|
|
A general purpose preview widget which caches its pixel data.
|
|
</p>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2641004"></a><h2>Details</h2>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2641015"></a><h3>
|
|
<a name="GimpPreviewArea-struct"></a>GimpPreviewArea</h3>
|
|
<a class="indexterm" name="id2641026"></a><pre class="programlisting">typedef struct _GimpPreviewArea GimpPreviewArea;</pre>
|
|
<p>
|
|
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2641043"></a><h3>
|
|
<a name="gimp-preview-area-new"></a>gimp_preview_area_new ()</h3>
|
|
<a class="indexterm" name="id2641054"></a><pre class="programlisting"><a
|
|
href="../gtk/GtkWidget.html"
|
|
>GtkWidget</a>* gimp_preview_area_new (void);</pre>
|
|
<p>
|
|
Creates a new <a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a> widget.</p>
|
|
<p>
|
|
|
|
</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 new <a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a> widget.
|
|
|
|
Since GIMP 2.2
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2641108"></a><h3>
|
|
<a name="gimp-preview-area-draw"></a>gimp_preview_area_draw ()</h3>
|
|
<a class="indexterm" name="id2641119"></a><pre class="programlisting">void gimp_preview_area_draw (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> x,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> y,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> width,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> height,
|
|
<a
|
|
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageType"
|
|
>GimpImageType</a> type,
|
|
const <a
|
|
href="../glib/glib-Basic-Types.html#guchar"
|
|
>guchar</a> *buf,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> rowstride);</pre>
|
|
<p>
|
|
Draws <em class="parameter"><code>buf</code></em> on <em class="parameter"><code>area</code></em> and queues a redraw on the given rectangle.
|
|
</p>
|
|
<p>
|
|
Since GIMP 2.2</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>area</code></em> :</span></p></td>
|
|
<td> a <a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a> widget.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
|
|
<td> x offset in preview
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
|
|
<td> y offset in preview
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
|
|
<td> buffer width
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
|
|
<td> buffer height
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
|
|
<td> the <a
|
|
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageType"
|
|
><span class="type">GimpImageType</span></a> of <em class="parameter"><code>buf</code></em>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>buf</code></em> :</span></p></td>
|
|
<td> a <a
|
|
href="../glib/glib-Basic-Types.html#guchar"
|
|
><span class="type">guchar</span></a> buffer that contains the preview pixel data.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>rowstride</code></em> :</span></p></td>
|
|
<td> rowstride of <em class="parameter"><code>buf</code></em>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2647079"></a><h3>
|
|
<a name="gimp-preview-area-fill"></a>gimp_preview_area_fill ()</h3>
|
|
<a class="indexterm" name="id2647089"></a><pre class="programlisting">void gimp_preview_area_fill (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> x,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> y,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> width,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> height,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#guchar"
|
|
>guchar</a> red,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#guchar"
|
|
>guchar</a> green,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#guchar"
|
|
>guchar</a> blue);</pre>
|
|
<p>
|
|
Fills the given rectangle of <em class="parameter"><code>area</code></em> in the given color and queues a
|
|
redraw.
|
|
</p>
|
|
<p>
|
|
Since GIMP 2.2</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>area</code></em> :</span></p></td>
|
|
<td> a <a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a> widget.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
|
|
<td> x offset in preview
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
|
|
<td> y offset in preview
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
|
|
<td> width of the rectangle to fill
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
|
|
<td> height of the rectangle to fill
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>red</code></em> :</span></p></td>
|
|
<td> red component of the fill color (0-255)
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>green</code></em> :</span></p></td>
|
|
<td> green component of the fill color (0-255)
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>blue</code></em> :</span></p></td>
|
|
<td> red component of the fill color (0-255)
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2647299"></a><h3>
|
|
<a name="gimp-preview-area-blend"></a>gimp_preview_area_blend ()</h3>
|
|
<a class="indexterm" name="id2647311"></a><pre class="programlisting">void gimp_preview_area_blend (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> x,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> y,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> width,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> height,
|
|
<a
|
|
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageType"
|
|
>GimpImageType</a> type,
|
|
const <a
|
|
href="../glib/glib-Basic-Types.html#guchar"
|
|
>guchar</a> *buf1,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> rowstride1,
|
|
const <a
|
|
href="../glib/glib-Basic-Types.html#guchar"
|
|
>guchar</a> *buf2,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> rowstride2,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#guchar"
|
|
>guchar</a> opacity);</pre>
|
|
<p>
|
|
Composites <em class="parameter"><code>buf1</code></em> on <em class="parameter"><code>buf2</code></em> with the given <em class="parameter"><code>opacity</code></em>, draws the result
|
|
to <em class="parameter"><code>area</code></em> and queues a redraw on the given rectangle.
|
|
</p>
|
|
<p>
|
|
Since GIMP 2.2</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>area</code></em> :</span></p></td>
|
|
<td> a <a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a> widget.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
|
|
<td> x offset in preview
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
|
|
<td> y offset in preview
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
|
|
<td> buffer width
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
|
|
<td> buffer height
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
|
|
<td> the <a
|
|
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageType"
|
|
><span class="type">GimpImageType</span></a> of <em class="parameter"><code>buf1</code></em> and <em class="parameter"><code>buf2</code></em>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>buf1</code></em> :</span></p></td>
|
|
<td> a <a
|
|
href="../glib/glib-Basic-Types.html#guchar"
|
|
><span class="type">guchar</span></a> buffer that contains the pixel data for
|
|
the lower layer
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>rowstride1</code></em> :</span></p></td>
|
|
<td> rowstride of <em class="parameter"><code>buf1</code></em>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>buf2</code></em> :</span></p></td>
|
|
<td> a <a
|
|
href="../glib/glib-Basic-Types.html#guchar"
|
|
><span class="type">guchar</span></a> buffer that contains the pixel data for
|
|
the upper layer
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>rowstride2</code></em> :</span></p></td>
|
|
<td> rowstride of <em class="parameter"><code>buf2</code></em>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>opacity</code></em> :</span></p></td>
|
|
<td> The opacity of the first layer.
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2647658"></a><h3>
|
|
<a name="gimp-preview-area-mask"></a>gimp_preview_area_mask ()</h3>
|
|
<a class="indexterm" name="id2647669"></a><pre class="programlisting">void gimp_preview_area_mask (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> x,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> y,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> width,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> height,
|
|
<a
|
|
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageType"
|
|
>GimpImageType</a> type,
|
|
const <a
|
|
href="../glib/glib-Basic-Types.html#guchar"
|
|
>guchar</a> *buf1,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> rowstride1,
|
|
const <a
|
|
href="../glib/glib-Basic-Types.html#guchar"
|
|
>guchar</a> *buf2,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> rowstride2,
|
|
const <a
|
|
href="../glib/glib-Basic-Types.html#guchar"
|
|
>guchar</a> *mask,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> rowstride_mask);</pre>
|
|
<p>
|
|
Composites <em class="parameter"><code>buf1</code></em> on <em class="parameter"><code>buf2</code></em> with the given <em class="parameter"><code>mask</code></em>, draws the result on
|
|
<em class="parameter"><code>area</code></em> and queues a redraw on the given rectangle.
|
|
</p>
|
|
<p>
|
|
Since GIMP 2.2</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>area</code></em> :</span></p></td>
|
|
<td> a <a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a> widget.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
|
|
<td> x offset in preview
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
|
|
<td> y offset in preview
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
|
|
<td> buffer width
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
|
|
<td> buffer height
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
|
|
<td> the <a
|
|
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpImageType"
|
|
><span class="type">GimpImageType</span></a> of <em class="parameter"><code>buf1</code></em> and <em class="parameter"><code>buf2</code></em>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>buf1</code></em> :</span></p></td>
|
|
<td> a <a
|
|
href="../glib/glib-Basic-Types.html#guchar"
|
|
><span class="type">guchar</span></a> buffer that contains the pixel data for
|
|
the lower layer
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>rowstride1</code></em> :</span></p></td>
|
|
<td> rowstride of <em class="parameter"><code>buf1</code></em>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>buf2</code></em> :</span></p></td>
|
|
<td> a <a
|
|
href="../glib/glib-Basic-Types.html#guchar"
|
|
><span class="type">guchar</span></a> buffer that contains the pixel data for
|
|
the upper layer
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>rowstride2</code></em> :</span></p></td>
|
|
<td> rowstride of <em class="parameter"><code>buf2</code></em>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>mask</code></em> :</span></p></td>
|
|
<td> a <a
|
|
href="../glib/glib-Basic-Types.html#guchar"
|
|
><span class="type">guchar</span></a> buffer representing the mask of the second
|
|
layer.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>rowstride_mask</code></em> :</span></p></td>
|
|
<td> rowstride for the mask.
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2648046"></a><h3>
|
|
<a name="gimp-preview-area-set-offsets"></a>gimp_preview_area_set_offsets ()</h3>
|
|
<a class="indexterm" name="id2648061"></a><pre class="programlisting">void gimp_preview_area_set_offsets (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> x,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> y);</pre>
|
|
<p>
|
|
Sets the offsets of the previewed area. This information is used
|
|
when drawing the checkerboard and to determine the dither offsets.</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>area</code></em> :</span></p></td>
|
|
<td> a <a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
|
|
<td> horizontal offset
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
|
|
<td> vertical offset
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p class="since">Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2648170"></a><h3>
|
|
<a name="gimp-preview-area-set-colormap"></a>gimp_preview_area_set_colormap ()</h3>
|
|
<a class="indexterm" name="id2648183"></a><pre class="programlisting">void gimp_preview_area_set_colormap (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
|
|
const <a
|
|
href="../glib/glib-Basic-Types.html#guchar"
|
|
>guchar</a> *colormap,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> num_colors);</pre>
|
|
<p>
|
|
Sets the colormap for the <a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a> widget. You need to
|
|
call this function before you use <a class="link" href="GimpPreviewArea.html#gimp-preview-area-draw"><code class="function">gimp_preview_area_draw()</code></a> with
|
|
an image type of <code class="literal">GIMP_INDEXED_IMAGE</code> or <code class="literal">GIMP_INDEXEDA_IMAGE</code>.
|
|
</p>
|
|
<p>
|
|
Since GIMP 2.2</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>area</code></em> :</span></p></td>
|
|
<td> a <a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>colormap</code></em> :</span></p></td>
|
|
<td> a <a
|
|
href="../glib/glib-Basic-Types.html#guchar"
|
|
><span class="type">guchar</span></a> buffer that contains the colormap
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>num_colors</code></em> :</span></p></td>
|
|
<td> the number of colors in the colormap
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2648330"></a><h3>
|
|
<a name="gimp-preview-area-set-max-size"></a>gimp_preview_area_set_max_size ()</h3>
|
|
<a class="indexterm" name="id2573202"></a><pre class="programlisting">void gimp_preview_area_set_max_size (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> width,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> height);</pre>
|
|
<p>
|
|
Usually a <a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a> fills the size that it is
|
|
allocated. This funtion allows you to limit the preview area to a
|
|
maximum size. If a larger size is allocated for the widget, the
|
|
preview will draw itself centered into the allocated area.</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>area</code></em> :</span></p></td>
|
|
<td> a <a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a> widget
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
|
|
<td> the maximum width in pixels or -1 to unset the limit
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
|
|
<td> the maximum height in pixels or -1 to unset the limit
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p class="since">Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2648435"></a><h3>
|
|
<a name="gimp-preview-area-menu-popup"></a>gimp_preview_area_menu_popup ()</h3>
|
|
<a class="indexterm" name="id2648450"></a><pre class="programlisting">void gimp_preview_area_menu_popup (<a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea">GimpPreviewArea</a> *area,
|
|
<a
|
|
href="../gdk/gdk-Event-Structures.html#GdkEventButton"
|
|
>GdkEventButton</a> *event);</pre>
|
|
<p>
|
|
Creates a popup menu that allows to configure the size and type of
|
|
the checkerboard pattern that the <em class="parameter"><code>area</code></em> uses to visualize transparency.</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>area</code></em> :</span></p></td>
|
|
<td> a <a class="link" href="GimpPreviewArea.html" title="GimpPreviewArea"><span class="type">GimpPreviewArea</span></a>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
|
|
<td> the button event that causes the menu to popup or <a
|
|
href="../glib/glib-Standard-Macros.html#NULL:CAPS"
|
|
><code class="literal">NULL</code></a>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
<p class="since">Since GIMP 2.2
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2648544"></a><h2>Property Details</h2>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2648553"></a><h3>
|
|
<a name="GimpPreviewArea--check-size"></a>The "<code class="literal">check-size</code>" property</h3>
|
|
<a class="indexterm" name="id2648566"></a><pre class="programlisting"> "check-size" <a
|
|
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpCheckSize"
|
|
>GimpCheckSize</a> : Read / Write</pre>
|
|
<p></p>
|
|
<p>Default value: GIMP_CHECK_SIZE_MEDIUM_CHECKS</p>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2648588"></a><h3>
|
|
<a name="GimpPreviewArea--check-type"></a>The "<code class="literal">check-type</code>" property</h3>
|
|
<a class="indexterm" name="id2648601"></a><pre class="programlisting"> "check-type" <a
|
|
href="../libgimpbase/libgimpbase-gimpbaseenums.html#GimpCheckType"
|
|
>GimpCheckType</a> : Read / Write</pre>
|
|
<p></p>
|
|
<p>Default value: GIMP_CHECK_TYPE_GRAY_CHECKS</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|