summaryrefslogtreecommitdiffstats
path: root/libgimp/gimpdrawable.h
blob: 7d7aaec74327dce7b6a52c84ae6c1866debefc13 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
/* LIBGIMP - The GIMP Library
 * Copyright (C) 1995-1997 Peter Mattis and Spencer Kimball
 *
 * gimpdrawable.h
 *
 * 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
 * Lesser 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/>.
 */

#if !defined (__GIMP_H_INSIDE__) && !defined (GIMP_COMPILATION)
#error "Only <libgimp/gimp.h> can be included directly."
#endif

#ifndef __GIMP_DRAWABLE_H__
#define __GIMP_DRAWABLE_H__

G_BEGIN_DECLS

/* For information look into the C source or the html documentation */

struct _GimpDrawable
{
  gint32    drawable_id;   /* drawable ID */
  guint     width;         /* width of drawble */
  guint     height;        /* height of drawble */
  guint     bpp;           /* bytes per pixel of drawable */
  guint     ntile_rows;    /* # of tile rows */
  guint     ntile_cols;    /* # of tile columns */
  GimpTile *tiles;         /* the normal tiles */
  GimpTile *shadow_tiles;  /* the shadow tiles */
};


GeglBuffer   * gimp_drawable_get_buffer             (gint32         drawable_ID);
GeglBuffer   * gimp_drawable_get_shadow_buffer      (gint32         drawable_ID);

const Babl   * gimp_drawable_get_format             (gint32         drawable_ID);
const Babl   * gimp_drawable_get_thumbnail_format   (gint32         drawable_ID);

GIMP_DEPRECATED_FOR(gimp_drawable_get_buffer)
GimpDrawable * gimp_drawable_get                    (gint32         drawable_ID);
GIMP_DEPRECATED
void           gimp_drawable_detach                 (GimpDrawable  *drawable);
GIMP_DEPRECATED_FOR(gegl_buffer_flush)
void           gimp_drawable_flush                  (GimpDrawable  *drawable);
GIMP_DEPRECATED_FOR(gimp_drawable_get_buffer)
GimpTile     * gimp_drawable_get_tile               (GimpDrawable  *drawable,
                                                     gboolean       shadow,
                                                     gint           row,
                                                     gint           col);
GIMP_DEPRECATED_FOR(gimp_drawable_get_buffer)
GimpTile     * gimp_drawable_get_tile2              (GimpDrawable  *drawable,
                                                     gboolean       shadow,
                                                     gint           x,
                                                     gint           y);

GIMP_DEPRECATED
void           gimp_drawable_get_color_uchar        (gint32         drawable_ID,
                                                     const GimpRGB *color,
                                                     guchar        *color_uchar);

guchar       * gimp_drawable_get_thumbnail_data     (gint32         drawable_ID,
                                                     gint          *width,
                                                     gint          *height,
                                                     gint          *bpp);
guchar       * gimp_drawable_get_sub_thumbnail_data (gint32         drawable_ID,
                                                     gint           src_x,
                                                     gint           src_y,
                                                     gint           src_width,
                                                     gint           src_height,
                                                     gint          *dest_width,
                                                     gint          *dest_height,
                                                     gint          *bpp);

GIMP_DEPRECATED_FOR(gimp_item_is_valid)
gboolean       gimp_drawable_is_valid               (gint32              drawable_ID);
GIMP_DEPRECATED_FOR(gimp_item_is_layer)
gboolean       gimp_drawable_is_layer               (gint32              drawable_ID);
GIMP_DEPRECATED_FOR(gimp_item_is_text_layer)
gboolean       gimp_drawable_is_text_layer          (gint32              drawable_ID);
GIMP_DEPRECATED_FOR(gimp_item_is_layer_mask)
gboolean       gimp_drawable_is_layer_mask          (gint32              drawable_ID);
GIMP_DEPRECATED_FOR(gimp_item_is_channel)
gboolean       gimp_drawable_is_channel             (gint32              drawable_ID);
GIMP_DEPRECATED_FOR(gimp_item_delete)
gboolean       gimp_drawable_delete                 (gint32              drawable_ID);
GIMP_DEPRECATED_FOR(gimp_item_get_image)
gint32         gimp_drawable_get_image              (gint32              drawable_ID);
GIMP_DEPRECATED_FOR(gimp_item_get_name)
gchar*         gimp_drawable_get_name               (gint32              drawable_ID);
GIMP_DEPRECATED_FOR(gimp_item_set_name)
gboolean       gimp_drawable_set_name               (gint32              drawable_ID,
                                                     const gchar        *name);
GIMP_DEPRECATED_FOR(gimp_item_get_visible)
gboolean       gimp_drawable_get_visible            (gint32              drawable_ID);
GIMP_DEPRECATED_FOR(gimp_item_set_visible)
gboolean       gimp_drawable_set_visible            (gint32              drawable_ID,
                                                     gboolean            visible);
GIMP_DEPRECATED_FOR(gimp_item_get_linked)
gboolean       gimp_drawable_get_linked             (gint32              drawable_ID);
GIMP_DEPRECATED_FOR(gimp_item_set_linked)
gboolean       gimp_drawable_set_linked             (gint32              drawable_ID,
                                                     gboolean            linked);
GIMP_DEPRECATED_FOR(gimp_item_get_tattoo)
gint           gimp_drawable_get_tattoo             (gint32              drawable_ID);
GIMP_DEPRECATED_FOR(gimp_item_set_tattoo)
gboolean       gimp_drawable_set_tattoo             (gint32              drawable_ID,
                                                     gint                tattoo);
GIMP_DEPRECATED_FOR(gimp_item_get_parasite)
GimpParasite * gimp_drawable_parasite_find          (gint32              drawable_ID,
                                                     const gchar        *name);
GIMP_DEPRECATED_FOR(gimp_item_attach_parasite)
gboolean       gimp_drawable_parasite_attach        (gint32              drawable_ID,
                                                     const GimpParasite *parasite);
GIMP_DEPRECATED_FOR(gimp_item_detach_parasite)
gboolean       gimp_drawable_parasite_detach        (gint32              drawable_ID,
                                                     const gchar        *name);
GIMP_DEPRECATED_FOR(gimp_item_get_parasite_list)
gboolean       gimp_drawable_parasite_list          (gint32              drawable_ID,
                                                     gint               *num_parasites,
                                                     gchar            ***parasites);
GIMP_DEPRECATED_FOR(gimp_item_attach_parasite)
gboolean       gimp_drawable_attach_new_parasite    (gint32              drawable_ID,
                                                     const gchar        *name,
                                                     gint                flags,
                                                     gint                size,
                                                     gconstpointer       data);

G_END_DECLS

#endif /* __GIMP_DRAWABLE_H__ */