gimp_text (1998)

NAME

gimp_text - Add text at the specified location as a floating selection or a new layer.

SYNOPSIS

text_layer = gimp_text (image,drawable,x,y,text,border,antialias,size,size_type,foundry,family,weight,slant,set_width,spacing,registry,encoding)

DESCRIPTION

This tool requires font information in the form of nine parameters: size, foundry, family, weight, slant, set_width, spacing, registry, encoding. The font size can either be specified in units of pixels or points, and the appropriate metric is specified using the size_type argument. The x and y parameters together control the placement of the new text by specifying the upper left corner of the text bounding box. If the antialias parameter is non-zero, the generated text will blend more smoothly with underlying layers. This option requires more time and memory to compute than non-antialiased text; the resulting floating selection or layer, however, will require the same amount of memory with or without antialiasing. If the specified drawable parameter is valid, the text will be created as a floating selection attached to the drawable. If the drawable parameter is not valid (-1), the text will appear as a new layer. Finally, a border can be specified around the final rendered text.The border is measured in pixels. If the border is specified as -1, empty spaces around the text will not be cropped.

INPUT ARGUMENTS

TYPE	NAME	DESCRIPTION
IMAGE	image	The image
DRAWABLE	drawable	The affected drawable: (-1 for a new text layer)
FLOAT	x	The x coordinate for the left of the text bounding box
FLOAT	y	The y coordinate for the top of the text bounding box
STRING	text	The text to generate
INT32	border	The size of the border: -1 <= border
INT32	antialias	Antialiasing (TRUE or FALSE)
FLOAT	size	The size of text in either pixels or points
INT32	size_type	The units of specified size: PIXELS (0) or POINTS (1)
STRING	foundry	The font foundry, "*" for any
STRING	family	The font family, "*" for any
STRING	weight	The font weight, "*" for any
STRING	slant	The font slant, "*" for any
STRING	set_width	The font set-width, "*" for any
STRING	spacing	The font spacing, "*" for any
STRING	registry	The font registry, "*" for any
STRING	encoding	The font encoding, "*" for any

RETURN VALUES

TYPE	NAME	DESCRIPTION
LAYER	text_layer	The new text layer

SOME SYNTAX ALTERNATIVES

text_layer = $drawable->text (x,y,text,border,antialias,size,size_type,foundry,family,weight,slant,set_width,spacing,registry,encoding)
text_layer = $image->text (drawable,x,y,text,border,antialias,size,size_type,foundry,family,weight,slant,set_width,spacing,registry,encoding)
text_layer = gimp_text (drawable,x,y,text,border,antialias,size,size_type,foundry,family,weight,slant,set_width,spacing,registry,encoding)

AUTHOR

Martin Edlman
(c)1998 Spencer Kimball & Peter Mattis