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

The Gimp pattern functions

gimp_context_get_pattern	Retrieve the currently active pattern.
gimp_context_set_pattern	Set the specified pattern as the active pattern.
gimp_pattern_get_info	Retrieve information about the specified pattern.
gimp_pattern_get_pixels	Retrieve information about the specified pattern (including pixels).
gimp_patterns_close_popup	Popdown the Gimp pattern selection.
gimp_patterns_get_list	Retrieve a complete listing of the available patterns.
gimp_patterns_get_pattern	This procedure is deprecated! Use 'gimp_context_get_pattern' instead.
gimp_patterns_get_pattern_data	This procedure is deprecated! Use 'gimp_pattern_get_pixels' instead.
gimp_patterns_list	This procedure is deprecated! Use 'gimp_patterns_get_list' instead.
gimp_patterns_popup	Invokes the Gimp pattern selection.
gimp_patterns_refresh	Refresh current patterns. This function always succeeds.
gimp_patterns_set_pattern	This procedure is deprecated! Use 'gimp_context_set_pattern' instead.
gimp_patterns_set_popup	Sets the current pattern selection in a popup.
python_fu_pattern	Creates a possibly overlapping pattern

gimp_pattern_get_info

Input:

STRING

name

The pattern name.

Returns:

INT32	width	The pattern width
INT32	height	The pattern height
INT32	bpp	The pattern bpp

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

gimp_pattern_get_pixels

Input:

STRING

name

The pattern name.

Returns:

INT32	width	The pattern width
INT32	height	The pattern height
INT32	bpp	The pattern bpp
INT32	num_color_bytes	Number of pattern bytes
INT8ARRAY	color_bytes	The pattern data.

This procedure retrieves information about the specified. This includes the pattern extents (width and height), its bpp and its pixel data.
Michael Natterer; 2004

gimp_patterns_close_popup

Input:

STRING

pattern_callback

The name of the callback registered for this popup

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

gimp_patterns_get_list

Input:

STRING

filter

An optional regular expression used to filter the list

Returns:

INT32	num_patterns	The number of patterns in the pattern list
STRINGARRAY	pattern_list	The list of pattern names

This procedure returns a complete listing of available GIMP patterns. Each name returned can be used as input to the 'gimp_context_set_pattern'.
Spencer Kimball & Peter Mattis; 1995-1996

gimp_patterns_get_pattern

Input: none
Returns:

STRING	name	The pattern name
INT32	width	The pattern width
INT32	height	The pattern height

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

gimp_patterns_get_pattern_data

Input:

STRING

name

The pattern name ("" means currently active pattern)

Returns:

STRING	name	The pattern name
INT32	width	The pattern width
INT32	height	The pattern height
INT32	mask_bpp	Pattern bytes per pixel
INT32	length	Length of pattern mask data
INT8ARRAY	mask_data	The pattern mask data

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

gimp_patterns_list

Input:

STRING

filter

An optional regular expression used to filter the list

Returns:

INT32	num_patterns	The number of patterns in the pattern list
STRINGARRAY	pattern_list	The list of pattern names

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

gimp_patterns_popup

Input:

STRING	pattern_callback	The callback PDB proc to call when pattern selection is made
STRING	popup_title	Title to give the pattern popup window
STRING	initial_pattern	The name of the pattern to set as the first selected

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

gimp_patterns_refresh

Input: none
Returns: nothing
This procedure retrieves all patterns currently in the user's pattern path and updates all pattern dialogs accordingly.
Michael Natterer; 2002

gimp_patterns_set_pattern

Input:

STRING

name

The name of the pattern

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

gimp_patterns_set_popup

Input:

STRING	pattern_callback	The name of the callback registered for this popup
STRING	pattern_name	The name of the pattern to set as selected

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

python_fu_pattern

Input:

INT32	run_mode	Interactive, Non-Interactive
IMAGE	image	The image to work on
DRAWABLE	drawable	The drawable to work on
COLOR	color	The colour of the form
INT32	edges	Edges of form (>3!)
INT32	radius	Radius as distance of corner points from center
SUCCESS	angle	Angle to rotate form
INT32	x_delta	X delta: distance of centers
INT32	y_delta	Y delta: distance of centers
INT32	x_mirror	mirror every 2nd line
INT32	y_mirror	mirror every 2nd column

Returns: nothing
Creates a possibly overlapping pattern out of simple geometric forms
Hans Breuer <Hans@Breuer.Org>; 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>*