libgimp/gimpbuffer_pdb.c

   1 /* LIBGIMP - The GIMP Library
   2  * Copyright (C) 1995-2003 Peter Mattis and Spencer Kimball
   3  *
   4  * gimpbuffer_pdb.c
   5  *
   6  * This library is free software: you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 3 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library.  If not, see
  18  * <https://www.gnu.org/licenses/>.
  19  */
  20
  21 /* NOTE: This file is auto-generated by pdbgen.pl */
  22
  23 #include "config.h"
  24
  25 #include "gimp.h"
  26
  27
  28 /**
  29  * SECTION: gimpbuffer
  30  * @title: gimpbuffer
  31  * @short_description: Functions for manipulating cut buffers.
  32  *
  33  * Functions related to named cut buffers.
  34  **/
  35
  36
  37 /**
  38  * gimp_buffers_get_list:
  39  * @filter: An optional regular expression used to filter the list.
  40  * @num_buffers: The number of buffers.
  41  *
  42  * Retrieve a complete listing of the available buffers.
  43  *
  44  * This procedure returns a complete listing of available named
  45  * buffers.
  46  *
  47  * Returns: The list of buffer names. The returned value must be freed
  48  * with g_strfreev().
  49  *
  50  * Since: 2.4
  51  **/
  52 gchar **
  53 gimp_buffers_get_list (const gchar *filter,
  54                        gint        *num_buffers)
  55 {
  56   GimpParam *return_vals;
  57   gint nreturn_vals;
  58   gchar **buffer_list = NULL;
  59   gint i;
  60
  61   return_vals = gimp_run_procedure ("gimp-buffers-get-list",
  62                                     &nreturn_vals,
  63                                     GIMP_PDB_STRING, filter,
  64                                     GIMP_PDB_END);
  65
  66   *num_buffers = 0;
  67
  68   if (return_vals[0].data.d_status == GIMP_PDB_SUCCESS)
  69     {
  70       *num_buffers = return_vals[1].data.d_int32;
  71       if (*num_buffers > 0)
  72         {
  73           buffer_list = g_new0 (gchar *, *num_buffers + 1);
  74           for (i = 0; i < *num_buffers; i++)
  75             buffer_list[i] = g_strdup (return_vals[2].data.d_stringarray[i]);
  76         }
  77     }
  78
  79   gimp_destroy_params (return_vals, nreturn_vals);
  80
  81   return buffer_list;
  82 }
  83
  84 /**
  85  * gimp_buffer_rename:
  86  * @buffer_name: The buffer name.
  87  * @new_name: The buffer's new name.
  88  *
  89  * Renames a named buffer.
  90  *
  91  * This procedure renames a named buffer.
  92  *
  93  * Returns: The real name given to the buffer.
  94  *
  95  * Since: 2.4
  96  **/
  97 gchar *
  98 gimp_buffer_rename (const gchar *buffer_name,
  99                     const gchar *new_name)
 100 {
 101   GimpParam *return_vals;
 102   gint nreturn_vals;
 103   gchar *real_name = NULL;
 104
 105   return_vals = gimp_run_procedure ("gimp-buffer-rename",
 106                                     &nreturn_vals,
 107                                     GIMP_PDB_STRING, buffer_name,
 108                                     GIMP_PDB_STRING, new_name,
 109                                     GIMP_PDB_END);
 110
 111   if (return_vals[0].data.d_status == GIMP_PDB_SUCCESS)
 112     real_name = g_strdup (return_vals[1].data.d_string);
 113
 114   gimp_destroy_params (return_vals, nreturn_vals);
 115
 116   return real_name;
 117 }
 118
 119 /**
 120  * gimp_buffer_delete:
 121  * @buffer_name: The buffer name.
 122  *
 123  * Deletes a named buffer.
 124  *
 125  * This procedure deletes a named buffer.
 126  *
 127  * Returns: TRUE on success.
 128  *
 129  * Since: 2.4
 130  **/
 131 gboolean
 132 gimp_buffer_delete (const gchar *buffer_name)
 133 {
 134   GimpParam *return_vals;
 135   gint nreturn_vals;
 136   gboolean success = TRUE;
 137
 138   return_vals = gimp_run_procedure ("gimp-buffer-delete",
 139                                     &nreturn_vals,
 140                                     GIMP_PDB_STRING, buffer_name,
 141                                     GIMP_PDB_END);
 142
 143   success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS;
 144
 145   gimp_destroy_params (return_vals, nreturn_vals);
 146
 147   return success;
 148 }
 149
 150 /**
 151  * gimp_buffer_get_width:
 152  * @buffer_name: The buffer name.
 153  *
 154  * Retrieves the specified buffer's width.
 155  *
 156  * This procedure retrieves the specified named buffer's width.
 157  *
 158  * Returns: The buffer width.
 159  *
 160  * Since: 2.4
 161  **/
 162 gint
 163 gimp_buffer_get_width (const gchar *buffer_name)
 164 {
 165   GimpParam *return_vals;
 166   gint nreturn_vals;
 167   gint width = 0;
 168
 169   return_vals = gimp_run_procedure ("gimp-buffer-get-width",
 170                                     &nreturn_vals,
 171                                     GIMP_PDB_STRING, buffer_name,
 172                                     GIMP_PDB_END);
 173
 174   if (return_vals[0].data.d_status == GIMP_PDB_SUCCESS)
 175     width = return_vals[1].data.d_int32;
 176
 177   gimp_destroy_params (return_vals, nreturn_vals);
 178
 179   return width;
 180 }
 181
 182 /**
 183  * gimp_buffer_get_height:
 184  * @buffer_name: The buffer name.
 185  *
 186  * Retrieves the specified buffer's height.
 187  *
 188  * This procedure retrieves the specified named buffer's height.
 189  *
 190  * Returns: The buffer height.
 191  *
 192  * Since: 2.4
 193  **/
 194 gint
 195 gimp_buffer_get_height (const gchar *buffer_name)
 196 {
 197   GimpParam *return_vals;
 198   gint nreturn_vals;
 199   gint height = 0;
 200
 201   return_vals = gimp_run_procedure ("gimp-buffer-get-height",
 202                                     &nreturn_vals,
 203                                     GIMP_PDB_STRING, buffer_name,
 204                                     GIMP_PDB_END);
 205
 206   if (return_vals[0].data.d_status == GIMP_PDB_SUCCESS)
 207     height = return_vals[1].data.d_int32;
 208
 209   gimp_destroy_params (return_vals, nreturn_vals);
 210
 211   return height;
 212 }
 213
 214 /**
 215  * gimp_buffer_get_bytes:
 216  * @buffer_name: The buffer name.
 217  *
 218  * Retrieves the specified buffer's bytes.
 219  *
 220  * This procedure retrieves the specified named buffer's bytes.
 221  *
 222  * Returns: The buffer bpp.
 223  *
 224  * Since: 2.4
 225  **/
 226 gint
 227 gimp_buffer_get_bytes (const gchar *buffer_name)
 228 {
 229   GimpParam *return_vals;
 230   gint nreturn_vals;
 231   gint bytes = 0;
 232
 233   return_vals = gimp_run_procedure ("gimp-buffer-get-bytes",
 234                                     &nreturn_vals,
 235                                     GIMP_PDB_STRING, buffer_name,
 236                                     GIMP_PDB_END);
 237
 238   if (return_vals[0].data.d_status == GIMP_PDB_SUCCESS)
 239     bytes = return_vals[1].data.d_int32;
 240
 241   gimp_destroy_params (return_vals, nreturn_vals);
 242
 243   return bytes;
 244 }
 245
 246 /**
 247  * gimp_buffer_get_image_type:
 248  * @buffer_name: The buffer name.
 249  *
 250  * Retrieves the specified buffer's image type.
 251  *
 252  * This procedure retrieves the specified named buffer's image type.
 253  *
 254  * Returns: The buffer image type.
 255  *
 256  * Since: 2.4
 257  **/
 258 GimpImageBaseType
 259 gimp_buffer_get_image_type (const gchar *buffer_name)
 260 {
 261   GimpParam *return_vals;
 262   gint nreturn_vals;
 263   GimpImageBaseType image_type = 0;
 264
 265   return_vals = gimp_run_procedure ("gimp-buffer-get-image-type",
 266                                     &nreturn_vals,
 267                                     GIMP_PDB_STRING, buffer_name,
 268                                     GIMP_PDB_END);
 269
 270   if (return_vals[0].data.d_status == GIMP_PDB_SUCCESS)
 271     image_type = return_vals[1].data.d_int32;
 272
 273   gimp_destroy_params (return_vals, nreturn_vals);
 274
 275   return image_type;
 276 }