gimpbrushes

gimpbrushes — Functions for manipulating brushes.

Synopsis




gboolean    gimp_brushes_refresh            (void);
gchar**     gimp_brushes_get_list           (const gchar *filter,
                                             gint *num_brushes);
gchar*      gimp_brushes_get_brush          (gint *width,
                                             gint *height,
                                             gint *spacing);
gboolean    gimp_brushes_set_brush          (const gchar *name);
gdouble     gimp_brushes_get_opacity        (void);
gboolean    gimp_brushes_set_opacity        (gdouble opacity);
GimpLayerModeEffects gimp_brushes_get_paint_mode
                                            (void);
gboolean    gimp_brushes_set_paint_mode     (GimpLayerModeEffects paint_mode);
gint        gimp_brushes_get_spacing        (void);
gboolean    gimp_brushes_set_spacing        (gint spacing);
gchar*      gimp_brushes_get_brush_data     (const gchar *name,
                                             gdouble *opacity,
                                             gint *spacing,
                                             GimpLayerModeEffects *paint_mode,
                                             gint *width,
                                             gint *height,
                                             gint *length,
                                             guint8 **mask_data);

Description

Functions related to getting and setting brushes.

Details

gimp_brushes_refresh ()

gboolean    gimp_brushes_refresh            (void);

Refresh current brushes. This function always succeeds.

This procedure retrieves all brushes currently in the user's brush path and updates the brush dialogs accordingly.

Returns : TRUE on success.

gimp_brushes_get_list ()

gchar**     gimp_brushes_get_list           (const gchar *filter,
                                             gint *num_brushes);

Retrieve a complete listing of the available brushes.

This procedure returns a complete listing of available GIMP brushes. Each name returned can be used as input to the 'gimp_context_set_brush' procedure.

filter : An optional regular expression used to filter the list.
num_brushes : The number of brushes in the brush list.
Returns : The list of brush names.

gimp_brushes_get_brush ()

gchar*      gimp_brushes_get_brush          (gint *width,
                                             gint *height,
                                             gint *spacing);

Warning

gimp_brushes_get_brush is deprecated and should not be used in newly-written code.

This procedure is deprecated! Use 'gimp_context_get_brush' instead.

This procedure is deprecated! Use 'gimp_context_get_brush' instead.

width : The brush width.
height : The brush height.
spacing : The brush spacing.
Returns : The brush name.

gimp_brushes_set_brush ()

gboolean    gimp_brushes_set_brush          (const gchar *name);

Warning

gimp_brushes_set_brush is deprecated and should not be used in newly-written code.

Set the specified brush as the active brush.

This procedure is deprecated! Use 'gimp_context_set_brush' instead.

name : The brush name.
Returns : TRUE on success.

gimp_brushes_get_opacity ()

gdouble     gimp_brushes_get_opacity        (void);

Warning

gimp_brushes_get_opacity is deprecated and should not be used in newly-written code.

Get the brush opacity.

This procedure is deprecated! Use 'gimp_context_get_opacity' instead.

Returns : The brush opacity.

gimp_brushes_set_opacity ()

gboolean    gimp_brushes_set_opacity        (gdouble opacity);

Warning

gimp_brushes_set_opacity is deprecated and should not be used in newly-written code.

Set the brush opacity.

This procedure is deprecated! Use 'gimp_context_set_opacity' instead.

opacity : The brush opacity.
Returns : TRUE on success.

gimp_brushes_get_paint_mode ()

GimpLayerModeEffects gimp_brushes_get_paint_mode
                                            (void);

Warning

gimp_brushes_get_paint_mode is deprecated and should not be used in newly-written code.

Get the brush paint mode.

This procedure isdeprecated! Use 'gimp_context_get_paint_mode' instead.

Returns : The paint mode.

gimp_brushes_set_paint_mode ()

gboolean    gimp_brushes_set_paint_mode     (GimpLayerModeEffects paint_mode);

Warning

gimp_brushes_set_paint_mode is deprecated and should not be used in newly-written code.

Set the brush paint mode.

This procedure is deprecated! Use 'gimp_context_set_paint_mode' instead.

paint_mode : The paint mode.
Returns : TRUE on success.

gimp_brushes_get_spacing ()

gint        gimp_brushes_get_spacing        (void);

Warning

gimp_brushes_get_spacing is deprecated and should not be used in newly-written code.

This procedure is deprecated! Use 'gimp_brush_get_spacing' instead.

This procedure is deprecated! Use 'gimp_brush_get_spacing' instead.

Returns : The brush spacing.

gimp_brushes_set_spacing ()

gboolean    gimp_brushes_set_spacing        (gint spacing);

Warning

gimp_brushes_set_spacing is deprecated and should not be used in newly-written code.

This procedure is deprecated! Use 'gimp_brush_set_spacing' instead.

This procedure is deprecated! Use 'gimp_brush_set_spacing' instead.

spacing : The brush spacing.
Returns : TRUE on success.

gimp_brushes_get_brush_data ()

gchar*      gimp_brushes_get_brush_data     (const 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 brush).
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.