See also: Main Index; Alphabetic; Misc; By Author; By Module; By Menu External Links: The Gimp; Gimp User Manual

The Gimp brush functions

gimp_airbrush	Paint in the current brush with varying pressure. Paint application is time-dependent.
gimp_airbrush_default	Paint in the current brush with varying pressure. Paint application is time-dependent.
gimp_brush_delete	Deletes a brush
gimp_brush_duplicate	Duplicates a brush
gimp_brush_get_angle	Get the rotation angle of a generated brush.
gimp_brush_get_aspect_ratio	Get the aspect ratio of a generated brush.
gimp_brush_get_hardness	Get the hardness of a generated brush.
gimp_brush_get_info	Retrieve information about the specified brush.
gimp_brush_get_pixels	Retrieve information about the specified brush.
gimp_brush_get_radius	Get the radius of a generated brush.
gimp_brush_get_shape	Get the shape of a generated brush.
gimp_brush_get_spacing	Get the brush spacing.
gimp_brush_get_spikes	Get the number of spikes for a generated brush.
gimp_brush_is_editable	Tests if brush can be edited
gimp_brush_is_generated	Tests if generated
gimp_brush_new	Creates a new brush
gimp_brush_rename	Rename a brush
gimp_brush_set_angle	Set the rotation angle of a generated brush.
gimp_brush_set_aspect_ratio	Set the aspect ratio of a generated brush.
gimp_brush_set_hardness	Set the hardness of a generated brush.
gimp_brush_set_radius	Set the radius of a generated brush.
gimp_brush_set_shape	Set the shape of a generated brush.
gimp_brush_set_spacing	Set the brush spacing.
gimp_brush_set_spikes	Set the number of spikes for a generated brush.
gimp_brushes_close_popup	Popdown the Gimp brush selection.
gimp_brushes_get_brush	This procedure is deprecated! Use 'gimp_context_get_brush' instead.
gimp_brushes_get_brush_data	This procedure is deprecated! Use 'gimp_brush_get_pixels' instead.
gimp_brushes_get_list	Retrieve a complete listing of the available brushes.
gimp_brushes_get_opacity	This procedure is deprecated! Use 'gimp_context_get_opacity' instead.
gimp_brushes_get_paint_mode	This procedure is deprecated! Use 'gimp_context_get_paint_mode' instead.
gimp_brushes_get_spacing	This procedure is deprecated! Use 'gimp_brush_get_spacing' instead.
gimp_brushes_list	This procedure is deprecated! Use 'gimp_brushes_get_list' instead.
gimp_brushes_popup	Invokes the Gimp brush selection.
gimp_brushes_refresh	Refresh current brushes. This function always succeeds.
gimp_brushes_set_brush	This procedure is deprecated! Use 'gimp_context_set_brush' instead.
gimp_brushes_set_opacity	This procedure is deprecated! Use 'gimp_context_set_opacity' instead.
gimp_brushes_set_paint_mode	This procedure is deprecated! Use 'gimp_context_set_paint_mode' instead.
gimp_brushes_set_popup	Sets the current brush selection in a popup.
gimp_brushes_set_spacing	This procedure is deprecated! Use 'gimp_brush_set_spacing' instead.
gimp_context_get_brush	Retrieve the currently active brush.
gimp_context_set_brush	Set the specified brush as the active brush.
gimp_paintbrush	Paint in the current brush with optional fade out parameter and pull colors from a gradient.
gimp_paintbrush_default	Paint in the current brush. The fade out parameter and pull colors from a gradient parameter are set from the paintbrush options dialog. If this dialog has not been activated then the dialog defaults will be used.

gimp_airbrush

Input:

DRAWABLE	drawable	The affected drawable
SUCCESS	pressure	The pressure of the airbrush strokes (0 <= pressure <= 100)
INT32	num_strokes	Number of stroke control points (count each coordinate as 2 points)
FLOATARRAY	strokes	Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }

Returns: nothing
This tool simulates the use of an airbrush. Paint pressure represents the relative intensity of the paint application. High pressure results in a thicker layer of paint while low pressure results in a thinner layer.
Spencer Kimball & Peter Mattis; 1995-1996

gimp_airbrush_default

Input:

DRAWABLE	drawable	The affected drawable
INT32	num_strokes	Number of stroke control points (count each coordinate as 2 points)
FLOATARRAY	strokes	Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }

Returns: nothing
This tool simulates the use of an airbrush. It is similar to gimp_airbrush except that the pressure is derived from the airbrush tools options box. It the option has not been set the default for the option will be used.
Andy Thomas; 1999

gimp_brush_delete

Input:

STRING

name

The brush name

Returns: nothing
This procedure deletes a brush
Michael Natterer; 2004

gimp_brush_duplicate

Input:

STRING

name

The brush name

Returns:

STRING

name

The name of the brush's copy

This procedure creates an identical brush by a different name
Michael Natterer; 2004

gimp_brush_get_angle

Input:

STRING

name

The brush name

Returns:

SUCCESS

angle

The rotation angle of the brush.

This procedure gets the angle of rotation for a generated brush. If called for any other type of brush, it does not succeed.
Bill Skaggs; 2004

gimp_brush_get_aspect_ratio

Input:

STRING

name

The brush name

Returns:

SUCCESS

aspect_ratio

The aspect ratio of the brush.

This procedure gets the aspect ratio of a generated brush. If called for any other type of brush, it does not succeed.
Bill Skaggs; 2004

gimp_brush_get_hardness

Input:

STRING

name

The brush name

Returns:

SUCCESS

hardness

The hardness of the brush.

This procedure gets the hardness of a generated brush. The hardness of a brush is the amount its intensity fades at the outside edge. If called for any other type of brush, the function does not succeed.
Bill Skaggs; 2004

gimp_brush_get_info

Input:

STRING

name

The brush name

Returns:

INT32	width	The brush width
INT32	height	The brush height
INT32	mask_bpp	The brush mask bpp
INT32	color_bpp	The brush color bpp

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

gimp_brush_get_pixels

Input:

STRING

name

The brush name

Returns:

INT32	width	The brush width
INT32	height	The brush height
INT32	mask_bpp	The brush mask bpp
INT32	num_mask_bytes	Length of brush mask data
INT8ARRAY	mask_bytes	The brush mask data
INT32	color_bpp	The brush color bpp
INT32	num_color_bytes	Length of brush color data
INT8ARRAY	color_bytes	The brush color data

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

gimp_brush_get_radius

Input:

STRING

name

The brush name

Returns:

SUCCESS

radius

The radius of the brush in pixels

This procedure gets the radius value for a generated brush. If called for any other type of brush, it does not succeed.
Bill Skaggs; 2004

gimp_brush_get_shape

Input:

STRING

name

The brush name

Returns:

INT32

shape

An enumerated value representing the brush shape

This procedure gets the shape value for a generated brush. If called for any other type of brush, it does not succeed. The current possibilities are Circle (GIMP_BRUSH_GENERATED_CIRCLE), Square (GIMP_BRUSH_GENERATED_SQUARE), and Diamond (GIMP_BRUSH_GENERATED_DIAMOND). Other shapes are likely to be added in the future.
Bill Skaggs; 2004

gimp_brush_get_spacing

Input:

STRING

name

The brush name

Returns:

INT32

spacing

The brush spacing: 0 <= spacing <= 1000

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.
Michael Natterer; 2004

gimp_brush_get_spikes

Input:

STRING

name

The brush name

Returns:

INT32

spikes

The number of spikes on the brush.

This procedure gets the number of spikes for a generated brush. If called for any other type of brush, it does not succeed.
Bill Skaggs; 2004

gimp_brush_is_editable

Input:

STRING

name

The brush name

Returns:

INT32

editable

True if the brush can be edited

Returns True if you have permission to change the brush
Bill Skaggs; 2004

gimp_brush_is_generated

Input:

STRING

name

The brush name

Returns:

INT32

generated

True if the brush is generated

Returns True if this brush is parametric, False for other types
Bill Skaggs; 2004

gimp_brush_new

Input:

STRING

name

The requested name of the new brush

Returns:

STRING

name

The actual new brush name

This procedure creates a new, uninitialized brush
Michael Natterer; 2004

gimp_brush_rename

Input:

STRING	name	The brush name
STRING	new_name	The new name of the brush

Returns:

STRING

name

The actual new name of the brush

This procedure renames a brush
Michael Natterer; 2004

gimp_brush_set_angle

Input:

STRING	name	The brush name
SUCCESS	angle_in	The desired brush rotation angle

Returns:

SUCCESS

angle_out

The brush rotation angle actually assigned

This procedure sets the rotation angle for a generated brush. If called for any other type of brush, it does not succeed.
Bill Skaggs; 2004

gimp_brush_set_aspect_ratio

Input:

STRING	name	The brush name
SUCCESS	aspect_ratio_in	The desired brush aspect ratio

Returns:

SUCCESS

aspect_ratio_out

The brush aspect ratio actually assigned

This procedure sets the aspect ratio for a generated brush. If called for any other type of brush, it does not succeed.
Bill Skaggs; 2004

gimp_brush_set_hardness

Input:

STRING	name	The brush name
SUCCESS	hardness_in	The desired brush hardness

Returns:

SUCCESS

hardness_out

The brush hardness actually assigned

This procedure sets the hardness for a generated brush. If called for any other type of brush, it does not succeed.
Bill Skaggs; 2004

gimp_brush_set_radius

Input:

STRING	name	The brush name
SUCCESS	radius_in	The desired brush radius

Returns:

SUCCESS

radius_out

The brush radius actually assigned

This procedure sets the radius for a generated brush. If called for any other type of brush, it does not succeed.
Bill Skaggs; 2004

gimp_brush_set_shape

Input:

STRING	name	The brush name
INT32	shape_in	An enumerated value representing the desired brush shape

Returns:

INT32

shape_out

The brush shape actually assigned

This procedure sets the shape value for a generated brush. If called for any other type of brush, it does not succeed. The current possibilities are Circle (GIMP_BRUSH_GENERATED_CIRCLE), Square (GIMP_BRUSH_GENERATED_SQUARE), and Diamond (GIMP_BRUSH_GENERATED_DIAMOND). Other shapes are likely to be added in the future.
Bill Skaggs; 2004

gimp_brush_set_spacing

Input:

STRING	name	The brush name
INT32	spacing	The brush spacing: 0 <= spacing <= 1000

Returns: nothing
This procedure modifies the spacing setting for the specified brush. The value should be a integer between 0 and 1000.
Bill Skaggs; 2004

gimp_brush_set_spikes

Input:

STRING	name	The brush name
INT32	spikes_in	The desired number of spikes

Returns:

INT32

spikes_out

The number of spikes actually assigned

This procedure sets the number of spikes for a generated brush. If called for any other type of brush, it does not succeed.
Bill Skaggs; 2004

gimp_brushes_close_popup

Input:

STRING

brush_callback

The name of the callback registered for this popup

Returns: nothing
This procedure closes an opened brush selection dialog.
Andy Thomas; 1998

gimp_brushes_get_brush

Input: none
Returns:

STRING	name	The brush name
INT32	width	The brush width
INT32	height	The brush height
INT32	spacing	The brush spacing: 0 <= spacing <= 1000

This procedure is deprecated! Use 'gimp_context_get_brush' instead.
;

gimp_brushes_get_brush_data

Input:

STRING

name

The brush name ("" means current active brush)

Returns:

STRING	name	The brush name
SUCCESS	opacity	The brush opacity: 0 <= opacity <= 100
INT32	spacing	The brush spacing: 0 <= spacing <= 1000
INT32	paint_mode	The paint mode: { GIMP_NORMAL_MODE (0), GIMP_DISSOLVE_MODE (1), GIMP_BEHIND_MODE (2), GIMP_MULTIPLY_MODE (3), GIMP_SCREEN_MODE (4), GIMP_OVERLAY_MODE (5), GIMP_DIFFERENCE_MODE (6), GIMP_ADDITION_MODE (7), GIMP_SUBTRACT_MODE (8), GIMP_DARKEN_ONLY_MODE (9), GIMP_LIGHTEN_ONLY_MODE (10), GIMP_HUE_MODE (11), GIMP_SATURATION_MODE (12), GIMP_COLOR_MODE (13), GIMP_VALUE_MODE (14), GIMP_DIVIDE_MODE (15), GIMP_DODGE_MODE (16), GIMP_BURN_MODE (17), GIMP_HARDLIGHT_MODE (18), GIMP_SOFTLIGHT_MODE (19), GIMP_GRAIN_EXTRACT_MODE (20), GIMP_GRAIN_MERGE_MODE (21), GIMP_COLOR_ERASE_MODE (22) }
INT32	width	The brush width
INT32	height	The brush height
INT32	length	Length of brush mask data
INT8ARRAY	mask_data	The brush mask data

This procedure is deprecated! Use 'gimp_brush_get_pixels' instead.
;

gimp_brushes_get_list

Input:

STRING

filter

An optional regular expression used to filter the list

Returns:

INT32	num_brushes	The number of brushes in the brush list
STRINGARRAY	brush_list	The list of brush names

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.
Spencer Kimball & Peter Mattis; 1995-1996

gimp_brushes_get_opacity

Input: none
Returns:

SUCCESS

opacity

The opacity: 0 <= opacity <= 100

This procedure is deprecated! Use 'gimp_context_get_opacity' instead.
;

gimp_brushes_get_paint_mode

Input: none
Returns:

INT32

paint_mode

The paint mode: { GIMP_NORMAL_MODE (0), GIMP_DISSOLVE_MODE (1), GIMP_BEHIND_MODE (2), GIMP_MULTIPLY_MODE (3), GIMP_SCREEN_MODE (4), GIMP_OVERLAY_MODE (5), GIMP_DIFFERENCE_MODE (6), GIMP_ADDITION_MODE (7), GIMP_SUBTRACT_MODE (8), GIMP_DARKEN_ONLY_MODE (9), GIMP_LIGHTEN_ONLY_MODE (10), GIMP_HUE_MODE (11), GIMP_SATURATION_MODE (12), GIMP_COLOR_MODE (13), GIMP_VALUE_MODE (14), GIMP_DIVIDE_MODE (15), GIMP_DODGE_MODE (16), GIMP_BURN_MODE (17), GIMP_HARDLIGHT_MODE (18), GIMP_SOFTLIGHT_MODE (19), GIMP_GRAIN_EXTRACT_MODE (20), GIMP_GRAIN_MERGE_MODE (21), GIMP_COLOR_ERASE_MODE (22) }

This procedure is deprecated! Use 'gimp_context_get_paint_mode' instead.
;

gimp_brushes_get_spacing

Input: none
Returns:

INT32

spacing

The brush spacing: 0 <= spacing <= 1000

This procedure is deprecated! Use 'gimp_brush_get_spacing' instead.
;

gimp_brushes_list

Input:

STRING

filter

An optional regular expression used to filter the list

Returns:

INT32	num_brushes	The number of brushes in the brush list
STRINGARRAY	brush_list	The list of brush names

This procedure is deprecated! Use 'gimp_brushes_get_list' instead.
;

gimp_brushes_popup

Input:

STRING	brush_callback	The callback PDB proc to call when brush selection is made
STRING	popup_title	Title to give the brush popup window
STRING	initial_brush	The name of the brush to set as the first selected
SUCCESS	opacity	The initial opacity of the brush
INT32	spacing	The initial spacing of the brush (if < 0 then use brush default spacing)
INT32	paint_mode	The initial paint mode: { GIMP_NORMAL_MODE (0), GIMP_DISSOLVE_MODE (1), GIMP_BEHIND_MODE (2), GIMP_MULTIPLY_MODE (3), GIMP_SCREEN_MODE (4), GIMP_OVERLAY_MODE (5), GIMP_DIFFERENCE_MODE (6), GIMP_ADDITION_MODE (7), GIMP_SUBTRACT_MODE (8), GIMP_DARKEN_ONLY_MODE (9), GIMP_LIGHTEN_ONLY_MODE (10), GIMP_HUE_MODE (11), GIMP_SATURATION_MODE (12), GIMP_COLOR_MODE (13), GIMP_VALUE_MODE (14), GIMP_DIVIDE_MODE (15), GIMP_DODGE_MODE (16), GIMP_BURN_MODE (17), GIMP_HARDLIGHT_MODE (18), GIMP_SOFTLIGHT_MODE (19), GIMP_GRAIN_EXTRACT_MODE (20), GIMP_GRAIN_MERGE_MODE (21), GIMP_COLOR_ERASE_MODE (22) }

Returns: nothing
This procedure popups the brush selection dialog.
Andy Thomas; 1998

gimp_brushes_refresh

Input: none
Returns: nothing
This procedure retrieves all brushes currently in the user's brush path and updates the brush dialogs accordingly.
Seth Burgess; 1997

gimp_brushes_set_brush

Input:

STRING

name

The name o the brush

Returns: nothing
This procedure is deprecated! Use 'gimp_context_set_brush' instead.
;

gimp_brushes_set_opacity

Input:

SUCCESS

opacity

The opacity: 0 <= opacity <= 100

Returns: nothing
This procedure is deprecated! Use 'gimp_context_set_opacity' instead.
;

gimp_brushes_set_paint_mode

Input:

INT32

paint_mode

Returns: nothing
This procedure is deprecated! Use 'gimp_context_set_paint_mode' instead.
;

gimp_brushes_set_popup

Input:

STRING	brush_callback	The name of the callback registered for this popup
STRING	brush_name	The name of the brush to set as selected
SUCCESS	opacity	The initial opacity of the brush
INT32	spacing	The initial spacing of the brush (if < 0 then use brush default spacing)
INT32	paint_mode	The initial paint mode: { GIMP_NORMAL_MODE (0), GIMP_DISSOLVE_MODE (1), GIMP_BEHIND_MODE (2), GIMP_MULTIPLY_MODE (3), GIMP_SCREEN_MODE (4), GIMP_OVERLAY_MODE (5), GIMP_DIFFERENCE_MODE (6), GIMP_ADDITION_MODE (7), GIMP_SUBTRACT_MODE (8), GIMP_DARKEN_ONLY_MODE (9), GIMP_LIGHTEN_ONLY_MODE (10), GIMP_HUE_MODE (11), GIMP_SATURATION_MODE (12), GIMP_COLOR_MODE (13), GIMP_VALUE_MODE (14), GIMP_DIVIDE_MODE (15), GIMP_DODGE_MODE (16), GIMP_BURN_MODE (17), GIMP_HARDLIGHT_MODE (18), GIMP_SOFTLIGHT_MODE (19), GIMP_GRAIN_EXTRACT_MODE (20), GIMP_GRAIN_MERGE_MODE (21), GIMP_COLOR_ERASE_MODE (22) }

Returns: nothing
Sets the current brush selection in a popup.
Andy Thomas; 1998

gimp_brushes_set_spacing

Input:

INT32

spacing

The brush spacing: 0 <= spacing <= 1000

Returns: nothing
This procedure is deprecated! Use 'gimp_brush_set_spacing' instead.
;

gimp_paintbrush

Input:

DRAWABLE	drawable	The affected drawable
SUCCESS	fade_out	Fade out parameter: 0 <= fade_out
INT32	num_strokes	Number of stroke control points (count each coordinate as 2 points)
FLOATARRAY	strokes	Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }
INT32	method	GIMP_PAINT_CONSTANT (0) or GIMP_PAINT_INCREMENTAL (1)
SUCCESS	gradient_length	Length of gradient to draw: 0 <= gradient_length

Returns: nothing
This tool is the standard paintbrush. It draws linearly interpolated lines through the specified stroke coordinates. It operates on the specified drawable in the foreground color with the active brush. The "fade_out" parameter is measured in pixels and allows the brush stroke to linearly fall off. The pressure is set to the maximum at the beginning of the stroke. As the distance of the stroke nears the fade_out value, the pressure will approach zero. The gradient_length is the distance to spread the gradient over. It is measured in pixels. If the gradient_length is 0, no gradient is used.
Spencer Kimball & Peter Mattis; 1995-1996

gimp_paintbrush_default

Input:

DRAWABLE	drawable	The affected drawable
INT32	num_strokes	Number of stroke control points (count each coordinate as 2 points)
FLOATARRAY	strokes	Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }

Returns: nothing
This tool is similar to the standard paintbrush. It draws linearly interpolated lines through the specified stroke coordinates. It operates on the specified drawable in the foreground color with the active brush. The "fade_out" parameter is measured in pixels and allows the brush stroke to linearly fall off (value obtained from the option dialog). The pressure is set to the maximum at the beginning of the stroke. As the distance of the stroke nears the fade_out value, the pressure will approach zero. The gradient_length (value obtained from the option dialog) is the distance to spread the gradient over. It is measured in pixels. If the gradient_length is 0, no gradient is used.
Andy Thomas; 1999

The Gimp 2.3.2 (win32)	Documentation fresh from PDB	22:53:15 Fr 22.07.2005
Generated by pdb2doc.py* written by Hans Breuer <Hans@Breuer.org>*