132 lines
5.3 KiB
XML
132 lines
5.3 KiB
XML
<?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>gimppattern</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo>LIBGIMP Library</refmiscinfo>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>gimppattern</refname><refpurpose>Functions operating on a single pattern.</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv><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>
|
|
<title>Description</title>
|
|
<para>
|
|
Functions operating on a single pattern.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>Details</title>
|
|
<refsect2>
|
|
<title><anchor id="gimp-pattern-get-info"/>gimp_pattern_get_info ()</title>
|
|
<indexterm role="GIMP"><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"/>gimp_pattern_get_pixels ()</title>
|
|
<indexterm role="GIMP"><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>
|