332 lines
13 KiB
HTML
332 lines
13 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>gimppatterns</title>
|
|
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
|
|
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
|
|
<link rel="up" href="libgimp-data.html" title="Data Objects">
|
|
<link rel="prev" href="libgimp-gimppattern.html" title="gimppattern">
|
|
<link rel="next" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
|
|
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
|
|
<link rel="stylesheet" href="style.css" type="text/css">
|
|
<link rel="part" href="libgimp.html" title="Part I. GIMP Library">
|
|
<link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images">
|
|
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and their Properties">
|
|
<link rel="chapter" href="libgimp-data.html" title="Data Objects">
|
|
<link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
|
|
<link rel="part" href="libgimpui.html" title="Part II. GIMP User Interface Library">
|
|
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
|
|
<link rel="index" href="libgimp-index.html" title="Index">
|
|
<link rel="index" href="libgimp-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
|
|
<link rel="index" href="libgimp-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
|
|
<link rel="index" href="libgimp-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="libgimp-gimppattern.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
|
|
<td><a accesskey="u" href="libgimp-data.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 Library Reference Manual</th>
|
|
<td><a accesskey="n" href="libgimp-selectors.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="#id2610539" class="shortcut">Top</a>
|
|
 | 
|
|
<a href="#id2712375" class="shortcut">Description</a></nobr></td></tr>
|
|
</table>
|
|
<div class="refentry" lang="en">
|
|
<a name="libgimp-gimppatterns"></a><div class="titlepage"></div>
|
|
<div class="refnamediv"><table width="100%"><tr>
|
|
<td valign="top">
|
|
<h2>
|
|
<a name="id2610539"></a><span class="refentrytitle">gimppatterns</span>
|
|
</h2>
|
|
<p>gimppatterns — Functions relating to patterns.</p>
|
|
</td>
|
|
<td valign="top" align="right"></td>
|
|
</tr></table></div>
|
|
<div class="refsynopsisdiv">
|
|
<h2>Synopsis</h2>
|
|
<pre class="synopsis">
|
|
|
|
|
|
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> <a class="link" href="libgimp-gimppatterns.html#gimp-patterns-refresh">gimp_patterns_refresh</a> (void);
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gchar"
|
|
>gchar</a>** <a class="link" href="libgimp-gimppatterns.html#gimp-patterns-get-list">gimp_patterns_get_list</a> (const <a
|
|
href="../glib/glib-Basic-Types.html#gchar"
|
|
>gchar</a> *filter,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> *num_patterns);
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gchar"
|
|
>gchar</a>* <a class="link" href="libgimp-gimppatterns.html#gimp-patterns-get-pattern">gimp_patterns_get_pattern</a> (<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#gboolean"
|
|
>gboolean</a> <a class="link" href="libgimp-gimppatterns.html#gimp-patterns-set-pattern">gimp_patterns_set_pattern</a> (const <a
|
|
href="../glib/glib-Basic-Types.html#gchar"
|
|
>gchar</a> *name);
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gchar"
|
|
>gchar</a>* <a class="link" href="libgimp-gimppatterns.html#gimp-patterns-get-pattern-data">gimp_patterns_get_pattern_data</a> (const <a
|
|
href="../glib/glib-Basic-Types.html#gchar"
|
|
>gchar</a> *name,
|
|
<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#gint"
|
|
>gint</a> *mask_bpp,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> *length,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#guint8"
|
|
>guint8</a> **mask_data);
|
|
</pre>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2712375"></a><h2>Description</h2>
|
|
<p>
|
|
Functions relating to patterns.
|
|
|
|
</p>
|
|
</div>
|
|
<div class="refsect1" lang="en">
|
|
<a name="id2712390"></a><h2>Details</h2>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2712400"></a><h3>
|
|
<a name="gimp-patterns-refresh"></a>gimp_patterns_refresh ()</h3>
|
|
<a class="indexterm" name="id2712412"></a><pre class="programlisting"><a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> gimp_patterns_refresh (void);</pre>
|
|
<p>
|
|
Refresh current patterns. This function always succeeds.
|
|
</p>
|
|
<p>
|
|
This procedure retrieves all patterns currently in the user's
|
|
pattern path and updates all pattern dialogs accordingly.</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> TRUE on success.
|
|
</td>
|
|
</tr></tbody>
|
|
</table></div>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2710235"></a><h3>
|
|
<a name="gimp-patterns-get-list"></a>gimp_patterns_get_list ()</h3>
|
|
<a class="indexterm" name="id2710246"></a><pre class="programlisting"><a
|
|
href="../glib/glib-Basic-Types.html#gchar"
|
|
>gchar</a>** gimp_patterns_get_list (const <a
|
|
href="../glib/glib-Basic-Types.html#gchar"
|
|
>gchar</a> *filter,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> *num_patterns);</pre>
|
|
<p>
|
|
Retrieve a complete listing of the available patterns.
|
|
</p>
|
|
<p>
|
|
This procedure returns a complete listing of available GIMP
|
|
patterns. Each name returned can be used as input to the
|
|
<a class="link" href="libgimp-gimpcontext.html#gimp-context-set-pattern"><code class="function">gimp_context_set_pattern()</code></a>.</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>filter</code></em> :</span></p></td>
|
|
<td> An optional regular expression used to filter the list.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>num_patterns</code></em> :</span></p></td>
|
|
<td> The number of patterns in the pattern list.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
|
<td> The list of pattern names.
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2708996"></a><h3>
|
|
<a name="gimp-patterns-get-pattern"></a>gimp_patterns_get_pattern ()</h3>
|
|
<a class="indexterm" name="id2709009"></a><pre class="programlisting"><a
|
|
href="../glib/glib-Basic-Types.html#gchar"
|
|
>gchar</a>* gimp_patterns_get_pattern (<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> *width,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> *height);</pre>
|
|
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
|
|
<h3 class="title">Warning</h3>
|
|
<p><code class="literal">gimp_patterns_get_pattern</code> is deprecated and should not be used in newly-written code.</p>
|
|
</div>
|
|
<p>
|
|
This procedure is deprecated! Use <a class="link" href="libgimp-gimpcontext.html#gimp-context-get-pattern"><code class="function">gimp_context_get_pattern()</code></a>
|
|
instead.</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>width</code></em> :</span></p></td>
|
|
<td> The pattern width.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
|
|
<td> The pattern height.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
|
<td> The pattern name.
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2709110"></a><h3>
|
|
<a name="gimp-patterns-set-pattern"></a>gimp_patterns_set_pattern ()</h3>
|
|
<a class="indexterm" name="id2709124"></a><pre class="programlisting"><a
|
|
href="../glib/glib-Basic-Types.html#gboolean"
|
|
>gboolean</a> gimp_patterns_set_pattern (const <a
|
|
href="../glib/glib-Basic-Types.html#gchar"
|
|
>gchar</a> *name);</pre>
|
|
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
|
|
<h3 class="title">Warning</h3>
|
|
<p><code class="literal">gimp_patterns_set_pattern</code> is deprecated and should not be used in newly-written code.</p>
|
|
</div>
|
|
<p>
|
|
This procedure is deprecated! Use <a class="link" href="libgimp-gimpcontext.html#gimp-context-set-pattern"><code class="function">gimp_context_set_pattern()</code></a> instead.</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 pattern name.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
|
<td> TRUE on success.
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
<hr>
|
|
<div class="refsect2" lang="en">
|
|
<a name="id2711668"></a><h3>
|
|
<a name="gimp-patterns-get-pattern-data"></a>gimp_patterns_get_pattern_data ()</h3>
|
|
<a class="indexterm" name="id2711682"></a><pre class="programlisting"><a
|
|
href="../glib/glib-Basic-Types.html#gchar"
|
|
>gchar</a>* gimp_patterns_get_pattern_data (const <a
|
|
href="../glib/glib-Basic-Types.html#gchar"
|
|
>gchar</a> *name,
|
|
<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#gint"
|
|
>gint</a> *mask_bpp,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#gint"
|
|
>gint</a> *length,
|
|
<a
|
|
href="../glib/glib-Basic-Types.html#guint8"
|
|
>guint8</a> **mask_data);</pre>
|
|
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
|
|
<h3 class="title">Warning</h3>
|
|
<p><code class="literal">gimp_patterns_get_pattern_data</code> is deprecated and should not be used in newly-written code.</p>
|
|
</div>
|
|
<p>
|
|
This procedure is deprecated! Use <a class="link" href="libgimp-gimppattern.html#gimp-pattern-get-pixels"><code class="function">gimp_pattern_get_pixels()</code></a> instead.</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 pattern name (\"\" means currently active pattern).
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
|
|
<td> The pattern width.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
|
|
<td> The pattern height.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>mask_bpp</code></em> :</span></p></td>
|
|
<td> Pattern bytes per pixel.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
|
|
<td> Length of pattern mask data.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><em class="parameter"><code>mask_data</code></em> :</span></p></td>
|
|
<td> The pattern mask data.
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
|
|
<td> The pattern name.
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|