summaryrefslogtreecommitdiffstats
path: root/app/core/gimpdrawable.h
blob: 73c42831d715cf172bb32db7e2485959825597b4 (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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
/* GIMP - The GNU Image Manipulation Program
 * Copyright (C) 1995 Spencer Kimball and Peter Mattis
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

#ifndef __GIMP_DRAWABLE_H__
#define __GIMP_DRAWABLE_H__


#include "gimpitem.h"


#define GIMP_TYPE_DRAWABLE            (gimp_drawable_get_type ())
#define GIMP_DRAWABLE(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GIMP_TYPE_DRAWABLE, GimpDrawable))
#define GIMP_DRAWABLE_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GIMP_TYPE_DRAWABLE, GimpDrawableClass))
#define GIMP_IS_DRAWABLE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GIMP_TYPE_DRAWABLE))
#define GIMP_IS_DRAWABLE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GIMP_TYPE_DRAWABLE))
#define GIMP_DRAWABLE_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GIMP_TYPE_DRAWABLE, GimpDrawableClass))


typedef struct _GimpDrawablePrivate GimpDrawablePrivate;
typedef struct _GimpDrawableClass   GimpDrawableClass;

struct _GimpDrawable
{
  GimpItem             parent_instance;

  GimpDrawablePrivate *private;
};

struct _GimpDrawableClass
{
  GimpItemClass  parent_class;

  /*  signals  */
  void          (* update)                (GimpDrawable         *drawable,
                                           gint                  x,
                                           gint                  y,
                                           gint                  width,
                                           gint                  height);
  void          (* format_changed)        (GimpDrawable         *drawable);
  void          (* alpha_changed)         (GimpDrawable         *drawable);
  void          (* bounding_box_changed)  (GimpDrawable         *drawable);

  /*  virtual functions  */
  gint64        (* estimate_memsize)      (GimpDrawable         *drawable,
                                           GimpComponentType     component_type,
                                           gint                  width,
                                           gint                  height);
  void          (* update_all)            (GimpDrawable         *drawable);
  void          (* invalidate_boundary)   (GimpDrawable         *drawable);
  void          (* get_active_components) (GimpDrawable         *drawable,
                                           gboolean             *active);
  GimpComponentMask (* get_active_mask)   (GimpDrawable         *drawable);
  gboolean      (* supports_alpha)        (GimpDrawable         *drawable);
  void          (* convert_type)          (GimpDrawable         *drawable,
                                           GimpImage            *dest_image,
                                           const Babl           *new_format,
                                           GimpColorProfile     *dest_profile,
                                           GeglDitherMethod      layer_dither_type,
                                           GeglDitherMethod      mask_dither_type,
                                           gboolean              push_undo,
                                           GimpProgress         *progress);
  void          (* apply_buffer)          (GimpDrawable         *drawable,
                                           GeglBuffer           *buffer,
                                           const GeglRectangle  *buffer_region,
                                           gboolean              push_undo,
                                           const gchar          *undo_desc,
                                           gdouble               opacity,
                                           GimpLayerMode         mode,
                                           GimpLayerColorSpace   blend_space,
                                           GimpLayerColorSpace   composite_space,
                                           GimpLayerCompositeMode composite_mode,
                                           GeglBuffer           *base_buffer,
                                           gint                  base_x,
                                           gint                  base_y);
  GeglBuffer  * (* get_buffer)            (GimpDrawable         *drawable);
  void          (* set_buffer)            (GimpDrawable         *drawable,
                                           gboolean              push_undo,
                                           const gchar          *undo_desc,
                                           GeglBuffer           *buffer,
                                           const GeglRectangle  *bounds);
  GeglRectangle (* get_bounding_box)      (GimpDrawable         *drawable);
  void          (* push_undo)             (GimpDrawable         *drawable,
                                           const gchar          *undo_desc,
                                           GeglBuffer           *buffer,
                                           gint                  x,
                                           gint                  y,
                                           gint                  width,
                                           gint                  height);
  void          (* swap_pixels)           (GimpDrawable         *drawable,
                                           GeglBuffer           *buffer,
                                           gint                  x,
                                           gint                  y);
  GeglNode    * (* get_source_node)       (GimpDrawable         *drawable);
};


GType           gimp_drawable_get_type           (void) G_GNUC_CONST;

GimpDrawable  * gimp_drawable_new                (GType               type,
                                                  GimpImage          *image,
                                                  const gchar        *name,
                                                  gint                offset_x,
                                                  gint                offset_y,
                                                  gint                width,
                                                  gint                height,
                                                  const Babl         *format);

gint64          gimp_drawable_estimate_memsize   (GimpDrawable       *drawable,
                                                  GimpComponentType   component_type,
                                                  gint                width,
                                                  gint                height);

void            gimp_drawable_update             (GimpDrawable       *drawable,
                                                  gint                x,
                                                  gint                y,
                                                  gint                width,
                                                  gint                height);
void            gimp_drawable_update_all         (GimpDrawable       *drawable);

void           gimp_drawable_invalidate_boundary (GimpDrawable       *drawable);
void         gimp_drawable_get_active_components (GimpDrawable       *drawable,
                                                  gboolean           *active);
GimpComponentMask gimp_drawable_get_active_mask  (GimpDrawable       *drawable);

gboolean        gimp_drawable_supports_alpha     (GimpDrawable       *drawable);

void            gimp_drawable_convert_type       (GimpDrawable       *drawable,
                                                  GimpImage          *dest_image,
                                                  GimpImageBaseType   new_base_type,
                                                  GimpPrecision       new_precision,
                                                  gboolean            new_has_alpha,
                                                  GimpColorProfile   *dest_profile,
                                                  GeglDitherMethod    layer_dither_type,
                                                  GeglDitherMethod    mask_dither_type,
                                                  gboolean            push_undo,
                                                  GimpProgress       *progress);

void            gimp_drawable_apply_buffer       (GimpDrawable        *drawable,
                                                  GeglBuffer          *buffer,
                                                  const GeglRectangle *buffer_rect,
                                                  gboolean             push_undo,
                                                  const gchar         *undo_desc,
                                                  gdouble              opacity,
                                                  GimpLayerMode        mode,
                                                  GimpLayerColorSpace  blend_space,
                                                  GimpLayerColorSpace  composite_space,
                                                  GimpLayerCompositeMode composite_mode,
                                                  GeglBuffer          *base_buffer,
                                                  gint                 base_x,
                                                  gint                 base_y);

GeglBuffer    * gimp_drawable_get_buffer         (GimpDrawable       *drawable);
void            gimp_drawable_set_buffer         (GimpDrawable       *drawable,
                                                  gboolean            push_undo,
                                                  const gchar        *undo_desc,
                                                  GeglBuffer         *buffer);
void            gimp_drawable_set_buffer_full    (GimpDrawable       *drawable,
                                                  gboolean            push_undo,
                                                  const gchar        *undo_desc,
                                                  GeglBuffer         *buffer,
                                                  const GeglRectangle *bounds,
                                                  gboolean            update);

void            gimp_drawable_steal_buffer       (GimpDrawable       *drawable,
                                                  GimpDrawable       *src_drawable);

GeglNode      * gimp_drawable_get_source_node    (GimpDrawable       *drawable);
GeglNode      * gimp_drawable_get_mode_node      (GimpDrawable       *drawable);

GeglRectangle   gimp_drawable_get_bounding_box   (GimpDrawable       *drawable);
gboolean        gimp_drawable_update_bounding_box
                                                 (GimpDrawable       *drawable);

void            gimp_drawable_swap_pixels        (GimpDrawable       *drawable,
                                                  GeglBuffer         *buffer,
                                                  gint                x,
                                                  gint                y);

void            gimp_drawable_push_undo          (GimpDrawable       *drawable,
                                                  const gchar        *undo_desc,
                                                  GeglBuffer         *buffer,
                                                  gint                x,
                                                  gint                y,
                                                  gint                width,
                                                  gint                height);

const Babl      * gimp_drawable_get_format           (GimpDrawable    *drawable);
const Babl      * gimp_drawable_get_format_with_alpha(GimpDrawable    *drawable);
const Babl      * gimp_drawable_get_format_without_alpha
                                                     (GimpDrawable    *drawable);
gboolean          gimp_drawable_get_linear           (GimpDrawable    *drawable);
gboolean          gimp_drawable_has_alpha            (GimpDrawable    *drawable);
GimpImageBaseType gimp_drawable_get_base_type        (GimpDrawable    *drawable);
GimpComponentType gimp_drawable_get_component_type   (GimpDrawable    *drawable);
GimpPrecision     gimp_drawable_get_precision        (GimpDrawable    *drawable);
gboolean          gimp_drawable_is_rgb               (GimpDrawable    *drawable);
gboolean          gimp_drawable_is_gray              (GimpDrawable    *drawable);
gboolean          gimp_drawable_is_indexed           (GimpDrawable    *drawable);

const Babl      * gimp_drawable_get_component_format (GimpDrawable    *drawable,
                                                      GimpChannelType  channel);
gint              gimp_drawable_get_component_index  (GimpDrawable    *drawable,
                                                      GimpChannelType  channel);

const guchar    * gimp_drawable_get_colormap         (GimpDrawable    *drawable);

void              gimp_drawable_start_paint          (GimpDrawable    *drawable);
gboolean          gimp_drawable_end_paint            (GimpDrawable    *drawable);
gboolean          gimp_drawable_flush_paint          (GimpDrawable    *drawable);
gboolean          gimp_drawable_is_painting          (GimpDrawable    *drawable);


#endif /* __GIMP_DRAWABLE_H__ */