gimp_patterns_get_pattern_data (1998)

NAME

gimp_patterns_get_pattern_data - Retrieve information about the currently active pattern (including data).

SYNOPSIS

(name,width,height,mask_bpp,length,mask_data) = gimp_patterns_get_pattern_data (name)

DESCRIPTION

This procedure retrieves information about the currently active pattern. This includes the pattern name, and the pattern extents (width and height). It also returns the pattern data.

INPUT ARGUMENTS

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

RETURN VALUES

TYPE	NAME	DESCRIPTION
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

SOME SYNTAX ALTERNATIVES

(name,width,height,mask_bpp,mask_data) = Patterns->get_pattern_data (name)
(name,width,height,mask_bpp,mask_data) = Gimp->patterns_get_pattern_data (name)
(name,width,height,mask_bpp,mask_data) = patterns_get_pattern_data Layer (name)
(name,width,height,mask_bpp,mask_data) = patterns_get_pattern_data Image (name)
(name,width,height,mask_bpp,mask_data) = patterns_get_pattern_data Channel (name)
(name,width,height,mask_bpp,mask_data) = patterns_get_pattern_data Display (name)

AUTHOR

Andy Thomas
(c)1998 Andy Thomas