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

The Gimp file functions

file_bmp_load	Loads files of Windows BMP file format
file_bmp_save	Saves files in Windows BMP file format
file_bz2_load	loads files compressed with bzip2
file_bz2_save	saves files compressed with bzip2
file_cel_load	Loads files in KISS CEL file format
file_cel_save	Saves files in KISS CEL file format
file_colorhtml_save	Saves the image as colored html text
file_colorxhtml_save	Saves the image as colored xhtml text
file_csource_save	Dump image data in RGB(A) format for C source
file_dicom_load	loads files of the dicom file format
file_dicom_save	Save file in the DICOM file format
file_eps_load	load Encapsulated PostScript images
file_eps_save	save image as Encapsulated PostScript image
file_faxg3_load	loads g3 fax files
file_fits_load	load file of the FITS file format
file_fits_save	save file in the FITS file format
file_fli_info	Get info about a Fli movie
file_fli_load	load FLI-movies
file_fli_save	save FLI-movies
file_gbr_load	Loads GIMP brushes (1 or 4 bpp and old .gpb format)
file_gbr_save	saves files in the .gbr file format
file_gif_load	loads files of Compuserve GIF file format
file_gif_save	saves files in Compuserve GIF file format
file_gih_load	loads images in GIMP brush pipe format
file_gih_save	saves images in GIMP brush pipe format
file_glob	Returns a list of matching filenames
file_gtm_save	GIMP Table Magic
file_gz_load	loads files compressed with gzip
file_gz_save	saves files compressed with gzip
file_header_save	saves files as C unsigned character array
file_hrz_load	loads files of the hrz file format
file_hrz_save	saves files in the hrz file format
file_ico_load	Loads files of Windows ICO file format
file_ico_load_thumb	Loads a preview from an Windows ICO file
file_ico_save	Saves files in Windows ICO file format
file_jpeg_load	loads files in the JPEG file format
file_jpeg_save	saves files in the JPEG file format
file_page_setup	This plug-in sets up the page for printing from the GIMP.
file_pat_load	Loads Gimp's .PAT pattern files
file_pat_save	Saves Gimp pattern file (.PAT)
file_pcx_load	Loads files in Zsoft PCX file format
file_pcx_save	Saves files in ZSoft PCX file format
file_pdf_load	load PDF documents
file_pgm_save	saves files in the pnm file format
file_pix_load	loads files of the PIX file format
file_pix_save	save file in the Alias\|Wavefront pix/matte file format
file_png_get_defaults	Get the current set of defaults used by the PNG file save plug-in
file_png_load	Loads files in PNG file format
file_png_save	Saves files in PNG file format
file_png_save2	Saves files in PNG file format
file_png_save_defaults	Saves files in PNG file format
file_png_set_defaults	Set the current set of defaults used by the PNG file save plug-in
file_pnm_load	loads files of the pnm file format
file_pnm_save	saves files in the pnm file format
file_ppm_save	saves files in the pnm file format
file_print	This plug-in prints images from the GIMP.
file_ps_load	load PostScript documents
file_ps_load_setargs	set additional parameters for procedure file_ps_load
file_ps_load_thumb	Loads a small preview from a Postscript or PDF document
file_ps_save	save image as PostScript docuement
file_psd_load	loads files of the Photoshop(tm) PSD file format
file_psd_save	saves files in the Photoshop(tm) PSD file format
file_psp_load	loads images from the Paint Shop Pro PSP file format
file_raw_load	Load raw images, specifying image information
file_raw_save	Dump images to disk in raw format
file_sgi_load	Loads files in SGI image file format
file_sgi_save	Saves files in SGI image file format
file_sunras_load	load file of the SunRaster file format
file_sunras_save	save file in the SunRaster file format
file_svg_load	Loads files in the SVG file format
file_svg_load_thumb	Loads a small preview from an SVG image
file_tga_load	Loads files of Targa file format
file_tga_save	saves files in the Targa file format
file_tiff_load	loads files of the tiff file format
file_tiff_save	saves files in the tiff file format
file_tiff_save2	saves files in the tiff file format
file_xbm_load	Load a file in X10 or X11 bitmap (XBM) file format
file_xbm_save	Save a file in X10 or X11 bitmap (XBM) file format
file_xjt_load	loads files of the jpeg-tar file format
file_xjt_save	saves files in the jpeg-tar file format
file_xwd_load	Loads files in the XWD (X Window Dump) format
file_xwd_save	Saves files in the XWD (X Window Dump) format
gimp_file_load	Loads a file by invoking the right load handler.
gimp_file_load_thumbnail	Loads the thumbnail for a file.
gimp_file_save	Saves a file by extension.
gimp_file_save_thumbnail	Saves a thumbnail for the given image
gimp_image_get_filename	Returns the specified image's filename.
gimp_image_set_filename	Sets the specified image's filename.
gimp_register_file_handler_mime	Associates a MIME type with a file handler procedure.

file_bmp_load

Input:

INT32	run_mode	Interactive, non-interactive
STRING	filename	The name of the file to load
STRING	raw_filename	The name entered

Returns:

IMAGE

image

Output image

Loads files of Windows BMP file format
Alexander Schulz; 1997

file_bmp_save

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image
DRAWABLE	drawable	Drawable to save
STRING	filename	The name of the file to save the image in
STRING	raw_filename	The name entered

Returns: nothing
Saves files in Windows BMP file format
Alexander Schulz; 1997

file_bz2_load

Input:

INT32	run_mode	Interactive, non-interactive
STRING	filename	The name of the file to load
STRING	raw_filename	The name entered

Returns:

IMAGE

image

Output image

You need to have bzip2 installed.
Daniel Risacher, Spencer Kimball and Peter Mattis; 1995-1997

file_bz2_save

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image
DRAWABLE	drawable	Drawable to save
STRING	filename	The name of the file to save the image in
STRING	raw_filename	The name of the file to save the image in

Returns: nothing
You need to have bzip2 installed
Daniel Risacher, Spencer Kimball and Peter Mattis; 1995-1997

file_cel_load

Input:

INT32	run_mode	Interactive, non-interactive
STRING	filename	Filename to load image from
STRING	raw_filename	Name entered
STRING	palette_filename	Filename to load palette from

Returns:

IMAGE

image

Output image

This plug-in loads individual KISS cell files.
Nick Lamb <njl195@zepler.org.uk>; May 1998

file_cel_save

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image
DRAWABLE	drawable	Drawable to save
STRING	filename	Filename to save image to
STRING	raw_filename	Name entered
STRING	palette_filename	Filename to save palette to

Returns: nothing
This plug-in saves individual KISS cell files.
Nick Lamb <njl195@zepler.org.uk>; May 1998

file_colorhtml_save

Input:

INT32	run_mode	Interactive, Non-Interactive
IMAGE	image	The image to work on
DRAWABLE	drawable	The drawable to work on
STRING	filename	The name of the file
STRING	raw_filename	The name of the file
STRING	source	Where to take the characters from
STRING	characters	The filename to read or the characters to use
INT32	font_size	The font size in pixels
INT32	separate	Separate CSS file

Returns: nothing
Saves the image as colored html text (based on perl version by Marc Lehmann)
Manish Singh; 2003

file_colorxhtml_save

Input:

INT32	run_mode	Interactive, Non-Interactive
IMAGE	image	The image to work on
DRAWABLE	drawable	The drawable to work on
STRING	filename	The name of the file
STRING	raw_filename	The name of the file
STRING	source	Where to take the characters from
STRING	characters	The filename to read or the characters to use
INT32	font_size	The font size in pixels
INT32	separate	Separate CSS file

Returns: nothing
Saves the image as colored xhtml text (based on perl version by Marc Lehmann)
Manish Singh; 2003

file_csource_save

Input:

INT32	run_mode	Interactive
IMAGE	image	Input image
DRAWABLE	drawable	Drawable to save
STRING	filename	The name of the file to save the image in
STRING	raw_filename	The name of the file to save the image in

Returns: nothing
CSource cannot be run non-interactively.
Tim Janik; 1999

Load a file in the DICOM standard format.The standard is defined at http://medical.nema.org/. The plug-in currently only supports reading images with uncompressed pixel sections.
Dov Grobgeld <dov@imagic.weizmann.ac.il>; 2003

file_dicom_save

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image
DRAWABLE	drawable	Drawable to save
STRING	filename	The name of the file to save
STRING	raw_filename	The name of the file to save

Returns: nothing
Save an image in the medical standard DICOM image formats. The standard is defined at http://medical.nema.org/. The file format is defined in section 10 of the standard. The files are saved uncompressed and the compulsory DICOM tags are filled with default dummy values.
Dov Grobgeld <dov@imagic.weizmann.ac.il>; 2003

file_eps_load

Input:

INT32	run_mode	Interactive, non-interactive
STRING	filename	The name of the file to load
STRING	raw_filename	The name of the file to load

Returns:

IMAGE

image

Output image

load Encapsulated PostScript images
Peter Kirchgessner; v1.17 19-Sep-2004

file_eps_save

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image
DRAWABLE	drawable	Drawable to save
STRING	filename	The name of the file to save the image in
STRING	raw_filename	The name of the file to save the image in
SUCCESS	width	Width of the image in PostScript file (0: use input image size)
SUCCESS	height	Height of image in PostScript file (0: use input image size)
SUCCESS	x_offset	X-offset to image from lower left corner
SUCCESS	y_offset	Y-offset to image from lower left corner
INT32	unit	Unit for width/height/offset. 0: inches, 1: millimeters
INT32	keep_ratio	0: use width/height, 1: keep aspect ratio
INT32	rotation	0, 90, 180, 270
INT32	eps_flag	0: PostScript, 1: Encapsulated PostScript
INT32	preview	0: no preview, >0: max. size of preview
INT32	level	1: PostScript Level 1, 2: PostScript Level 2

Returns: nothing
PostScript saving handles all image types except those with alpha channels.
Peter Kirchgessner; v1.17 19-Sep-2004

file_faxg3_load

Input:

INT32	run_mode	Interactive, non-interactive
STRING	filename	The name of the file to load
STRING	raw_filename	The name of the file to load

Returns:

IMAGE

image

Output image

This plug-in loads Fax G3 Image files.
Jochen Friedrich, Gert Doering, Spencer Kimball & Peter Mattis; 0.6

file_fits_load

Input:

INT32	run_mode	Interactive, non-interactive
STRING	filename	The name of the file to load
STRING	raw_filename	The name of the file to load

Returns:

IMAGE

image

Output image

load file of the FITS file format (Flexible Image Transport System)
Peter Kirchgessner (peter@kirchgessner.net); 1997

file_fits_save

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image
DRAWABLE	drawable	Drawable to save
STRING	filename	The name of the file to save the image in
STRING	raw_filename	The name of the file to save the image in

Returns: nothing
FITS saving handles all image types except those with alpha channels.
Peter Kirchgessner (peter@kirchgessner.net); 1997

file_fli_info

Input:

STRING

filename

The name of the file to get info

Returns:

INT32	width	Width of one frame
INT32	height	Height of one frame
INT32	frames	Number of Frames

This is a experimantal plug-in to handle FLI movies
Jens Ch. Restemeier; 1997

file_fli_load

Input:

INT32	run_mode	Interactive, non-interactive
STRING	filename	The name of the file to load
STRING	raw_filename	The name entered

Returns:

IMAGE

image

Output image

This is an experimantal plug-in to handle FLI movies
Jens Ch. Restemeier; 1997

file_fli_save

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image
DRAWABLE	drawable	Input drawable (unused)
STRING	filename	The name of the file to save
STRING	raw_filename	The name entered
INT32	from_frame	Save beginning from this frame
INT32	to_frame	End saving with this frame

Returns: nothing
This is an experimantal plug-in to handle FLI movies
Jens Ch. Restemeier; 1997

file_gbr_load

Input:

INT32	run_mode	Interactive, non-interactive
STRING	filename	The name of the file to load
STRING	raw_filename	The name of the file to load

Returns:

IMAGE

image

Output image

FIXME: write help
Tim Newsome, Jens Lautenbacher, Sven Neumann; 1997-2000

file_gbr_save

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image
DRAWABLE	drawable	Drawable to save
STRING	filename	The name of the file to save the image in
STRING	raw_filename	The name of the file to save the image in
INT32	spacing	Spacing of the brush
STRING	description	Short description of the brush

Returns: nothing
Yeah!
Tim Newsome, Jens Lautenbacher, Sven Neumann; 1997-2000

file_gif_load

Input:

INT32	run_mode	Interactive, non-interactive
STRING	filename	The name of the file to load
STRING	raw_filename	The name entered

Returns:

IMAGE

image

Output image

FIXME: write help for gif_load
Spencer Kimball, Peter Mattis, Adam Moss, David Koblas; 1995-1997

file_gif_save

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Image to save
DRAWABLE	drawable	Drawable to save
STRING	filename	The name of the file to save the image in
STRING	raw_filename	The name entered
INT32	interlace	Try to save as interlaced
INT32	loop	(animated gif) loop infinitely
INT32	default_delay	(animated gif) Default delay between framese in milliseconds
INT32	default_dispose	(animated gif) Default disposal type (0=`don't care`, 1=combine, 2=replace)

Returns: nothing
Save a file in Compuserve GIF format, with possible animation, transparency, and comment. To save an animation, operate on a multi-layer file. The plug-in will intrepret <50% alpha as transparent. When run non-interactively, the value for the comment is taken from the 'gimp-comment' parasite.
Spencer Kimball, Peter Mattis, Adam Moss, David Koblas; 1995-1997

file_gih_load

Input:

INT32	run_mode	Interactive, non-interactive
STRING	filename	The name of the file to load
STRING	raw_filename	The name of the file to load

Returns:

IMAGE

image

Output image

This plug-in loads a GIMP brush pipe as an image.
Jens Lautenbacher, Sven Neumann; 2000

file_gih_save

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image
DRAWABLE	drawable	Drawable to save
STRING	filename	The name of the file to save the brush pipe in
STRING	raw_filename	The name of the file to save the brush pipe in
INT32	spacing	Spacing of the brush
STRING	description	Short description of the brush pipe
INT32	cell_width	Width of the brush cells
INT32	cell_height	Width of the brush cells
PASS_THROUGH	display_cols	Display column number
PASS_THROUGH	display_rows	Display row number
INT32	dimension	Dimension of the brush pipe
INT8ARRAY	rank	Ranks of the dimensions
INT32	dimension	Dimension (again)
STRINGARRAY	sel	Selection modes

Returns: nothing
This plug-in saves an image in the GIMP brush pipe format. The image must have an alpha chnannel and can be multi-layered, and additionally the layers can be divided into a rectangular array of brushes.
Tor Lillqvist; 1999

file_glob

Input:

STRING	pattern	The glob pattern (in UTF-8 encoding)
INT32	encoding	Encoding of the returned names: { UTF-8 (0), filename encoding (1) }

Returns:

INT32	num_files	The number of returned names
STRINGARRAY	files	The list of matching names

This can be useful in scripts and other plugins (e.g., batch-conversion). See the glob(7) manpage for more info. Note however that this isn't a full-featured glob implementation. It only handles simple patterns like "/home/foo/bar/*.jpg".
Sven Neumann; 2004

file_gtm_save

Input:

INT32	run_mode	Interactive
IMAGE	image	Input image
DRAWABLE	drawable	Drawable to save
STRING	filename	The name of the file to save the image in
STRING	raw_filename	The name of the file to save the image in

Returns: nothing
Allows you to draw an HTML table in GIMP. See help for more info.
Daniel Dunbar; 1998

file_gz_load

Input:

INT32	run_mode	Interactive, non-interactive
STRING	filename	The name of the file to load
STRING	raw_filename	The name entered

Returns:

IMAGE

image

Output image

You need to have gzip installed.
Daniel Risacher, Spencer Kimball and Peter Mattis; 1995-1997

file_gz_save

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image
DRAWABLE	drawable	Drawable to save
STRING	filename	The name of the file to save the image in
STRING	raw_filename	The name of the file to save the image in

Returns: nothing
You need to have gzip installed.
Daniel Risacher, Spencer Kimball and Peter Mattis; 1995-1997

file_header_save

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image
DRAWABLE	drawable	Drawable to save
STRING	filename	The name of the file to save the image in
STRING	raw_filename	The name of the file to save the image in

Returns: nothing
FIXME: write help
Spencer Kimball & Peter Mattis; 1997

file_hrz_load

Input:

INT32	run_mode	Interactive, non-interactive
STRING	filename	The name of the file to load
STRING	raw_filename	The name of the file to load

Returns:

IMAGE

image

Output image

FIXME: write help for hrz_load
Albert Cahalan; 1997

file_hrz_save

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image
DRAWABLE	drawable	Drawable to save
STRING	filename	The name of the file to save the image in
STRING	raw_filename	The name of the file to save the image in

Returns: nothing
HRZ saving handles all image types except those with alpha channels.
Albert Cahalan; 1997

file_ico_load

Input:

INT32	run_mode	Interactive, non-interactive
STRING	filename	The name of the file to load
STRING	raw_filename	The name entered

Returns:

IMAGE

image

Output image

Loads files of Windows ICO file format
Christian Kreibich <christian@whoop.org>; 2002

file_ico_load_thumb

Input:

STRING	filename	The name of the file to load
INT32	thumb_size	Preferred thumbnail size

Returns:

IMAGE	image	Thumbnail image
INT32	image_width	Width of full-sized image
INT32	image_height	Height of full-sized image

blurb repeated: Loads a preview from an Windows ICO file
Sven Neumann <sven@gimp.org>; 2005

file_ico_save

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image
DRAWABLE	drawable	Drawable to save
STRING	filename	The name of the file to save the image in
STRING	raw_filename	The name entered

Returns: nothing
Saves files in Windows ICO file format
Christian Kreibich <christian@whoop.org>; 2002

file_jpeg_load

Input:

INT32	run_mode	Interactive, non-interactive
STRING	filename	The name of the file to load
STRING	raw_filename	The name of the file to load

Returns:

IMAGE

image

Output image

loads files in the JPEG file format
Spencer Kimball & Peter Mattis; 1995-1999

file_jpeg_save

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image
DRAWABLE	drawable	Drawable to save
STRING	filename	The name of the file to save the image in
STRING	raw_filename	The name of the file to save the image in
SUCCESS	quality	Quality of saved image (0 <= quality <= 1)
SUCCESS	smoothing	Smoothing factor for saved image (0 <= smoothing <= 1)
INT32	optimize	Optimization of entropy encoding parameters (0/1)
INT32	progressive	Enable progressive jpeg image loading (0/1)
STRING	comment	Image comment
INT32	subsmp	The subsampling option number
INT32	baseline	Force creation of a baseline JPEG (non-baseline JPEGs can't be read by all decoders) (0/1)
INT32	restart	Frequency of restart markers (in rows, 0 = no restart markers)
INT32	dct	DCT algorithm to use (speed/quality tradeoff)

Returns: nothing
saves files in the lossy, widely supported JPEG format
Spencer Kimball & Peter Mattis; 1995-1999

file_page_setup

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image
DRAWABLE	drawable	Input drawable

Returns: nothing
Sets up the page parameters for printing to any Windows printer.
Copyright 1999 Tor Lillqvist; $Id: winprint.c,v 1.18 2004/11/02 12:00:24 mitch Exp $

file_pat_load

Input:

INT32	run_mode	Interactive, non-interactive
STRING	filename	The name of the file to load
STRING	raw_filename	The name of the file to load

Returns:

IMAGE

image

Output image

The images in the pattern dialog can be loaded directly with this plug-in
Tim Newsome; 1997

file_pat_save

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image
DRAWABLE	drawable	Drawable to save
STRING	filename	The name of the file to save the image in
STRING	raw_filename	The name of the file to save the image in
STRING	description	Short description of the pattern

Returns: nothing
New Gimp patterns can be created by saving them in the appropriate place with this plug-in.
Tim Newsome; 1997

file_pcx_load

Input:

INT32	run_mode	Interactive, non-interactive
STRING	filename	The name of the file to load
STRING	raw_filename	The name entered

Returns:

IMAGE

image

Output image

FIXME: write help for pcx_load
Nick Lamb <njl195@zepler.org.uk>; January 1997

file_pcx_save

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image
DRAWABLE	drawable	Drawable to save
STRING	filename	The name of the file to save the image in
STRING	raw_filename	The name entered

Returns: nothing
FIXME: write help for pcx_save
Nick Lamb <njl195@zepler.org.uk>; January 1997

file_pdf_load

Input:

INT32	run_mode	Interactive, non-interactive
STRING	filename	The name of the file to load
STRING	raw_filename	The name of the file to load

Returns:

IMAGE

image

Output image

load PDF documents
Peter Kirchgessner; v1.17 19-Sep-2004

file_pgm_save

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image
DRAWABLE	drawable	Drawable to save
STRING	filename	The name of the file to save the image in
STRING	raw_filename	The name of the file to save the image in
INT32	raw	Specify non-zero for raw output, zero for ascii output

Returns: nothing
PGM saving produces grayscale images without transparency.
Erik Nygren; 1996

file_pix_load

Input:

INT32	run_mode	Interactive, non-interactive
STRING	filename	The name of the file to load
STRING	raw_filename	The name entered

Returns:

IMAGE

image

Output image

loads files of the PIX file format
Michael Taylor; 1997

file_pix_save

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image
DRAWABLE	drawable	Drawable to save
STRING	filename	The name of the file to save the image in
STRING	raw_filename	The name of the file to save the image in

Returns: nothing
save file in the Alias|Wavefront pix/matte file format
Michael Taylor; 1997

file_png_get_defaults

Input: none
Returns:

INT32	interlace	Use Adam7 interlacing?
INT32	compression	Deflate Compression factor (0--9)
INT32	bkgd	Write bKGD chunk?
INT32	gama	Write gAMA chunk?
INT32	offs	Write oFFs chunk?
INT32	phys	Write pHYs chunk?
INT32	time	Write tIME chunk?
INT32	comment	Write comment?
INT32	svtrans	Preserve color of transparent pixels?

This procedure returns the current set of defaults stored as a parasite for the PNG save plug-in. These defaults are used to seed the UI, by the file_png_save_defaults procedure, and by gimp_file_save when it detects to use PNG.
Michael Sweet <mike@easysw.com>, Daniel Skarda <0rfelyus@atrey.karlin.mff.cuni.cz>, Nick Lamb <njl195@zepler.org.uk>; 1.3.4 - 03 September 2002

file_png_load

Input:

INT32	run_mode	Interactive, non-interactive
STRING	filename	The name of the file to load
STRING	raw_filename	The name of the file to load

Returns:

IMAGE

image

Output image

This plug-in loads Portable Network Graphics (PNG) files.
Michael Sweet <mike@easysw.com>, Daniel Skarda <0rfelyus@atrey.karlin.mff.cuni.cz>, Nick Lamb <njl195@zepler.org.uk>; 1.3.4 - 03 September 2002

file_png_save

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image
DRAWABLE	drawable	Drawable to save
STRING	filename	The name of the file to save the image in
STRING	raw_filename	The name of the file to save the image in
INT32	interlace	Use Adam7 interlacing?
INT32	compression	Deflate Compression factor (0--9)
INT32	bkgd	Write bKGD chunk?
INT32	gama	Write gAMA chunk?
INT32	offs	Write oFFs chunk?
INT32	phys	Write pHYs chunk?
INT32	time	Write tIME chunk?

Returns: nothing
This plug-in saves Portable Network Graphics (PNG) files.
Michael Sweet <mike@easysw.com>, Daniel Skarda <0rfelyus@atrey.karlin.mff.cuni.cz>, Nick Lamb <njl195@zepler.org.uk>; 1.3.4 - 03 September 2002

file_png_save2

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image
DRAWABLE	drawable	Drawable to save
STRING	filename	The name of the file to save the image in
STRING	raw_filename	The name of the file to save the image in
INT32	interlace	Use Adam7 interlacing?
INT32	compression	Deflate Compression factor (0--9)
INT32	bkgd	Write bKGD chunk?
INT32	gama	Write gAMA chunk?
INT32	offs	Write oFFs chunk?
INT32	phys	Write pHYs chunk?
INT32	time	Write tIME chunk?
INT32	comment	Write comment?
INT32	svtrans	Preserve color of transparent pixels?

Returns: nothing
This plug-in saves Portable Network Graphics (PNG) files. This procedure adds 2 extra parameters to file_png_save that allows to control whether image comments are saved and whether transparent pixels are saved or nullified.
Michael Sweet <mike@easysw.com>, Daniel Skarda <0rfelyus@atrey.karlin.mff.cuni.cz>, Nick Lamb <njl195@zepler.org.uk>; 1.3.4 - 03 September 2002

file_png_save_defaults

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image
DRAWABLE	drawable	Drawable to save
STRING	filename	The name of the file to save the image in
STRING	raw_filename	The name of the file to save the image in

Returns: nothing
This plug-in saves Portable Network Graphics (PNG) files, using the default settings stored as a parasite.
Michael Sweet <mike@easysw.com>, Daniel Skarda <0rfelyus@atrey.karlin.mff.cuni.cz>, Nick Lamb <njl195@zepler.org.uk>; 1.3.4 - 03 September 2002

file_png_set_defaults

Input:

INT32	interlace	Use Adam7 interlacing?
INT32	compression	Deflate Compression factor (0--9)
INT32	bkgd	Write bKGD chunk?
INT32	gama	Write gAMA chunk?
INT32	offs	Write oFFs chunk?
INT32	phys	Write pHYs chunk?
INT32	time	Write tIME chunk?
INT32	comment	Write comment?
INT32	svtrans	Preserve color of transparent pixels?

Returns: nothing
This procedure set the current set of defaults stored as a parasite for the PNG save plug-in. These defaults are used to seed the UI, by the file_png_save_defaults procedure, and by gimp_file_save when it detects to use PNG.
Michael Sweet <mike@easysw.com>, Daniel Skarda <0rfelyus@atrey.karlin.mff.cuni.cz>, Nick Lamb <njl195@zepler.org.uk>; 1.3.4 - 03 September 2002

file_pnm_load

Input:

INT32	run_mode	Interactive, non-interactive
STRING	filename	The name of the file to load
STRING	raw_filename	The name of the file to load

Returns:

IMAGE

image

Output image

FIXME: write help for pnm_load
Erik Nygren; 1996

file_pnm_save

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image
DRAWABLE	drawable	Drawable to save
STRING	filename	The name of the file to save the image in
STRING	raw_filename	The name of the file to save the image in
INT32	raw	Specify non-zero for raw output, zero for ascii output

Returns: nothing
PNM saving handles all image types without transparency.
Erik Nygren; 1996

file_ppm_save

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image
DRAWABLE	drawable	Drawable to save
STRING	filename	The name of the file to save the image in
STRING	raw_filename	The name of the file to save the image in
INT32	raw	Specify non-zero for raw output, zero for ascii output

Returns: nothing
PPM saving handles RGB images without transparency.
Erik Nygren; 1996

file_print

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image
DRAWABLE	drawable	Input drawable
STRING	printer	Printer
STRING	ppd_file	PPD file
INT32	output_type	Output type (0 = gray, 1 = color)
STRING	resolution	Resolution ("300", "720", etc.)
STRING	media_size	Media size ("Letter", "A4", etc.)
STRING	media_type	Media type ("Plain", "Glossy", etc.)
STRING	media_source	Media source ("Tray1", "Manual", etc.)
INT32	brightness	Brightness (0-200%)
SUCCESS	scaling	Output scaling (0-100%, -PPI)
INT32	orientation	Output orientation (-1 = auto, 0 = portrait, 1 = landscape)
INT32	left	Left offset (points, -1 = centered)
INT32	top	Top offset (points, -1 = centered)

Returns: nothing
Prints images to any printer recognized by Windows.
Copyright 1999 Tor Lillqvist; $Id: winprint.c,v 1.18 2004/11/02 12:00:24 mitch Exp $

file_ps_load

Input:

INT32	run_mode	Interactive, non-interactive
STRING	filename	The name of the file to load
STRING	raw_filename	The name of the file to load

Returns:

IMAGE

image

Output image

load PostScript documents
Peter Kirchgessner; v1.17 19-Sep-2004

file_ps_load_setargs

Input:

INT32	resolution	Resolution to interprete image (dpi)
INT32	width	Desired width
INT32	height	Desired height
INT32	check_bbox	0: Use width/height, 1: Use BoundingBox
STRING	pages	Pages to load (e.g.: 1,3,5-7)
INT32	coloring	4: b/w, 5: grey, 6: colour image, 7: automatic
INT32	TextAlphaBits	1, 2, or 4
INT32	GraphicsAlphaBits	1, 2, or 4

Returns: nothing
set additional parameters for procedure file_ps_load
Peter Kirchgessner; v1.17 19-Sep-2004

file_ps_load_thumb

Input:

STRING	filename	The name of the file to load
INT32	thumb_size	Preferred thumbnail size

Returns:

IMAGE

image

Output image

blurb repeated: Loads a small preview from a Postscript or PDF document
Peter Kirchgessner; v1.17 19-Sep-2004

file_ps_save

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image
DRAWABLE	drawable	Drawable to save
STRING	filename	The name of the file to save the image in
STRING	raw_filename	The name of the file to save the image in
SUCCESS	width	Width of the image in PostScript file (0: use input image size)
SUCCESS	height	Height of image in PostScript file (0: use input image size)
SUCCESS	x_offset	X-offset to image from lower left corner
SUCCESS	y_offset	Y-offset to image from lower left corner
INT32	unit	Unit for width/height/offset. 0: inches, 1: millimeters
INT32	keep_ratio	0: use width/height, 1: keep aspect ratio
INT32	rotation	0, 90, 180, 270
INT32	eps_flag	0: PostScript, 1: Encapsulated PostScript
INT32	preview	0: no preview, >0: max. size of preview
INT32	level	1: PostScript Level 1, 2: PostScript Level 2

Returns: nothing
PostScript saving handles all image types except those with alpha channels.
Peter Kirchgessner; v1.17 19-Sep-2004

file_psd_load

Input:

INT32	run_mode	Interactive, non-interactive
STRING	filename	The name of the file to load
STRING	raw_filename	The name of the file to load

Returns:

IMAGE

image

Output image

This filter loads files of Adobe Photoshop(tm) native PSD format. These files may be of any image type supported by GIMP, with or without layers, layer masks, aux channels and guides.
Adam D. Moss & Torsten Martinsen; 1996-1998

file_psd_save

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image
DRAWABLE	drawable	Drawable to save
STRING	filename	The name of the file to save the image in
STRING	raw_filename	The name of the file to save the image in
INT32	compression	Compression type: { NONE (0), LZW (1), PACKBITS (2)
INT32	fillorder	Fill Order: { MSB to LSB (0), LSB to MSB (1)

Returns: nothing
This filter saves files of Adobe Photoshop(tm) native PSD format. These files may be of any image type supported by GIMP, with or without layers, layer masks, aux channels and guides.
Monigotes; 2000

file_psp_load

Input:

INT32	run_mode	Interactive, non-interactive
STRING	filename	The name of the file to load
STRING	raw_filename	The name of the file to load

Returns:

IMAGE

image

Output image

This plug-in loads and saves images in Paint Shop Pro's native PSP format. Vector layers aren't handled. Saving isn't yet implemented.
Tor Lillqvist; 1999

file_raw_load

Input:

INT32	run_mode	Interactive
STRING	filename	The name of the file to load
STRING	raw_filename	The name entered

Returns:

IMAGE

image

Output image

Load raw images, specifying image information
timecop, pg@futureware.at; Aug 2004

file_raw_save

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image
DRAWABLE	drawable	Drawable to save
STRING	filename	The name of the file to save the image in
STRING	raw_filename	The name entered

Returns: nothing
Dump images to disk in raw format
timecop, pg@futureware.at; Aug 2004

file_sgi_load

Input:

INT32	run_mode	Interactive, non-interactive
STRING	filename	The name of the file to load
STRING	raw_filename	The name of the file to load

Returns:

IMAGE

image

Output image

This plug-in loads SGI image files.
Copyright 1997-1998 by Michael Sweet; 1.1.1 - 17 May 1998

file_sgi_save

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image
DRAWABLE	drawable	Drawable to save
STRING	filename	The name of the file to save the image in
STRING	raw_filename	The name of the file to save the image in
INT32	compression	Compression level (0 = none, 1 = RLE, 2 = ARLE)

Returns: nothing
This plug-in saves SGI image files.
Copyright 1997-1998 by Michael Sweet; 1.1.1 - 17 May 1998

file_sunras_load

Input:

INT32	run_mode	Interactive, non-interactive
STRING	filename	The name of the file to load
STRING	raw_filename	The name of the file to load

Returns:

IMAGE

image

Output image

load file of the SunRaster file format
Peter Kirchgessner; 1996

file_sunras_save

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image
DRAWABLE	drawable	Drawable to save
STRING	filename	The name of the file to save the image in
STRING	raw_filename	The name of the file to save the image in
INT32	rle	Specify non-zero for rle output, zero for standard output

Returns: nothing
SUNRAS saving handles all image types except those with alpha channels.
Peter Kirchgessner; 1996

file_svg_load

Input:

INT32	run_mode	Interactive, non-interactive
STRING	filename	The name of the file to load
STRING	raw_filename	The name of the file to load
SUCCESS	resolution	Resolution to use for rendering the SVG (defaults to 72 dpi
INT32	width	Width (in pixels) to load the SVG in. (0 for original width, a negative width to specify a maximum width)
INT32	height	Height (in pixels) to load the SVG in. (0 for original height, a negative width to specify a maximum height)
INT32	paths	Whether to not import paths (0), import paths individually (1) or merge all imported paths (2)

Returns:

IMAGE

image

Output image

Renders SVG files to raster graphics using librsvg.
Dom Lachowicz <cinamod@hotmail.com>; 2.5.0

file_svg_load_thumb

Input:

STRING	filename	The name of the file to load
INT32	thumb_size	Preferred thumbnail size

Returns:

IMAGE	image	Thumbnail image
INT32	image_width	Width of full-sized image
INT32	image_height	Height of full-sized image

blurb repeated: Loads a small preview from an SVG image
Dom Lachowicz <cinamod@hotmail.com>; 2.5.0

file_tga_load

Input:

INT32	run_mode	Interactive, non-interactive
STRING	filename	The name of the file to load
STRING	raw_filename	The name entered

Returns:

IMAGE

image

Output image

FIXME: write help for tga_load
Raphael FRANCOIS, Gordon Matzigkeit; 1997

file_tga_save

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image
DRAWABLE	drawable	Drawable to save
STRING	filename	The name of the file to save the image in
STRING	raw_filename	The name of the file to save the image in
INT32	rle	Use RLE compression
INT32	origin	Image origin (0 = top-left, 1 = bottom-left)

Returns: nothing
FIXME: write help for tga_save
Raphael FRANCOIS, Gordon Matzigkeit; 1997

file_tiff_load

Input:

INT32	run_mode	Interactive, non-interactive
STRING	filename	The name of the file to load
STRING	raw_filename	The name of the file to load

Returns:

IMAGE

image

Output image

FIXME: write help for tiff_load
Nick Lamb <njl195@zepler.org.uk>; 1995-1996,1998-2003

file_tiff_save

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image
DRAWABLE	drawable	Drawable to save
STRING	filename	The name of the file to save the image in
STRING	raw_filename	The name of the file to save the image in
INT32	compression	Compression type: { NONE (0), LZW (1), PACKBITS (2), DEFLATE (3), JPEG (4)

Returns: nothing
Saves files in the Tagged Image File Format. The value for the saved comment is taken from the 'gimp-comment' parasite.
Spencer Kimball & Peter Mattis; 1995-1996,2000-2003

file_tiff_save2

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image
DRAWABLE	drawable	Drawable to save
STRING	filename	The name of the file to save the image in
STRING	raw_filename	The name of the file to save the image in
INT32	compression	Compression type: { NONE (0), LZW (1), PACKBITS (2), DEFLATE (3), JPEG (4)
INT32	save_transp_pixels	Keep the color data masked by an alpha channel intact

Returns: nothing
Saves files in the Tagged Image File Format. The value for the saved comment is taken from the 'gimp-comment' parasite.
Spencer Kimball & Peter Mattis; 1995-1996,2000-2003

file_xbm_load

Input:

INT32	run_mode	Interactive, non-interactive
STRING	filename	The name of the file to load
STRING	raw_filename	The name entered

Returns:

IMAGE

image

Output image

Load a file in X10 or X11 bitmap (XBM) file format. XBM is a lossless format for flat black-and-white (two color indexed) images.
Gordon Matzigkeit; 1998

file_xbm_save

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image
DRAWABLE	drawable	Drawable to save
STRING	filename	The name of the file to save
STRING	raw_filename	The name entered
STRING	comment	Image description (maximum 72 bytes)
INT32	x10	Save in X10 format
INT32	x_hot	X coordinate of hotspot
INT32	y_hot	Y coordinate of hotspot
STRING	prefix	Identifier prefix [determined from filename]
INT32	write_mask	(0 = ignore, 1 = save as extra file)
STRING	mask_extension	Extension of the mask file

Returns: nothing
Save a file in X10 or X11 bitmap (XBM) file format. XBM is a lossless format for flat black-and-white (two color indexed) images.
Gordon Matzigkeit; 1998

file_xjt_load

Input:

INT32	run_mode	Interactive, non-interactive
STRING	filename	The name of the file to load
STRING	raw_filename	The name of the file to load

Returns:

IMAGE

image

Output image

loads files of the jpeg-tar file format
Wolfgang Hofer; 2000-Mar-07

file_xjt_save

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image
DRAWABLE	drawable	is ignored
STRING	filename	The name of the file to save the image in
STRING	raw_filename	The name of the file to save the image in
SUCCESS	quality	Quality of saved image (0 <= quality <= 1)
SUCCESS	smoothing	Smoothing factor for saved image (0 <= smoothing <= 1)
INT32	optimize	Optimization of entropy encoding parameters
INT32	clr_transparent	set all full-transparent pixels to 0

Returns: nothing
saves files in the jpeg-tar file format
Wolfgang Hofer; 2000-Mar-07

file_xwd_load

Input:

INT32	run_mode	Interactive, non-interactive
STRING	filename	The name of the file to load
STRING	raw_filename	The name of the file to load

Returns:

IMAGE

image

Output image

Loads files in the XWD (X Window Dump) format. XWD image files are produced by the program xwd. Xwd is an X Window System window dumping utility.
Peter Kirchgessner; 1996

file_xwd_save

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image
DRAWABLE	drawable	Drawable to save
STRING	filename	The name of the file to save the image in
STRING	raw_filename	The name of the file to save the image in

Returns: nothing
XWD saving handles all image types except those with alpha channels.
Peter Kirchgessner; 1996

gimp_file_load

Input:

INT32	run_mode	The run mode: GIMP_RUN_INTERACTIVE (0) or GIMP_RUN_NONINTERACTIVE (1)
STRING	filename	The name of the file to load
STRING	raw_filename	The name as entered by the user

Returns:

IMAGE

image

The output image

This procedure invokes the correct file load handler using magic if possible, and falling back on the file's extension and/or prefix if not. The name of the file to load is typically a full pathname, and the name entered is what the user actually typed before prepending a directory path. The reason for this is that if the user types http://www.xcf/~gimp/ he wants to fetch a URL, and the full pathname will not look like a URL."
Josh MacDonald; 1997

gimp_file_load_thumbnail

Input:

STRING

filename

The name of the file that owns the thumbnail to load

Returns:

INT32	width	The width of the thumbnail
INT32	height	The height of the thumbnail
INT32	thumbnail_data_count	The number of bytes in thumbnail data
INT8ARRAY	thumb_data	The thumbnail data

This procedure tries to load a thumbnail that belongs to the file with the given filename. This name is a full pathname. The returned data is an array of colordepth 3 (RGB), regardless of the image type. Width and height of the thumbnail are also returned. Don't use this function if you need a thumbnail of an already opened image, use gimp_image_thumbnail instead.
Adam D. Moss, Sven Neumann; 1999-2003

gimp_file_save

Input:

INT32	run_mode	The run mode: GIMP_RUN_INTERACTIVE (0) or GIMP_RUN_NONINTERACTIVE (1)
IMAGE	image	Input image
DRAWABLE	drawable	Drawable to save
STRING	filename	The name of the file to save the image in
STRING	raw_filename	The name as entered by the user

Returns: nothing
This procedure invokes the correct file save handler according to the file's extension and/or prefix. The name of the file to save is typically a full pathname, and the name entered is what the user actually typed before prepending a directory path. The reason for this is that if the user types http://www.xcf/~gimp/ she wants to fetch a URL, and the full pathname will not look like a URL.
Josh MacDonald; 1997

gimp_file_save_thumbnail

Input:

IMAGE	image	The image
STRING	filename	The name of the file the thumbnail belongs to

Returns: nothing
This procedure saves a thumbnail for the given image according to the Free Desktop Thumbnail Managing Standard. The thumbnail is saved so that it belongs to the file with the given filename. This means you have to save the image under this name first, otherwise this procedure will fail. This procedure may become useful if you want to explicitely save a thumbnail with a file.
Josh MacDonald; 1997

gimp_register_file_handler_mime

Input:

STRING	procedure_name	The name of the procedure to associate a MIME type with.
STRING	mime_type	A single MIME type, like for example "image/jpeg".

Returns: nothing
Registers a MIME type for a file handler procedure. This allows GIMP to determine the MIME type of the file opened or saved using this procedure.
Sven Neumann; 2004

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>*