See also: Main Index; Alphabetic; Misc; By Author; By Module; By Menu External Links: The Gimp; Gimp User Manual
The Gimp channel functions
gimp_channel_copy
Input:
| CHANNEL | channel | The channel to copy |
Returns:
| CHANNEL | channel_copy | The newly copied channel |
This procedure copies the specified channel and returns the copy.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_channel_delete
Input:
| CHANNEL | channel | The channel to delete |
Returns: nothing
This procedure deletes the specified channel. This must not be done if the gimage containing this channel was already deleted or if the channel was already removed from the image. The only case in which this procedure is useful is if you want to get rid of a channel which has not yet been added to an image.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_channel_get_color
Input:
| CHANNEL | channel | The channel |
Returns:
| COLOR | color | The channel compositing color |
This procedure returns the specified channel's compositing color.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_channel_get_name
Input:
| CHANNEL | channel | The channel |
Returns:
| STRING | name | The channel name |
This procedure returns the specified channel's name.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_channel_get_opacity
Input:
| CHANNEL | channel | The channel |
Returns:
| FLOAT | opacity | The channel opacity |
This procedure returns the specified channel's opacity.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_channel_get_tattoo
Input:
| CHANNEL | channel | The channel |
Returns:
| INT32 | tattoo | The channel tattoo |
This procedure returns the specified channel's tattoo. A tattoo is a unique and permanent identifier attached to a channel that can be used to uniquely identify a channel within an image even between sessions.
Jay Cox; 1998
gimp_channel_get_visible
Input:
| CHANNEL | channel | The channel |
Returns:
| INT32 | visible | The channel visibility |
This procedure returns the specified channel's visibility.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_channel_new
Input:
| IMAGE | image | The image to which to add the channel |
| INT32 | width | The channel width: (0 < width) |
| INT32 | height | The channel height: (0 < height) |
| STRING | name | The channel name |
| FLOAT | opacity | The channel opacity: (0 <= opacity <= 100) |
| COLOR | color | The channel compositing color |
Returns:
| CHANNEL | channel | The newly created channel |
This procedure creates a new channel with the specified width and height. Name, opacity, and color are also supplied parameters. The new channel still needs to be added to the image, as this is not automatic. Add the new channel with the 'gimp_image_add_channel' command. Other attributes such as channel show masked, should be set with explicit procedure calls. The channel's contents are undefined initially.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_channel_ops_duplicate
Input:
Returns:
| IMAGE | new_image | The new, duplicated image |
This procedure duplicates the specified image, copying all layers, channels, and image information.
Spencer Kimball & Peter Mattis; 1997
gimp_channel_ops_offset
Input:
| DRAWABLE | drawable | The drawable to offset |
| INT32 | wrap_around | wrap image around or fill vacated regions |
| INT32 | fill_type | fill vacated regions of drawable with background or transparent: OFFSET_BACKGROUND (0) or OFFSET_TRANSPARENT (1) |
| INT32 | offset_x | offset by this amount in X direction |
| INT32 | offset_y | offset by this amount in Y direction |
Returns: nothing
This procedure offsets the specified drawable by the amounts specified by 'offset_x' and 'offset_y'. If 'wrap_around' is set to TRUE, then portions of the drawable which are offset out of bounds are wrapped around. Alternatively, the undefined regions of the drawable can be filled with transparency or the background color, as specified by the 'fill_type' parameter.
Spencer Kimball & Peter Mattis; 1997
gimp_channel_set_color
Input:
| CHANNEL | channel | The channel |
| COLOR | color | The new channel compositing color |
Returns: nothing
This procedure sets the specified channel's compositing color.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_channel_set_name
Input:
| CHANNEL | channel | The channel |
| STRING | name | The new channel name |
Returns: nothing
This procedure sets the specified channel's name.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_channel_set_opacity
Input:
| CHANNEL | channel | The channel |
| FLOAT | opacity | The new channel opacity (0 <= opacity <= 100) |
Returns: nothing
This procedure sets the specified channel's opacity.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_channel_set_tattoo
Input:
| CHANNEL | channel | The channel |
| INT32 | tattoo | The new channel tattoo |
Returns: nothing
This procedure sets the specified channel's tattoo. A tattoo is a unique and permanent identifier attached to a channel that can be used to uniquely identify a channel within an image even between sessions.
Jay Cox; 1998
gimp_channel_set_visible
Input:
| CHANNEL | channel | The channel |
| INT32 | visible | The new channel visibility |
Returns: nothing
This procedure sets the specified channel's visibility.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_image_add_channel
Input:
| IMAGE | image | The image |
| CHANNEL | channel | The channel |
| INT32 | position | The channel position |
Returns: nothing
This procedure adds the specified channel to the image. The position channel is not currently used, so the channel is always inserted at the top of the channel stack.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_image_get_active_channel
Input:
Returns:
| CHANNEL | active_channel | The active channel |
If there is an active channel, this will return the channel ID, otherwise, -1.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_image_get_channel_by_tattoo
Input:
| IMAGE | image | The image |
| INT32 | tattoo | The tattoo of the channel to find |
Returns:
| CHANNEL | channel | The channel with the specified tattoo |
This procedure returns the channel with the given tattoo in the specified image.
Jay Cox; 1998
gimp_image_get_channels
Input:
Returns:
| INT32 | num_channels | The number of channels contained in the image |
| INT32ARRAY | channel_ids | The list of channels contained in the image |
This procedure returns the list of channels contained in the specified image. This does not include the selection mask, or layer masks. The order is from topmost to bottommost.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_image_lower_channel
Input:
| IMAGE | image | The image |
| LAYER | layer | The layer to lower |
Returns: nothing
This procedure lowers the specified layer one step in the existing layer stack. It will not move the layer if there is no layer below it, or the layer has no alpha channel.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_image_raise_channel
Input:
| IMAGE | image | The image |
| CHANNEL | channel | The channel to raise |
Returns: nothing
This procedure raises the specified channel one step in the existing channel stack. It will not move the channel if there is no channel above it.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_image_remove_channel
Input:
| IMAGE | image | The image |
| CHANNEL | channel | The channel |
Returns: nothing
This procedure removes the specified channel from the image. If the channel doesn't exist, an error is returned.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_image_set_active_channel
Input:
| IMAGE | image | The image |
| CHANNEL | active_channel | The new image active channel |
Returns: nothing
If the channel exists, it is set as the active channel in the image. Any previous active channel or channel is set to inactive. An exception is a previously existing floating selection, in which case this procedure will return an execution error.
Spencer Kimball & Peter Mattis; 1995-1996
gimp_image_unset_active_channel
Input:
Returns: nothing
If an active channel exists, it is unset. There then exists no active channel, and if desired, one can be set through a call to 'Set Active Channel'. No error is returned in the case of no existing active channel.
Spencer Kimball & Peter Mattis; 1995-1996