mirror of
https://gitlab.gnome.org/GNOME/gimp.git
synced 2025-07-04 01:43:24 +00:00

Though I am not fond of these macros for our core code (it makes the code more cumbersome especially for using private data in derivable types), this definitely makes sense for public API, since it would allow easier modifications with less chances of messing API/ABI stability.
72 lines
2.8 KiB
C
72 lines
2.8 KiB
C
/* GIMP - The GNU Image Manipulation Program
|
|
* Copyright (C) 1995 Spencer Kimball and Peter Mattis
|
|
*
|
|
* gimpimageprocedure.h
|
|
* Copyright (C) 2019 Michael Natterer <mitch@gimp.org>
|
|
*
|
|
* 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/>.
|
|
*/
|
|
|
|
#ifndef __GIMP_IMAGE_PROCEDURE_H__
|
|
#define __GIMP_IMAGE_PROCEDURE_H__
|
|
|
|
#include <libgimp/gimpprocedure.h>
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
/* For information look into the C source or the html documentation */
|
|
|
|
|
|
/**
|
|
* GimpRunImageFunc:
|
|
* @procedure: the #GimpProcedure that runs.
|
|
* @run_mode: the #GimpRunMode.
|
|
* @image: the #GimpImage.
|
|
* @n_drawables: the number of #GimpDrawable-s.
|
|
* @drawables: (array length=n_drawables): the input #GimpDrawable-s.
|
|
* @config: the @procedure's remaining arguments.
|
|
* @run_data: (closure): the run_data given in gimp_image_procedure_new().
|
|
*
|
|
* The image function is run during the lifetime of the GIMP session,
|
|
* each time a plug-in image procedure is called.
|
|
*
|
|
* Returns: (transfer full): the @procedure's return values.
|
|
*
|
|
* Since: 3.0
|
|
**/
|
|
typedef GimpValueArray * (* GimpRunImageFunc) (GimpProcedure *procedure,
|
|
GimpRunMode run_mode,
|
|
GimpImage *image,
|
|
gint n_drawables,
|
|
GimpDrawable **drawables,
|
|
GimpProcedureConfig *config,
|
|
gpointer run_data);
|
|
|
|
|
|
#define GIMP_TYPE_IMAGE_PROCEDURE (gimp_image_procedure_get_type ())
|
|
G_DECLARE_FINAL_TYPE (GimpImageProcedure, gimp_image_procedure, GIMP, IMAGE_PROCEDURE, GimpProcedure)
|
|
|
|
|
|
GimpProcedure * gimp_image_procedure_new (GimpPlugIn *plug_in,
|
|
const gchar *name,
|
|
GimpPDBProcType proc_type,
|
|
GimpRunImageFunc run_func,
|
|
gpointer run_data,
|
|
GDestroyNotify run_data_destroy);
|
|
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __GIMP_IMAGE_PROCEDURE_H__ */
|