gimp/libgimp/gimpgradients_pdb.c

433 lines
11 KiB
C

/* LIBGIMP - The GIMP Library
* Copyright (C) 1995-2003 Peter Mattis and Spencer Kimball
*
* gimpgradients_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 2 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, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
/* NOTE: This file is autogenerated by pdbgen.pl */
#include "config.h"
#include <string.h>
#include "gimp.h"
/**
* gimp_gradients_refresh:
*
* Refresh current gradients. This function always succeeds.
*
* This procedure retrieves all gradients currently in the user's
* gradient path and updates the gradient dialogs accordingly.
*
* Returns: TRUE on success.
*/
gboolean
gimp_gradients_refresh (void)
{
GimpParam *return_vals;
gint nreturn_vals;
gboolean success = TRUE;
return_vals = gimp_run_procedure ("gimp_gradients_refresh",
&nreturn_vals,
GIMP_PDB_END);
success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS;
gimp_destroy_params (return_vals, nreturn_vals);
return success;
}
/**
* gimp_gradients_get_list:
* @filter: An optional regular expression used to filter the list.
* @num_gradients: The number of loaded gradients.
*
* Retrieve the list of loaded gradients.
*
* This procedure returns a list of the gradients that are currently
* loaded in the gradient editor. You can later use the
* gimp_gradients_set_active function to set the active gradient.
*
* Returns: The list of gradient names.
*/
gchar **
gimp_gradients_get_list (const gchar *filter,
gint *num_gradients)
{
GimpParam *return_vals;
gint nreturn_vals;
gchar **gradient_list = NULL;
gint i;
return_vals = gimp_run_procedure ("gimp_gradients_get_list",
&nreturn_vals,
GIMP_PDB_STRING, filter,
GIMP_PDB_END);
*num_gradients = 0;
if (return_vals[0].data.d_status == GIMP_PDB_SUCCESS)
{
*num_gradients = return_vals[1].data.d_int32;
gradient_list = g_new (gchar *, *num_gradients);
for (i = 0; i < *num_gradients; i++)
gradient_list[i] = g_strdup (return_vals[2].data.d_stringarray[i]);
}
gimp_destroy_params (return_vals, nreturn_vals);
return gradient_list;
}
/**
* gimp_gradients_get_gradient:
*
* Retrieve the name of the active gradient.
*
* This procedure returns the name of the active gradient in the
* gradient editor.
*
* Returns: The name of the active gradient.
*/
gchar *
gimp_gradients_get_gradient (void)
{
GimpParam *return_vals;
gint nreturn_vals;
gchar *name = NULL;
return_vals = gimp_run_procedure ("gimp_gradients_get_gradient",
&nreturn_vals,
GIMP_PDB_END);
if (return_vals[0].data.d_status == GIMP_PDB_SUCCESS)
name = g_strdup (return_vals[1].data.d_string);
gimp_destroy_params (return_vals, nreturn_vals);
return name;
}
/**
* gimp_gradients_set_gradient:
* @name: The name of the gradient to set.
*
* Sets the specified gradient as the active gradient.
*
* This procedure lets you set the specified gradient as the active or
* \"current\" one. The name is simply a string which corresponds to
* one of the loaded gradients in the gradient editor. If no matching
* gradient is found, this procedure will return an error. Otherwise,
* the specified gradient will become active and will be used for
* subsequent custom gradient operations.
*
* Returns: TRUE on success.
*/
gboolean
gimp_gradients_set_gradient (const gchar *name)
{
GimpParam *return_vals;
gint nreturn_vals;
gboolean success = TRUE;
return_vals = gimp_run_procedure ("gimp_gradients_set_gradient",
&nreturn_vals,
GIMP_PDB_STRING, name,
GIMP_PDB_END);
success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS;
gimp_destroy_params (return_vals, nreturn_vals);
return success;
}
/**
* gimp_gradients_sample_uniform:
* @num_samples: The number of samples to take.
* @reverse: Use the reverse gradient.
*
* Sample the active gradient in uniform parts.
*
* This procedure samples the active gradient from the gradient editor
* in the specified number of uniform parts. It returns a list of
* floating-point values which correspond to the RGBA values for each
* sample. The minimum number of samples to take is 2, in which case
* the returned colors will correspond to the { 0.0, 1.0 } positions in
* the gradient. For example, if the number of samples is 3, the
* procedure will return the colors at positions { 0.0, 0.5, 1.0 }.
*
* Returns: Color samples: { R1, G1, B1, A1, ..., Rn, Gn, Bn, An }.
*/
gdouble *
gimp_gradients_sample_uniform (gint num_samples,
gboolean reverse)
{
GimpParam *return_vals;
gint nreturn_vals;
gdouble *color_samples = NULL;
gint num_color_samples;
return_vals = gimp_run_procedure ("gimp_gradients_sample_uniform",
&nreturn_vals,
GIMP_PDB_INT32, num_samples,
GIMP_PDB_INT32, reverse,
GIMP_PDB_END);
if (return_vals[0].data.d_status == GIMP_PDB_SUCCESS)
{
num_color_samples = return_vals[1].data.d_int32;
color_samples = g_new (gdouble, num_color_samples);
memcpy (color_samples, return_vals[2].data.d_floatarray,
num_color_samples * sizeof (gdouble));
}
gimp_destroy_params (return_vals, nreturn_vals);
return color_samples;
}
/**
* gimp_gradients_sample_custom:
* @num_samples: The number of samples to take.
* @positions: The list of positions to sample along the gradient.
* @reverse: Use the reverse gradient.
*
* Sample the active gradient in custom positions.
*
* This procedure samples the active gradient from the gradient editor
* in the specified number of points. The procedure will sample the
* gradient in the specified positions from the list. The left endpoint
* of the gradient corresponds to position 0.0, and the right endpoint
* corresponds to 1.0. The procedure returns a list of floating-point
* values which correspond to the RGBA values for each sample.
*
* Returns: Color samples: { R1, G1, B1, A1, ..., Rn, Gn, Bn, An }.
*/
gdouble *
gimp_gradients_sample_custom (gint num_samples,
const gdouble *positions,
gboolean reverse)
{
GimpParam *return_vals;
gint nreturn_vals;
gdouble *color_samples = NULL;
gint num_color_samples;
return_vals = gimp_run_procedure ("gimp_gradients_sample_custom",
&nreturn_vals,
GIMP_PDB_INT32, num_samples,
GIMP_PDB_FLOATARRAY, positions,
GIMP_PDB_INT32, reverse,
GIMP_PDB_END);
if (return_vals[0].data.d_status == GIMP_PDB_SUCCESS)
{
num_color_samples = return_vals[1].data.d_int32;
color_samples = g_new (gdouble, num_color_samples);
memcpy (color_samples, return_vals[2].data.d_floatarray,
num_color_samples * sizeof (gdouble));
}
gimp_destroy_params (return_vals, nreturn_vals);
return color_samples;
}
/**
* gimp_gradients_get_gradient_data:
* @name: The gradient name (\"\" means current active gradient).
* @sample_size: Size of the sample to return when the gradient is changed.
* @reverse: Use the reverse gradient.
* @width: The gradient sample width (r,g,b,a).
* @grad_data: The gradient sample data.
*
* Retrieve information about the specified gradient (including data).
*
* This procedure retrieves information about the gradient. This
* includes the gradient name, and the sample data for the gradient.
*
* Returns: The gradient name.
*/
gchar *
gimp_gradients_get_gradient_data (const gchar *name,
gint sample_size,
gboolean reverse,
gint *width,
gdouble **grad_data)
{
GimpParam *return_vals;
gint nreturn_vals;
gchar *ret_name = NULL;
return_vals = gimp_run_procedure ("gimp_gradients_get_gradient_data",
&nreturn_vals,
GIMP_PDB_STRING, name,
GIMP_PDB_INT32, sample_size,
GIMP_PDB_INT32, reverse,
GIMP_PDB_END);
*width = 0;
if (return_vals[0].data.d_status == GIMP_PDB_SUCCESS)
{
ret_name = g_strdup (return_vals[1].data.d_string);
*width = return_vals[2].data.d_int32;
*grad_data = g_new (gdouble, *width);
memcpy (*grad_data, return_vals[3].data.d_floatarray,
*width * sizeof (gdouble));
}
gimp_destroy_params (return_vals, nreturn_vals);
return ret_name;
}
/**
* gimp_gradients_new:
* @name: The requested name of the new gradient.
*
* Creates a new gradient
*
* This procedure creates a new, uninitialized gradient
*
* Returns: The actual new gradient name.
*
* Since: GIMP 2.2
*/
gchar *
gimp_gradients_new (const gchar *name)
{
GimpParam *return_vals;
gint nreturn_vals;
gchar *ret_name = NULL;
return_vals = gimp_run_procedure ("gimp_gradients_new",
&nreturn_vals,
GIMP_PDB_STRING, name,
GIMP_PDB_END);
if (return_vals[0].data.d_status == GIMP_PDB_SUCCESS)
ret_name = g_strdup (return_vals[1].data.d_string);
gimp_destroy_params (return_vals, nreturn_vals);
return ret_name;
}
/**
* gimp_gradients_duplicate:
* @name: The name of the gradient to duplicate.
*
* Duplicates a gradient
*
* This procedure creates an identical gradient by a different name
*
* Returns: The name of the gradient's copy.
*
* Since: GIMP 2.2
*/
gchar *
gimp_gradients_duplicate (const gchar *name)
{
GimpParam *return_vals;
gint nreturn_vals;
gchar *ret_name = NULL;
return_vals = gimp_run_procedure ("gimp_gradients_duplicate",
&nreturn_vals,
GIMP_PDB_STRING, name,
GIMP_PDB_END);
if (return_vals[0].data.d_status == GIMP_PDB_SUCCESS)
ret_name = g_strdup (return_vals[1].data.d_string);
gimp_destroy_params (return_vals, nreturn_vals);
return ret_name;
}
/**
* gimp_gradients_delete:
* @name: The name of the gradient to delete.
*
* Deletes a gradient
*
* This procedure deletes a gradient
*
* Returns: TRUE on success.
*
* Since: GIMP 2.2
*/
gboolean
gimp_gradients_delete (const gchar *name)
{
GimpParam *return_vals;
gint nreturn_vals;
gboolean success = TRUE;
return_vals = gimp_run_procedure ("gimp_gradients_delete",
&nreturn_vals,
GIMP_PDB_STRING, name,
GIMP_PDB_END);
success = return_vals[0].data.d_status == GIMP_PDB_SUCCESS;
gimp_destroy_params (return_vals, nreturn_vals);
return success;
}
/**
* gimp_gradients_rename:
* @name: The name of the gradient to rename.
* @new_name: The new name of the gradient.
*
* Rename a gradient
*
* This procedure renames a gradient
*
* Returns: The actual new name of the gradient.
*
* Since: GIMP 2.2
*/
gchar *
gimp_gradients_rename (const gchar *name,
const gchar *new_name)
{
GimpParam *return_vals;
gint nreturn_vals;
gchar *ret_name = NULL;
return_vals = gimp_run_procedure ("gimp_gradients_rename",
&nreturn_vals,
GIMP_PDB_STRING, name,
GIMP_PDB_STRING, new_name,
GIMP_PDB_END);
if (return_vals[0].data.d_status == GIMP_PDB_SUCCESS)
ret_name = g_strdup (return_vals[1].data.d_string);
gimp_destroy_params (return_vals, nreturn_vals);
return ret_name;
}