67 lines
9.8 KiB
HTML
67 lines
9.8 KiB
HTML
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gimppatterns</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.1"><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.3 (XML mode)"><link rel="stylesheet" href="style.css" type="text/css"><link rel="part" href="gimpdefinitions.html" title="Part I. GIMP Constants"><link rel="part" href="libgimp.html" title="Part II. 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 all 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 III. GIMP User Interface Library"><link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" 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></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><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">
|
||
|
||
|
||
|
||
gboolean <a href="libgimp-gimppatterns.html#gimp-patterns-refresh">gimp_patterns_refresh</a> (void);
|
||
gchar** <a href="libgimp-gimppatterns.html#gimp-patterns-get-list">gimp_patterns_get_list</a> (const gchar *filter,
|
||
gint *num_patterns);
|
||
gchar* <a href="libgimp-gimppatterns.html#gimp-patterns-get-pattern">gimp_patterns_get_pattern</a> (gint *width,
|
||
gint *height);
|
||
gboolean <a href="libgimp-gimppatterns.html#gimp-patterns-set-pattern">gimp_patterns_set_pattern</a> (const gchar *name);
|
||
gchar* <a href="libgimp-gimppatterns.html#gimp-patterns-get-pattern-data">gimp_patterns_get_pattern_data</a> (const gchar *name,
|
||
gint *width,
|
||
gint *height,
|
||
gint *mask_bpp,
|
||
gint *length,
|
||
guint8 **mask_data);
|
||
</pre></div><div class="refsect1" lang="en"><a name="id2657416"></a><h2>Description</h2><p>
|
||
Functions relating to patterns.
|
||
|
||
</p></div><div class="refsect1" lang="en"><a name="id2657426"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2657431"></a><h3><a name="gimp-patterns-refresh"></a>gimp_patterns_refresh ()</h3><a class="indexterm" name="id2657440"></a><pre class="programlisting">gboolean 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><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> TRUE on success.
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2660847"></a><h3><a name="gimp-patterns-get-list"></a>gimp_patterns_get_list ()</h3><a class="indexterm" name="id2660855"></a><pre class="programlisting">gchar** gimp_patterns_get_list (const gchar *filter,
|
||
gint *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
|
||
'gimp_context_set_pattern'.</p><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>filter</tt></i> :</span></td><td> An optional regular expression used to filter the list.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>num_patterns</tt></i> :</span></td><td> The number of patterns in the pattern list.
|
||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> The list of pattern names.
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2660928"></a><h3><a name="gimp-patterns-get-pattern"></a>gimp_patterns_get_pattern ()</h3><a class="indexterm" name="id2660937"></a><pre class="programlisting">gchar* gimp_patterns_get_pattern (gint *width,
|
||
gint *height);</pre><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p><tt class="literal">gimp_patterns_get_pattern</tt> is deprecated and should not be used in newly-written code.</p></div><p>
|
||
This procedure is deprecated! Use <a href="libgimp-gimpcontext.html#gimp-context-get-pattern"><tt class="function">gimp_context_get_pattern()</tt></a>
|
||
instead.</p><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>width</tt></i> :</span></td><td> The pattern width.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>height</tt></i> :</span></td><td> The pattern height.
|
||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> The pattern name.
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2638486"></a><h3><a name="gimp-patterns-set-pattern"></a>gimp_patterns_set_pattern ()</h3><a class="indexterm" name="id2638494"></a><pre class="programlisting">gboolean gimp_patterns_set_pattern (const gchar *name);</pre><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p><tt class="literal">gimp_patterns_set_pattern</tt> is deprecated and should not be used in newly-written code.</p></div><p>
|
||
This procedure is deprecated! Use <a href="libgimp-gimpcontext.html#gimp-context-set-pattern"><tt class="function">gimp_context_set_pattern()</tt></a> instead.</p><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>name</tt></i> :</span></td><td> The pattern name.
|
||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> TRUE on success.
|
||
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2638557"></a><h3><a name="gimp-patterns-get-pattern-data"></a>gimp_patterns_get_pattern_data ()</h3><a class="indexterm" name="id2638565"></a><pre class="programlisting">gchar* gimp_patterns_get_pattern_data (const gchar *name,
|
||
gint *width,
|
||
gint *height,
|
||
gint *mask_bpp,
|
||
gint *length,
|
||
guint8 **mask_data);</pre><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p><tt class="literal">gimp_patterns_get_pattern_data</tt> is deprecated and should not be used in newly-written code.</p></div><p>
|
||
This procedure is deprecated! Use <a href="libgimp-gimppattern.html#gimp-pattern-get-pixels"><tt class="function">gimp_pattern_get_pixels()</tt></a> instead.</p><p>
|
||
|
||
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>name</tt></i> :</span></td><td> The pattern name (\"\" means currently active pattern).
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>width</tt></i> :</span></td><td> The pattern width.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>height</tt></i> :</span></td><td> The pattern height.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>mask_bpp</tt></i> :</span></td><td> Pattern bytes per pixel.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>length</tt></i> :</span></td><td> Length of pattern mask data.
|
||
</td></tr><tr><td><span class="term"><i class="parameter"><tt>mask_data</tt></i> :</span></td><td> The pattern mask data.
|
||
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> The pattern name.
|
||
</td></tr></tbody></table></div></div></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="libgimp-gimppattern.html"><b><< gimppattern</b></a></td><td align="right"><a accesskey="n" href="libgimp-selectors.html"><b>Controlling the Core's Selection Dialogs >></b></a></td></tr></table></body></html>
|