gimpchannel.c 3.12 KB
Newer Older
1 2 3 4 5
/* LIBGIMP - The GIMP Library
 * Copyright (C) 1995-1997 Peter Mattis and Spencer Kimball
 *
 * gimpchannel.c
 *
6
 * This library is free software: you can redistribute it and/or
7 8
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
9
 * version 3 of the License, or (at your option) any later version.
10 11 12 13 14 15 16
 *
 * 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
17
 * License along with this library.  If not, see
18
 * <https://www.gnu.org/licenses/>.
19 20
 */

Sven Neumann's avatar
Sven Neumann committed
21 22
#include "config.h"

23 24 25
#include "gimp.h"


26 27 28 29 30 31 32
struct _GimpChannelPrivate
{
  gpointer unused;
};


G_DEFINE_TYPE_WITH_PRIVATE (GimpChannel, gimp_channel, GIMP_TYPE_DRAWABLE)
33 34 35

#define parent_class gimp_drawable_parent_class

36

37 38 39 40 41 42 43 44
static void
gimp_channel_class_init (GimpChannelClass *klass)
{
}

static void
gimp_channel_init (GimpChannel *channel)
{
45
  channel->priv = gimp_channel_get_instance_private (channel);
46 47
}

48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
/**
 * 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;
}

74 75
/**
 * gimp_channel_new:
76 77 78 79
 * @image:   The image to which to add the channel.
 * @name:    The channel name.
 * @width:   The channel width.
 * @height:  The channel height.
80
 * @opacity: The channel opacity.
81
 * @color:   The channel compositing color.
82 83 84 85 86 87
 *
 * 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
88 89 90 91
 * 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.
92
 *
93 94
 * Returns: (transfer none): The newly created channel.
 *          The object belongs to libgimp and you should not free it.
95
 */
96
GimpChannel *
97
gimp_channel_new (GimpImage     *image,
Sven Neumann's avatar
Sven Neumann committed
98 99 100 101 102
                  const gchar   *name,
                  guint          width,
                  guint          height,
                  gdouble        opacity,
                  const GimpRGB *color)
103
{
104
  return _gimp_channel_new (image,
Sven Neumann's avatar
Sven Neumann committed
105 106 107 108 109
                            width,
                            height,
                            name,
                            opacity,
                            color);
110
}