/* LIBGIMP - The GIMP Library * Copyright (C) 1995-2003 Peter Mattis and Spencer Kimball * * gimpdrawableedit_pdb.c * * 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 * . */ /* NOTE: This file is auto-generated by pdbgen.pl */ #include "config.h" #include "gimp.h" /** * SECTION: gimpdrawableedit * @title: gimpdrawableedit * @short_description: Drawable edit functions (clear, fill, gradient, stroke etc.) * * Drawable edit functions (clear, fill, gradient, stroke etc.) **/ /** * gimp_drawable_edit_clear: * @drawable_ID: The drawable to clear from. * * Clear selected area of drawable. * * This procedure clears the specified drawable. If the drawable has an * alpha channel, the cleared pixels will become transparent. If the * drawable does not have an alpha channel, cleared pixels will be set * to the background color. This procedure only affects regions within * a selection if there is a selection active. * * This procedure is affected by the following context setters: * gimp_context_set_background(). * * Returns: TRUE on success. **/ gboolean gimp_drawable_edit_clear (gint32 drawable_ID) { GimpParam *return_vals; gint nreturn_vals; gboolean success = TRUE; return_vals = gimp_run_procedure ("gimp-drawable-edit-clear", &nreturn_vals, GIMP_PDB_DRAWABLE, drawable_ID, GIMP_PDB_END); success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS; gimp_destroy_params (return_vals, nreturn_vals); return success; } /** * gimp_drawable_edit_fill: * @drawable_ID: The drawable to fill to. * @fill_type: The type of fill. * * Fill selected area of drawable. * * This procedure fills the specified drawable according to fill mode. * This procedure only affects regions within a selection if there is a * selection active. If you want to fill the whole drawable, regardless * of the selection, use gimp_drawable_fill(). * * This procedure is affected by the following context setters: * gimp_context_set_opacity(), gimp_context_set_paint_mode(), * gimp_context_set_foreground(), gimp_context_set_background(), * gimp_context_set_pattern(). * * Returns: TRUE on success. **/ gboolean gimp_drawable_edit_fill (gint32 drawable_ID, GimpFillType fill_type) { GimpParam *return_vals; gint nreturn_vals; gboolean success = TRUE; return_vals = gimp_run_procedure ("gimp-drawable-edit-fill", &nreturn_vals, GIMP_PDB_DRAWABLE, drawable_ID, GIMP_PDB_INT32, fill_type, GIMP_PDB_END); success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS; gimp_destroy_params (return_vals, nreturn_vals); return success; } /** * gimp_drawable_edit_bucket_fill: * @drawable_ID: The affected drawable. * @fill_type: The type of fill. * @x: The x coordinate of this bucket fill's application. * @y: The y coordinate of this bucket fill's application. * * Fill the area by a seed fill starting at the specified coordinates. * * This procedure does a seed fill at the specified coordinates, using * various parameters from the current context. * In the case of merged sampling, the x and y coordinates are relative * to the image's origin; otherwise, they are relative to the * drawable's origin. * * This procedure is affected by the following context setters: * gimp_context_set_opacity(), gimp_context_set_paint_mode(), * gimp_context_set_foreground(), gimp_context_set_background(), * gimp_context_set_pattern(), gimp_context_set_sample_threshold(), * gimp_context_set_sample_merged(), * gimp_context_set_sample_criterion(), * gimp_context_set_diagonal_neighbors(), gimp_context_set_antialias(). * * Returns: TRUE on success. * * Since: 2.10 **/ gboolean gimp_drawable_edit_bucket_fill (gint32 drawable_ID, GimpFillType fill_type, gdouble x, gdouble y) { GimpParam *return_vals; gint nreturn_vals; gboolean success = TRUE; return_vals = gimp_run_procedure ("gimp-drawable-edit-bucket-fill", &nreturn_vals, GIMP_PDB_DRAWABLE, drawable_ID, GIMP_PDB_INT32, fill_type, GIMP_PDB_FLOAT, x, GIMP_PDB_FLOAT, y, GIMP_PDB_END); success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS; gimp_destroy_params (return_vals, nreturn_vals); return success; } /** * gimp_drawable_edit_gradient_fill: * @drawable_ID: The affected drawable. * @gradient_type: The type of gradient. * @offset: Offset relates to the starting and ending coordinates specified for the blend. This parameter is mode dependent. * @supersample: Do adaptive supersampling. * @supersample_max_depth: Maximum recursion levels for supersampling. * @supersample_threshold: Supersampling threshold. * @dither: Use dithering to reduce banding. * @x1: The x coordinate of this gradient's starting point. * @y1: The y coordinate of this gradient's starting point. * @x2: The x coordinate of this gradient's ending point. * @y2: The y coordinate of this gradient's ending point. * * Draw a gradient between the starting and ending coordinates with the * specified gradient type. * * This tool requires information on the gradient type. It creates the * specified variety of gradient using the starting and ending * coordinates as defined for each gradient type. For shapeburst * gradient types, the context's distance metric is also relevant and * can be updated with gimp_context_set_distance_metric(). * * This procedure is affected by the following context setters: * gimp_context_set_opacity(), gimp_context_set_paint_mode(), * gimp_context_set_foreground(), gimp_context_set_background(), * gimp_context_set_gradient() and all gradient property settings, * gimp_context_set_distance_metric(). * * Returns: TRUE on success. * * Since: 2.10 **/ gboolean gimp_drawable_edit_gradient_fill (gint32 drawable_ID, GimpGradientType gradient_type, gdouble offset, gboolean supersample, gint supersample_max_depth, gdouble supersample_threshold, gboolean dither, gdouble x1, gdouble y1, gdouble x2, gdouble y2) { GimpParam *return_vals; gint nreturn_vals; gboolean success = TRUE; return_vals = gimp_run_procedure ("gimp-drawable-edit-gradient-fill", &nreturn_vals, GIMP_PDB_DRAWABLE, drawable_ID, GIMP_PDB_INT32, gradient_type, GIMP_PDB_FLOAT, offset, GIMP_PDB_INT32, supersample, GIMP_PDB_INT32, supersample_max_depth, GIMP_PDB_FLOAT, supersample_threshold, GIMP_PDB_INT32, dither, GIMP_PDB_FLOAT, x1, GIMP_PDB_FLOAT, y1, GIMP_PDB_FLOAT, x2, GIMP_PDB_FLOAT, y2, GIMP_PDB_END); success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS; gimp_destroy_params (return_vals, nreturn_vals); return success; } /** * gimp_drawable_edit_stroke_selection: * @drawable_ID: The drawable to stroke to. * * Stroke the current selection * * This procedure strokes the current selection, painting along the * selection boundary with the active paint method and brush, or using * a plain line with configurable properties. The paint is applied to * the specified drawable regardless of the active selection. * * This procedure is affected by the following context setters: * gimp_context_set_opacity(), gimp_context_set_paint_mode(), * gimp_context_set_paint_method(), gimp_context_set_stroke_method(), * gimp_context_set_foreground(), gimp_context_set_brush() and all * brush property settings, gimp_context_set_gradient() and all * gradient property settings, gimp_context_set_line_width() and all * line property settings, gimp_context_set_antialias(). * * Returns: TRUE on success. **/ gboolean gimp_drawable_edit_stroke_selection (gint32 drawable_ID) { GimpParam *return_vals; gint nreturn_vals; gboolean success = TRUE; return_vals = gimp_run_procedure ("gimp-drawable-edit-stroke-selection", &nreturn_vals, GIMP_PDB_DRAWABLE, drawable_ID, GIMP_PDB_END); success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS; gimp_destroy_params (return_vals, nreturn_vals); return success; } /** * gimp_drawable_edit_stroke_item: * @drawable_ID: The drawable to stroke to. * @item_ID: The item to stroke. * * Stroke the specified item * * This procedure strokes the specified item, painting along its * outline (e.g. along a path, or along a channel's boundary), with the * active paint method and brush, or using a plain line with * configurable properties. * * This procedure is affected by the following context setters: * gimp_context_set_opacity(), gimp_context_set_paint_mode(), * gimp_context_set_paint_method(), gimp_context_set_stroke_method(), * gimp_context_set_foreground(), gimp_context_set_brush() and all * brush property settings, gimp_context_set_gradient() and all * gradient property settings, gimp_context_set_line_width() and all * line property settings, gimp_context_set_antialias(). * * Returns: TRUE on success. * * Since: 2.10 **/ gboolean gimp_drawable_edit_stroke_item (gint32 drawable_ID, gint32 item_ID) { GimpParam *return_vals; gint nreturn_vals; gboolean success = TRUE; return_vals = gimp_run_procedure ("gimp-drawable-edit-stroke-item", &nreturn_vals, GIMP_PDB_DRAWABLE, drawable_ID, GIMP_PDB_ITEM, item_ID, GIMP_PDB_END); success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS; gimp_destroy_params (return_vals, nreturn_vals); return success; }