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

The Gimp plug_in_gap functions

plug_in_gap_anim_crop	This plugin crops all anim_frames (images on disk) to the given new_width/new_height
plug_in_gap_anim_resize	This plugin resizes all anim_frames (images on disk) to the given new_width/new_height
plug_in_gap_anim_scale	This plugin scales all anim_frames (images on disk) to the given new_width/new_height
plug_in_gap_del	This plugin deletes the given number of frames from disk including the current frame.
plug_in_gap_dup	This plugin duplicates the current frames on disk n-times.
plug_in_gap_exchg	This plugin exchanges content of the current with destination frame.
plug_in_gap_first	This plugin exchanges current image with (lowest nubered) image from disk.
plug_in_gap_get_animinfo	This plugin gets animation infos about AnimFrames.
plug_in_gap_goto	This plugin exchanges current image with requested image (nr) from disk.
plug_in_gap_last	This plugin exchanges current image with (highest nubered) image from disk.
plug_in_gap_layers_run_animfilter	This plugin calls another plugin for each layer of an image, varying its settings (to produce animated effects). The called plugin must work on a single drawable and must be able to GIMP_RUN_WITH_LAST_VALS
plug_in_gap_modify	This plugin performs a modifying action on each selected layer in each selected framerange
plug_in_gap_move	This plugin copies layer(s) from one sourceimage to multiple frames on disk, varying position, size and opacity.
plug_in_gap_move_path	This plugin copies layer(s) from one sourceimage or source animation to multiple frames on disk, varying position, size and opacity.
plug_in_gap_move_path2	This plugin copies layer(s) from one sourceimage or source animation to multiple frames on disk, varying position, size and opacity.
plug_in_gap_next	This plugin exchanges current image with (next nubered) image from disk.
plug_in_gap_prev	This plugin exchanges current image with (previous nubered) image from disk.
plug_in_gap_range_convert	This plugin converts the given range of frame-images to other fileformats (on disk) depending on extension
plug_in_gap_range_convert2	This plugin converts the given range of frame-images to other fileformats (on disk) depending on extension
plug_in_gap_range_flatten	This plugin flattens the given range of frame-images (on disk)
plug_in_gap_range_layer_del	This plugin deletes one layer in the given range of frame-images (on disk). exception: the last remaining layer of a frame is not deleted
plug_in_gap_range_to_multilayer	This plugin creates a new image from the given range of frame-images. Each frame is converted to one layer in the new image, according to flatten_mode. (the frames on disk are not changed).
plug_in_gap_set_framerate	This plugin sets the framerate for AnimFrames
plug_in_gap_shift	This plugin exchanges frame numbers in the given range. (discfile frame_0001.xcf is renamed to frame_0002.xcf, 2->3, 3->4 ... n->1)
plug_in_gap_split	This plugin splits the current image to anim frames (images on disk). Each layer is saved as one frame
plug_in_gap_video_edit_clear	clear the video paste buffer by deleting all framefilesthe video paste buffer is a directory configured by gimprc (video-paste-dir )and a framefile basename configured by gimprc (video-paste-basename)
plug_in_gap_video_edit_copy	This plugin appends the selected framerange to the video paste bufferthe video paste buffer is a directory configured by gimprc (video-paste-dir )and a framefile basename configured by gimprc (video-paste-basename)
plug_in_gap_video_edit_paste	This plugin copies all frames from the video paste bufferto the current video. Depending on the paste_mode parameterthe copied frames are replacing frames beginning at current frameor are inserted before or after the current framethe pasted frames are scaled to fit the current video sizeand converted in Imagetype (RGB,GRAY,INDEXED) if necessarythe video paste buffer is a directory configured by gimprc (video-paste-dir )and a framefile basename configured by gimprc (video-paste-basename)

plug_in_gap_anim_crop

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image (one of the Anim Frames)
DRAWABLE	drawable	Input drawable (unused)
INT32	new_width	width of the resulting anim_frame images in pixels
INT32	new_height	height of the resulting anim_frame images in pixels
INT32	offset_x	X offset in pixels
INT32	offset_y	Y offset in pixels

Returns: nothing
blurb repeated: This plugin crops all anim_frames (images on disk) to the given new_width/new_height
Wolfgang Hofer; 1.1.29b; 2000/11/30

plug_in_gap_anim_resize

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image (one of the Anim Frames)
DRAWABLE	drawable	Input drawable (unused)
INT32	new_width	width of the resulting anim_frame images in pixels
INT32	new_height	height of the resulting anim_frame images in pixels
INT32	offset_x	X offset in pixels
INT32	offset_y	Y offset in pixels

Returns: nothing
blurb repeated: This plugin resizes all anim_frames (images on disk) to the given new_width/new_height
Wolfgang Hofer; 1.1.29b; 2000/11/30

plug_in_gap_anim_scale

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image (one of the Anim Frames)
DRAWABLE	drawable	Input drawable (unused)
INT32	new_width	width of the resulting anim_frame images in pixels
INT32	new_height	height of the resulting anim_frame images in pixels

Returns: nothing
blurb repeated: This plugin scales all anim_frames (images on disk) to the given new_width/new_height
Wolfgang Hofer; 1.1.29b; 2000/11/30

plug_in_gap_del

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image (current one of the Anim Frames)
DRAWABLE	drawable	Input drawable (unused)
INT32	nr	number of frames to delete (delete starts at current frame)

Returns: nothing
blurb repeated: This plugin deletes the given number of frames from disk including the current frame.
Wolfgang Hofer; 1.1.29b; 2000/11/30

plug_in_gap_dup

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image (current one of the Anim Frames)
DRAWABLE	drawable	Input drawable (unused)
INT32	nr	how often to copy current frame
INT32	range_from	frame nr to start
INT32	range_to	frame nr to stop (can be lower than range_from)

Returns: nothing
blurb repeated: This plugin duplicates the current frames on disk n-times.
Wolfgang Hofer; 1.1.29b; 2000/11/30

plug_in_gap_exchg

Input:

INT32	run_mode	non-interactive
IMAGE	image	Input image (current one of the Anim Frames)
DRAWABLE	drawable	Input drawable (unused)
INT32	nr	nr of frame to exchange with current frame

Returns: nothing
blurb repeated: This plugin exchanges content of the current with destination frame.
Wolfgang Hofer; 1.1.29b; 2000/11/30

plug_in_gap_first

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image (current one of the Anim Frames)
DRAWABLE	drawable	Input drawable (unused)

Returns: nothing
blurb repeated: This plugin exchanges current image with (lowest nubered) image from disk.
Wolfgang Hofer; 1.1.29b; 2000/11/30

plug_in_gap_get_animinfo

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image (current one of the Anim Frames)
DRAWABLE	drawable	Input drawable (unused)

Returns:

INT32	first_frame_nr	lowest frame number of all AnimFrame discfiles
INT32	last_frame_nr	highest frame number of all AnimFrame discfiles
INT32	curr_frame_nr	current frame number (extracted from the imagename)
INT32	frame_cnt	total number of all AnimFrame discfiles that belong to the passed image
STRING	basename	basename of the AnimFrame (without frame number and extension) may also include path (depending how the current frame image was opened)
STRING	extension	extension of the AnimFrames (.xcf)
FLOAT	framerate	framerate in frames per second

Informations about the AnimFrames belonging to the passed image_id are returned. (therefore the directory is scanned and checked for AnimFrame discfiles. If you call this plugin on images without a Name You will get just default values.
Wolfgang Hofer; 1.1.29b; 2000/11/30

plug_in_gap_goto

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image (current one of the Anim Frames)
DRAWABLE	drawable	Input drawable (unused)
INT32	nr	frame nr where to go

Returns: nothing
blurb repeated: This plugin exchanges current image with requested image (nr) from disk.
Wolfgang Hofer; 1.1.29b; 2000/11/30

plug_in_gap_last

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image (current one of the Anim Frames)
DRAWABLE	drawable	Input drawable (unused)

Returns: nothing
blurb repeated: This plugin exchanges current image with (highest nubered) image from disk.
Wolfgang Hofer; 1.1.29b; 2000/11/30

plug_in_gap_modify

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image (current one of the Anim Frames)
DRAWABLE	drawable	Input drawable (unused)
INT32	range_from	frame nr to start
INT32	range_to	frame nr to stop
INT32	action_mode	0:set_visible, 1:set_invisible, 2:set_linked, 3:set_unlinked, 4:raise, 5:lower, 6:merge_expand, 7:merge_img, 8:merge_bg, 9:apply_filter, 10:duplicate, 11:delete, 12:rename
INT32	select_mode	Mode how to identify a layer: 0-3 by layername 0=equal, 1=prefix, 2=suffix, 3=contains, 4=layerstack_numberslist, 5=inv_layerstack, 6=all_visible
INT32	select_case	0: ignore case 1: select_string is case sensitive
INT32	select_invert	0: select normal 1: invert (select all unselected layers)
STRING	select_string	string to match with layername (how to match is defined by select_mode)
STRING	new_layername	is only used at action rename. [####] is replaced by the framnumber

Returns: nothing
blurb repeated: This plugin performs a modifying action on each selected layer in each selected framerange
Wolfgang Hofer; 1.1.29b; 2000/11/30

plug_in_gap_move

Input:

INT32	run_mode	Interactive
IMAGE	image	Input image (one of the Anim Frames)
DRAWABLE	drawable	Input drawable (unused)

Returns: nothing
For NONINTERACTIVE PDB interfaces see also (plug_in_gap_move_path, plug_in_gap_move_path2)
Wolfgang Hofer; 1.1.29b; 2000/11/30

plug_in_gap_next

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image (current one of the Anim Frames)
DRAWABLE	drawable	Input drawable (unused)

Returns: nothing
blurb repeated: This plugin exchanges current image with (next nubered) image from disk.
Wolfgang Hofer; 1.1.29b; 2000/11/30

plug_in_gap_prev

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image (current one of the Anim Frames)
DRAWABLE	drawable	Input drawable (unused)

Returns: nothing
blurb repeated: This plugin exchanges current image with (previous nubered) image from disk.
Wolfgang Hofer; 1.1.29b; 2000/11/30

plug_in_gap_range_convert

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image (one of the Anim Frames)
DRAWABLE	drawable	Input drawable (unused)
INT32	range_from	frame nr to start
INT32	range_to	frame nr to stop (can be lower than range_from)
INT32	flatten	0 .. dont flatten image before save
INT32	dest_type	0=RGB, 1=GRAY, 2=INDEXED
INT32	dest_colors	1 upto 256 (used only for dest_type INDEXED)
INT32	dest_dither	0=no, 1=floyd-steinberg 2=fs/low-bleed, 3=fixed (used only for dest_type INDEXED)
STRING	extension	extension for the destination filetype (jpg, tif ...or any other gimp supported type)
STRING	basename	(optional parameter) here you may specify the basename of the destination frames "/my_dir/myframe" _0001.ext is added)

Returns: nothing
WARNING this procedure is obsolete, please use plug_in_gap_range_convert2
Wolfgang Hofer; 1.1.29b; 2000/11/30

plug_in_gap_range_convert2

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image (one of the Anim Frames)
DRAWABLE	drawable	Input drawable (unused)
INT32	range_from	frame nr to start
INT32	range_to	frame nr to stop (can be lower than range_from)
INT32	flatten	0 .. dont flatten image before save
INT32	dest_type	0=RGB, 1=GRAY, 2=INDEXED
INT32	dest_colors	1 upto 256 (used only for dest_type INDEXED)
INT32	dest_dither	0=no, 1=floyd-steinberg 2=fs/low-bleed, 3=fixed(used only for dest_type INDEXED)
STRING	extension	extension for the destination filetype (jpg, tif ...or any other gimp supported type)
STRING	basename	(optional parameter) here you may specify the basename of the destination frames "/my_dir/myframe" _0001.ext is added)
INT32	palette_type	0 == MAKE_PALETTE, 2 == WEB_PALETTE, 3 == MONO_PALETTE (bw) 4 == CUSTOM_PALETTE (used only for dest_type INDEXED)
INT32	alpha_dither	dither transparency to fake partial opacity (used only for dest_type INDEXED)
INT32	remove_unused	remove unused or double colors from final palette (used only for dest_type INDEXED)
STRING	palette	name of the cutom palette to use (used only for dest_type INDEXED and palette_type == CUSTOM_PALETTE)

Returns: nothing
blurb repeated: This plugin converts the given range of frame-images to other fileformats (on disk) depending on extension
Wolfgang Hofer; 1.1.29b; 2000/11/30

plug_in_gap_range_flatten

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image (one of the Anim Frames)
DRAWABLE	drawable	Input drawable (unused)
INT32	range_from	frame nr to start
INT32	range_to	frame nr to stop (can be lower than range_from)

Returns: nothing
blurb repeated: This plugin flattens the given range of frame-images (on disk)
Wolfgang Hofer; 1.1.29b; 2000/11/30

plug_in_gap_set_framerate

Input:

INT32	run_mode	non-interactive
IMAGE	image	Input image (current one of the Anim Frames)
DRAWABLE	drawable	Input drawable (unused)
FLOAT	framerate	framerate in frames per second

Returns: nothing
The framerate is stored in a video info file named like the basename of the AnimFrames without a framenumber. The extension of this video info file is .vin
Wolfgang Hofer; 1.1.29b; 2000/11/30

plug_in_gap_shift

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image (current one of the Anim Frames)
DRAWABLE	drawable	Input drawable (unused)
INT32	nr	how many framenumbers to shift the framesequence
INT32	range_from	frame nr to start
INT32	range_to	frame nr to stop

Returns: nothing
blurb repeated: This plugin exchanges frame numbers in the given range. (discfile frame_0001.xcf is renamed to frame_0002.xcf, 2->3, 3->4 ... n->1)
Wolfgang Hofer; 1.1.29b; 2000/11/30

plug_in_gap_split

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image (NO Anim Frame allowed)
DRAWABLE	drawable	Input drawable (unused)
INT32	inverse_order	True/False
INT32	no_alpha	True: remove alpha channel(s) in the destination frames
STRING	extension	extension for the destination filetype (jpg, tif ...or any other gimp supported type)

Returns:

IMAGE

new_image

Output image (first or last resulting frame)

blurb repeated: This plugin splits the current image to anim frames (images on disk). Each layer is saved as one frame
Wolfgang Hofer; 1.1.29b; 2000/11/30

plug_in_gap_video_edit_clear

Input:

INT32	run_mode	always non-interactive
IMAGE	image	Input image (is ignored)
DRAWABLE	drawable	Input drawable (unused)

Returns: nothing
blurb repeated: clear the video paste buffer by deleting all framefilesthe video paste buffer is a directory configured by gimprc (video-paste-dir )and a framefile basename configured by gimprc (video-paste-basename)
Wolfgang Hofer; 1.1.29b; 2000/11/30

plug_in_gap_video_edit_copy

Input:

INT32	run_mode	always non-interactive
IMAGE	image	Input image (current one of the Anim Frames)
DRAWABLE	drawable	Input drawable (unused)
INT32	range_from	frame nr to start
INT32	range_to	frame nr to stop

Returns: nothing
blurb repeated: This plugin appends the selected framerange to the video paste bufferthe video paste buffer is a directory configured by gimprc (video-paste-dir )and a framefile basename configured by gimprc (video-paste-basename)
Wolfgang Hofer; 1.1.29b; 2000/11/30

plug_in_gap_video_edit_paste

Input:

INT32	run_mode	always non-interactive
IMAGE	image	Input image (current one of the Anim Frames)
DRAWABLE	drawable	Input drawable (unused)
INT32	paste_mode	0 .. paste at current frame (replacing current and following frames)1 .. paste insert before current frame 2 .. paste insert after current frame

Returns: nothing
blurb repeated: This plugin copies all frames from the video paste bufferto the current video. Depending on the paste_mode parameterthe copied frames are replacing frames beginning at current frameor are inserted before or after the current framethe pasted frames are scaled to fit the current video sizeand converted in Imagetype (RGB,GRAY,INDEXED) if necessarythe video paste buffer is a directory configured by gimprc (video-paste-dir )and a framefile basename configured by gimprc (video-paste-basename)
Wolfgang Hofer; 1.1.29b; 2000/11/30

The Gimp 1.2.5 (win32)	Documentation fresh from PDB	12:10:17 Do 19.06.03
Generated by pdb2doc.py* written by Hans Breuer <Hans(at)Breuer.org>*