gimp/libgimp/gimpchannel.c

/* LIBGIMP - The GIMP Library
 * Copyright (C) 1995-1997 Peter Mattis and Spencer Kimball
 *
 * gimpchannel.c
 *
 * This library is free software: you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library.  If not, see
 * <https://www.gnu.org/licenses/>.
 */

#include "config.h"

#include "gimp.h"


G_DEFINE_TYPE (GimpChannel, gimp_channel, GIMP_TYPE_DRAWABLE)

#define parent_class gimp_drawable_parent_class


static void
gimp_channel_class_init (GimpChannelClass *klass)
{
}

static void
gimp_channel_init (GimpChannel *channel)
{
}

/**
 * gimp_channel_get_by_id:
 * @channel_id: The channel id.
 *
 * Returns a #GimpChannel representing @channel_id. This function
 * calls gimp_item_get_by_id() and returns the item if it is channel
 * or %NULL otherwise.
 *
 * Returns: (nullable) (transfer none): a #GimpChannel for @channel_id
 *          or %NULL if @channel_id does not represent a valid
 *          channel. The object belongs to libgimp and you must not
 *          modify or unref it.
 *
 * Since: 3.0
 **/
GimpChannel *
gimp_channel_get_by_id (gint32 channel_id)
{
  GimpItem *item = gimp_item_get_by_id (channel_id);

  if (GIMP_IS_CHANNEL (item))
    return (GimpChannel *) item;

  return NULL;
}

/**
 * gimp_channel_new:
 * @image:   The image to which to add the channel.
 * @name:    The channel name.
 * @width:   The channel width.
 * @height:  The channel height.
 * @opacity: The channel opacity.
 * @color:   The channel compositing color.
 *
 * Create a new 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_insert_channel()
 * command. Other attributes such as channel show masked, should be
 * set with explicit procedure calls. The channel's contents are
 * undefined initially.
 *
 * Returns: (transfer none): The newly created channel.
 *          The object belongs to libgimp and you should not free it.
 */
GimpChannel *
gimp_channel_new (GimpImage     *image,
                  const gchar   *name,
                  guint          width,
                  guint          height,
                  gdouble        opacity,
                  const GimpRGB *color)
{
  return _gimp_channel_new (image,
                            width,
                            height,
                            name,
                            opacity,
                            color);
}