289 lines
13 KiB
XML
289 lines
13 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-gimpbrush">
|
|
<refmeta>
|
|
<refentrytitle>gimpbrush</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo>LIBGIMP Library</refmiscinfo>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>gimpbrush</refname><refpurpose>Functions operating on a single brush.</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv><title>Synopsis</title>
|
|
|
|
<synopsis>
|
|
|
|
|
|
|
|
<link linkend="gchar">gchar</link>* <link linkend="gimp-brush-new">gimp_brush_new</link> (const <link linkend="gchar">gchar</link> *name);
|
|
<link linkend="gchar">gchar</link>* <link linkend="gimp-brush-duplicate">gimp_brush_duplicate</link> (const <link linkend="gchar">gchar</link> *name);
|
|
<link linkend="gchar">gchar</link>* <link linkend="gimp-brush-rename">gimp_brush_rename</link> (const <link linkend="gchar">gchar</link> *name,
|
|
const <link linkend="gchar">gchar</link> *new_name);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-brush-delete">gimp_brush_delete</link> (const <link linkend="gchar">gchar</link> *name);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-brush-get-info">gimp_brush_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> *mask_bpp,
|
|
<link linkend="gint">gint</link> *color_bpp);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-brush-get-pixels">gimp_brush_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> *mask_bpp,
|
|
<link linkend="gint">gint</link> *num_mask_bytes,
|
|
<link linkend="guint8">guint8</link> **mask_bytes,
|
|
<link linkend="gint">gint</link> *color_bpp,
|
|
<link linkend="gint">gint</link> *num_color_bytes,
|
|
<link linkend="guint8">guint8</link> **color_bytes);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-brush-get-spacing">gimp_brush_get_spacing</link> (const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> *spacing);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-brush-set-spacing">gimp_brush_set_spacing</link> (const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> spacing);
|
|
</synopsis>
|
|
</refsynopsisdiv>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<para>
|
|
Functions operating on a single brush.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1>
|
|
<title>Details</title>
|
|
<refsect2>
|
|
<title><anchor id="gimp-brush-new"/>gimp_brush_new ()</title>
|
|
<indexterm role="GIMP"><primary>gimp_brush_new</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_brush_new (const <link linkend="gchar">gchar</link> *name);</programlisting>
|
|
<para>
|
|
Creates a new brush
|
|
</para>
|
|
<para>
|
|
This procedure creates a new, uninitialized brush</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The requested name of the new brush.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The actual new brush name.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para>Since GIMP 2.2
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-brush-duplicate"/>gimp_brush_duplicate ()</title>
|
|
<indexterm role="GIMP"><primary>gimp_brush_duplicate</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_brush_duplicate (const <link linkend="gchar">gchar</link> *name);</programlisting>
|
|
<para>
|
|
Duplicates a brush
|
|
</para>
|
|
<para>
|
|
This procedure creates an identical brush by a different name</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The brush name.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The name of the brush's copy.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para>Since GIMP 2.2
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-brush-rename"/>gimp_brush_rename ()</title>
|
|
<indexterm role="GIMP"><primary>gimp_brush_rename</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gimp_brush_rename (const <link linkend="gchar">gchar</link> *name,
|
|
const <link linkend="gchar">gchar</link> *new_name);</programlisting>
|
|
<para>
|
|
Rename a brush
|
|
</para>
|
|
<para>
|
|
This procedure renames a brush</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The brush name.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>new_name</parameter> :</term>
|
|
<listitem><simpara> The new name of the brush.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The actual new name of the brush.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para>Since GIMP 2.2
|
|
</para></refsect2>
|
|
<refsect2>
|
|
<title><anchor id="gimp-brush-delete"/>gimp_brush_delete ()</title>
|
|
<indexterm role="GIMP"><primary>gimp_brush_delete</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_brush_delete (const <link linkend="gchar">gchar</link> *name);</programlisting>
|
|
<para>
|
|
Deletes a brush
|
|
</para>
|
|
<para>
|
|
This procedure deletes a brush</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The brush name.
|
|
</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-brush-get-info"/>gimp_brush_get_info ()</title>
|
|
<indexterm role="GIMP"><primary>gimp_brush_get_info</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_brush_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> *mask_bpp,
|
|
<link linkend="gint">gint</link> *color_bpp);</programlisting>
|
|
<para>
|
|
Retrieve information about the specified brush.
|
|
</para>
|
|
<para>
|
|
This procedure retrieves information about the specified brush. This
|
|
includes the brush name, and the brush extents (width and height).</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The brush name.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>width</parameter> :</term>
|
|
<listitem><simpara> The brush width.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>height</parameter> :</term>
|
|
<listitem><simpara> The brush height.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>mask_bpp</parameter> :</term>
|
|
<listitem><simpara> The brush mask bpp.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>color_bpp</parameter> :</term>
|
|
<listitem><simpara> The brush color 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-brush-get-pixels"/>gimp_brush_get_pixels ()</title>
|
|
<indexterm role="GIMP"><primary>gimp_brush_get_pixels</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_brush_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> *mask_bpp,
|
|
<link linkend="gint">gint</link> *num_mask_bytes,
|
|
<link linkend="guint8">guint8</link> **mask_bytes,
|
|
<link linkend="gint">gint</link> *color_bpp,
|
|
<link linkend="gint">gint</link> *num_color_bytes,
|
|
<link linkend="guint8">guint8</link> **color_bytes);</programlisting>
|
|
<para>
|
|
Retrieve information about the specified brush.
|
|
</para>
|
|
<para>
|
|
This procedure retrieves information about the specified brush. This
|
|
includes the brush extents (width and height) and its pixels data.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The brush name.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>width</parameter> :</term>
|
|
<listitem><simpara> The brush width.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>height</parameter> :</term>
|
|
<listitem><simpara> The brush height.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>mask_bpp</parameter> :</term>
|
|
<listitem><simpara> The brush mask bpp.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>num_mask_bytes</parameter> :</term>
|
|
<listitem><simpara> Length of brush mask data.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>mask_bytes</parameter> :</term>
|
|
<listitem><simpara> The brush mask data.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>color_bpp</parameter> :</term>
|
|
<listitem><simpara> The brush color bpp.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>num_color_bytes</parameter> :</term>
|
|
<listitem><simpara> Length of brush color data.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>color_bytes</parameter> :</term>
|
|
<listitem><simpara> The brush color 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>
|
|
<refsect2>
|
|
<title><anchor id="gimp-brush-get-spacing"/>gimp_brush_get_spacing ()</title>
|
|
<indexterm role="GIMP"><primary>gimp_brush_get_spacing</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_brush_get_spacing (const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> *spacing);</programlisting>
|
|
<para>
|
|
Get the brush spacing.
|
|
</para>
|
|
<para>
|
|
This procedure returns the spacing setting for the specified brush.
|
|
The return value is an integer between 0 and 1000 which represents
|
|
percentage of the maximum of the width and height of the mask.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The brush name.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>spacing</parameter> :</term>
|
|
<listitem><simpara> The brush spacing.
|
|
</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-brush-set-spacing"/>gimp_brush_set_spacing ()</title>
|
|
<indexterm role="GIMP"><primary>gimp_brush_set_spacing</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_brush_set_spacing (const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> spacing);</programlisting>
|
|
<para>
|
|
Set the brush spacing.
|
|
</para>
|
|
<para>
|
|
This procedure modifies the spacing setting for the specified brush.
|
|
The value should be a integer between 0 and 1000.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The brush name.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>spacing</parameter> :</term>
|
|
<listitem><simpara> The brush spacing.
|
|
</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>
|