GIMP Library Reference Manual
<<< Previous Page | Home | Up | Next Page >>>

# gimpbrushes

## Name

gimpbrushes --

## Synopsis

    gboolean    gimp_brushes_popup              (gchar *brush_callback,
                                                 gchar *popup_title,
                                                 gchar *initial_brush,
                                                 gdouble opacity,
                                                 gint spacing,
                                                 GimpLayerModeEffects paint_mode);
    gboolean    gimp_brushes_close_popup        (gchar *brush_callback);
    gboolean    gimp_brushes_set_popup          (gchar *brush_callback,
                                                 gchar *brush_name,
                                                 gdouble opacity,
                                                 gint spacing,
                                                 GimpLayerModeEffects paint_mode);
    gchar*      gimp_brushes_get_brush_data     (gchar *name,
                                                 gdouble *opacity,
                                                 gint *spacing,
                                                 GimpLayerModeEffects *paint_mode,
                                                 gint *width,
                                                 gint *height,
                                                 gint *length,
                                                 guint8 **mask_data);

## Description

## Details

### gimp_brushes_popup ()

    gboolean    gimp_brushes_popup              (gchar *brush_callback,
                                                 gchar *popup_title,
                                                 gchar *initial_brush,
                                                 gdouble opacity,
                                                 gint spacing,
                                                 GimpLayerModeEffects paint_mode);

Invokes the Gimp brush selection.

This procedure popups the brush selection dialog.

`brush_callback` : | The callback PDB proc to call when brush selection is made.
`popup_title` : | Title to give the brush popup window.
`initial_brush` : | The name of the brush to set as the first selected.
`opacity` : | The initial opacity of the brush.
`spacing` : | The initial spacing of the brush (if < 0 then use brush default spacing).
`paint_mode` : | The initial paint mode.
Returns : | TRUE on success.

### gimp_brushes_close_popup ()

    gboolean    gimp_brushes_close_popup        (gchar *brush_callback);

Popdown the Gimp brush selection.

This procedure closes an opened brush selection dialog.

`brush_callback` : | The name of the callback registered for this popup.
Returns : | TRUE on success.

### gimp_brushes_set_popup ()

    gboolean    gimp_brushes_set_popup          (gchar *brush_callback,
                                                 gchar *brush_name,
                                                 gdouble opacity,
                                                 gint spacing,
                                                 GimpLayerModeEffects paint_mode);

Sets the current brush selection in a popup.

Sets the current brush selection in a popup.

`brush_callback` : | The name of the callback registered for this popup.
`brush_name` : | The name of the brush to set as selected.
`opacity` : | The initial opacity of the brush.
`spacing` : | The initial spacing of the brush (if < 0 then use brush default spacing).
`paint_mode` : | The initial paint mode.
Returns : | TRUE on success.

### gimp_brushes_get_brush_data ()

    gchar*      gimp_brushes_get_brush_data     (gchar *name,
                                                 gdouble *opacity,
                                                 gint *spacing,
                                                 GimpLayerModeEffects *paint_mode,
                                                 gint *width,
                                                 gint *height,
                                                 gint *length,
                                                 guint8 **mask_data);

Retrieve information about the currently active brush (including data).

This procedure retrieves information about the currently active brush. This includes the brush name, and the brush extents (width and height). It also returns the brush data.

`name` : | the brush name (\"\" means current active pattern).
`opacity` : | The brush opacity.
`spacing` : | The brush spacing.
`paint_mode` : | The paint mode.
`width` : | The brush width.
`height` : | The brush height.
`length` : | Length of brush mask data.
`mask_data` : | The brush mask data.
Returns : | The brush name.

<<< Previous Page | Home | Up | Next Page >>>
gimpcompat | gimpchannel