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
|
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libgimp-gimppatterns">
<refmeta>
<refentrytitle role="top_of_page">gimppatterns</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMP Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimppatterns</refname>
<refpurpose>Functions relating to patterns.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="gboolean">gboolean</link> <link linkend="gimp-patterns-refresh">gimp_patterns_refresh</link> (void);
<link linkend="gchar">gchar</link>** <link linkend="gimp-patterns-get-list">gimp_patterns_get_list</link> (const <link linkend="gchar">gchar</link> *filter,
<link linkend="gint">gint</link> *num_patterns);
<link linkend="gchar">gchar</link>* <link linkend="gimp-patterns-get-pattern">gimp_patterns_get_pattern</link> (<link linkend="gint">gint</link> *width,
<link linkend="gint">gint</link> *height);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-patterns-set-pattern">gimp_patterns_set_pattern</link> (const <link linkend="gchar">gchar</link> *name);
<link linkend="gchar">gchar</link>* <link linkend="gimp-patterns-get-pattern-data">gimp_patterns_get_pattern_data</link> (const <link linkend="gchar">gchar</link> *name,
<link linkend="gint">gint</link> *width,
<link linkend="gint">gint</link> *height,
<link linkend="gint">gint</link> *mask_bpp,
<link linkend="gint">gint</link> *length,
<link linkend="guint8">guint8</link> **mask_data);
</synopsis>
</refsynopsisdiv>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
Functions relating to patterns.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="gimp-patterns-refresh" role="function"/>gimp_patterns_refresh ()</title>
<indexterm><primary>gimp_patterns_refresh</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_patterns_refresh (void);</programlisting>
<para>
Refresh current patterns. This function always succeeds.
</para>
<para>
This procedure retrieves all patterns currently in the user's
pattern path and updates all pattern dialogs accordingly.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-patterns-get-list" role="function"/>gimp_patterns_get_list ()</title>
<indexterm><primary>gimp_patterns_get_list</primary></indexterm><programlisting><link linkend="gchar">gchar</link>** gimp_patterns_get_list (const <link linkend="gchar">gchar</link> *filter,
<link linkend="gint">gint</link> *num_patterns);</programlisting>
<para>
Retrieve a complete listing of the available patterns.
</para>
<para>
This procedure returns a complete listing of available GIMP
patterns. Each name returned can be used as input to the
'gimp_context_set_pattern'.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>filter</parameter> :</term>
<listitem><simpara> An optional regular expression used to filter the list.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>num_patterns</parameter> :</term>
<listitem><simpara> The number of patterns in the pattern list.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The list of pattern names.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-patterns-get-pattern" role="function" condition="deprecated:"/>gimp_patterns_get_pattern ()</title>
<indexterm role="deprecated"><primary>gimp_patterns_get_pattern</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_patterns_get_pattern (<link linkend="gint">gint</link> *width,
<link linkend="gint">gint</link> *height);</programlisting>
<warning><para><literal>gimp_patterns_get_pattern</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
This procedure is deprecated! Use <link linkend="gimp-context-get-pattern"><function>gimp_context_get_pattern()</function></link>
instead.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>width</parameter> :</term>
<listitem><simpara> The pattern width.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter> :</term>
<listitem><simpara> The pattern height.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The pattern name.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-patterns-set-pattern" role="function" condition="deprecated:"/>gimp_patterns_set_pattern ()</title>
<indexterm role="deprecated"><primary>gimp_patterns_set_pattern</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_patterns_set_pattern (const <link linkend="gchar">gchar</link> *name);</programlisting>
<warning><para><literal>gimp_patterns_set_pattern</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
This procedure is deprecated! Use <link linkend="gimp-context-set-pattern"><function>gimp_context_set_pattern()</function></link> instead.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> The pattern name.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-patterns-get-pattern-data" role="function" condition="deprecated:"/>gimp_patterns_get_pattern_data ()</title>
<indexterm role="deprecated"><primary>gimp_patterns_get_pattern_data</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_patterns_get_pattern_data (const <link linkend="gchar">gchar</link> *name,
<link linkend="gint">gint</link> *width,
<link linkend="gint">gint</link> *height,
<link linkend="gint">gint</link> *mask_bpp,
<link linkend="gint">gint</link> *length,
<link linkend="guint8">guint8</link> **mask_data);</programlisting>
<warning><para><literal>gimp_patterns_get_pattern_data</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
This procedure is deprecated! Use <link linkend="gimp-pattern-get-pixels"><function>gimp_pattern_get_pixels()</function></link> instead.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> The pattern name (\"\" means currently active pattern).
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter> :</term>
<listitem><simpara> The pattern width.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter> :</term>
<listitem><simpara> The pattern height.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mask_bpp</parameter> :</term>
<listitem><simpara> Pattern bytes per pixel.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>length</parameter> :</term>
<listitem><simpara> Length of pattern mask data.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mask_data</parameter> :</term>
<listitem><simpara> The pattern mask data.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The pattern name.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
