gimpbrush 3 LIBGIMP Library
gimpbrush Functions operating on a single brush.

## Synopsis

    gchar*      gimp_brush_new                  (const gchar *name);
    gchar*      gimp_brush_duplicate            (const gchar *name);
    gchar*      gimp_brush_rename               (const gchar *name,
                                                 const gchar *new_name);
    gboolean    gimp_brush_delete               (const gchar *name);
    gboolean    gimp_brush_get_info             (const gchar *name,
                                                 gint *width,
                                                 gint *height,
                                                 gint *mask_bpp,
                                                 gint *color_bpp);
    gboolean    gimp_brush_get_pixels           (const gchar *name,
                                                 gint *width,
                                                 gint *height,
                                                 gint *mask_bpp,
                                                 gint *num_mask_bytes,
                                                 guint8 **mask_bytes,
                                                 gint *color_bpp,
                                                 gint *num_color_bytes,
                                                 guint8 **color_bytes);
    gboolean    gimp_brush_get_spacing          (const gchar *name,
                                                 gint *spacing);
    gboolean    gimp_brush_set_spacing          (const gchar *name,
                                                 gint spacing);

## Description

Functions operating on a single brush.

## Details

### gimp_brush_new ()

    gchar*      gimp_brush_new                  (const gchar *name);

Creates a new brush

This procedure creates a new, uninitialized brush

name :

  The requested name of the new brush.

Returns :

  The actual new brush name.

Since GIMP 2.2

gimp_brush_new

### gimp_brush_duplicate ()

    gchar*      gimp_brush_duplicate            (const gchar *name);

Duplicates a brush

This procedure creates an identical brush by a different name

name :

  The brush name.

Returns :

  The name of the brush's copy.

Since GIMP 2.2

gimp_brush_duplicate

### gimp_brush_rename ()

    gchar*      gimp_brush_rename               (const gchar *name,
                                                 const gchar *new_name);

Rename a brush

This procedure renames a brush

name :

  The brush name.

new_name :

  The new name of the brush.

Returns :

  The actual new name of the brush.

Since GIMP 2.2

gimp_brush_rename

### gimp_brush_delete ()

    gboolean    gimp_brush_delete               (const gchar *name);

Deletes a brush

This procedure deletes a brush

name :

  The brush name.

Returns :

  TRUE on success.

Since GIMP 2.2

gimp_brush_delete

### gimp_brush_get_info ()

    gboolean    gimp_brush_get_info             (const gchar *name,
                                                 gint *width,
                                                 gint *height,
                                                 gint *mask_bpp,
                                                 gint *color_bpp);

Retrieve information about the specified brush.

This procedure retrieves information about the specified brush. This includes the brush name, and the brush extents (width and height).

name :

  The brush name.

width :

  The brush width.

height :

  The brush height.

mask_bpp :

  The brush mask bpp.

color_bpp :

  The brush color bpp.

Returns :

  TRUE on success.

Since GIMP 2.2

gimp_brush_get_info

### gimp_brush_get_pixels ()

    gboolean    gimp_brush_get_pixels           (const gchar *name,
                                                 gint *width,
                                                 gint *height,
                                                 gint *mask_bpp,
                                                 gint *num_mask_bytes,
                                                 guint8 **mask_bytes,
                                                 gint *color_bpp,
                                                 gint *num_color_bytes,
                                                 guint8 **color_bytes);

Retrieve information about the specified brush.

This procedure retrieves information about the specified brush. This includes the brush extents (width and height) and its pixels data.

name :

  The brush name.

width :

  The brush width.

height :

  The brush height.

mask_bpp :

  The brush mask bpp.

num_mask_bytes :

  Length of brush mask data.

mask_bytes :

  The brush mask data.

color_bpp :

  The brush color bpp.

num_color_bytes :

  Length of brush color data.

color_bytes :

  The brush color data.

Returns :

  TRUE on success.

Since GIMP 2.2

gimp_brush_get_pixels

### gimp_brush_get_spacing ()

    gboolean    gimp_brush_get_spacing          (const gchar *name,
                                                 gint *spacing);

Get the brush spacing.

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.

name :

  The brush name.

spacing :

  The brush spacing.

Returns :

  TRUE on success.

Since GIMP 2.2

gimp_brush_get_spacing

### gimp_brush_set_spacing ()

    gboolean    gimp_brush_set_spacing          (const gchar *name,
                                                 gint spacing);

Set the brush spacing.

This procedure modifies the spacing setting for the specified brush. The value should be a integer between 0 and 1000.

name :

  The brush name.

spacing :

  The brush spacing.

Returns :

  TRUE on success.

Since GIMP 2.2

gimp_brush_set_spacing