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

The Gimp palette functions

gimp_context_get_palette	Retrieve the currently active palette.
gimp_context_set_palette	Set the specified palette as the active palette.
gimp_palette_add_entry	Adds a palette entry to the specified palette.
gimp_palette_delete	Deletes a palette
gimp_palette_delete_entry	Deletes a palette entry from the specified palette.
gimp_palette_duplicate	Duplicates a palette
gimp_palette_entry_get_color	Gets the specified palette entry from the specified palette.
gimp_palette_entry_get_name	Gets the specified palette entry from the specified palette.
gimp_palette_entry_set_color	Sets the specified palette entry in the specified palette.
gimp_palette_entry_set_name	Sets the specified palette entry in the specified palette.
gimp_palette_get_background	This procedure is deprecated! Use 'gimp_context_get_background' instead.
gimp_palette_get_columns	Retrieves the number of columns to use to display this palette
gimp_palette_get_foreground	This procedure is deprecated! Use 'gimp_context_get_foreground' instead.
gimp_palette_get_info	Retrieve information about the specified palette.
gimp_palette_is_editable	Tests if palette can be edited
gimp_palette_new	Creates a new palette
gimp_palette_refresh	This procedure is deprecated! Use 'gimp_palettes_refresh' instead.
gimp_palette_rename	Rename a palette
gimp_palette_set_background	This procedure is deprecated! Use 'gimp_context_set_background' instead.
gimp_palette_set_columns	Sets the number of columns to use when displaying the palette
gimp_palette_set_default_colors	This procedure is deprecated! Use 'gimp_context_set_default_colors' instead.
gimp_palette_set_foreground	This procedure is deprecated! Use 'gimp_context_set_foreground' instead.
gimp_palette_swap_colors	This procedure is deprecated! Use 'gimp_context_swap_colors' instead.
gimp_palettes_close_popup	Popdown the Gimp palette selection.
gimp_palettes_get_list	Retrieves a list of all of the available palettes
gimp_palettes_get_palette	This procedure is deprecated! Use 'gimp_context_get_palette' instead.
gimp_palettes_get_palette_entry	This procedure is deprecated! Use 'gimp_palette_entry_get_color' instead.
gimp_palettes_popup	Invokes the Gimp palette selection.
gimp_palettes_refresh	Refreshes current palettes. This function always succeeds.
gimp_palettes_set_palette	This procedure is deprecated! Use 'gimp_context_set_palette' instead.
gimp_palettes_set_popup	Sets the current palette selection in a popup.
plug_in_palettemap	Map the contents of the specified drawable with the active palette
plug_in_smooth_palette	derive smooth palette from image

gimp_palette_add_entry

Input:

STRING	name	The palette name.
STRING	entry_name	The name of the entry
COLOR	color	The new entry's color color

Returns:

INT32

entry_num

The index of the added entry

This procedure adds an entry to the specifed palette. It returns an error if the entry palette does not exist.
Michael Natterer; 2004

gimp_palette_delete

Input:

STRING

name

The palette name.

Returns: nothing
This procedure deletes a palette
Michael Natterer; 2004

gimp_palette_delete_entry

Input:

STRING	name	The palette name.
INT32	entry_num	The index of the added entry

Returns: nothing
This procedure deletes an entry from the specifed palette. It returns an error if the entry palette does not exist.
Michael Natterer; 2004

gimp_palette_duplicate

Input:

STRING

name

The palette name.

Returns:

STRING

name

The name of the palette's copy

This procedure creates an identical palette by a different name
Michael Natterer; 2004

gimp_palette_entry_get_color

Input:

STRING	name	The palette name.
INT32	entry_num	The entry to retrieve

Returns:

COLOR

color

The color requested

This procedure retrieves the color of the zero-based entry specifed for the specified palette. It returns an error if the entry does not exist.
Michael Natterer; 2004

gimp_palette_entry_get_name

Input:

STRING	name	The palette name.
INT32	entry_num	The entry to retrieve

Returns:

STRING

entry_name

The name requested

This procedure retrieves the name of the zero-based entry specifed for the specified palette. It returns an error if the entry does not exist.
Michael Natterer; 2004

gimp_palette_entry_set_color

Input:

STRING	name	The palette name.
INT32	entry_num	The entry to retrieve
COLOR	color	The new color

Returns: nothing
This procedure sets the color of the zero-based entry specifed for the specified palette. It returns an error if the entry does not exist.
Michael Natterer; 2004

gimp_palette_entry_set_name

Input:

STRING	name	The palette name.
INT32	entry_num	The entry to retrieve
STRING	entry_name	The new name

Returns: nothing
This procedure sets the name of the zero-based entry specifed for the specified palette. It returns an error if the entry does not exist.
Michael Natterer; 2004

gimp_palette_get_background

Input: none
Returns:

COLOR

background

The background color

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

gimp_palette_get_columns

Input:

STRING

name

The palette name.

Returns:

INT32

num_columns

The number of columns used to display this palette

This procedures retrieves the prefered number of columns to use when the palette is being displayed.
Sven Neumann; 2005

gimp_palette_get_foreground

Input: none
Returns:

COLOR

foreground

The foreground color

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

gimp_palette_get_info

Input:

STRING

name

The palette name.

Returns:

INT32

num_colors

The number of colors in the palette

This procedure retrieves information about the specified palette. This includes the name, and the number of colors.
Michael Natterer; 2004

gimp_palette_is_editable

Input:

STRING

name

The palette name.

Returns:

INT32

editable

True if the palette can be edited

Returns True if you have permission to change the palette
Bill Skaggs; 2004

gimp_palette_new

Input:

STRING

name

The requested name of the new palette

Returns:

STRING

name

The actual new palette name

This procedure creates a new, uninitialized palette
Michael Natterer; 2004

gimp_palette_refresh

Input: none
Returns: nothing
This procedure is deprecated! Use 'gimp_palettes_refresh' instead.
;

gimp_palette_rename

Input:

STRING	name	The palette name.
STRING	new_name	The new name of the palette

Returns:

STRING

name

The actual new name of the palette

This procedure renames a palette
Michael Natterer; 2004

gimp_palette_set_background

Input:

COLOR

background

The background color

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

gimp_palette_set_columns

Input:

STRING	name	The palette name.
INT32	columns	The new number of columns

Returns: nothing
This procedures allows to control how many colors are shown per row when the palette is being displayed. This value can only be changed if the palette is writable. The maximum allowed value is 64.
Sven Neumann; 2005

gimp_palette_set_default_colors

Input: none
Returns: nothing
This procedure is deprecated! Use 'gimp_context_set_default_colors' instead.
;

gimp_palette_set_foreground

Input:

COLOR

foreground

The foreground color

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

gimp_palette_swap_colors

Input: none
Returns: nothing
This procedure is deprecated! Use 'gimp_context_swap_colors' instead.
;

gimp_palettes_close_popup

Input:

STRING

palette_callback

The name of the callback registered for this popup

Returns: nothing
This procedure closes an opened palette selection dialog.
Michael Natterer; 2002

gimp_palettes_get_list

Input:

STRING

filter

An optional regular expression used to filter the list

Returns:

INT32	num_palettes	The number of palettes in the list
STRINGARRAY	palette_list	The list of palette names

This procedure returns a complete listing of available palettes. Each name returned can be used as input to the command 'gimp_context_set_palette'.
Nathan Summers; 2001

gimp_palettes_get_palette

Input: none
Returns:

STRING	name	The palette name
INT32	num_colors	The palette num_colors

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

gimp_palettes_get_palette_entry

Input:

STRING	name	The palette name ("" means currently active palette)
INT32	entry_num	The entry to retrieve

Returns:

STRING	name	The palette name
INT32	num_colors	The palette num_colors
COLOR	color	The color requested

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

gimp_palettes_popup

Input:

STRING	palette_callback	The callback PDB proc to call when palette selection is made
STRING	popup_title	Title to give the palette popup window
STRING	initial_palette	The name of the palette to set as the first selected

Returns: nothing
This procedure popups the palette selection dialog.
Michael Natterer; 2002

gimp_palettes_refresh

Input: none
Returns: nothing
This procedure retrieves all palettes currently in the user's palette path and updates the palette dialogs accordingly.
Adrian Likins; 1998

gimp_palettes_set_palette

Input:

STRING

name

The name of the palette

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

gimp_palettes_set_popup

Input:

STRING	palette_callback	The name of the callback registered for this popup
STRING	palette_name	The name of the palette to set as selected

Returns: nothing
Sets the current palette selection in a popup.
Michael Natterer; 2002

plug_in_palettemap

Input:

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

Returns: nothing
This plug-in maps the contents of the specified drawable with the active palette. It calculates luminosity of each pixel and replaces the pixel by the palette sample at the corresponding index. A complete black pixel becomes the lowest palette entry, and complete white becomes the highest. Works on both Grayscale and RGB image with/without alpha channel.
Bill Skaggs; 2004

plug_in_smooth_palette

Input:

INT32	run_mode	Interactive, non-interactive
IMAGE	image	Input image (unused)
DRAWABLE	drawable	Input drawable
INT32	width	Width
INT32	height	Height
INT32	ntries	Search Depth
INT32	show_image	Show Image?

Returns:

IMAGE	new_image	Output image
LAYER	new_layer	Output layer

help!
Scott Draves; 1997

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