Gimp/app/core/gimpbuffer.h
Jehan d493f0537f Issue #8900 and #9923: reimplementing GimpUnit as a proper class.
This fixes all our GObject Introspection issues with GimpUnit which was
both an enum and an int-derived type of user-defined units *completing*
the enum values. GIR clearly didn't like this!

Now GimpUnit is a proper class and units are unique objects, allowing to
compare them with an identity test (i.e. `unit == gimp_unit_pixel ()`
tells us if unit is the pixel unit or not), which makes it easy to use,
just like with int, yet adding also methods, making for nicer
introspected API.

As an aside, this also fixes #10738, by having all the built-in units
retrievable even if libgimpbase had not been properly initialized with
gimp_base_init().
I haven't checked in details how GIR works to introspect, but it looks
like it loads the library to inspect and runs functions, hence
triggering some CRITICALS because virtual methods (supposed to be
initialized with gimp_base_init() run by libgimp) are not set. This new
code won't trigger any critical because the vtable method are now not
necessary, at least for all built-in units.

Note that GimpUnit is still in libgimpbase. It could have been moved to
libgimp in order to avoid any virtual method table (since we need to
keep core and libgimp side's units in sync, PDB is required), but too
many libgimpwidgets widgets were already using GimpUnit. And technically
most of GimpUnit logic doesn't require PDB (only the creation/sync
part). This is one of the reasons why user-created GimpUnit list is
handled and stored differently from other types of objects.

Globally this simplifies the code a lot too and we don't need separate
implementations of various utils for core and libgimp, which means less
prone to errors.
2024-08-02 10:46:38 +02:00

91 lines
3.8 KiB
C

/* 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_BUFFER_H__
#define __GIMP_BUFFER_H__
#include "gimpviewable.h"
#define GIMP_TYPE_BUFFER (gimp_buffer_get_type ())
#define GIMP_BUFFER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GIMP_TYPE_BUFFER, GimpBuffer))
#define GIMP_BUFFER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GIMP_TYPE_BUFFER, GimpBufferClass))
#define GIMP_IS_BUFFER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GIMP_TYPE_BUFFER))
#define GIMP_IS_BUFFER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GIMP_TYPE_BUFFER))
#define GIMP_BUFFER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GIMP_TYPE_BUFFER, GimpBufferClass))
typedef struct _GimpBufferClass GimpBufferClass;
struct _GimpBuffer
{
GimpViewable parent_instance;
GeglBuffer *buffer;
gint offset_x;
gint offset_y;
gdouble resolution_x;
gdouble resolution_y;
GimpUnit *unit;
GimpColorProfile *color_profile;
GimpColorProfile *format_profile;
};
struct _GimpBufferClass
{
GimpViewableClass parent_class;
};
GType gimp_buffer_get_type (void) G_GNUC_CONST;
GimpBuffer * gimp_buffer_new (GeglBuffer *buffer,
const gchar *name,
gint offset_x,
gint offset_y,
gboolean copy_pixels);
GimpBuffer * gimp_buffer_new_from_pixbuf (GdkPixbuf *pixbuf,
const gchar *name,
gint offset_x,
gint offset_y);
gint gimp_buffer_get_width (GimpBuffer *buffer);
gint gimp_buffer_get_height (GimpBuffer *buffer);
const Babl * gimp_buffer_get_format (GimpBuffer *buffer);
GeglBuffer * gimp_buffer_get_buffer (GimpBuffer *buffer);
void gimp_buffer_set_resolution (GimpBuffer *buffer,
gdouble resolution_x,
gdouble resolution_y);
gboolean gimp_buffer_get_resolution (GimpBuffer *buffer,
gdouble *resolution_x,
gdouble *resolution_y);
void gimp_buffer_set_unit (GimpBuffer *buffer,
GimpUnit *unit);
GimpUnit * gimp_buffer_get_unit (GimpBuffer *buffer);
void gimp_buffer_set_color_profile (GimpBuffer *buffer,
GimpColorProfile *profile);
GimpColorProfile * gimp_buffer_get_color_profile (GimpBuffer *buffer);
#endif /* __GIMP_BUFFER_H__ */