gimpbrushes3LIBGIMP LibrarygimpbrushesFunctions 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.
Detailsgimp_brushes_refresh ()gimp_brushes_refreshgboolean 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 ()gimp_brushes_get_listgchar** 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 ()gimp_brushes_get_brushgchar* gimp_brushes_get_brush (gint *width,
gint *height,
gint *spacing);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.width : The brush width.
height : The brush height.
spacing : The brush spacing.
Returns : The brush name.
gimp_brushes_set_brush ()gimp_brushes_set_brushgboolean gimp_brushes_set_brush (const gchar *name);gimp_brushes_set_brush is deprecated and should not be used in newly-written code.
This procedure is deprecated! Use gimp_context_set_brush() instead.name : The brush name.
Returns : TRUE on success.
gimp_brushes_get_opacity ()gimp_brushes_get_opacitygdouble gimp_brushes_get_opacity (void);gimp_brushes_get_opacity is deprecated and should not be used in newly-written code.
This procedure is deprecated! Use gimp_context_get_opacity() instead.Returns : The brush opacity.
gimp_brushes_set_opacity ()gimp_brushes_set_opacitygboolean gimp_brushes_set_opacity (gdouble opacity);gimp_brushes_set_opacity is deprecated and should not be used in newly-written code.
This procedure is deprecated! Use gimp_context_set_opacity() instead.opacity : The brush opacity.
Returns : TRUE on success.
gimp_brushes_get_paint_mode ()gimp_brushes_get_paint_modeGimpLayerModeEffects gimp_brushes_get_paint_mode (void);gimp_brushes_get_paint_mode is deprecated and should not be used in newly-written code.
This procedure is deprecated! Use gimp_context_get_paint_mode() instead.Returns : The paint mode.
gimp_brushes_set_paint_mode ()gimp_brushes_set_paint_modegboolean gimp_brushes_set_paint_mode (GimpLayerModeEffects paint_mode);gimp_brushes_set_paint_mode is deprecated and should not be used in newly-written code.
This procedure is deprecated! Use gimp_context_set_paint_mode() instead.paint_mode : The paint mode.
Returns : TRUE on success.
gimp_brushes_get_spacing ()gimp_brushes_get_spacinggint gimp_brushes_get_spacing (void);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.Returns : The brush spacing.
gimp_brushes_set_spacing ()gimp_brushes_set_spacinggboolean gimp_brushes_set_spacing (gint spacing);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.spacing : The brush spacing.
Returns : TRUE on success.
gimp_brushes_get_brush_data ()gimp_brushes_get_brush_datagchar* gimp_brushes_get_brush_data (const gchar *name,
gdouble *opacity,
gint *spacing,
GimpLayerModeEffects *paint_mode,
gint *width,
gint *height,
gint *length,
guint8 **mask_data);gimp_brushes_get_brush_data is deprecated and should not be used in newly-written code.
This procedure is deprecated! Use gimp_brush_get_pixels() instead.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.