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
|
<?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-gimppattern">
<refmeta>
<refentrytitle role="top_of_page">gimppattern</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMP Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimppattern</refname>
<refpurpose>Functions operating on a single pattern.</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-pattern-get-info">gimp_pattern_get_info</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> *bpp);
<link linkend="gboolean">gboolean</link> <link linkend="gimp-pattern-get-pixels">gimp_pattern_get_pixels</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> *bpp,
<link linkend="gint">gint</link> *num_color_bytes,
<link linkend="guint8">guint8</link> **color_bytes);
</synopsis>
</refsynopsisdiv>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
Functions operating on a single pattern.
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="gimp-pattern-get-info" role="function" condition="since:GIMP 2.2"/>gimp_pattern_get_info ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_pattern_get_info</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_pattern_get_info (const <link linkend="gchar">gchar</link> *name,
<link linkend="gint">gint</link> *width,
<link linkend="gint">gint</link> *height,
<link linkend="gint">gint</link> *bpp);</programlisting>
<para>
Retrieve information about the specified pattern.
</para>
<para>
This procedure retrieves information about the specified pattern.
This includes the pattern extents (width and height).</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> The pattern name.
</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>bpp</parameter> :</term>
<listitem><simpara> The pattern bpp.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
<refsect2>
<title><anchor id="gimp-pattern-get-pixels" role="function" condition="since:GIMP 2.2"/>gimp_pattern_get_pixels ()</title>
<indexterm role="GIMP 2.2"><primary>gimp_pattern_get_pixels</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_pattern_get_pixels (const <link linkend="gchar">gchar</link> *name,
<link linkend="gint">gint</link> *width,
<link linkend="gint">gint</link> *height,
<link linkend="gint">gint</link> *bpp,
<link linkend="gint">gint</link> *num_color_bytes,
<link linkend="guint8">guint8</link> **color_bytes);</programlisting>
<para>
Retrieve information about the specified pattern (including pixels).
</para>
<para>
This procedure retrieves information about the specified. This
includes the pattern extents (width and height), its bpp and its
pixel data.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> The pattern name.
</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>bpp</parameter> :</term>
<listitem><simpara> The pattern bpp.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>num_color_bytes</parameter> :</term>
<listitem><simpara> Number of pattern bytes.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>color_bytes</parameter> :</term>
<listitem><simpara> The pattern data.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
</refsect1>
</refentry>
|