gimp_brushes_get_brush_data (1998)

NAME

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

SYNOPSIS

(name,opacity,spacing,paint_mode,width,height,length,mask_data) = gimp_brushes_get_brush_data (name)

DESCRIPTION

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.

INPUT ARGUMENTS

TYPE	NAME	DESCRIPTION
STRING	name	the brush name ("" means current active pattern)

RETURN VALUES

TYPE	NAME	DESCRIPTION
STRING	name	The brush name
FLOAT	opacity	The brush opacity: 0 <= opacity <= 100
INT32	spacing	The brush spacing: 0 <= spacing <= 1000
INT32	paint_mode	The paint mode: { NORMAL_MODE (0), DISSOLVE_MODE (1), BEHIND_MODE (2), MULTIPLY_MODE (3), SCREEN_MODE (4), OVERLAY_MODE (5), DIFFERENCE_MODE (6), ADDITION_MODE (7), SUBTRACT_MODE (8), DARKEN_ONLY_MODE (9), LIGHTEN_ONLY_MODE (10), HUE_MODE (11), SATURATION_MODE (12), COLOR_MODE (13), VALUE_MODE (14), DIVIDE_MODE (15) }
INT32	width	The brush width
INT32	height	The brush height
INT32	length	Length of brush mask data
INT8ARRAY	mask_data	The brush mask data

SOME SYNTAX ALTERNATIVES

(name,opacity,spacing,paint_mode,width,height,mask_data) = Gimp->brushes_get_brush_data (name)
(name,opacity,spacing,paint_mode,width,height,mask_data) = brushes_get_brush_data Layer (name)
(name,opacity,spacing,paint_mode,width,height,mask_data) = brushes_get_brush_data Image (name)
(name,opacity,spacing,paint_mode,width,height,mask_data) = brushes_get_brush_data Channel (name)
(name,opacity,spacing,paint_mode,width,height,mask_data) = brushes_get_brush_data Display (name)
(name,opacity,spacing,paint_mode,width,height,mask_data) = brushes_get_brush_data Drawable (name)

AUTHOR

Andy Thomas
(c)1998 Andy Thomas