From e42129241681dde7adae7d20697e7b421682fbb4 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sat, 27 Apr 2024 18:23:22 +0200 Subject: Adding upstream version 2.10.22. Signed-off-by: Daniel Baumann --- devel-docs/libgimp/html/GimpAspectPreview.html | 233 + devel-docs/libgimp/html/GimpBrushSelectButton.html | 461 ++ devel-docs/libgimp/html/GimpDrawablePreview.html | 348 ++ devel-docs/libgimp/html/GimpFontSelectButton.html | 322 ++ .../libgimp/html/GimpGradientSelectButton.html | 336 ++ devel-docs/libgimp/html/GimpImageComboBox.html | 163 + .../libgimp/html/GimpPaletteSelectButton.html | 324 ++ .../libgimp/html/GimpPatternSelectButton.html | 348 ++ devel-docs/libgimp/html/GimpProcBrowserDialog.html | 282 ++ devel-docs/libgimp/html/GimpProgressBar.html | 113 + devel-docs/libgimp/html/GimpSelectButton.html | 130 + devel-docs/libgimp/html/GimpZoomPreview.html | 550 +++ devel-docs/libgimp/html/api-index-full.html | 4577 ++++++++++++++++++ devel-docs/libgimp/html/home.png | Bin 0 -> 256 bytes devel-docs/libgimp/html/index.html | 304 ++ devel-docs/libgimp/html/left-insensitive.png | Bin 0 -> 395 bytes devel-docs/libgimp/html/left.png | Bin 0 -> 262 bytes .../libgimp/html/libgimp-GimpItemComboBox.html | 368 ++ devel-docs/libgimp/html/libgimp-GimpProcView.html | 84 + devel-docs/libgimp/html/libgimp-data.html | 61 + devel-docs/libgimp/html/libgimp-general.html | 64 + devel-docs/libgimp/html/libgimp-gimp.html | 1857 ++++++++ devel-docs/libgimp/html/libgimp-gimpbrush.html | 1028 +++++ devel-docs/libgimp/html/libgimp-gimpbrushes.html | 458 ++ devel-docs/libgimp/html/libgimp-gimpbrushmenu.html | 222 + .../libgimp/html/libgimp-gimpbrushselect.html | 273 ++ devel-docs/libgimp/html/libgimp-gimpbuffer.html | 325 ++ devel-docs/libgimp/html/libgimp-gimpchannel.html | 527 +++ devel-docs/libgimp/html/libgimp-gimpcolor.html | 921 ++++ devel-docs/libgimp/html/libgimp-gimpcontext.html | 3583 +++++++++++++++ devel-docs/libgimp/html/libgimp-gimpdebug.html | 108 + devel-docs/libgimp/html/libgimp-gimpdisplay.html | 280 ++ devel-docs/libgimp/html/libgimp-gimpdrawable.html | 2286 +++++++++ .../libgimp/html/libgimp-gimpdrawablecolor.html | 926 ++++ .../libgimp/html/libgimp-gimpdrawableedit.html | 420 ++ .../html/libgimp-gimpdrawabletransform.html | 1502 ++++++ devel-docs/libgimp/html/libgimp-gimpdynamics.html | 124 + devel-docs/libgimp/html/libgimp-gimpedit.html | 983 ++++ devel-docs/libgimp/html/libgimp-gimpenums.html | 960 ++++ devel-docs/libgimp/html/libgimp-gimpexport.html | 376 ++ devel-docs/libgimp/html/libgimp-gimpfileops.html | 753 +++ .../libgimp/html/libgimp-gimpfloatingsel.html | 306 ++ devel-docs/libgimp/html/libgimp-gimpfontmenu.html | 186 + devel-docs/libgimp/html/libgimp-gimpfonts.html | 122 + .../libgimp/html/libgimp-gimpfontselect.html | 228 + devel-docs/libgimp/html/libgimp-gimpgimprc.html | 322 ++ devel-docs/libgimp/html/libgimp-gimpgradient.html | 1691 +++++++ .../libgimp/html/libgimp-gimpgradientmenu.html | 187 + devel-docs/libgimp/html/libgimp-gimpgradients.html | 336 ++ .../libgimp/html/libgimp-gimpgradientselect.html | 237 + devel-docs/libgimp/html/libgimp-gimphelp.html | 101 + devel-docs/libgimp/html/libgimp-gimpimage.html | 4857 ++++++++++++++++++++ .../html/libgimp-gimpimagecolorprofile.html | 345 ++ .../libgimp/html/libgimp-gimpimageconvert.html | 317 ++ devel-docs/libgimp/html/libgimp-gimpimagegrid.html | 516 +++ .../libgimp/html/libgimp-gimpimageguides.html | 324 ++ .../html/libgimp-gimpimagesamplepoints.html | 253 + .../libgimp/html/libgimp-gimpimageselect.html | 564 +++ .../libgimp/html/libgimp-gimpimagetransform.html | 424 ++ devel-docs/libgimp/html/libgimp-gimpimageundo.html | 333 ++ devel-docs/libgimp/html/libgimp-gimpitem.html | 1361 ++++++ .../libgimp/html/libgimp-gimpitemtransform.html | 885 ++++ devel-docs/libgimp/html/libgimp-gimplayer.html | 1943 ++++++++ devel-docs/libgimp/html/libgimp-gimpmenu.html | 317 ++ devel-docs/libgimp/html/libgimp-gimpmessage.html | 150 + devel-docs/libgimp/html/libgimp-gimpmetadata.html | 323 ++ .../libgimp/html/libgimp-gimppainttools.html | 1196 +++++ devel-docs/libgimp/html/libgimp-gimppalette.html | 924 ++++ .../libgimp/html/libgimp-gimppalettemenu.html | 189 + devel-docs/libgimp/html/libgimp-gimppalettes.html | 251 + .../libgimp/html/libgimp-gimppaletteselect.html | 228 + devel-docs/libgimp/html/libgimp-gimppaths.html | 818 ++++ devel-docs/libgimp/html/libgimp-gimppattern.html | 182 + .../libgimp/html/libgimp-gimppatternmenu.html | 186 + devel-docs/libgimp/html/libgimp-gimppatterns.html | 271 ++ .../libgimp/html/libgimp-gimppatternselect.html | 232 + devel-docs/libgimp/html/libgimp-gimppixbuf.html | 306 ++ .../libgimp/html/libgimp-gimppixelfetcher.html | 382 ++ devel-docs/libgimp/html/libgimp-gimppixelrgn.html | 940 ++++ devel-docs/libgimp/html/libgimp-gimpplugin.html | 374 ++ .../libgimp/html/libgimp-gimpproceduraldb.html | 611 +++ devel-docs/libgimp/html/libgimp-gimpprogress.html | 614 +++ .../libgimp/html/libgimp-gimpregioniterator.html | 330 ++ devel-docs/libgimp/html/libgimp-gimpselection.html | 882 ++++ .../libgimp/html/libgimp-gimpselectiontools.html | 778 ++++ devel-docs/libgimp/html/libgimp-gimptextlayer.html | 1401 ++++++ devel-docs/libgimp/html/libgimp-gimptexttool.html | 502 ++ devel-docs/libgimp/html/libgimp-gimptile.html | 218 + .../libgimp/html/libgimp-gimptransformtools.html | 457 ++ devel-docs/libgimp/html/libgimp-gimpui.html | 256 ++ devel-docs/libgimp/html/libgimp-gimpvectors.html | 2190 +++++++++ devel-docs/libgimp/html/libgimp-image.html | 139 + devel-docs/libgimp/html/libgimp-selectors.html | 64 + devel-docs/libgimp/html/libgimp.devhelp2 | 1343 ++++++ devel-docs/libgimp/html/libgimp.html | 258 ++ devel-docs/libgimp/html/libgimpui-hierarchy.html | 63 + devel-docs/libgimp/html/libgimpui.html | 85 + devel-docs/libgimp/html/right-insensitive.png | Bin 0 -> 373 bytes devel-docs/libgimp/html/right.png | Bin 0 -> 261 bytes devel-docs/libgimp/html/style.css | 533 +++ devel-docs/libgimp/html/up-insensitive.png | Bin 0 -> 374 bytes devel-docs/libgimp/html/up.png | Bin 0 -> 260 bytes 102 files changed, 60811 insertions(+) create mode 100644 devel-docs/libgimp/html/GimpAspectPreview.html create mode 100644 devel-docs/libgimp/html/GimpBrushSelectButton.html create mode 100644 devel-docs/libgimp/html/GimpDrawablePreview.html create mode 100644 devel-docs/libgimp/html/GimpFontSelectButton.html create mode 100644 devel-docs/libgimp/html/GimpGradientSelectButton.html create mode 100644 devel-docs/libgimp/html/GimpImageComboBox.html create mode 100644 devel-docs/libgimp/html/GimpPaletteSelectButton.html create mode 100644 devel-docs/libgimp/html/GimpPatternSelectButton.html create mode 100644 devel-docs/libgimp/html/GimpProcBrowserDialog.html create mode 100644 devel-docs/libgimp/html/GimpProgressBar.html create mode 100644 devel-docs/libgimp/html/GimpSelectButton.html create mode 100644 devel-docs/libgimp/html/GimpZoomPreview.html create mode 100644 devel-docs/libgimp/html/api-index-full.html create mode 100644 devel-docs/libgimp/html/home.png create mode 100644 devel-docs/libgimp/html/index.html create mode 100644 devel-docs/libgimp/html/left-insensitive.png create mode 100644 devel-docs/libgimp/html/left.png create mode 100644 devel-docs/libgimp/html/libgimp-GimpItemComboBox.html create mode 100644 devel-docs/libgimp/html/libgimp-GimpProcView.html create mode 100644 devel-docs/libgimp/html/libgimp-data.html create mode 100644 devel-docs/libgimp/html/libgimp-general.html create mode 100644 devel-docs/libgimp/html/libgimp-gimp.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpbrush.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpbrushes.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpbrushmenu.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpbrushselect.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpbuffer.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpchannel.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpcolor.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpcontext.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpdebug.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpdisplay.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpdrawable.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpdrawablecolor.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpdrawableedit.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpdrawabletransform.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpdynamics.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpedit.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpenums.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpexport.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpfileops.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpfloatingsel.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpfontmenu.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpfonts.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpfontselect.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpgimprc.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpgradient.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpgradientmenu.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpgradients.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpgradientselect.html create mode 100644 devel-docs/libgimp/html/libgimp-gimphelp.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpimage.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpimagecolorprofile.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpimageconvert.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpimagegrid.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpimageguides.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpimagesamplepoints.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpimageselect.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpimagetransform.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpimageundo.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpitem.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpitemtransform.html create mode 100644 devel-docs/libgimp/html/libgimp-gimplayer.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpmenu.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpmessage.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpmetadata.html create mode 100644 devel-docs/libgimp/html/libgimp-gimppainttools.html create mode 100644 devel-docs/libgimp/html/libgimp-gimppalette.html create mode 100644 devel-docs/libgimp/html/libgimp-gimppalettemenu.html create mode 100644 devel-docs/libgimp/html/libgimp-gimppalettes.html create mode 100644 devel-docs/libgimp/html/libgimp-gimppaletteselect.html create mode 100644 devel-docs/libgimp/html/libgimp-gimppaths.html create mode 100644 devel-docs/libgimp/html/libgimp-gimppattern.html create mode 100644 devel-docs/libgimp/html/libgimp-gimppatternmenu.html create mode 100644 devel-docs/libgimp/html/libgimp-gimppatterns.html create mode 100644 devel-docs/libgimp/html/libgimp-gimppatternselect.html create mode 100644 devel-docs/libgimp/html/libgimp-gimppixbuf.html create mode 100644 devel-docs/libgimp/html/libgimp-gimppixelfetcher.html create mode 100644 devel-docs/libgimp/html/libgimp-gimppixelrgn.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpplugin.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpproceduraldb.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpprogress.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpregioniterator.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpselection.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpselectiontools.html create mode 100644 devel-docs/libgimp/html/libgimp-gimptextlayer.html create mode 100644 devel-docs/libgimp/html/libgimp-gimptexttool.html create mode 100644 devel-docs/libgimp/html/libgimp-gimptile.html create mode 100644 devel-docs/libgimp/html/libgimp-gimptransformtools.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpui.html create mode 100644 devel-docs/libgimp/html/libgimp-gimpvectors.html create mode 100644 devel-docs/libgimp/html/libgimp-image.html create mode 100644 devel-docs/libgimp/html/libgimp-selectors.html create mode 100644 devel-docs/libgimp/html/libgimp.devhelp2 create mode 100644 devel-docs/libgimp/html/libgimp.html create mode 100644 devel-docs/libgimp/html/libgimpui-hierarchy.html create mode 100644 devel-docs/libgimp/html/libgimpui.html create mode 100644 devel-docs/libgimp/html/right-insensitive.png create mode 100644 devel-docs/libgimp/html/right.png create mode 100644 devel-docs/libgimp/html/style.css create mode 100644 devel-docs/libgimp/html/up-insensitive.png create mode 100644 devel-docs/libgimp/html/up.png (limited to 'devel-docs/libgimp/html') diff --git a/devel-docs/libgimp/html/GimpAspectPreview.html b/devel-docs/libgimp/html/GimpAspectPreview.html new file mode 100644 index 0000000..255aeff --- /dev/null +++ b/devel-docs/libgimp/html/GimpAspectPreview.html @@ -0,0 +1,233 @@ + + + + +GimpAspectPreview: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

GimpAspectPreview

+

GimpAspectPreview — A widget providing a preview with fixed aspect ratio.

+
+
+

Functions

+
++++ + + + + + + + + + + +
+GtkWidget * + +gimp_aspect_preview_new () +
+GtkWidget * + +gimp_aspect_preview_new_from_drawable_id () +
+
+
+

Properties

+
+++++ + + + + + + + + + + + + +
gpointerdrawableRead / Write / Construct Only
gintdrawable-idRead / Write / Construct Only
+
+
+

Types and Values

+
++++ + + + + +
 GimpAspectPreview
+
+
+

Object Hierarchy

+
    GObject
+    ╰── GInitiallyUnowned
+        ╰── GtkObject
+            ╰── GtkWidget
+                ╰── GtkContainer
+                    ╰── GtkBox
+                        ╰── GimpPreview
+                            ╰── GimpAspectPreview
+
+
+
+

Implemented Interfaces

+

+GimpAspectPreview implements + AtkImplementorIface, GtkBuildable and GtkOrientable.

+
+
+

Description

+

A widget providing a preview with fixed aspect ratio.

+
+
+

Functions

+
+

gimp_aspect_preview_new ()

+
GtkWidget *
+gimp_aspect_preview_new (GimpDrawable *drawable,
+                         gboolean *toggle);
+

gimp_aspect_preview_new is deprecated and should not be used in newly-written code.

+

Creates a new GimpAspectPreview widget for drawable +. See also +gimp_drawable_preview_new().

+

In GIMP 2.2 the toggle + parameter was provided to conviently access +the state of the "Preview" check-button. This is not any longer +necessary as the preview itself now stores this state, as well as +the scroll offset.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

drawable

a GimpDrawable

 

toggle

unused

 
+
+
+

Returns

+

a new GimpAspectPreview.

+
+

Since: 2.2

+
+
+
+

gimp_aspect_preview_new_from_drawable_id ()

+
GtkWidget *
+gimp_aspect_preview_new_from_drawable_id
+                               (gint32 drawable_ID);
+

Creates a new GimpAspectPreview widget for drawable_ID +. See also +gimp_drawable_preview_new_from_drawable_id().

+
+

Parameters

+
+++++ + + + + + +

drawable_ID

a drawable ID

 
+
+
+

Returns

+

a new GimpAspectPreview.

+
+

Since: 2.10

+
+
+
+

Types and Values

+
+

GimpAspectPreview

+
typedef struct _GimpAspectPreview GimpAspectPreview;
+
+
+
+

Property Details

+
+

The “drawable” property

+
  “drawable”                 gpointer
+

Deprecated: use the drawable-id property instead.

+
+

GimpAspectPreview:drawable is deprecated and should not be used in newly-written code.

+

use the drawable-id property instead.

+
+

Owner: GimpAspectPreview

+

Flags: Read / Write / Construct Only

+

Since: 2.4

+
+
+
+

The “drawable-id” property

+
  “drawable-id”              gint
+

The drawable the GimpAspectPreview is attached to.

+

Owner: GimpAspectPreview

+

Flags: Read / Write / Construct Only

+

Allowed values: >= -1

+

Default value: -1

+

Since: 2.10

+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/GimpBrushSelectButton.html b/devel-docs/libgimp/html/GimpBrushSelectButton.html new file mode 100644 index 0000000..c66b2bd --- /dev/null +++ b/devel-docs/libgimp/html/GimpBrushSelectButton.html @@ -0,0 +1,461 @@ + + + + +gimpbrushselectbutton: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpbrushselectbutton

+

gimpbrushselectbutton — A button that pops up a brush selection dialog.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + +
+GtkWidget * + +gimp_brush_select_button_new () +
const gchar * + +gimp_brush_select_button_get_brush () +
+void + +gimp_brush_select_button_set_brush () +
+
+
+

Properties

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+gchar *brush-nameRead / Write
gdoublebrush-opacityRead / Write
gintbrush-paint-modeRead / Write
gintbrush-spacingRead / Write
+gchar *titleRead / Write / Construct Only
+
+
+

Signals

+
+++++ + + + + + +
voidbrush-setRun First
+
+
+

Types and Values

+
++++ + + + + +
 GimpBrushSelectButton
+
+
+

Object Hierarchy

+
    GObject
+    ╰── GInitiallyUnowned
+        ╰── GtkObject
+            ╰── GtkWidget
+                ╰── GtkContainer
+                    ╰── GtkBox
+                        ╰── GimpSelectButton
+                            ╰── GimpBrushSelectButton
+
+
+
+

Implemented Interfaces

+

+GimpBrushSelectButton implements + AtkImplementorIface, GtkBuildable and GtkOrientable.

+
+
+

Description

+

A button that pops up a brush selection dialog.

+
+
+

Functions

+
+

gimp_brush_select_button_new ()

+
GtkWidget *
+gimp_brush_select_button_new (const gchar *title,
+                              const gchar *brush_name,
+                              gdouble opacity,
+                              gint spacing,
+                              GimpLayerMode paint_mode);
+

Creates a new GtkWidget that completely controls the selection of +a brush. This widget is suitable for placement in a table in a +plug-in dialog.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

title

Title of the dialog to use or NULL means to use the default +title.

 

brush_name

Initial brush name or NULL to use current selection.

 

opacity

Initial opacity. -1 means to use current opacity.

 

spacing

Initial spacing. -1 means to use current spacing.

 

paint_mode

Initial paint mode. -1 means to use current paint mode.

 
+
+
+

Returns

+

A GtkWidget that you can use in your UI.

+
+

Since: 2.4

+
+
+
+

gimp_brush_select_button_get_brush ()

+
const  gchar *
+gimp_brush_select_button_get_brush (GimpBrushSelectButton *button,
+                                    gdouble *opacity,
+                                    gint *spacing,
+                                    GimpLayerMode *paint_mode);
+

Retrieves the properties of currently selected brush.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

button

A GimpBrushSelectButton

 

opacity

Opacity of the selected brush.

 

spacing

Spacing of the selected brush.

 

paint_mode

Paint mode of the selected brush.

 
+
+
+

Returns

+

an internal copy of the brush name which must not be freed.

+
+

Since: 2.4

+
+
+
+

gimp_brush_select_button_set_brush ()

+
void
+gimp_brush_select_button_set_brush (GimpBrushSelectButton *button,
+                                    const gchar *brush_name,
+                                    gdouble opacity,
+                                    gint spacing,
+                                    GimpLayerMode paint_mode);
+

Sets the current brush and other values for the brush select +button.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

button

A GimpBrushSelectButton

 

brush_name

Brush name to set; NULL means no change.

 

opacity

Opacity to set. -1.0 means no change.

 

spacing

Spacing to set. -1 means no change.

 

paint_mode

Paint mode to set. -1 means no change.

 
+
+

Since: 2.4

+
+
+
+

Types and Values

+
+

GimpBrushSelectButton

+
typedef struct _GimpBrushSelectButton GimpBrushSelectButton;
+
+
+
+

Property Details

+
+

The “brush-name” property

+
  “brush-name”               gchar *
+

The name of the currently selected brush.

+

Owner: GimpBrushSelectButton

+

Flags: Read / Write

+

Default value: NULL

+

Since: 2.4

+
+
+
+

The “brush-opacity” property

+
  “brush-opacity”            gdouble
+

The opacity of the currently selected brush.

+

Owner: GimpBrushSelectButton

+

Flags: Read / Write

+

Allowed values: [-1,100]

+

Default value: -1

+
+
+
+

The “brush-paint-mode” property

+
  “brush-paint-mode”         gint
+

The paint mode of the currently selected brush.

+

Owner: GimpBrushSelectButton

+

Flags: Read / Write

+

Allowed values: [-1,56]

+

Default value: -1

+
+
+
+

The “brush-spacing” property

+
  “brush-spacing”            gint
+

The spacing of the currently selected brush.

+

Owner: GimpBrushSelectButton

+

Flags: Read / Write

+

Allowed values: [-2147483647,1000]

+

Default value: -1

+
+
+
+

The “title” property

+
  “title”                    gchar *
+

The title to be used for the brush selection popup dialog.

+

Owner: GimpBrushSelectButton

+

Flags: Read / Write / Construct Only

+

Default value: "Brush Selection"

+

Since: 2.4

+
+
+
+

Signal Details

+
+

The “brush-set” signal

+
void
+user_function (GimpBrushSelectButton *widget,
+               gchar                 *brush_name,
+               gdouble                opacity,
+               gint                   spacing,
+               gint                   paint_mode,
+               gint                   width,
+               gint                   height,
+               gpointer               mask_data,
+               gboolean               dialog_closing,
+               gpointer               user_data)
+

The ::brush-set signal is emitted when the user selects a brush.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

widget

the object which received the signal.

 

brush_name

the name of the currently selected brush.

 

opacity

opacity of the brush

 

spacing

spacing of the brush

 

paint_mode

paint mode of the brush

 

width

width of the brush

 

height

height of the brush

 

mask_data

brush mask data

 

dialog_closing

whether the dialog was closed or not.

 

user_data

user data set when the signal handler was connected.

 
+
+

Flags: Run First

+

Since: 2.4

+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/GimpDrawablePreview.html b/devel-docs/libgimp/html/GimpDrawablePreview.html new file mode 100644 index 0000000..db622f7 --- /dev/null +++ b/devel-docs/libgimp/html/GimpDrawablePreview.html @@ -0,0 +1,348 @@ + + + + +GimpDrawablePreview: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

GimpDrawablePreview

+

GimpDrawablePreview — A widget providing a preview of a GimpDrawable.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+GtkWidget * + +gimp_drawable_preview_new () +
+GtkWidget * + +gimp_drawable_preview_new_from_drawable_id () +
+GimpDrawable * + +gimp_drawable_preview_get_drawable () +
+gint32 + +gimp_drawable_preview_get_drawable_id () +
+void + +gimp_drawable_preview_draw_region () +
+
+
+

Properties

+
+++++ + + + + + + + + + + + + +
gpointerdrawableRead / Write / Construct Only
gintdrawable-idRead / Write / Construct Only
+
+
+

Types and Values

+
++++ + + + + +
 GimpDrawablePreview
+
+
+

Object Hierarchy

+
    GObject
+    ╰── GInitiallyUnowned
+        ╰── GtkObject
+            ╰── GtkWidget
+                ╰── GtkContainer
+                    ╰── GtkBox
+                        ╰── GimpPreview
+                            ╰── GimpScrolledPreview
+                                ╰── GimpDrawablePreview
+
+
+
+

Implemented Interfaces

+

+GimpDrawablePreview implements + AtkImplementorIface, GtkBuildable and GtkOrientable.

+
+
+

Description

+

A widget providing a preview of a GimpDrawable.

+
+
+

Functions

+
+

gimp_drawable_preview_new ()

+
GtkWidget *
+gimp_drawable_preview_new (GimpDrawable *drawable,
+                           gboolean *toggle);
+
+

gimp_drawable_preview_new is deprecated and should not be used in newly-written code.

+

Use gimp_drawable_preview_new_from_drawable_id() instead.

+
+

Creates a new GimpDrawablePreview widget for drawable +.

+

In GIMP 2.2 the toggle + parameter was provided to conviently access +the state of the "Preview" check-button. This is not any longer +necessary as the preview itself now stores this state, as well as +the scroll offset.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

drawable

a GimpDrawable

 

toggle

unused

 
+
+
+

Returns

+

A pointer to the new GimpDrawablePreview widget.

+
+

Since: 2.2

+
+
+
+

gimp_drawable_preview_new_from_drawable_id ()

+
GtkWidget *
+gimp_drawable_preview_new_from_drawable_id
+                               (gint32 drawable_ID);
+

Creates a new GimpDrawablePreview widget for drawable_ID +.

+
+

Parameters

+
+++++ + + + + + +

drawable_ID

a drawable ID

 
+
+
+

Returns

+

A pointer to the new GimpDrawablePreview widget.

+
+

Since: 2.10

+
+
+
+

gimp_drawable_preview_get_drawable ()

+
GimpDrawable *
+gimp_drawable_preview_get_drawable (GimpDrawablePreview *preview);
+
+

gimp_drawable_preview_get_drawable is deprecated and should not be used in newly-written code.

+

use gimp_drawable_preview_get_drawable_id() instead.

+
+
+

Parameters

+
+++++ + + + + + +

preview

a GimpDrawablePreview widget

 
+
+
+

Returns

+

the GimpDrawable that has been passed to +gimp_drawable_preview_new().

+
+

Since: 2.2

+
+
+
+

gimp_drawable_preview_get_drawable_id ()

+
gint32
+gimp_drawable_preview_get_drawable_id (GimpDrawablePreview *preview);
+
+

Parameters

+
+++++ + + + + + +

preview

a GimpDrawablePreview widget

 
+
+
+

Returns

+

the drawable_ID that has been passed to +gimp_drawable_preview_new_from_drawable_id().

+
+

Since: 2.10

+
+
+
+

gimp_drawable_preview_draw_region ()

+
void
+gimp_drawable_preview_draw_region (GimpDrawablePreview *preview,
+                                   const GimpPixelRgn *region);
+

gimp_drawable_preview_draw_region is deprecated and should not be used in newly-written code.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

preview

a GimpDrawablePreview widget

 

region

a GimpPixelRgn

 
+
+

Since: 2.2

+
+
+
+

Types and Values

+
+

GimpDrawablePreview

+
typedef struct _GimpDrawablePreview GimpDrawablePreview;
+
+
+
+

Property Details

+
+

The “drawable” property

+
  “drawable”                 gpointer
+

Deprecated: use the drawable-id property instead.

+
+

GimpDrawablePreview:drawable is deprecated and should not be used in newly-written code.

+

use the drawable-id property instead.

+
+

Owner: GimpDrawablePreview

+

Flags: Read / Write / Construct Only

+

Since: 2.4

+
+
+
+

The “drawable-id” property

+
  “drawable-id”              gint
+

The drawable the GimpDrawablePreview is attached to.

+

Owner: GimpDrawablePreview

+

Flags: Read / Write / Construct Only

+

Allowed values: >= -1

+

Default value: -1

+

Since: 2.10

+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/GimpFontSelectButton.html b/devel-docs/libgimp/html/GimpFontSelectButton.html new file mode 100644 index 0000000..4c19304 --- /dev/null +++ b/devel-docs/libgimp/html/GimpFontSelectButton.html @@ -0,0 +1,322 @@ + + + + +GimpFontSelectButton: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

GimpFontSelectButton

+

GimpFontSelectButton — A button which pops up a font selection dialog.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + +
+GtkWidget * + +gimp_font_select_button_new () +
const gchar * + +gimp_font_select_button_get_font () +
+void + +gimp_font_select_button_set_font () +
+
+
+

Properties

+
+++++ + + + + + + + + + + + + +
+gchar *font-nameRead / Write
+gchar *titleRead / Write / Construct Only
+
+
+

Signals

+
+++++ + + + + + +
voidfont-setRun First
+
+
+

Types and Values

+
++++ + + + + +
 GimpFontSelectButton
+
+
+

Object Hierarchy

+
    GObject
+    ╰── GInitiallyUnowned
+        ╰── GtkObject
+            ╰── GtkWidget
+                ╰── GtkContainer
+                    ╰── GtkBox
+                        ╰── GimpSelectButton
+                            ╰── GimpFontSelectButton
+
+
+
+

Implemented Interfaces

+

+GimpFontSelectButton implements + AtkImplementorIface, GtkBuildable and GtkOrientable.

+
+
+

Description

+

A button which pops up a font selection dialog.

+
+
+

Functions

+
+

gimp_font_select_button_new ()

+
GtkWidget *
+gimp_font_select_button_new (const gchar *title,
+                             const gchar *font_name);
+

Creates a new GtkWidget that completely controls the selection of +a font. This widget is suitable for placement in a table in a +plug-in dialog.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

title

Title of the dialog to use or NULL to use the default title.

 

font_name

Initial font name.

 
+
+
+

Returns

+

A GtkWidget that you can use in your UI.

+
+

Since: 2.4

+
+
+
+

gimp_font_select_button_get_font ()

+
const gchar *
+gimp_font_select_button_get_font (GimpFontSelectButton *button);
+

Retrieves the name of currently selected font.

+
+

Parameters

+
+++++ + + + + + +

button

A GimpFontSelectButton

 
+
+
+

Returns

+

an internal copy of the font name which must not be freed.

+
+

Since: 2.4

+
+
+
+

gimp_font_select_button_set_font ()

+
void
+gimp_font_select_button_set_font (GimpFontSelectButton *button,
+                                  const gchar *font_name);
+

Sets the current font for the font select button.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

button

A GimpFontSelectButton

 

font_name

Font name to set; NULL means no change.

 
+
+

Since: 2.4

+
+
+
+

Types and Values

+
+

GimpFontSelectButton

+
typedef struct _GimpFontSelectButton GimpFontSelectButton;
+
+
+
+

Property Details

+
+

The “font-name” property

+
  “font-name”                gchar *
+

The name of the currently selected font.

+

Owner: GimpFontSelectButton

+

Flags: Read / Write

+

Default value: "Sans-serif"

+

Since: 2.4

+
+
+
+

The “title” property

+
  “title”                    gchar *
+

The title to be used for the font selection popup dialog.

+

Owner: GimpFontSelectButton

+

Flags: Read / Write / Construct Only

+

Default value: "Font Selection"

+

Since: 2.4

+
+
+
+

Signal Details

+
+

The “font-set” signal

+
void
+user_function (GimpFontSelectButton *widget,
+               gchar                *font_name,
+               gboolean              dialog_closing,
+               gpointer              user_data)
+

The ::font-set signal is emitted when the user selects a font.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

widget

the object which received the signal.

 

font_name

the name of the currently selected font.

 

dialog_closing

whether the dialog was closed or not.

 

user_data

user data set when the signal handler was connected.

 
+
+

Flags: Run First

+

Since: 2.4

+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/GimpGradientSelectButton.html b/devel-docs/libgimp/html/GimpGradientSelectButton.html new file mode 100644 index 0000000..f651568 --- /dev/null +++ b/devel-docs/libgimp/html/GimpGradientSelectButton.html @@ -0,0 +1,336 @@ + + + + +GimpGradientSelectButton: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

GimpGradientSelectButton

+

GimpGradientSelectButton — A button which pops up a gradient select dialog.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + +
+GtkWidget * + +gimp_gradient_select_button_new () +
const gchar * + +gimp_gradient_select_button_get_gradient () +
+void + +gimp_gradient_select_button_set_gradient () +
+
+
+

Properties

+
+++++ + + + + + + + + + + + + +
+gchar *gradient-nameRead / Write
+gchar *titleRead / Write / Construct Only
+
+
+

Signals

+
+++++ + + + + + +
voidgradient-setRun First
+
+
+

Types and Values

+
++++ + + + + +
 GimpGradientSelectButton
+
+
+

Object Hierarchy

+
    GObject
+    ╰── GInitiallyUnowned
+        ╰── GtkObject
+            ╰── GtkWidget
+                ╰── GtkContainer
+                    ╰── GtkBox
+                        ╰── GimpSelectButton
+                            ╰── GimpGradientSelectButton
+
+
+
+

Implemented Interfaces

+

+GimpGradientSelectButton implements + AtkImplementorIface, GtkBuildable and GtkOrientable.

+
+
+

Description

+

A button which pops up a gradient select dialog.

+
+
+

Functions

+
+

gimp_gradient_select_button_new ()

+
GtkWidget *
+gimp_gradient_select_button_new (const gchar *title,
+                                 const gchar *gradient_name);
+

Creates a new GtkWidget that completely controls the selection of +a gradient. This widget is suitable for placement in a table in a +plug-in dialog.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

title

Title of the dialog to use or NULL to use the default title.

 

gradient_name

Initial gradient name.

 
+
+
+

Returns

+

A GtkWidget that you can use in your UI.

+
+

Since: 2.4

+
+
+
+

gimp_gradient_select_button_get_gradient ()

+
const gchar *
+gimp_gradient_select_button_get_gradient
+                               (GimpGradientSelectButton *button);
+

Retrieves the name of currently selected gradient.

+
+

Parameters

+
+++++ + + + + + +

button

A GimpGradientSelectButton

 
+
+
+

Returns

+

an internal copy of the gradient name which must not be freed.

+
+

Since: 2.4

+
+
+
+

gimp_gradient_select_button_set_gradient ()

+
void
+gimp_gradient_select_button_set_gradient
+                               (GimpGradientSelectButton *button,
+                                const gchar *gradient_name);
+

Sets the current gradient for the gradient select button.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

button

A GimpGradientSelectButton

 

gradient_name

Gradient name to set.

 
+
+

Since: 2.4

+
+
+
+

Types and Values

+
+

GimpGradientSelectButton

+
typedef struct _GimpGradientSelectButton GimpGradientSelectButton;
+
+
+
+

Property Details

+
+

The “gradient-name” property

+
  “gradient-name”            gchar *
+

The name of the currently selected gradient.

+

Owner: GimpGradientSelectButton

+

Flags: Read / Write

+

Default value: NULL

+

Since: 2.4

+
+
+
+

The “title” property

+
  “title”                    gchar *
+

The title to be used for the gradient selection popup dialog.

+

Owner: GimpGradientSelectButton

+

Flags: Read / Write / Construct Only

+

Default value: "Gradient Selection"

+

Since: 2.4

+
+
+
+

Signal Details

+
+

The “gradient-set” signal

+
void
+user_function (GimpGradientSelectButton *widget,
+               gchar                    *gradient_name,
+               gint                      width,
+               gpointer                  grad_data,
+               gboolean                  dialog_closing,
+               gpointer                  user_data)
+

The ::gradient-set signal is emitted when the user selects a gradient.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

widget

the object which received the signal.

 

gradient_name

the name of the currently selected gradient.

 

width

width of the gradient

 

grad_data

gradient data

 

dialog_closing

whether the dialog was closed or not.

 

user_data

user data set when the signal handler was connected.

 
+
+

Flags: Run First

+

Since: 2.4

+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/GimpImageComboBox.html b/devel-docs/libgimp/html/GimpImageComboBox.html new file mode 100644 index 0000000..5aea5e2 --- /dev/null +++ b/devel-docs/libgimp/html/GimpImageComboBox.html @@ -0,0 +1,163 @@ + + + + +GimpImageComboBox: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

GimpImageComboBox

+

GimpImageComboBox — A widget providing a popup menu of images.

+
+
+

Functions

+
++++ + + + + + + + + + + +
+gboolean + +(*GimpImageConstraintFunc) () +
+GtkWidget * + +gimp_image_combo_box_new () +
+
+
+

Types and Values

+
++++ + + + + +
 GimpImageComboBox
+
+
+

Object Hierarchy

+
    GObject
+    ╰── GInitiallyUnowned
+        ╰── GtkObject
+            ╰── GtkWidget
+                ╰── GtkContainer
+                    ╰── GtkBin
+                        ╰── GtkComboBox
+                            ╰── GimpIntComboBox
+                                ╰── GimpImageComboBox
+
+
+
+

Implemented Interfaces

+

+GimpImageComboBox implements + AtkImplementorIface, GtkBuildable, GtkCellLayout and GtkCellEditable.

+
+
+

Description

+

A widget providing a popup menu of images.

+
+
+

Functions

+
+

GimpImageConstraintFunc ()

+
gboolean
+(*GimpImageConstraintFunc) (gint32 image_id,
+                            gpointer data);
+
+
+
+

gimp_image_combo_box_new ()

+
GtkWidget *
+gimp_image_combo_box_new (GimpImageConstraintFunc constraint,
+                          gpointer data);
+

Creates a new GimpIntComboBox filled with all currently opened +images. If a constraint + function is specified, it is called for +each image and only if the function returns TRUE, the image is +added to the combobox.

+

You should use gimp_int_combo_box_connect() to initialize and +connect the combo. Use gimp_int_combo_box_set_active() to get the +active image ID and gimp_int_combo_box_get_active() to retrieve the +ID of the selected image.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

constraint

a GimpImageConstraintFunc or NULL

 

data

a pointer that is passed to constraint +

 
+
+
+

Returns

+

a new GimpIntComboBox.

+
+

Since: 2.2

+
+
+
+

Types and Values

+
+

GimpImageComboBox

+
typedef struct _GimpImageComboBox GimpImageComboBox;
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/GimpPaletteSelectButton.html b/devel-docs/libgimp/html/GimpPaletteSelectButton.html new file mode 100644 index 0000000..0c92fdd --- /dev/null +++ b/devel-docs/libgimp/html/GimpPaletteSelectButton.html @@ -0,0 +1,324 @@ + + + + +GimpPaletteSelect: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

GimpPaletteSelect

+

GimpPaletteSelect — A button which pops up a palette select dialog.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + +
+GtkWidget * + +gimp_palette_select_button_new () +
const gchar * + +gimp_palette_select_button_get_palette () +
+void + +gimp_palette_select_button_set_palette () +
+
+
+

Properties

+
+++++ + + + + + + + + + + + + +
+gchar *palette-nameRead / Write
+gchar *titleRead / Write / Construct Only
+
+
+

Signals

+
+++++ + + + + + +
voidpalette-setRun First
+
+
+

Types and Values

+
++++ + + + + +
 GimpPaletteSelectButton
+
+
+

Object Hierarchy

+
    GObject
+    ╰── GInitiallyUnowned
+        ╰── GtkObject
+            ╰── GtkWidget
+                ╰── GtkContainer
+                    ╰── GtkBox
+                        ╰── GimpSelectButton
+                            ╰── GimpPaletteSelectButton
+
+
+
+

Implemented Interfaces

+

+GimpPaletteSelectButton implements + AtkImplementorIface, GtkBuildable and GtkOrientable.

+
+
+

Description

+

A button which pops up a palette select dialog.

+
+
+

Functions

+
+

gimp_palette_select_button_new ()

+
GtkWidget *
+gimp_palette_select_button_new (const gchar *title,
+                                const gchar *palette_name);
+

Creates a new GtkWidget that completely controls the selection of +a palette. This widget is suitable for placement in a table in a +plug-in dialog.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

title

Title of the dialog to use or NULL to use the default title.

 

palette_name

Initial palette name.

 
+
+
+

Returns

+

A GtkWidget that you can use in your UI.

+
+

Since: 2.4

+
+
+
+

gimp_palette_select_button_get_palette ()

+
const gchar *
+gimp_palette_select_button_get_palette
+                               (GimpPaletteSelectButton *button);
+

Retrieves the name of currently selected palette.

+
+

Parameters

+
+++++ + + + + + +

button

A GimpPaletteSelectButton

 
+
+
+

Returns

+

an internal copy of the palette name which must not be freed.

+
+

Since: 2.4

+
+
+
+

gimp_palette_select_button_set_palette ()

+
void
+gimp_palette_select_button_set_palette
+                               (GimpPaletteSelectButton *button,
+                                const gchar *palette_name);
+

Sets the current palette for the palette select button.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

button

A GimpPaletteSelectButton

 

palette_name

Palette name to set; NULL means no change.

 
+
+

Since: 2.4

+
+
+
+

Types and Values

+
+

GimpPaletteSelectButton

+
typedef struct _GimpPaletteSelectButton GimpPaletteSelectButton;
+
+
+
+

Property Details

+
+

The “palette-name” property

+
  “palette-name”             gchar *
+

The name of the currently selected palette.

+

Owner: GimpPaletteSelectButton

+

Flags: Read / Write

+

Default value: NULL

+

Since: 2.4

+
+
+
+

The “title” property

+
  “title”                    gchar *
+

The title to be used for the palette selection popup dialog.

+

Owner: GimpPaletteSelectButton

+

Flags: Read / Write / Construct Only

+

Default value: "Palette Selection"

+

Since: 2.4

+
+
+
+

Signal Details

+
+

The “palette-set” signal

+
void
+user_function (GimpPaletteSelectButton *widget,
+               gchar                   *palette_name,
+               gboolean                 dialog_closing,
+               gpointer                 user_data)
+

The ::palette-set signal is emitted when the user selects a palette.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

widget

the object which received the signal.

 

palette_name

the name of the currently selected palette.

 

dialog_closing

whether the dialog was closed or not.

 

user_data

user data set when the signal handler was connected.

 
+
+

Flags: Run First

+

Since: 2.4

+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/GimpPatternSelectButton.html b/devel-docs/libgimp/html/GimpPatternSelectButton.html new file mode 100644 index 0000000..a835b1f --- /dev/null +++ b/devel-docs/libgimp/html/GimpPatternSelectButton.html @@ -0,0 +1,348 @@ + + + + +GimpPatternSelectButton: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

GimpPatternSelectButton

+

GimpPatternSelectButton — A button which pops up a pattern select dialog.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + +
+GtkWidget * + +gimp_pattern_select_button_new () +
const gchar * + +gimp_pattern_select_button_get_pattern () +
+void + +gimp_pattern_select_button_set_pattern () +
+
+
+

Properties

+
+++++ + + + + + + + + + + + + +
+gchar *pattern-nameRead / Write
+gchar *titleRead / Write / Construct Only
+
+
+

Signals

+
+++++ + + + + + +
voidpattern-setRun First
+
+
+

Types and Values

+
++++ + + + + +
 GimpPatternSelectButton
+
+
+

Object Hierarchy

+
    GObject
+    ╰── GInitiallyUnowned
+        ╰── GtkObject
+            ╰── GtkWidget
+                ╰── GtkContainer
+                    ╰── GtkBox
+                        ╰── GimpSelectButton
+                            ╰── GimpPatternSelectButton
+
+
+
+

Implemented Interfaces

+

+GimpPatternSelectButton implements + AtkImplementorIface, GtkBuildable and GtkOrientable.

+
+
+

Description

+

A button which pops up a pattern select dialog.

+
+
+

Functions

+
+

gimp_pattern_select_button_new ()

+
GtkWidget *
+gimp_pattern_select_button_new (const gchar *title,
+                                const gchar *pattern_name);
+

Creates a new GtkWidget that completely controls the selection of +a pattern. This widget is suitable for placement in a table in a +plug-in dialog.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

title

Title of the dialog to use or NULL to use the default title.

 

pattern_name

Initial pattern name or NULL to use current selection.

 
+
+
+

Returns

+

A GtkWidget that you can use in your UI.

+
+

Since: 2.4

+
+
+
+

gimp_pattern_select_button_get_pattern ()

+
const gchar *
+gimp_pattern_select_button_get_pattern
+                               (GimpPatternSelectButton *button);
+

Retrieves the name of currently selected pattern.

+
+

Parameters

+
+++++ + + + + + +

button

A GimpPatternSelectButton

 
+
+
+

Returns

+

an internal copy of the pattern name which must not be freed.

+
+

Since: 2.4

+
+
+
+

gimp_pattern_select_button_set_pattern ()

+
void
+gimp_pattern_select_button_set_pattern
+                               (GimpPatternSelectButton *button,
+                                const gchar *pattern_name);
+

Sets the current pattern for the pattern select button.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

button

A GimpPatternSelectButton

 

pattern_name

Pattern name to set; NULL means no change.

 
+
+

Since: 2.4

+
+
+
+

Types and Values

+
+

GimpPatternSelectButton

+
typedef struct _GimpPatternSelectButton GimpPatternSelectButton;
+
+
+
+

Property Details

+
+

The “pattern-name” property

+
  “pattern-name”             gchar *
+

The name of the currently selected pattern.

+

Owner: GimpPatternSelectButton

+

Flags: Read / Write

+

Default value: NULL

+

Since: 2.4

+
+
+
+

The “title” property

+
  “title”                    gchar *
+

The title to be used for the pattern selection popup dialog.

+

Owner: GimpPatternSelectButton

+

Flags: Read / Write / Construct Only

+

Default value: "Pattern Selection"

+

Since: 2.4

+
+
+
+

Signal Details

+
+

The “pattern-set” signal

+
void
+user_function (GimpPatternSelectButton *widget,
+               gchar                   *pattern_name,
+               gint                     width,
+               gint                     height,
+               gint                     bpp,
+               gpointer                 mask_data,
+               gboolean                 dialog_closing,
+               gpointer                 user_data)
+

The ::pattern-set signal is emitted when the user selects a pattern.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

widget

the object which received the signal.

 

pattern_name

the name of the currently selected pattern.

 

width

width of the pattern

 

height

height of the pattern

 

bpp

bpp of the pattern

 

mask_data

pattern mask data

 

dialog_closing

whether the dialog was closed or not.

 

user_data

user data set when the signal handler was connected.

 
+
+

Flags: Run First

+

Since: 2.4

+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/GimpProcBrowserDialog.html b/devel-docs/libgimp/html/GimpProcBrowserDialog.html new file mode 100644 index 0000000..1f7aeaa --- /dev/null +++ b/devel-docs/libgimp/html/GimpProcBrowserDialog.html @@ -0,0 +1,282 @@ + + + + +GimpProcBrowserDialog: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

GimpProcBrowserDialog

+

GimpProcBrowserDialog — The dialog for the procedure and plugin browsers.

+
+
+

Functions

+
++++ + + + + + + + + + + +
+GtkWidget * + +gimp_proc_browser_dialog_new () +
+gchar * + +gimp_proc_browser_dialog_get_selected () +
+
+
+

Signals

+
+++++ + + + + + + + + + + + + +
voidrow-activatedRun Last
voidselection-changedRun Last
+
+
+

Types and Values

+
++++ + + + + +
 GimpProcBrowserDialog
+
+
+

Object Hierarchy

+
    GObject
+    ╰── GInitiallyUnowned
+        ╰── GtkObject
+            ╰── GtkWidget
+                ╰── GtkContainer
+                    ╰── GtkBin
+                        ╰── GtkWindow
+                            ╰── GtkDialog
+                                ╰── GimpDialog
+                                    ╰── GimpProcBrowserDialog
+
+
+
+

Implemented Interfaces

+

+GimpProcBrowserDialog implements + AtkImplementorIface and GtkBuildable.

+
+
+

Description

+

The dialog for the procedure and plugin browsers.

+
+
+

Functions

+
+

gimp_proc_browser_dialog_new ()

+
GtkWidget *
+gimp_proc_browser_dialog_new (const gchar *title,
+                              const gchar *role,
+                              GimpHelpFunc help_func,
+                              const gchar *help_id,
+                              ...);
+

Create a new GimpProcBrowserDialog.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

title

The dialog's title.

 

role

The dialog's role, see gtk_window_set_role().

 

help_func

The function which will be called if the user presses "F1".

 

help_id

The help_id which will be passed to help_func +.

 

...

A NULL-terminated list destribing the action_area buttons.

 
+
+
+

Returns

+

a newly created GimpProcBrowserDialog.

+
+

Since: 2.4

+
+
+
+

gimp_proc_browser_dialog_get_selected ()

+
gchar *
+gimp_proc_browser_dialog_get_selected (GimpProcBrowserDialog *dialog);
+

Retrieves the name of the currently selected procedure.

+
+

Parameters

+
+++++ + + + + + +

dialog

a GimpProcBrowserDialog

 
+
+
+

Returns

+

The name of the selected procedure of NULL if no +procedure is selected.

+
+

Since: 2.4

+
+
+
+

Types and Values

+
+

GimpProcBrowserDialog

+
typedef struct _GimpProcBrowserDialog GimpProcBrowserDialog;
+
+
+
+

Signal Details

+
+

The “row-activated” signal

+
void
+user_function (GimpProcBrowserDialog *dialog,
+               gpointer               user_data)
+

Emitted when one of the rows in the contained GtkTreeView is activated.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

dialog

the object that received the signal

 

user_data

user data set when the signal handler was connected.

 
+
+

Flags: Run Last

+
+
+
+

The “selection-changed” signal

+
void
+user_function (GimpProcBrowserDialog *dialog,
+               gpointer               user_data)
+

Emitted when the selection in the contained GtkTreeView changes.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

dialog

the object that received the signal

 

user_data

user data set when the signal handler was connected.

 
+
+

Flags: Run Last

+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/GimpProgressBar.html b/devel-docs/libgimp/html/GimpProgressBar.html new file mode 100644 index 0000000..050eb45 --- /dev/null +++ b/devel-docs/libgimp/html/GimpProgressBar.html @@ -0,0 +1,113 @@ + + + + +GimpProgressBar: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

GimpProgressBar

+

GimpProgressBar — A widget providing a progress bar.

+
+
+

Functions

+
++++ + + + + +
+GtkWidget * + +gimp_progress_bar_new () +
+
+
+

Types and Values

+
++++ + + + + +
 GimpProgressBar
+
+
+

Object Hierarchy

+
    GObject
+    ╰── GInitiallyUnowned
+        ╰── GtkObject
+            ╰── GtkWidget
+                ╰── GtkProgress
+                    ╰── GtkProgressBar
+                        ╰── GimpProgressBar
+
+
+
+

Implemented Interfaces

+

+GimpProgressBar implements + AtkImplementorIface and GtkBuildable.

+
+
+

Description

+

A widget providing a progress bar that automatically redirects any +progress calls to itself.

+
+
+

Functions

+
+

gimp_progress_bar_new ()

+
GtkWidget *
+gimp_progress_bar_new (void);
+

Creates a new GimpProgressBar widget.

+
+

Returns

+

the new widget.

+
+

Since: 2.2

+
+
+
+

Types and Values

+
+

GimpProgressBar

+
typedef struct _GimpProgressBar GimpProgressBar;
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/GimpSelectButton.html b/devel-docs/libgimp/html/GimpSelectButton.html new file mode 100644 index 0000000..80aa9ff --- /dev/null +++ b/devel-docs/libgimp/html/GimpSelectButton.html @@ -0,0 +1,130 @@ + + + + +GimpSelectButton: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

GimpSelectButton

+

GimpSelectButton — The base class of the data select buttons.

+
+
+

Functions

+
++++ + + + + +
+void + +gimp_select_button_close_popup () +
+
+
+

Types and Values

+
++++ + + + + +
 GimpSelectButton
+
+
+

Object Hierarchy

+
    GObject
+    ╰── GInitiallyUnowned
+        ╰── GtkObject
+            ╰── GtkWidget
+                ╰── GtkContainer
+                    ╰── GtkBox
+                        ╰── GimpSelectButton
+                            ├── GimpBrushSelectButton
+                            ├── GimpFontSelectButton
+                            ├── GimpGradientSelectButton
+                            ├── GimpPaletteSelectButton
+                            ╰── GimpPatternSelectButton
+
+
+
+

Implemented Interfaces

+

+GimpSelectButton implements + AtkImplementorIface, GtkBuildable and GtkOrientable.

+
+
+

Description

+

The base class of the brush, pattern, gradient, palette and font +select buttons.

+
+
+

Functions

+
+

gimp_select_button_close_popup ()

+
void
+gimp_select_button_close_popup (GimpSelectButton *button);
+

Closes the popup window associated with button +.

+
+

Parameters

+
+++++ + + + + + +

button

A GimpSelectButton

 
+
+

Since: 2.4

+
+
+
+

Types and Values

+
+

GimpSelectButton

+
typedef struct _GimpSelectButton GimpSelectButton;
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/GimpZoomPreview.html b/devel-docs/libgimp/html/GimpZoomPreview.html new file mode 100644 index 0000000..7597e17 --- /dev/null +++ b/devel-docs/libgimp/html/GimpZoomPreview.html @@ -0,0 +1,550 @@ + + + + +GimpZoomPreview: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

GimpZoomPreview

+

GimpZoomPreview — A drawable preview with zooming capabilities.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+GtkWidget * + +gimp_zoom_preview_new () +
+GtkWidget * + +gimp_zoom_preview_new_from_drawable_id () +
+GtkWidget * + +gimp_zoom_preview_new_with_model_from_drawable_id () +
+GtkWidget * + +gimp_zoom_preview_new_with_model () +
+guchar * + +gimp_zoom_preview_get_source () +
+GimpDrawable * + +gimp_zoom_preview_get_drawable () +
+gint32 + +gimp_zoom_preview_get_drawable_id () +
+gdouble + +gimp_zoom_preview_get_factor () +
+GimpZoomModel * + +gimp_zoom_preview_get_model () +
+
+
+

Properties

+
+++++ + + + + + + + + + + + + + + + + + +
gpointerdrawableRead / Write / Construct Only
gintdrawable-idRead / Write / Construct Only
+GimpZoomModel *modelRead / Write / Construct Only
+
+
+

Types and Values

+
++++ + + + + +
 GimpZoomPreview
+
+
+

Object Hierarchy

+
    GObject
+    ╰── GInitiallyUnowned
+        ╰── GtkObject
+            ╰── GtkWidget
+                ╰── GtkContainer
+                    ╰── GtkBox
+                        ╰── GimpPreview
+                            ╰── GimpScrolledPreview
+                                ╰── GimpZoomPreview
+
+
+
+

Implemented Interfaces

+

+GimpZoomPreview implements + AtkImplementorIface, GtkBuildable and GtkOrientable.

+
+
+

Description

+

A drawable preview with zooming capabilities.

+
+
+

Functions

+
+

gimp_zoom_preview_new ()

+
GtkWidget *
+gimp_zoom_preview_new (GimpDrawable *drawable);
+
+

gimp_zoom_preview_new has been deprecated since version 2.10 and should not be used in newly-written code.

+

Use gimp_zoom_preview_new_from_drawable_id() instead.

+
+

Creates a new GimpZoomPreview widget for drawable +.

+
+

Parameters

+
+++++ + + + + + +

drawable

a GimpDrawable

 
+
+
+

Returns

+

a new GimpZoomPreview.

+
+

Since: 2.4

+
+
+
+

gimp_zoom_preview_new_from_drawable_id ()

+
GtkWidget *
+gimp_zoom_preview_new_from_drawable_id
+                               (gint32 drawable_ID);
+

Creates a new GimpZoomPreview widget for drawable_ID +.

+
+

Parameters

+
+++++ + + + + + +

drawable_ID

a drawable ID

 
+
+
+

Returns

+

a new GimpZoomPreview.

+
+

Since: 2.10

+
+
+
+

gimp_zoom_preview_new_with_model_from_drawable_id ()

+
GtkWidget *
+gimp_zoom_preview_new_with_model_from_drawable_id
+                               (gint32 drawable_ID,
+                                GimpZoomModel *model);
+

Creates a new GimpZoomPreview widget for drawable_ID + using the +given model +.

+

This variant of gimp_zoom_preview_new_from_drawable_id() allows you +to create a preview using an existing zoom model. This may be +useful if for example you want to have two zoom previews that keep +their zoom factor in sync.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

drawable_ID

a drawable ID

 

model

a GimpZoomModel

 
+
+
+

Returns

+

a new GimpZoomPreview.

+
+

Since: 2.10

+
+
+
+

gimp_zoom_preview_new_with_model ()

+
GtkWidget *
+gimp_zoom_preview_new_with_model (GimpDrawable *drawable,
+                                  GimpZoomModel *model);
+
+

gimp_zoom_preview_new_with_model has been deprecated since version 2.10 and should not be used in newly-written code.

+

Use gimp_zoom_preview_new_with_model_from_drawable_id() +instead.

+
+

Creates a new GimpZoomPreview widget for drawable + using the +given model +.

+

This variant of gimp_zoom_preview_new() allows you to create a +preview using an existing zoom model. This may be useful if for +example you want to have two zoom previews that keep their zoom +factor in sync.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

drawable

a GimpDrawable

 

model

a GimpZoomModel

 
+
+
+

Returns

+

a new GimpZoomPreview.

+
+

Since: 2.4

+
+
+
+

gimp_zoom_preview_get_source ()

+
guchar *
+gimp_zoom_preview_get_source (GimpZoomPreview *preview,
+                              gint *width,
+                              gint *height,
+                              gint *bpp);
+

Returns the scaled image data of the part of the drawable the +GimpZoomPreview is currently showing, as a newly allocated array of guchar. +This function also allow to get the current width, height and bpp of the +GimpZoomPreview.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

preview

a GimpZoomPreview widget

 

width

a pointer to an int where the current width of the zoom widget +will be put.

 

height

a pointer to an int where the current width of the zoom widget +will be put.

 

bpp

return location for the number of bytes per pixel

 
+
+
+

Returns

+

newly allocated data that should be released using g_free() +when it is not any longer needed

+
+

Since: 2.4

+
+
+
+

gimp_zoom_preview_get_drawable ()

+
GimpDrawable *
+gimp_zoom_preview_get_drawable (GimpZoomPreview *preview);
+
+

gimp_zoom_preview_get_drawable has been deprecated since version 2.10 and should not be used in newly-written code.

+

Use gimp_zoom_preview_get_drawable_id() instead.

+
+

Returns the GimpDrawable the GimpZoomPreview is attached to.

+
+

Parameters

+
+++++ + + + + + +

preview

a GimpZoomPreview widget

 
+
+
+

Returns

+

the GimpDrawable that was passed to gimp_zoom_preview_new().

+
+

Since: 2.4

+
+
+
+

gimp_zoom_preview_get_drawable_id ()

+
gint32
+gimp_zoom_preview_get_drawable_id (GimpZoomPreview *preview);
+

Returns the drawable_ID the GimpZoomPreview is attached to.

+
+

Parameters

+
+++++ + + + + + +

preview

a GimpZoomPreview widget

 
+
+
+

Returns

+

the drawable_ID that was passed to +gimp_zoom_preview_new_from_drawable_id().

+
+

Since: 2.10

+
+
+
+

gimp_zoom_preview_get_factor ()

+
gdouble
+gimp_zoom_preview_get_factor (GimpZoomPreview *preview);
+

Returns the zoom factor the preview is currently using.

+
+

Parameters

+
+++++ + + + + + +

preview

a GimpZoomPreview widget

 
+
+
+

Returns

+

the current zoom factor

+
+

Since: 2.4

+
+
+
+

gimp_zoom_preview_get_model ()

+
GimpZoomModel *
+gimp_zoom_preview_get_model (GimpZoomPreview *preview);
+

Returns the GimpZoomModel the preview is using.

+
+

Parameters

+
+++++ + + + + + +

preview

a GimpZoomPreview widget

 
+
+
+

Returns

+

a pointer to the GimpZoomModel owned by the preview +

+
+

Since: 2.4

+
+
+
+

Types and Values

+
+

GimpZoomPreview

+
typedef struct _GimpZoomPreview GimpZoomPreview;
+
+
+
+

Property Details

+
+

The “drawable” property

+
  “drawable”                 gpointer
+

The drawable the GimpZoomPreview is attached to.

+
+

GimpZoomPreview:drawable is deprecated and should not be used in newly-written code.

+

use the drawable-id property instead.

+
+

Owner: GimpZoomPreview

+

Flags: Read / Write / Construct Only

+

Since: 2.4

+
+
+
+

The “drawable-id” property

+
  “drawable-id”              gint
+

The drawable the GimpZoomPreview is attached to.

+

Owner: GimpZoomPreview

+

Flags: Read / Write / Construct Only

+

Allowed values: >= -1

+

Default value: -1

+

Since: 2.10

+
+
+
+

The “model” property

+
  “model”                    GimpZoomModel *
+

The GimpZoomModel used by this GimpZoomPreview.

+

Owner: GimpZoomPreview

+

Flags: Read / Write / Construct Only

+

Since: 2.4

+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/api-index-full.html b/devel-docs/libgimp/html/api-index-full.html new file mode 100644 index 0000000..d0d1367 --- /dev/null +++ b/devel-docs/libgimp/html/api-index-full.html @@ -0,0 +1,4577 @@ + + + + +Index: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+

+Index

+

A

+
+GIMP_ADDITION_MODE, macro in gimpenums +
+
+
+gimp_airbrush, function in gimppainttools +
+
+
+gimp_airbrush_default, function in gimppainttools +
+
+
+GimpAspectPreview, struct in GimpAspectPreview +
+
+
+GimpAspectPreview:drawable, object property in GimpAspectPreview +
+
+
+GimpAspectPreview:drawable-id, object property in GimpAspectPreview +
+
+
+gimp_aspect_preview_new, function in GimpAspectPreview +
+
+
+gimp_aspect_preview_new_from_drawable_id, function in GimpAspectPreview +
+
+
+gimp_attach_new_parasite, function in gimp +
+
+
+gimp_attach_parasite, function in gimp +
+
+

B

+
+GIMP_BEHIND_MODE, macro in gimpenums +
+
+
+gimp_brightness_contrast, function in gimpcolor +
+
+
+GimpBrushApplicationMode, enum in gimpenums +
+
+
+gimp_brushes_close_popup, function in gimpbrushselect +
+
+
+gimp_brushes_get_brush, function in gimpbrushes +
+
+
+gimp_brushes_get_brush_data, function in gimpbrushes +
+
+
+gimp_brushes_get_list, function in gimpbrushes +
+
+
+gimp_brushes_get_opacity, function in gimpbrushes +
+
+
+gimp_brushes_get_paint_mode, function in gimpbrushes +
+
+
+gimp_brushes_get_spacing, function in gimpbrushes +
+
+
+gimp_brushes_popup, function in gimpbrushselect +
+
+
+gimp_brushes_refresh, function in gimpbrushes +
+
+
+gimp_brushes_set_brush, function in gimpbrushes +
+
+
+gimp_brushes_set_opacity, function in gimpbrushes +
+
+
+gimp_brushes_set_paint_mode, function in gimpbrushes +
+
+
+gimp_brushes_set_popup, function in gimpbrushselect +
+
+
+gimp_brushes_set_spacing, function in gimpbrushes +
+
+
+GimpBrushSelectButton, struct in GimpBrushSelectButton +
+
+
+GimpBrushSelectButton::brush-set, object signal in GimpBrushSelectButton +
+
+
+GimpBrushSelectButton:brush-name, object property in GimpBrushSelectButton +
+
+
+GimpBrushSelectButton:brush-opacity, object property in GimpBrushSelectButton +
+
+
+GimpBrushSelectButton:brush-paint-mode, object property in GimpBrushSelectButton +
+
+
+GimpBrushSelectButton:brush-spacing, object property in GimpBrushSelectButton +
+
+
+GimpBrushSelectButton:title, object property in GimpBrushSelectButton +
+
+
+gimp_brush_delete, function in gimpbrush +
+
+
+gimp_brush_duplicate, function in gimpbrush +
+
+
+gimp_brush_get_angle, function in gimpbrush +
+
+
+gimp_brush_get_aspect_ratio, function in gimpbrush +
+
+
+gimp_brush_get_hardness, function in gimpbrush +
+
+
+gimp_brush_get_info, function in gimpbrush +
+
+
+gimp_brush_get_pixels, function in gimpbrush +
+
+
+gimp_brush_get_radius, function in gimpbrush +
+
+
+gimp_brush_get_shape, function in gimpbrush +
+
+
+gimp_brush_get_spacing, function in gimpbrush +
+
+
+gimp_brush_get_spikes, function in gimpbrush +
+
+
+gimp_brush_is_editable, function in gimpbrush +
+
+
+gimp_brush_is_generated, function in gimpbrush +
+
+
+gimp_brush_new, function in gimpbrush +
+
+
+gimp_brush_rename, function in gimpbrush +
+
+
+gimp_brush_select_button_get_brush, function in GimpBrushSelectButton +
+
+
+gimp_brush_select_button_new, function in GimpBrushSelectButton +
+
+
+gimp_brush_select_button_set_brush, function in GimpBrushSelectButton +
+
+
+gimp_brush_select_destroy, function in gimpbrushselect +
+
+
+gimp_brush_select_new, function in gimpbrushselect +
+
+
+gimp_brush_select_widget_close, function in gimpbrushmenu +
+
+
+gimp_brush_select_widget_new, function in gimpbrushmenu +
+
+
+gimp_brush_select_widget_set, function in gimpbrushmenu +
+
+
+gimp_brush_set_angle, function in gimpbrush +
+
+
+gimp_brush_set_aspect_ratio, function in gimpbrush +
+
+
+gimp_brush_set_hardness, function in gimpbrush +
+
+
+gimp_brush_set_radius, function in gimpbrush +
+
+
+gimp_brush_set_shape, function in gimpbrush +
+
+
+gimp_brush_set_spacing, function in gimpbrush +
+
+
+gimp_brush_set_spikes, function in gimpbrush +
+
+
+gimp_buffers_get_list, function in gimpbuffer +
+
+
+gimp_buffer_delete, function in gimpbuffer +
+
+
+gimp_buffer_get_bytes, function in gimpbuffer +
+
+
+gimp_buffer_get_height, function in gimpbuffer +
+
+
+gimp_buffer_get_image_type, function in gimpbuffer +
+
+
+gimp_buffer_get_width, function in gimpbuffer +
+
+
+gimp_buffer_rename, function in gimpbuffer +
+
+
+GIMP_BURN_MODE, macro in gimpenums +
+
+
+gimp_by_color_select, function in gimpselectiontools +
+
+
+gimp_by_color_select_full, function in gimpselectiontools +
+
+

C

+
+GimpChannelComboBox, struct in GimpItemComboBox +
+
+
+gimp_channel_combine_masks, function in gimpchannel +
+
+
+gimp_channel_combo_box_new, function in GimpItemComboBox +
+
+
+gimp_channel_copy, function in gimpchannel +
+
+
+gimp_channel_get_color, function in gimpchannel +
+
+
+gimp_channel_get_opacity, function in gimpchannel +
+
+
+gimp_channel_get_show_masked, function in gimpchannel +
+
+
+gimp_channel_menu_new, function in gimpmenu +
+
+
+gimp_channel_new, function in gimpchannel +
+
+
+gimp_channel_new_from_component, function in gimpchannel +
+
+
+gimp_channel_set_color, function in gimpchannel +
+
+
+gimp_channel_set_opacity, function in gimpchannel +
+
+
+gimp_channel_set_show_masked, function in gimpchannel +
+
+
+gimp_check_size, function in gimp +
+
+
+gimp_check_type, function in gimp +
+
+
+gimp_clone, function in gimppainttools +
+
+
+gimp_clone_default, function in gimppainttools +
+
+
+gimp_colorize, function in gimpcolor +
+
+
+gimp_color_balance, function in gimpcolor +
+
+
+GIMP_COLOR_ERASE_MODE, macro in gimpenums +
+
+
+GIMP_COLOR_MODE, macro in gimpenums +
+
+
+GimpConstraintFunc, user_function in gimpmenu +
+
+
+gimp_context_get_antialias, function in gimpcontext +
+
+
+gimp_context_get_background, function in gimpcontext +
+
+
+gimp_context_get_brush, function in gimpcontext +
+
+
+gimp_context_get_brush_angle, function in gimpcontext +
+
+
+gimp_context_get_brush_aspect_ratio, function in gimpcontext +
+
+
+gimp_context_get_brush_force, function in gimpcontext +
+
+
+gimp_context_get_brush_hardness, function in gimpcontext +
+
+
+gimp_context_get_brush_size, function in gimpcontext +
+
+
+gimp_context_get_brush_spacing, function in gimpcontext +
+
+
+gimp_context_get_diagonal_neighbors, function in gimpcontext +
+
+
+gimp_context_get_distance_metric, function in gimpcontext +
+
+
+gimp_context_get_dynamics, function in gimpcontext +
+
+
+gimp_context_get_feather, function in gimpcontext +
+
+
+gimp_context_get_feather_radius, function in gimpcontext +
+
+
+gimp_context_get_font, function in gimpcontext +
+
+
+gimp_context_get_foreground, function in gimpcontext +
+
+
+gimp_context_get_gradient, function in gimpcontext +
+
+
+gimp_context_get_gradient_blend_color_space, function in gimpcontext +
+
+
+gimp_context_get_gradient_repeat_mode, function in gimpcontext +
+
+
+gimp_context_get_gradient_reverse, function in gimpcontext +
+
+
+gimp_context_get_ink_angle, function in gimpcontext +
+
+
+gimp_context_get_ink_blob_angle, function in gimpcontext +
+
+
+gimp_context_get_ink_blob_aspect_ratio, function in gimpcontext +
+
+
+gimp_context_get_ink_blob_type, function in gimpcontext +
+
+
+gimp_context_get_ink_size, function in gimpcontext +
+
+
+gimp_context_get_ink_size_sensitivity, function in gimpcontext +
+
+
+gimp_context_get_ink_speed_sensitivity, function in gimpcontext +
+
+
+gimp_context_get_ink_tilt_sensitivity, function in gimpcontext +
+
+
+gimp_context_get_interpolation, function in gimpcontext +
+
+
+gimp_context_get_line_cap_style, function in gimpcontext +
+
+
+gimp_context_get_line_dash_offset, function in gimpcontext +
+
+
+gimp_context_get_line_dash_pattern, function in gimpcontext +
+
+
+gimp_context_get_line_join_style, function in gimpcontext +
+
+
+gimp_context_get_line_miter_limit, function in gimpcontext +
+
+
+gimp_context_get_line_width, function in gimpcontext +
+
+
+gimp_context_get_line_width_unit, function in gimpcontext +
+
+
+gimp_context_get_mypaint_brush, function in gimpcontext +
+
+
+gimp_context_get_opacity, function in gimpcontext +
+
+
+gimp_context_get_paint_method, function in gimpcontext +
+
+
+gimp_context_get_paint_mode, function in gimpcontext +
+
+
+gimp_context_get_palette, function in gimpcontext +
+
+
+gimp_context_get_pattern, function in gimpcontext +
+
+
+gimp_context_get_sample_criterion, function in gimpcontext +
+
+
+gimp_context_get_sample_merged, function in gimpcontext +
+
+
+gimp_context_get_sample_threshold, function in gimpcontext +
+
+
+gimp_context_get_sample_threshold_int, function in gimpcontext +
+
+
+gimp_context_get_sample_transparent, function in gimpcontext +
+
+
+gimp_context_get_stroke_method, function in gimpcontext +
+
+
+gimp_context_get_transform_direction, function in gimpcontext +
+
+
+gimp_context_get_transform_recursion, function in gimpcontext +
+
+
+gimp_context_get_transform_resize, function in gimpcontext +
+
+
+gimp_context_list_paint_methods, function in gimpcontext +
+
+
+gimp_context_pop, function in gimpcontext +
+
+
+gimp_context_push, function in gimpcontext +
+
+
+gimp_context_set_antialias, function in gimpcontext +
+
+
+gimp_context_set_background, function in gimpcontext +
+
+
+gimp_context_set_brush, function in gimpcontext +
+
+
+gimp_context_set_brush_angle, function in gimpcontext +
+
+
+gimp_context_set_brush_aspect_ratio, function in gimpcontext +
+
+
+gimp_context_set_brush_default_hardness, function in gimpcontext +
+
+
+gimp_context_set_brush_default_size, function in gimpcontext +
+
+
+gimp_context_set_brush_default_spacing, function in gimpcontext +
+
+
+gimp_context_set_brush_force, function in gimpcontext +
+
+
+gimp_context_set_brush_hardness, function in gimpcontext +
+
+
+gimp_context_set_brush_size, function in gimpcontext +
+
+
+gimp_context_set_brush_spacing, function in gimpcontext +
+
+
+gimp_context_set_defaults, function in gimpcontext +
+
+
+gimp_context_set_default_colors, function in gimpcontext +
+
+
+gimp_context_set_diagonal_neighbors, function in gimpcontext +
+
+
+gimp_context_set_distance_metric, function in gimpcontext +
+
+
+gimp_context_set_dynamics, function in gimpcontext +
+
+
+gimp_context_set_feather, function in gimpcontext +
+
+
+gimp_context_set_feather_radius, function in gimpcontext +
+
+
+gimp_context_set_font, function in gimpcontext +
+
+
+gimp_context_set_foreground, function in gimpcontext +
+
+
+gimp_context_set_gradient, function in gimpcontext +
+
+
+gimp_context_set_gradient_blend_color_space, function in gimpcontext +
+
+
+gimp_context_set_gradient_fg_bg_hsv_ccw, function in gimpcontext +
+
+
+gimp_context_set_gradient_fg_bg_hsv_cw, function in gimpcontext +
+
+
+gimp_context_set_gradient_fg_bg_rgb, function in gimpcontext +
+
+
+gimp_context_set_gradient_fg_transparent, function in gimpcontext +
+
+
+gimp_context_set_gradient_repeat_mode, function in gimpcontext +
+
+
+gimp_context_set_gradient_reverse, function in gimpcontext +
+
+
+gimp_context_set_ink_angle, function in gimpcontext +
+
+
+gimp_context_set_ink_blob_angle, function in gimpcontext +
+
+
+gimp_context_set_ink_blob_aspect_ratio, function in gimpcontext +
+
+
+gimp_context_set_ink_blob_type, function in gimpcontext +
+
+
+gimp_context_set_ink_size, function in gimpcontext +
+
+
+gimp_context_set_ink_size_sensitivity, function in gimpcontext +
+
+
+gimp_context_set_ink_speed_sensitivity, function in gimpcontext +
+
+
+gimp_context_set_ink_tilt_sensitivity, function in gimpcontext +
+
+
+gimp_context_set_interpolation, function in gimpcontext +
+
+
+gimp_context_set_line_cap_style, function in gimpcontext +
+
+
+gimp_context_set_line_dash_offset, function in gimpcontext +
+
+
+gimp_context_set_line_dash_pattern, function in gimpcontext +
+
+
+gimp_context_set_line_join_style, function in gimpcontext +
+
+
+gimp_context_set_line_miter_limit, function in gimpcontext +
+
+
+gimp_context_set_line_width, function in gimpcontext +
+
+
+gimp_context_set_line_width_unit, function in gimpcontext +
+
+
+gimp_context_set_mypaint_brush, function in gimpcontext +
+
+
+gimp_context_set_opacity, function in gimpcontext +
+
+
+gimp_context_set_paint_method, function in gimpcontext +
+
+
+gimp_context_set_paint_mode, function in gimpcontext +
+
+
+gimp_context_set_palette, function in gimpcontext +
+
+
+gimp_context_set_pattern, function in gimpcontext +
+
+
+gimp_context_set_sample_criterion, function in gimpcontext +
+
+
+gimp_context_set_sample_merged, function in gimpcontext +
+
+
+gimp_context_set_sample_threshold, function in gimpcontext +
+
+
+gimp_context_set_sample_threshold_int, function in gimpcontext +
+
+
+gimp_context_set_sample_transparent, function in gimpcontext +
+
+
+gimp_context_set_stroke_method, function in gimpcontext +
+
+
+gimp_context_set_transform_direction, function in gimpcontext +
+
+
+gimp_context_set_transform_recursion, function in gimpcontext +
+
+
+gimp_context_set_transform_resize, function in gimpcontext +
+
+
+gimp_context_swap_colors, function in gimpcontext +
+
+
+GimpConvertDitherType, enum in gimpenums +
+
+
+gimp_convolve, function in gimppainttools +
+
+
+gimp_convolve_default, function in gimppainttools +
+
+
+gimp_curves_explicit, function in gimpcolor +
+
+
+gimp_curves_spline, function in gimpcolor +
+
+

D

+
+GIMP_DARKEN_ONLY_MODE, macro in gimpenums +
+
+
+gimp_debug_timer_end, function in gimpdebug +
+
+
+gimp_debug_timer_start, function in gimpdebug +
+
+
+gimp_default_display, function in gimp +
+
+
+gimp_desaturate, function in gimpcolor +
+
+
+gimp_desaturate_full, function in gimpcolor +
+
+
+gimp_destroy_paramdefs, function in gimp +
+
+
+gimp_destroy_params, function in gimp +
+
+
+gimp_detach_parasite, function in gimp +
+
+
+GIMP_DIFFERENCE_MODE, macro in gimpenums +
+
+
+gimp_displays_flush, function in gimpdisplay +
+
+
+gimp_displays_reconnect, function in gimpdisplay +
+
+
+gimp_display_delete, function in gimpdisplay +
+
+
+gimp_display_get_window_handle, function in gimpdisplay +
+
+
+gimp_display_is_valid, function in gimpdisplay +
+
+
+gimp_display_name, function in gimp +
+
+
+gimp_display_new, function in gimpdisplay +
+
+
+GIMP_DISSOLVE_MODE, macro in gimpenums +
+
+
+GIMP_DIVIDE_MODE, macro in gimpenums +
+
+
+gimp_dodgeburn, function in gimppainttools +
+
+
+gimp_dodgeburn_default, function in gimppainttools +
+
+
+GIMP_DODGE_MODE, macro in gimpenums +
+
+
+GimpDrawable, struct in gimpdrawable +
+
+
+GimpDrawableComboBox, struct in GimpItemComboBox +
+
+
+GimpDrawableConstraintFunc, typedef in GimpItemComboBox +
+
+
+GimpDrawablePreview, struct in GimpDrawablePreview +
+
+
+GimpDrawablePreview:drawable, object property in GimpDrawablePreview +
+
+
+GimpDrawablePreview:drawable-id, object property in GimpDrawablePreview +
+
+
+gimp_drawable_attach_new_parasite, function in gimpdrawable +
+
+
+gimp_drawable_bpp, function in gimpdrawable +
+
+
+gimp_drawable_brightness_contrast, function in gimpdrawablecolor +
+
+
+gimp_drawable_colorize_hsl, function in gimpdrawablecolor +
+
+
+gimp_drawable_color_balance, function in gimpdrawablecolor +
+
+
+gimp_drawable_combo_box_new, function in GimpItemComboBox +
+
+
+gimp_drawable_curves_explicit, function in gimpdrawablecolor +
+
+
+gimp_drawable_curves_spline, function in gimpdrawablecolor +
+
+
+gimp_drawable_delete, function in gimpdrawable +
+
+
+gimp_drawable_desaturate, function in gimpdrawablecolor +
+
+
+gimp_drawable_detach, function in gimpdrawable +
+
+
+gimp_drawable_edit_bucket_fill, function in gimpdrawableedit +
+
+
+gimp_drawable_edit_clear, function in gimpdrawableedit +
+
+
+gimp_drawable_edit_fill, function in gimpdrawableedit +
+
+
+gimp_drawable_edit_gradient_fill, function in gimpdrawableedit +
+
+
+gimp_drawable_edit_stroke_item, function in gimpdrawableedit +
+
+
+gimp_drawable_edit_stroke_selection, function in gimpdrawableedit +
+
+
+gimp_drawable_equalize, function in gimpdrawablecolor +
+
+
+gimp_drawable_fill, function in gimpdrawable +
+
+
+gimp_drawable_flush, function in gimpdrawable +
+
+
+gimp_drawable_foreground_extract, function in gimpdrawable +
+
+
+gimp_drawable_free_shadow, function in gimpdrawable +
+
+
+gimp_drawable_get, function in gimpdrawable +
+
+
+gimp_drawable_get_buffer, function in gimpdrawable +
+
+
+gimp_drawable_get_color_uchar, function in gimpdrawable +
+
+
+gimp_drawable_get_format, function in gimpdrawable +
+
+
+gimp_drawable_get_image, function in gimpdrawable +
+
+
+gimp_drawable_get_linked, function in gimpdrawable +
+
+
+gimp_drawable_get_name, function in gimpdrawable +
+
+
+gimp_drawable_get_pixel, function in gimpdrawable +
+
+
+gimp_drawable_get_shadow_buffer, function in gimpdrawable +
+
+
+gimp_drawable_get_sub_thumbnail, function in gimppixbuf +
+
+
+gimp_drawable_get_sub_thumbnail_data, function in gimpdrawable +
+
+
+gimp_drawable_get_tattoo, function in gimpdrawable +
+
+
+gimp_drawable_get_thumbnail, function in gimppixbuf +
+
+
+gimp_drawable_get_thumbnail_data, function in gimpdrawable +
+
+
+gimp_drawable_get_thumbnail_format, function in gimpdrawable +
+
+
+gimp_drawable_get_tile, function in gimpdrawable +
+
+
+gimp_drawable_get_tile2, function in gimpdrawable +
+
+
+gimp_drawable_get_visible, function in gimpdrawable +
+
+
+gimp_drawable_has_alpha, function in gimpdrawable +
+
+
+gimp_drawable_height, function in gimpdrawable +
+
+
+gimp_drawable_histogram, function in gimpdrawablecolor +
+
+
+gimp_drawable_hue_saturation, function in gimpdrawablecolor +
+
+
+gimp_drawable_invert, function in gimpdrawablecolor +
+
+
+gimp_drawable_is_channel, function in gimpdrawable +
+
+
+gimp_drawable_is_gray, function in gimpdrawable +
+
+
+gimp_drawable_is_indexed, function in gimpdrawable +
+
+
+gimp_drawable_is_layer, function in gimpdrawable +
+
+
+gimp_drawable_is_layer_mask, function in gimpdrawable +
+
+
+gimp_drawable_is_rgb, function in gimpdrawable +
+
+
+gimp_drawable_is_text_layer, function in gimpdrawable +
+
+
+gimp_drawable_is_valid, function in gimpdrawable +
+
+
+gimp_drawable_levels, function in gimpdrawablecolor +
+
+
+gimp_drawable_levels_stretch, function in gimpdrawablecolor +
+
+
+gimp_drawable_mask_bounds, function in gimpdrawable +
+
+
+gimp_drawable_mask_intersect, function in gimpdrawable +
+
+
+gimp_drawable_menu_new, function in gimpmenu +
+
+
+gimp_drawable_merge_shadow, function in gimpdrawable +
+
+
+gimp_drawable_offset, function in gimpdrawable +
+
+
+gimp_drawable_offsets, function in gimpdrawable +
+
+
+gimp_drawable_parasite_attach, function in gimpdrawable +
+
+
+gimp_drawable_parasite_detach, function in gimpdrawable +
+
+
+gimp_drawable_parasite_find, function in gimpdrawable +
+
+
+gimp_drawable_parasite_list, function in gimpdrawable +
+
+
+gimp_drawable_posterize, function in gimpdrawablecolor +
+
+
+gimp_drawable_preview_draw_region, function in GimpDrawablePreview +
+
+
+gimp_drawable_preview_get_drawable, function in GimpDrawablePreview +
+
+
+gimp_drawable_preview_get_drawable_id, function in GimpDrawablePreview +
+
+
+gimp_drawable_preview_new, function in GimpDrawablePreview +
+
+
+gimp_drawable_preview_new_from_drawable_id, function in GimpDrawablePreview +
+
+
+gimp_drawable_set_image, function in gimpdrawable +
+
+
+gimp_drawable_set_linked, function in gimpdrawable +
+
+
+gimp_drawable_set_name, function in gimpdrawable +
+
+
+gimp_drawable_set_pixel, function in gimpdrawable +
+
+
+gimp_drawable_set_tattoo, function in gimpdrawable +
+
+
+gimp_drawable_set_visible, function in gimpdrawable +
+
+
+gimp_drawable_threshold, function in gimpdrawablecolor +
+
+
+gimp_drawable_transform_2d, function in gimpdrawabletransform +
+
+
+gimp_drawable_transform_2d_default, function in gimpdrawabletransform +
+
+
+gimp_drawable_transform_flip, function in gimpdrawabletransform +
+
+
+gimp_drawable_transform_flip_default, function in gimpdrawabletransform +
+
+
+gimp_drawable_transform_flip_simple, function in gimpdrawabletransform +
+
+
+gimp_drawable_transform_matrix, function in gimpdrawabletransform +
+
+
+gimp_drawable_transform_matrix_default, function in gimpdrawabletransform +
+
+
+gimp_drawable_transform_perspective, function in gimpdrawabletransform +
+
+
+gimp_drawable_transform_perspective_default, function in gimpdrawabletransform +
+
+
+gimp_drawable_transform_rotate, function in gimpdrawabletransform +
+
+
+gimp_drawable_transform_rotate_default, function in gimpdrawabletransform +
+
+
+gimp_drawable_transform_rotate_simple, function in gimpdrawabletransform +
+
+
+gimp_drawable_transform_scale, function in gimpdrawabletransform +
+
+
+gimp_drawable_transform_scale_default, function in gimpdrawabletransform +
+
+
+gimp_drawable_transform_shear, function in gimpdrawabletransform +
+
+
+gimp_drawable_transform_shear_default, function in gimpdrawabletransform +
+
+
+gimp_drawable_type, function in gimpdrawable +
+
+
+gimp_drawable_type_with_alpha, function in gimpdrawable +
+
+
+gimp_drawable_update, function in gimpdrawable +
+
+
+gimp_drawable_width, function in gimpdrawable +
+
+
+gimp_dynamics_get_list, function in gimpdynamics +
+
+
+gimp_dynamics_refresh, function in gimpdynamics +
+
+

E

+
+gimp_edit_blend, function in gimpedit +
+
+
+gimp_edit_bucket_fill, function in gimpedit +
+
+
+gimp_edit_bucket_fill_full, function in gimppainttools +
+
+
+gimp_edit_clear, function in gimpedit +
+
+
+gimp_edit_copy, function in gimpedit +
+
+
+gimp_edit_copy_visible, function in gimpedit +
+
+
+gimp_edit_cut, function in gimpedit +
+
+
+gimp_edit_fill, function in gimpedit +
+
+
+gimp_edit_named_copy, function in gimpedit +
+
+
+gimp_edit_named_copy_visible, function in gimpedit +
+
+
+gimp_edit_named_cut, function in gimpedit +
+
+
+gimp_edit_named_paste, function in gimpedit +
+
+
+gimp_edit_named_paste_as_new, function in gimpedit +
+
+
+gimp_edit_named_paste_as_new_image, function in gimpedit +
+
+
+gimp_edit_paste, function in gimpedit +
+
+
+gimp_edit_paste_as_new, function in gimpedit +
+
+
+gimp_edit_paste_as_new_image, function in gimpedit +
+
+
+gimp_edit_stroke, function in gimpedit +
+
+
+gimp_edit_stroke_vectors, function in gimpedit +
+
+
+gimp_ellipse_select, function in gimpselectiontools +
+
+
+gimp_enums_get_type_names, function in gimpenums +
+
+
+gimp_enums_init, function in gimpenums +
+
+
+gimp_equalize, function in gimpcolor +
+
+
+gimp_eraser, function in gimppainttools +
+
+
+gimp_eraser_default, function in gimppainttools +
+
+
+GimpExportCapabilities, enum in gimpexport +
+
+
+GimpExportReturn, enum in gimpexport +
+
+
+gimp_export_color_profile, function in gimp +
+
+
+gimp_export_dialog_get_content_area, function in gimpexport +
+
+
+gimp_export_dialog_new, function in gimpexport +
+
+
+gimp_export_exif, function in gimp +
+
+
+gimp_export_image, function in gimpexport +
+
+
+gimp_export_iptc, function in gimp +
+
+
+gimp_export_xmp, function in gimp +
+
+
+gimp_extension_ack, function in gimp +
+
+
+gimp_extension_enable, function in gimp +
+
+
+gimp_extension_process, function in gimp +
+
+

F

+
+gimp_file_load, function in gimpfileops +
+
+
+gimp_file_load_layer, function in gimpfileops +
+
+
+gimp_file_load_layers, function in gimpfileops +
+
+
+gimp_file_save, function in gimpfileops +
+
+
+gimp_file_save_thumbnail, function in gimpfileops +
+
+
+GIMP_FIXED_DITHER, macro in gimpenums +
+
+
+gimp_flip, function in gimptransformtools +
+
+
+gimp_floating_sel_anchor, function in gimpfloatingsel +
+
+
+gimp_floating_sel_attach, function in gimpfloatingsel +
+
+
+gimp_floating_sel_relax, function in gimpfloatingsel +
+
+
+gimp_floating_sel_remove, function in gimpfloatingsel +
+
+
+gimp_floating_sel_rigor, function in gimpfloatingsel +
+
+
+gimp_floating_sel_to_layer, function in gimpfloatingsel +
+
+
+GimpFontSelectButton, struct in GimpFontSelectButton +
+
+
+GimpFontSelectButton::font-set, object signal in GimpFontSelectButton +
+
+
+GimpFontSelectButton:font-name, object property in GimpFontSelectButton +
+
+
+GimpFontSelectButton:title, object property in GimpFontSelectButton +
+
+
+gimp_fonts_close_popup, function in gimpfontselect +
+
+
+gimp_fonts_get_list, function in gimpfonts +
+
+
+gimp_fonts_popup, function in gimpfontselect +
+
+
+gimp_fonts_refresh, function in gimpfonts +
+
+
+gimp_fonts_set_popup, function in gimpfontselect +
+
+
+gimp_font_select_button_get_font, function in GimpFontSelectButton +
+
+
+gimp_font_select_button_new, function in GimpFontSelectButton +
+
+
+gimp_font_select_button_set_font, function in GimpFontSelectButton +
+
+
+gimp_font_select_destroy, function in gimpfontselect +
+
+
+gimp_font_select_new, function in gimpfontselect +
+
+
+gimp_font_select_widget_close, function in gimpfontmenu +
+
+
+gimp_font_select_widget_new, function in gimpfontmenu +
+
+
+gimp_font_select_widget_set, function in gimpfontmenu +
+
+
+gimp_free_select, function in gimpselectiontools +
+
+
+GIMP_FSLOWBLEED_DITHER, macro in gimpenums +
+
+
+GIMP_FS_DITHER, macro in gimpenums +
+
+
+gimp_fuzzy_select, function in gimpselectiontools +
+
+
+gimp_fuzzy_select_full, function in gimpselectiontools +
+
+

G

+
+gimp_gamma, function in gimp +
+
+
+gimp_getpid, function in gimp +
+
+
+gimp_get_color_configuration, function in gimpgimprc +
+
+
+gimp_get_data, macro in gimp +
+
+
+gimp_get_data_size, macro in gimp +
+
+
+gimp_get_default_comment, function in gimpgimprc +
+
+
+gimp_get_default_unit, function in gimpgimprc +
+
+
+gimp_get_icon_theme_dir, function in gimpgimprc +
+
+
+gimp_get_module_load_inhibit, function in gimpgimprc +
+
+
+gimp_get_monitor_resolution, function in gimpgimprc +
+
+
+gimp_get_parasite, function in gimp +
+
+
+gimp_get_parasite_list, function in gimp +
+
+
+gimp_get_path_by_tattoo, function in gimppaths +
+
+
+gimp_get_pdb_error, function in gimp +
+
+
+gimp_get_pdb_status, function in gimp +
+
+
+gimp_get_progname, function in gimp +
+
+
+gimp_get_theme_dir, function in gimpgimprc +
+
+
+gimp_gimprc_query, function in gimpgimprc +
+
+
+gimp_gimprc_set, function in gimpgimprc +
+
+
+GimpGradientSelectButton, struct in GimpGradientSelectButton +
+
+
+GimpGradientSelectButton::gradient-set, object signal in GimpGradientSelectButton +
+
+
+GimpGradientSelectButton:gradient-name, object property in GimpGradientSelectButton +
+
+
+GimpGradientSelectButton:title, object property in GimpGradientSelectButton +
+
+
+gimp_gradients_close_popup, function in gimpgradientselect +
+
+
+gimp_gradients_get_gradient, function in gimpgradients +
+
+
+gimp_gradients_get_gradient_data, function in gimpgradients +
+
+
+gimp_gradients_get_list, function in gimpgradients +
+
+
+gimp_gradients_popup, function in gimpgradientselect +
+
+
+gimp_gradients_refresh, function in gimpgradients +
+
+
+gimp_gradients_sample_custom, function in gimpgradients +
+
+
+gimp_gradients_sample_uniform, function in gimpgradients +
+
+
+gimp_gradients_set_gradient, function in gimpgradients +
+
+
+gimp_gradients_set_popup, function in gimpgradientselect +
+
+
+gimp_gradient_delete, function in gimpgradient +
+
+
+gimp_gradient_duplicate, function in gimpgradient +
+
+
+gimp_gradient_get_custom_samples, function in gimpgradient +
+
+
+gimp_gradient_get_number_of_segments, function in gimpgradient +
+
+
+gimp_gradient_get_uniform_samples, function in gimpgradient +
+
+
+gimp_gradient_is_editable, function in gimpgradient +
+
+
+gimp_gradient_new, function in gimpgradient +
+
+
+gimp_gradient_rename, function in gimpgradient +
+
+
+gimp_gradient_segment_get_blending_function, function in gimpgradient +
+
+
+gimp_gradient_segment_get_coloring_type, function in gimpgradient +
+
+
+gimp_gradient_segment_get_left_color, function in gimpgradient +
+
+
+gimp_gradient_segment_get_left_pos, function in gimpgradient +
+
+
+gimp_gradient_segment_get_middle_pos, function in gimpgradient +
+
+
+gimp_gradient_segment_get_right_color, function in gimpgradient +
+
+
+gimp_gradient_segment_get_right_pos, function in gimpgradient +
+
+
+gimp_gradient_segment_range_blend_colors, function in gimpgradient +
+
+
+gimp_gradient_segment_range_blend_opacity, function in gimpgradient +
+
+
+gimp_gradient_segment_range_delete, function in gimpgradient +
+
+
+gimp_gradient_segment_range_flip, function in gimpgradient +
+
+
+gimp_gradient_segment_range_move, function in gimpgradient +
+
+
+gimp_gradient_segment_range_redistribute_handles, function in gimpgradient +
+
+
+gimp_gradient_segment_range_replicate, function in gimpgradient +
+
+
+gimp_gradient_segment_range_set_blending_function, function in gimpgradient +
+
+
+gimp_gradient_segment_range_set_coloring_type, function in gimpgradient +
+
+
+gimp_gradient_segment_range_split_midpoint, function in gimpgradient +
+
+
+gimp_gradient_segment_range_split_uniform, function in gimpgradient +
+
+
+gimp_gradient_segment_set_left_color, function in gimpgradient +
+
+
+gimp_gradient_segment_set_left_pos, function in gimpgradient +
+
+
+gimp_gradient_segment_set_middle_pos, function in gimpgradient +
+
+
+gimp_gradient_segment_set_right_color, function in gimpgradient +
+
+
+gimp_gradient_segment_set_right_pos, function in gimpgradient +
+
+
+gimp_gradient_select_button_get_gradient, function in GimpGradientSelectButton +
+
+
+gimp_gradient_select_button_new, function in GimpGradientSelectButton +
+
+
+gimp_gradient_select_button_set_gradient, function in GimpGradientSelectButton +
+
+
+gimp_gradient_select_destroy, function in gimpgradientselect +
+
+
+gimp_gradient_select_new, function in gimpgradientselect +
+
+
+gimp_gradient_select_widget_close, function in gimpgradientmenu +
+
+
+gimp_gradient_select_widget_new, function in gimpgradientmenu +
+
+
+gimp_gradient_select_widget_set, function in gimpgradientmenu +
+
+
+GIMP_GRAIN_EXTRACT_MODE, macro in gimpenums +
+
+
+GIMP_GRAIN_MERGE_MODE, macro in gimpenums +
+
+

H

+
+GIMP_HARDLIGHT_MODE, macro in gimpenums +
+
+
+gimp_heal, function in gimppainttools +
+
+
+gimp_heal_default, function in gimppainttools +
+
+
+gimp_help, function in gimphelp +
+
+
+gimp_histogram, function in gimpcolor +
+
+
+GimpHistogramChannel, enum in gimpenums +
+
+
+GIMP_HUE_MODE, macro in gimpenums +
+
+
+gimp_hue_saturation, function in gimpcolor +
+
+

I

+
+gimp_icon_theme_dir, function in gimp +
+
+
+GimpImageComboBox, struct in GimpImageComboBox +
+
+
+GimpImageConstraintFunc, user_function in GimpImageComboBox +
+
+
+gimp_image_add_channel, function in gimpimage +
+
+
+gimp_image_add_hguide, function in gimpimageguides +
+
+
+gimp_image_add_layer, function in gimpimage +
+
+
+gimp_image_add_sample_point, function in gimpimagesamplepoints +
+
+
+gimp_image_add_vectors, function in gimpimage +
+
+
+gimp_image_add_vguide, function in gimpimageguides +
+
+
+gimp_image_attach_new_parasite, function in gimpimage +
+
+
+gimp_image_attach_parasite, function in gimpimage +
+
+
+gimp_image_base_type, function in gimpimage +
+
+
+gimp_image_clean_all, function in gimpimage +
+
+
+gimp_image_combo_box_new, function in GimpImageComboBox +
+
+
+gimp_image_convert_color_profile, function in gimpimagecolorprofile +
+
+
+gimp_image_convert_color_profile_from_file, function in gimpimagecolorprofile +
+
+
+gimp_image_convert_grayscale, function in gimpimageconvert +
+
+
+gimp_image_convert_indexed, function in gimpimageconvert +
+
+
+gimp_image_convert_precision, function in gimpimageconvert +
+
+
+gimp_image_convert_rgb, function in gimpimageconvert +
+
+
+gimp_image_convert_set_dither_matrix, function in gimpimageconvert +
+
+
+gimp_image_crop, function in gimpimagetransform +
+
+
+gimp_image_delete, function in gimpimage +
+
+
+gimp_image_delete_guide, function in gimpimageguides +
+
+
+gimp_image_delete_sample_point, function in gimpimagesamplepoints +
+
+
+gimp_image_detach_parasite, function in gimpimage +
+
+
+gimp_image_duplicate, function in gimpimage +
+
+
+gimp_image_find_next_guide, function in gimpimageguides +
+
+
+gimp_image_find_next_sample_point, function in gimpimagesamplepoints +
+
+
+gimp_image_flatten, function in gimpimage +
+
+
+gimp_image_flip, function in gimpimagetransform +
+
+
+gimp_image_floating_sel_attached_to, function in gimpimage +
+
+
+gimp_image_freeze_channels, function in gimpimage +
+
+
+gimp_image_freeze_layers, function in gimpimage +
+
+
+gimp_image_freeze_vectors, function in gimpimage +
+
+
+gimp_image_free_shadow, function in gimpimage +
+
+
+gimp_image_get_active_channel, function in gimpimage +
+
+
+gimp_image_get_active_drawable, function in gimpimage +
+
+
+gimp_image_get_active_layer, function in gimpimage +
+
+
+gimp_image_get_active_vectors, function in gimpimage +
+
+
+gimp_image_get_channels, function in gimpimage +
+
+
+gimp_image_get_channel_by_name, function in gimpimage +
+
+
+gimp_image_get_channel_by_tattoo, function in gimpimage +
+
+
+gimp_image_get_channel_position, function in gimpimage +
+
+
+gimp_image_get_cmap, function in gimpimage +
+
+
+gimp_image_get_colormap, function in gimpimage +
+
+
+gimp_image_get_color_profile, function in gimpimagecolorprofile +
+
+
+gimp_image_get_component_active, function in gimpimage +
+
+
+gimp_image_get_component_visible, function in gimpimage +
+
+
+gimp_image_get_default_new_layer_mode, function in gimpimage +
+
+
+gimp_image_get_effective_color_profile, function in gimpimagecolorprofile +
+
+
+gimp_image_get_exported_uri, function in gimpimage +
+
+
+gimp_image_get_filename, function in gimpimage +
+
+
+gimp_image_get_floating_sel, function in gimpimage +
+
+
+gimp_image_get_guide_orientation, function in gimpimageguides +
+
+
+gimp_image_get_guide_position, function in gimpimageguides +
+
+
+gimp_image_get_imported_uri, function in gimpimage +
+
+
+gimp_image_get_item_position, function in gimpimage +
+
+
+gimp_image_get_layers, function in gimpimage +
+
+
+gimp_image_get_layer_by_name, function in gimpimage +
+
+
+gimp_image_get_layer_by_tattoo, function in gimpimage +
+
+
+gimp_image_get_layer_position, function in gimpimage +
+
+
+gimp_image_get_metadata, function in gimpimage +
+
+
+gimp_image_get_name, function in gimpimage +
+
+
+gimp_image_get_parasite, function in gimpimage +
+
+
+gimp_image_get_parasite_list, function in gimpimage +
+
+
+gimp_image_get_precision, function in gimpimage +
+
+
+gimp_image_get_resolution, function in gimpimage +
+
+
+gimp_image_get_sample_point_position, function in gimpimagesamplepoints +
+
+
+gimp_image_get_selection, function in gimpimage +
+
+
+gimp_image_get_tattoo_state, function in gimpimage +
+
+
+gimp_image_get_thumbnail, function in gimppixbuf +
+
+
+gimp_image_get_thumbnail_data, function in gimpimage +
+
+
+gimp_image_get_unit, function in gimpimage +
+
+
+gimp_image_get_uri, function in gimpimage +
+
+
+gimp_image_get_vectors, function in gimpimage +
+
+
+gimp_image_get_vectors_by_name, function in gimpimage +
+
+
+gimp_image_get_vectors_by_tattoo, function in gimpimage +
+
+
+gimp_image_get_vectors_position, function in gimpimage +
+
+
+gimp_image_get_xcf_uri, function in gimpimage +
+
+
+gimp_image_grid_get_background_color, function in gimpimagegrid +
+
+
+gimp_image_grid_get_foreground_color, function in gimpimagegrid +
+
+
+gimp_image_grid_get_offset, function in gimpimagegrid +
+
+
+gimp_image_grid_get_spacing, function in gimpimagegrid +
+
+
+gimp_image_grid_get_style, function in gimpimagegrid +
+
+
+gimp_image_grid_set_background_color, function in gimpimagegrid +
+
+
+gimp_image_grid_set_foreground_color, function in gimpimagegrid +
+
+
+gimp_image_grid_set_offset, function in gimpimagegrid +
+
+
+gimp_image_grid_set_spacing, function in gimpimagegrid +
+
+
+gimp_image_grid_set_style, function in gimpimagegrid +
+
+
+gimp_image_height, function in gimpimage +
+
+
+gimp_image_insert_channel, function in gimpimage +
+
+
+gimp_image_insert_layer, function in gimpimage +
+
+
+gimp_image_insert_vectors, function in gimpimage +
+
+
+gimp_image_is_dirty, function in gimpimage +
+
+
+gimp_image_is_valid, function in gimpimage +
+
+
+gimp_image_list, function in gimpimage +
+
+
+gimp_image_lower_channel, function in gimpimage +
+
+
+gimp_image_lower_item, function in gimpimage +
+
+
+gimp_image_lower_item_to_bottom, function in gimpimage +
+
+
+gimp_image_lower_layer, function in gimpimage +
+
+
+gimp_image_lower_layer_to_bottom, function in gimpimage +
+
+
+gimp_image_lower_vectors, function in gimpimage +
+
+
+gimp_image_lower_vectors_to_bottom, function in gimpimage +
+
+
+gimp_image_menu_new, function in gimpmenu +
+
+
+gimp_image_merge_down, function in gimpimage +
+
+
+gimp_image_merge_layer_group, function in gimpimage +
+
+
+gimp_image_merge_visible_layers, function in gimpimage +
+
+
+gimp_image_metadata_load_finish, function in gimpmetadata +
+
+
+gimp_image_metadata_load_prepare, function in gimpmetadata +
+
+
+gimp_image_metadata_load_thumbnail, function in gimpmetadata +
+
+
+gimp_image_metadata_save_finish, function in gimpmetadata +
+
+
+gimp_image_metadata_save_prepare, function in gimpmetadata +
+
+
+gimp_image_new, function in gimpimage +
+
+
+gimp_image_new_with_precision, function in gimpimage +
+
+
+gimp_image_parasite_attach, function in gimpimage +
+
+
+gimp_image_parasite_detach, function in gimpimage +
+
+
+gimp_image_parasite_find, function in gimpimage +
+
+
+gimp_image_parasite_list, function in gimpimage +
+
+
+gimp_image_pick_color, function in gimpimage +
+
+
+gimp_image_pick_correlate_layer, function in gimpimage +
+
+
+gimp_image_raise_channel, function in gimpimage +
+
+
+gimp_image_raise_item, function in gimpimage +
+
+
+gimp_image_raise_item_to_top, function in gimpimage +
+
+
+gimp_image_raise_layer, function in gimpimage +
+
+
+gimp_image_raise_layer_to_top, function in gimpimage +
+
+
+gimp_image_raise_vectors, function in gimpimage +
+
+
+gimp_image_raise_vectors_to_top, function in gimpimage +
+
+
+gimp_image_remove_channel, function in gimpimage +
+
+
+gimp_image_remove_layer, function in gimpimage +
+
+
+gimp_image_remove_vectors, function in gimpimage +
+
+
+gimp_image_reorder_item, function in gimpimage +
+
+
+gimp_image_resize, function in gimpimagetransform +
+
+
+gimp_image_resize_to_layers, function in gimpimagetransform +
+
+
+gimp_image_rotate, function in gimpimagetransform +
+
+
+gimp_image_scale, function in gimpimagetransform +
+
+
+gimp_image_scale_full, function in gimpimagetransform +
+
+
+gimp_image_select_color, function in gimpimageselect +
+
+
+gimp_image_select_contiguous_color, function in gimpimageselect +
+
+
+gimp_image_select_ellipse, function in gimpimageselect +
+
+
+gimp_image_select_item, function in gimpimageselect +
+
+
+gimp_image_select_polygon, function in gimpimageselect +
+
+
+gimp_image_select_rectangle, function in gimpimageselect +
+
+
+gimp_image_select_round_rectangle, function in gimpimageselect +
+
+
+gimp_image_set_active_channel, function in gimpimage +
+
+
+gimp_image_set_active_layer, function in gimpimage +
+
+
+gimp_image_set_active_vectors, function in gimpimage +
+
+
+gimp_image_set_cmap, function in gimpimage +
+
+
+gimp_image_set_colormap, function in gimpimage +
+
+
+gimp_image_set_color_profile, function in gimpimagecolorprofile +
+
+
+gimp_image_set_color_profile_from_file, function in gimpimagecolorprofile +
+
+
+gimp_image_set_component_active, function in gimpimage +
+
+
+gimp_image_set_component_visible, function in gimpimage +
+
+
+gimp_image_set_filename, function in gimpimage +
+
+
+gimp_image_set_metadata, function in gimpimage +
+
+
+gimp_image_set_resolution, function in gimpimage +
+
+
+gimp_image_set_tattoo_state, function in gimpimage +
+
+
+gimp_image_set_unit, function in gimpimage +
+
+
+gimp_image_thaw_channels, function in gimpimage +
+
+
+gimp_image_thaw_layers, function in gimpimage +
+
+
+gimp_image_thaw_vectors, function in gimpimage +
+
+
+gimp_image_undo_disable, function in gimpimageundo +
+
+
+gimp_image_undo_enable, function in gimpimageundo +
+
+
+gimp_image_undo_freeze, function in gimpimageundo +
+
+
+gimp_image_undo_group_end, function in gimpimageundo +
+
+
+gimp_image_undo_group_start, function in gimpimageundo +
+
+
+gimp_image_undo_is_enabled, function in gimpimageundo +
+
+
+gimp_image_undo_thaw, function in gimpimageundo +
+
+
+gimp_image_unset_active_channel, function in gimpimage +
+
+
+gimp_image_width, function in gimpimage +
+
+
+GimpInitProc, user_function in gimp +
+
+
+gimp_install_cmap, function in gimp +
+
+
+gimp_install_procedure, function in gimp +
+
+
+gimp_install_temp_proc, function in gimp +
+
+
+gimp_invert, function in gimpcolor +
+
+
+GimpItemConstraintFunc, user_function in GimpItemComboBox +
+
+
+gimp_item_attach_parasite, function in gimpitem +
+
+
+gimp_item_delete, function in gimpitem +
+
+
+gimp_item_detach_parasite, function in gimpitem +
+
+
+gimp_item_get_children, function in gimpitem +
+
+
+gimp_item_get_color_tag, function in gimpitem +
+
+
+gimp_item_get_expanded, function in gimpitem +
+
+
+gimp_item_get_image, function in gimpitem +
+
+
+gimp_item_get_linked, function in gimpitem +
+
+
+gimp_item_get_lock_content, function in gimpitem +
+
+
+gimp_item_get_lock_position, function in gimpitem +
+
+
+gimp_item_get_name, function in gimpitem +
+
+
+gimp_item_get_parasite, function in gimpitem +
+
+
+gimp_item_get_parasite_list, function in gimpitem +
+
+
+gimp_item_get_parent, function in gimpitem +
+
+
+gimp_item_get_tattoo, function in gimpitem +
+
+
+gimp_item_get_visible, function in gimpitem +
+
+
+gimp_item_is_channel, function in gimpitem +
+
+
+gimp_item_is_drawable, function in gimpitem +
+
+
+gimp_item_is_group, function in gimpitem +
+
+
+gimp_item_is_layer, function in gimpitem +
+
+
+gimp_item_is_layer_mask, function in gimpitem +
+
+
+gimp_item_is_selection, function in gimpitem +
+
+
+gimp_item_is_text_layer, function in gimpitem +
+
+
+gimp_item_is_valid, function in gimpitem +
+
+
+gimp_item_is_vectors, function in gimpitem +
+
+
+gimp_item_set_color_tag, function in gimpitem +
+
+
+gimp_item_set_expanded, function in gimpitem +
+
+
+gimp_item_set_linked, function in gimpitem +
+
+
+gimp_item_set_lock_content, function in gimpitem +
+
+
+gimp_item_set_lock_position, function in gimpitem +
+
+
+gimp_item_set_name, function in gimpitem +
+
+
+gimp_item_set_tattoo, function in gimpitem +
+
+
+gimp_item_set_visible, function in gimpitem +
+
+
+gimp_item_transform_2d, function in gimpitemtransform +
+
+
+gimp_item_transform_flip, function in gimpitemtransform +
+
+
+gimp_item_transform_flip_simple, function in gimpitemtransform +
+
+
+gimp_item_transform_matrix, function in gimpitemtransform +
+
+
+gimp_item_transform_perspective, function in gimpitemtransform +
+
+
+gimp_item_transform_rotate, function in gimpitemtransform +
+
+
+gimp_item_transform_rotate_simple, function in gimpitemtransform +
+
+
+gimp_item_transform_scale, function in gimpitemtransform +
+
+
+gimp_item_transform_shear, function in gimpitemtransform +
+
+
+gimp_item_transform_translate, function in gimpitemtransform +
+
+

L

+
+GimpLayerColorSpace, enum in gimpenums +
+
+
+GimpLayerComboBox, struct in GimpItemComboBox +
+
+
+GimpLayerCompositeMode, enum in gimpenums +
+
+
+GimpLayerMode, enum in gimpenums +
+
+
+GimpLayerModeEffects, typedef in gimpenums +
+
+
+gimp_layer_add_alpha, function in gimplayer +
+
+
+gimp_layer_add_mask, function in gimplayer +
+
+
+gimp_layer_combo_box_new, function in GimpItemComboBox +
+
+
+gimp_layer_copy, function in gimplayer +
+
+
+gimp_layer_create_mask, function in gimplayer +
+
+
+gimp_layer_flatten, function in gimplayer +
+
+
+gimp_layer_from_mask, function in gimplayer +
+
+
+gimp_layer_get_apply_mask, function in gimplayer +
+
+
+gimp_layer_get_blend_space, function in gimplayer +
+
+
+gimp_layer_get_composite_mode, function in gimplayer +
+
+
+gimp_layer_get_composite_space, function in gimplayer +
+
+
+gimp_layer_get_edit_mask, function in gimplayer +
+
+
+gimp_layer_get_lock_alpha, function in gimplayer +
+
+
+gimp_layer_get_mask, function in gimplayer +
+
+
+gimp_layer_get_mode, function in gimplayer +
+
+
+gimp_layer_get_opacity, function in gimplayer +
+
+
+gimp_layer_get_preserve_trans, function in gimplayer +
+
+
+gimp_layer_get_show_mask, function in gimplayer +
+
+
+gimp_layer_group_new, function in gimplayer +
+
+
+gimp_layer_is_floating_sel, function in gimplayer +
+
+
+gimp_layer_menu_new, function in gimpmenu +
+
+
+gimp_layer_new, function in gimplayer +
+
+
+gimp_layer_new_from_drawable, function in gimplayer +
+
+
+gimp_layer_new_from_pixbuf, function in gimplayer +
+
+
+gimp_layer_new_from_surface, function in gimplayer +
+
+
+gimp_layer_new_from_visible, function in gimplayer +
+
+
+gimp_layer_remove_mask, function in gimplayer +
+
+
+gimp_layer_resize, function in gimplayer +
+
+
+gimp_layer_resize_to_image_size, function in gimplayer +
+
+
+gimp_layer_scale, function in gimplayer +
+
+
+gimp_layer_scale_full, function in gimplayer +
+
+
+gimp_layer_set_apply_mask, function in gimplayer +
+
+
+gimp_layer_set_blend_space, function in gimplayer +
+
+
+gimp_layer_set_composite_mode, function in gimplayer +
+
+
+gimp_layer_set_composite_space, function in gimplayer +
+
+
+gimp_layer_set_edit_mask, function in gimplayer +
+
+
+gimp_layer_set_lock_alpha, function in gimplayer +
+
+
+gimp_layer_set_mode, function in gimplayer +
+
+
+gimp_layer_set_offsets, function in gimplayer +
+
+
+gimp_layer_set_opacity, function in gimplayer +
+
+
+gimp_layer_set_preserve_trans, function in gimplayer +
+
+
+gimp_layer_set_show_mask, function in gimplayer +
+
+
+gimp_layer_translate, function in gimplayer +
+
+
+gimp_levels, function in gimpcolor +
+
+
+gimp_levels_auto, function in gimpcolor +
+
+
+gimp_levels_stretch, function in gimpcolor +
+
+
+GIMP_LIGHTEN_ONLY_MODE, macro in gimpenums +
+
+

M

+
+MAIN, macro in gimp +
+
+
+gimp_main, function in gimp +
+
+
+GimpMenuCallback, user_function in gimpmenu +
+
+
+gimp_message, function in gimpmessage +
+
+
+gimp_message_get_handler, function in gimpmessage +
+
+
+gimp_message_set_handler, function in gimpmessage +
+
+
+gimp_min_colors, function in gimp +
+
+
+gimp_monitor_number, function in gimp +
+
+
+GIMP_MULTIPLY_MODE, macro in gimpenums +
+
+

N

+
+GIMP_NORMAL_MODE, macro in gimpenums +
+
+
+GIMP_NO_DITHER, macro in gimpenums +
+
+

O

+
+GIMP_OVERLAY_MODE, macro in gimpenums +
+
+

P

+
+gimp_paintbrush, function in gimppainttools +
+
+
+gimp_paintbrush_default, function in gimppainttools +
+
+
+GimpPaletteSelectButton, struct in GimpPaletteSelectButton +
+
+
+GimpPaletteSelectButton::palette-set, object signal in GimpPaletteSelectButton +
+
+
+GimpPaletteSelectButton:palette-name, object property in GimpPaletteSelectButton +
+
+
+GimpPaletteSelectButton:title, object property in GimpPaletteSelectButton +
+
+
+gimp_palettes_close_popup, function in gimppaletteselect +
+
+
+gimp_palettes_get_list, function in gimppalettes +
+
+
+gimp_palettes_get_palette, function in gimppalettes +
+
+
+gimp_palettes_get_palette_entry, function in gimppalettes +
+
+
+gimp_palettes_popup, function in gimppaletteselect +
+
+
+gimp_palettes_refresh, function in gimppalettes +
+
+
+gimp_palettes_set_palette, function in gimppalettes +
+
+
+gimp_palettes_set_popup, function in gimppaletteselect +
+
+
+gimp_palette_add_entry, function in gimppalette +
+
+
+gimp_palette_delete, function in gimppalette +
+
+
+gimp_palette_delete_entry, function in gimppalette +
+
+
+gimp_palette_duplicate, function in gimppalette +
+
+
+gimp_palette_entry_get_color, function in gimppalette +
+
+
+gimp_palette_entry_get_name, function in gimppalette +
+
+
+gimp_palette_entry_set_color, function in gimppalette +
+
+
+gimp_palette_entry_set_name, function in gimppalette +
+
+
+gimp_palette_get_background, function in gimppalette +
+
+
+gimp_palette_get_colors, function in gimppalette +
+
+
+gimp_palette_get_columns, function in gimppalette +
+
+
+gimp_palette_get_foreground, function in gimppalette +
+
+
+gimp_palette_get_info, function in gimppalette +
+
+
+gimp_palette_is_editable, function in gimppalette +
+
+
+gimp_palette_new, function in gimppalette +
+
+
+gimp_palette_rename, function in gimppalette +
+
+
+gimp_palette_select_button_get_palette, function in GimpPaletteSelectButton +
+
+
+gimp_palette_select_button_new, function in GimpPaletteSelectButton +
+
+
+gimp_palette_select_button_set_palette, function in GimpPaletteSelectButton +
+
+
+gimp_palette_select_destroy, function in gimppaletteselect +
+
+
+gimp_palette_select_new, function in gimppaletteselect +
+
+
+gimp_palette_select_widget_close, function in gimppalettemenu +
+
+
+gimp_palette_select_widget_new, function in gimppalettemenu +
+
+
+gimp_palette_select_widget_set, function in gimppalettemenu +
+
+
+gimp_palette_set_background, function in gimppalette +
+
+
+gimp_palette_set_columns, function in gimppalette +
+
+
+gimp_palette_set_default_colors, function in gimppalette +
+
+
+gimp_palette_set_foreground, function in gimppalette +
+
+
+gimp_palette_swap_colors, function in gimppalette +
+
+
+GimpParam, struct in gimp +
+
+
+GimpParamData, union in gimp +
+
+
+GimpParamDef, struct in gimp +
+
+
+GimpParamRegion, struct in gimp +
+
+
+gimp_parasite_attach, function in gimp +
+
+
+gimp_parasite_detach, function in gimp +
+
+
+gimp_parasite_find, function in gimp +
+
+
+gimp_parasite_list, function in gimp +
+
+
+gimp_path_delete, function in gimppaths +
+
+
+gimp_path_get_current, function in gimppaths +
+
+
+gimp_path_get_locked, function in gimppaths +
+
+
+gimp_path_get_points, function in gimppaths +
+
+
+gimp_path_get_point_at_dist, function in gimppaths +
+
+
+gimp_path_get_tattoo, function in gimppaths +
+
+
+gimp_path_import, function in gimppaths +
+
+
+gimp_path_list, function in gimppaths +
+
+
+gimp_path_set_current, function in gimppaths +
+
+
+gimp_path_set_locked, function in gimppaths +
+
+
+gimp_path_set_points, function in gimppaths +
+
+
+gimp_path_set_tattoo, function in gimppaths +
+
+
+gimp_path_stroke_current, function in gimppaths +
+
+
+gimp_path_to_selection, function in gimppaths +
+
+
+GimpPatternSelectButton, struct in GimpPatternSelectButton +
+
+
+GimpPatternSelectButton::pattern-set, object signal in GimpPatternSelectButton +
+
+
+GimpPatternSelectButton:pattern-name, object property in GimpPatternSelectButton +
+
+
+GimpPatternSelectButton:title, object property in GimpPatternSelectButton +
+
+
+gimp_patterns_close_popup, function in gimppatternselect +
+
+
+gimp_patterns_get_list, function in gimppatterns +
+
+
+gimp_patterns_get_pattern, function in gimppatterns +
+
+
+gimp_patterns_get_pattern_data, function in gimppatterns +
+
+
+gimp_patterns_popup, function in gimppatternselect +
+
+
+gimp_patterns_refresh, function in gimppatterns +
+
+
+gimp_patterns_set_pattern, function in gimppatterns +
+
+
+gimp_patterns_set_popup, function in gimppatternselect +
+
+
+gimp_pattern_get_info, function in gimppattern +
+
+
+gimp_pattern_get_pixels, function in gimppattern +
+
+
+gimp_pattern_select_button_get_pattern, function in GimpPatternSelectButton +
+
+
+gimp_pattern_select_button_new, function in GimpPatternSelectButton +
+
+
+gimp_pattern_select_button_set_pattern, function in GimpPatternSelectButton +
+
+
+gimp_pattern_select_destroy, function in gimppatternselect +
+
+
+gimp_pattern_select_new, function in gimppatternselect +
+
+
+gimp_pattern_select_widget_close, function in gimppatternmenu +
+
+
+gimp_pattern_select_widget_new, function in gimppatternmenu +
+
+
+gimp_pattern_select_widget_set, function in gimppatternmenu +
+
+
+gimp_pencil, function in gimppainttools +
+
+
+gimp_perspective, function in gimptransformtools +
+
+
+GimpPixbufTransparency, enum in gimppixbuf +
+
+
+GimpPixelFetcher, struct in gimppixelfetcher +
+
+
+GimpPixelFetcherEdgeMode, enum in gimppixelfetcher +
+
+
+GimpPixelRgn, struct in gimppixelrgn +
+
+
+gimp_pixel_fetcher_destroy, function in gimppixelfetcher +
+
+
+gimp_pixel_fetcher_get_pixel, function in gimppixelfetcher +
+
+
+gimp_pixel_fetcher_new, function in gimppixelfetcher +
+
+
+gimp_pixel_fetcher_put_pixel, function in gimppixelfetcher +
+
+
+gimp_pixel_fetcher_set_bg_color, function in gimppixelfetcher +
+
+
+gimp_pixel_fetcher_set_edge_mode, function in gimppixelfetcher +
+
+
+gimp_pixel_rgns_process, function in gimppixelrgn +
+
+
+gimp_pixel_rgns_register, function in gimppixelrgn +
+
+
+gimp_pixel_rgns_register2, function in gimppixelrgn +
+
+
+gimp_pixel_rgn_get_col, function in gimppixelrgn +
+
+
+gimp_pixel_rgn_get_pixel, function in gimppixelrgn +
+
+
+gimp_pixel_rgn_get_rect, function in gimppixelrgn +
+
+
+gimp_pixel_rgn_get_row, function in gimppixelrgn +
+
+
+gimp_pixel_rgn_init, function in gimppixelrgn +
+
+
+gimp_pixel_rgn_resize, function in gimppixelrgn +
+
+
+gimp_pixel_rgn_set_col, function in gimppixelrgn +
+
+
+gimp_pixel_rgn_set_pixel, function in gimppixelrgn +
+
+
+gimp_pixel_rgn_set_rect, function in gimppixelrgn +
+
+
+gimp_pixel_rgn_set_row, function in gimppixelrgn +
+
+
+GimpPlugInInfo, struct in gimp +
+
+
+gimp_plugin_domain_register, function in gimpplugin +
+
+
+gimp_plugin_enable_precision, function in gimpplugin +
+
+
+gimp_plugin_get_pdb_error_handler, function in gimpplugin +
+
+
+gimp_plugin_help_register, function in gimpplugin +
+
+
+gimp_plugin_icon_register, function in gimpplugin +
+
+
+gimp_plugin_menu_branch_register, function in gimpplugin +
+
+
+gimp_plugin_menu_register, function in gimpplugin +
+
+
+gimp_plugin_precision_enabled, function in gimpplugin +
+
+
+gimp_plugin_set_pdb_error_handler, function in gimpplugin +
+
+
+gimp_posterize, function in gimpcolor +
+
+
+GimpProcBrowserDialog, struct in GimpProcBrowserDialog +
+
+
+GimpProcBrowserDialog::row-activated, object signal in GimpProcBrowserDialog +
+
+
+GimpProcBrowserDialog::selection-changed, object signal in GimpProcBrowserDialog +
+
+
+gimp_procedural_db_dump, function in gimpproceduraldb +
+
+
+gimp_procedural_db_get_data, function in gimpproceduraldb +
+
+
+gimp_procedural_db_get_data_size, function in gimpproceduraldb +
+
+
+gimp_procedural_db_proc_arg, function in gimpproceduraldb +
+
+
+gimp_procedural_db_proc_exists, function in gimpproceduraldb +
+
+
+gimp_procedural_db_proc_info, function in gimpproceduraldb +
+
+
+gimp_procedural_db_proc_val, function in gimpproceduraldb +
+
+
+gimp_procedural_db_query, function in gimpproceduraldb +
+
+
+gimp_procedural_db_set_data, function in gimpproceduraldb +
+
+
+gimp_procedural_db_temp_name, function in gimpproceduraldb +
+
+
+gimp_proc_browser_dialog_get_selected, function in GimpProcBrowserDialog +
+
+
+gimp_proc_browser_dialog_new, function in GimpProcBrowserDialog +
+
+
+gimp_proc_view_new, function in GimpProcView +
+
+
+GimpProgressBar, struct in GimpProgressBar +
+
+
+GimpProgressEndCallback, user_function in gimpprogress +
+
+
+GimpProgressStartCallback, user_function in gimpprogress +
+
+
+GimpProgressTextCallback, user_function in gimpprogress +
+
+
+GimpProgressValueCallback, user_function in gimpprogress +
+
+
+GimpProgressVtable, struct in gimpprogress +
+
+
+gimp_progress_bar_new, function in GimpProgressBar +
+
+
+gimp_progress_cancel, function in gimpprogress +
+
+
+gimp_progress_end, function in gimpprogress +
+
+
+gimp_progress_get_window_handle, function in gimpprogress +
+
+
+gimp_progress_init, function in gimpprogress +
+
+
+gimp_progress_init_printf, function in gimpprogress +
+
+
+gimp_progress_install, function in gimpprogress +
+
+
+gimp_progress_install_vtable, function in gimpprogress +
+
+
+gimp_progress_pulse, function in gimpprogress +
+
+
+gimp_progress_set_text, function in gimpprogress +
+
+
+gimp_progress_set_text_printf, function in gimpprogress +
+
+
+gimp_progress_uninstall, function in gimpprogress +
+
+
+gimp_progress_update, function in gimpprogress +
+
+

Q

+
+GimpQueryProc, user_function in gimp +
+
+
+gimp_quit, function in gimp +
+
+
+GimpQuitProc, user_function in gimp +
+
+

R

+
+gimp_rect_select, function in gimpselectiontools +
+
+
+gimp_register_file_handler_mime, function in gimpfileops +
+
+
+gimp_register_file_handler_priority, function in gimpfileops +
+
+
+gimp_register_file_handler_raw, function in gimpfileops +
+
+
+gimp_register_file_handler_uri, function in gimpfileops +
+
+
+gimp_register_load_handler, function in gimpfileops +
+
+
+gimp_register_magic_load_handler, function in gimpfileops +
+
+
+gimp_register_save_handler, function in gimpfileops +
+
+
+gimp_register_thumbnail_loader, function in gimpfileops +
+
+
+GimpRgnFunc1, user_function in gimpregioniterator +
+
+
+GimpRgnFunc2, user_function in gimpregioniterator +
+
+
+GimpRgnFuncDest, user_function in gimpregioniterator +
+
+
+GimpRgnFuncSrc, user_function in gimpregioniterator +
+
+
+GimpRgnFuncSrcDest, user_function in gimpregioniterator +
+
+
+GimpRgnIterator, struct in gimpregioniterator +
+
+
+gimp_rgn_iterate1, function in gimpregioniterator +
+
+
+gimp_rgn_iterate2, function in gimpregioniterator +
+
+
+gimp_rgn_iterator_dest, function in gimpregioniterator +
+
+
+gimp_rgn_iterator_free, function in gimpregioniterator +
+
+
+gimp_rgn_iterator_new, function in gimpregioniterator +
+
+
+gimp_rgn_iterator_src, function in gimpregioniterator +
+
+
+gimp_rgn_iterator_src_dest, function in gimpregioniterator +
+
+
+gimp_rotate, function in gimptransformtools +
+
+
+gimp_round_rect_select, function in gimpselectiontools +
+
+
+GimpRunBrushCallback, user_function in gimpbrushselect +
+
+
+GimpRunFontCallback, user_function in gimpfontselect +
+
+
+GimpRunGradientCallback, user_function in gimpgradientselect +
+
+
+GimpRunPaletteCallback, user_function in gimppaletteselect +
+
+
+GimpRunPatternCallback, user_function in gimppatternselect +
+
+
+GimpRunProc, user_function in gimp +
+
+
+gimp_run_procedure, function in gimp +
+
+
+gimp_run_procedure2, function in gimp +
+
+

S

+
+GIMP_SATURATION_MODE, macro in gimpenums +
+
+
+gimp_scale, function in gimptransformtools +
+
+
+GIMP_SCREEN_MODE, macro in gimpenums +
+
+
+GimpSelectButton, struct in GimpSelectButton +
+
+
+gimp_selection_all, function in gimpselection +
+
+
+gimp_selection_border, function in gimpselection +
+
+
+gimp_selection_bounds, function in gimpselection +
+
+
+gimp_selection_clear, function in gimpselection +
+
+
+gimp_selection_combine, function in gimpselection +
+
+
+gimp_selection_feather, function in gimpselection +
+
+
+gimp_selection_float, function in gimpselection +
+
+
+gimp_selection_flood, function in gimpselection +
+
+
+gimp_selection_grow, function in gimpselection +
+
+
+gimp_selection_invert, function in gimpselection +
+
+
+gimp_selection_is_empty, function in gimpselection +
+
+
+gimp_selection_layer_alpha, function in gimpselection +
+
+
+gimp_selection_load, function in gimpselection +
+
+
+gimp_selection_none, function in gimpselection +
+
+
+gimp_selection_save, function in gimpselection +
+
+
+gimp_selection_sharpen, function in gimpselection +
+
+
+gimp_selection_shrink, function in gimpselection +
+
+
+gimp_selection_translate, function in gimpselection +
+
+
+gimp_selection_value, function in gimpselection +
+
+
+gimp_select_button_close_popup, function in GimpSelectButton +
+
+
+gimp_set_data, macro in gimp +
+
+
+gimp_shear, function in gimptransformtools +
+
+
+gimp_shm_addr, function in gimp +
+
+
+gimp_shm_ID, function in gimp +
+
+
+gimp_show_help_button, function in gimp +
+
+
+gimp_show_tool_tips, function in gimp +
+
+
+gimp_smudge, function in gimppainttools +
+
+
+gimp_smudge_default, function in gimppainttools +
+
+
+GIMP_SOFTLIGHT_MODE, macro in gimpenums +
+
+
+GIMP_SUBTRACT_MODE, macro in gimpenums +
+
+

T

+
+gimp_temp_name, function in gimpfileops +
+
+
+gimp_text, function in gimptexttool +
+
+
+gimp_text_fontname, function in gimptexttool +
+
+
+gimp_text_get_extents, function in gimptexttool +
+
+
+gimp_text_get_extents_fontname, function in gimptexttool +
+
+
+gimp_text_layer_get_antialias, function in gimptextlayer +
+
+
+gimp_text_layer_get_base_direction, function in gimptextlayer +
+
+
+gimp_text_layer_get_color, function in gimptextlayer +
+
+
+gimp_text_layer_get_font, function in gimptextlayer +
+
+
+gimp_text_layer_get_font_size, function in gimptextlayer +
+
+
+gimp_text_layer_get_hinting, function in gimptextlayer +
+
+
+gimp_text_layer_get_hint_style, function in gimptextlayer +
+
+
+gimp_text_layer_get_indent, function in gimptextlayer +
+
+
+gimp_text_layer_get_justification, function in gimptextlayer +
+
+
+gimp_text_layer_get_kerning, function in gimptextlayer +
+
+
+gimp_text_layer_get_language, function in gimptextlayer +
+
+
+gimp_text_layer_get_letter_spacing, function in gimptextlayer +
+
+
+gimp_text_layer_get_line_spacing, function in gimptextlayer +
+
+
+gimp_text_layer_get_markup, function in gimptextlayer +
+
+
+gimp_text_layer_get_text, function in gimptextlayer +
+
+
+gimp_text_layer_new, function in gimptextlayer +
+
+
+gimp_text_layer_resize, function in gimptextlayer +
+
+
+gimp_text_layer_set_antialias, function in gimptextlayer +
+
+
+gimp_text_layer_set_base_direction, function in gimptextlayer +
+
+
+gimp_text_layer_set_color, function in gimptextlayer +
+
+
+gimp_text_layer_set_font, function in gimptextlayer +
+
+
+gimp_text_layer_set_font_size, function in gimptextlayer +
+
+
+gimp_text_layer_set_hinting, function in gimptextlayer +
+
+
+gimp_text_layer_set_hint_style, function in gimptextlayer +
+
+
+gimp_text_layer_set_indent, function in gimptextlayer +
+
+
+gimp_text_layer_set_justification, function in gimptextlayer +
+
+
+gimp_text_layer_set_kerning, function in gimptextlayer +
+
+
+gimp_text_layer_set_language, function in gimptextlayer +
+
+
+gimp_text_layer_set_letter_spacing, function in gimptextlayer +
+
+
+gimp_text_layer_set_line_spacing, function in gimptextlayer +
+
+
+gimp_text_layer_set_text, function in gimptextlayer +
+
+
+gimp_threshold, function in gimpcolor +
+
+
+GimpTile, struct in gimptile +
+
+
+gimp_tile_cache_ntiles, function in gimptile +
+
+
+gimp_tile_cache_size, function in gimptile +
+
+
+gimp_tile_flush, function in gimptile +
+
+
+gimp_tile_height, function in gimp +
+
+
+gimp_tile_ref, function in gimptile +
+
+
+gimp_tile_ref_zero, function in gimptile +
+
+
+gimp_tile_unref, function in gimptile +
+
+
+gimp_tile_width, function in gimp +
+
+
+gimp_transform_2d, function in gimptransformtools +
+
+

U

+
+gimp_ui_get_display_window, function in gimpui +
+
+
+gimp_ui_get_progress_window, function in gimpui +
+
+
+gimp_ui_init, function in gimpui +
+
+
+gimp_uninstall_temp_proc, function in gimp +
+
+
+gimp_user_time, function in gimp +
+
+

V

+
+GIMP_VALUE_MODE, macro in gimpenums +
+
+
+GimpVectorsComboBox, struct in GimpItemComboBox +
+
+
+GimpVectorsConstraintFunc, typedef in GimpItemComboBox +
+
+
+gimp_vectors_bezier_stroke_conicto, function in gimpvectors +
+
+
+gimp_vectors_bezier_stroke_cubicto, function in gimpvectors +
+
+
+gimp_vectors_bezier_stroke_lineto, function in gimpvectors +
+
+
+gimp_vectors_bezier_stroke_new_ellipse, function in gimpvectors +
+
+
+gimp_vectors_bezier_stroke_new_moveto, function in gimpvectors +
+
+
+gimp_vectors_combo_box_new, function in GimpItemComboBox +
+
+
+gimp_vectors_copy, function in gimpvectors +
+
+
+gimp_vectors_export_to_file, function in gimpvectors +
+
+
+gimp_vectors_export_to_string, function in gimpvectors +
+
+
+gimp_vectors_get_image, function in gimpvectors +
+
+
+gimp_vectors_get_linked, function in gimpvectors +
+
+
+gimp_vectors_get_name, function in gimpvectors +
+
+
+gimp_vectors_get_strokes, function in gimpvectors +
+
+
+gimp_vectors_get_tattoo, function in gimpvectors +
+
+
+gimp_vectors_get_visible, function in gimpvectors +
+
+
+gimp_vectors_import_from_file, function in gimpvectors +
+
+
+gimp_vectors_import_from_string, function in gimpvectors +
+
+
+gimp_vectors_is_valid, function in gimpvectors +
+
+
+gimp_vectors_new, function in gimpvectors +
+
+
+gimp_vectors_new_from_text_layer, function in gimpvectors +
+
+
+gimp_vectors_parasite_attach, function in gimpvectors +
+
+
+gimp_vectors_parasite_detach, function in gimpvectors +
+
+
+gimp_vectors_parasite_find, function in gimpvectors +
+
+
+gimp_vectors_parasite_list, function in gimpvectors +
+
+
+gimp_vectors_remove_stroke, function in gimpvectors +
+
+
+gimp_vectors_set_linked, function in gimpvectors +
+
+
+gimp_vectors_set_name, function in gimpvectors +
+
+
+gimp_vectors_set_tattoo, function in gimpvectors +
+
+
+gimp_vectors_set_visible, function in gimpvectors +
+
+
+gimp_vectors_stroke_close, function in gimpvectors +
+
+
+gimp_vectors_stroke_flip, function in gimpvectors +
+
+
+gimp_vectors_stroke_flip_free, function in gimpvectors +
+
+
+gimp_vectors_stroke_get_length, function in gimpvectors +
+
+
+gimp_vectors_stroke_get_points, function in gimpvectors +
+
+
+gimp_vectors_stroke_get_point_at_dist, function in gimpvectors +
+
+
+gimp_vectors_stroke_interpolate, function in gimpvectors +
+
+
+gimp_vectors_stroke_new_from_points, function in gimpvectors +
+
+
+gimp_vectors_stroke_rotate, function in gimpvectors +
+
+
+gimp_vectors_stroke_scale, function in gimpvectors +
+
+
+gimp_vectors_stroke_translate, function in gimpvectors +
+
+
+gimp_vectors_to_selection, function in gimpvectors +
+
+
+gimp_version, function in gimp +
+
+

W

+
+gimp_window_set_transient, function in gimpui +
+
+
+gimp_window_set_transient_for_display, function in gimpui +
+
+
+gimp_wm_class, function in gimp +
+
+

Z

+
+GimpZoomPreview, struct in GimpZoomPreview +
+
+
+GimpZoomPreview:drawable, object property in GimpZoomPreview +
+
+
+GimpZoomPreview:drawable-id, object property in GimpZoomPreview +
+
+
+GimpZoomPreview:model, object property in GimpZoomPreview +
+
+
+gimp_zoom_preview_get_drawable, function in GimpZoomPreview +
+
+
+gimp_zoom_preview_get_drawable_id, function in GimpZoomPreview +
+
+
+gimp_zoom_preview_get_factor, function in GimpZoomPreview +
+
+
+gimp_zoom_preview_get_model, function in GimpZoomPreview +
+
+
+gimp_zoom_preview_get_source, function in GimpZoomPreview +
+
+
+gimp_zoom_preview_new, function in GimpZoomPreview +
+
+
+gimp_zoom_preview_new_from_drawable_id, function in GimpZoomPreview +
+
+
+gimp_zoom_preview_new_with_model, function in GimpZoomPreview +
+
+
+gimp_zoom_preview_new_with_model_from_drawable_id, function in GimpZoomPreview +
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/home.png b/devel-docs/libgimp/html/home.png new file mode 100644 index 0000000..bf327ac Binary files /dev/null and b/devel-docs/libgimp/html/home.png differ diff --git a/devel-docs/libgimp/html/index.html b/devel-docs/libgimp/html/index.html new file mode 100644 index 0000000..55172d3 --- /dev/null +++ b/devel-docs/libgimp/html/index.html @@ -0,0 +1,304 @@ + + + + +GIMP Library Reference Manual: GIMP Library Reference Manual + + + + + + + +
+
+
+
+

+ for GIMP 2.10.22 + +

+
+
+
+
+
I. GIMP Library
+
+
Functions not Related to Specific Images
+
+
+gimp — Miscellaneous procedures +
+
+gimpenums +
+
+gimpbuffer — Functions for manipulating cut buffers. +
+
+gimpcontext — Functions to manipulate a plug-in's context. +
+
+gimpgimprc — Interactions with settings from gimprc. +
+
+gimphelp — Loading help pages using gimp_help. +
+
+gimpmessage — Display a dialog box with a message. +
+
+gimpplugin — Functions useful for plug-ins, e.g. registration and progress indicators. +
+
+gimpproceduraldb — Functions for querying and changing procedural database (PDB) entries. +
+
+gimpprogress — Functions for embedding the progress bar into a plug-in's GUI. +
+
+gimpdebug — Debug utility functions +
+
+
Manipulating Images and their Properties
+
+
+gimpchannel — Functions for manipulating channels. +
+
+gimpcolor — Functions for manipulating color. +
+
+gimpdisplay — Functions to create, delete and flush displays (views) on an image. +
+
+gimpdrawable — Functions to manipulate drawables. +
+
+gimpdrawablecolor — Functions for manipulating a drawable's color. +
+
+gimpdrawableedit — Drawable edit functions (clear, fill, gradient, stroke etc.) +
+
+gimpdrawabletransform — Functions to perform transformatrions on drawables. +
+
+gimpedit — Edit menu functions (cut, copy, paste, clear, etc.) +
+
+gimpfileops — Image file operations (load, save, etc.) +
+
+gimpfloatingsel — Functions for removing or attaching floating selections. +
+
+gimpimage — Operations on complete images. +
+
+gimpimagecolorprofile — Operations on an image's color profile. +
+
+gimpimageconvert — Conversions between RGB, indexed, and grayscale modes. +
+
+gimpimagegrid — Functions manuipulating an image's grid. +
+
+gimpimageguides — Functions for manipulating an image's guides. +
+
+gimpimagesamplepoints — Functions for manipulating an image's sample points. +
+
+gimpimageselect — Modify the image's selection. +
+
+gimpimagetransform — Transformations on images. +
+
+gimpimageundo — Control of image undo/redo. +
+
+gimpmetadata +
+
+gimpitem — Functions to manipulate items. +
+
+gimpitemtransform — Functions to perform transformations on items. +
+
+gimplayer — Operations on a single layer. +
+
+gimppaths — Deprecated operations related to paths. +
+
+gimppixbuf — Get a thumbnail pixbuf for a drawable or image. +
+
+gimppixelfetcher — Functions for operating on pixel regions. +
+
+gimppixelrgn — Functions for operating on pixel regions. +
+
+gimpregioniterator — Functions to traverse a pixel regions. +
+
+gimpselection — Functions for manipulating selections. +
+
+gimptextlayer — Functions for querying and manipulating text layers. +
+
+gimptexttool — Functions for controlling the text tool. +
+
+gimptile — Functions for working with tiles. +
+
+gimppainttools — Access to toolbox paint tools. +
+
+gimpselectiontools — Access to toolbox selection tools. +
+
+gimptransformtools — Access to toolbox transform tools. +
+
+gimpvectors — Functions for querying and manipulating vectors. +
+
+
Data Objects
+
+
+gimpbrush — Functions operating on a single brush. +
+
+gimpbrushes — Functions for manipulating brushes. +
+
+gimpdynamics — Operations related to paint dynamics. +
+
+gimpfonts — Operations related to fonts. +
+
+gimpgradient — Functions operating on a single gradient. +
+
+gimpgradients — Operations related to gradients. +
+
+gimppalette — Functions operating on a single palette. +
+
+gimppalettes — Operations related to palettes. +
+
+gimppattern — Functions operating on a single pattern. +
+
+gimppatterns — Functions relating to patterns. +
+
+
Controlling the Core's Selection Dialogs
+
+
+GimpSelectButton — The base class of the data select buttons. +
+
+gimpbrushselectbutton — A button that pops up a brush selection dialog. +
+
+GimpFontSelectButton — A button which pops up a font selection dialog. +
+
+GimpGradientSelectButton — A button which pops up a gradient select dialog. +
+
+GimpPaletteSelect — A button which pops up a palette select dialog. +
+
+GimpPatternSelectButton — A button which pops up a pattern select dialog. +
+
+gimpbrushselect — Functions providing a brush selection dialog. +
+
+gimpfontselect — Functions providing a font selection dialog. +
+
+gimpgradientselect — Functions providing a gradient selection dialog. +
+
+gimppaletteselect — Functions providing a palette selection dialog. +
+
+gimppatternselect — Functions providing a pattern selection dialog. +
+
+
+
II. GIMP User Interface Library
+
+
Object Hierarchy
+
+gimpui — Common user interface functions. This header includes +all other GIMP User Interface Library headers. +
+
+gimpexport — Export an image before it is saved. +
+
+GimpDrawablePreview — A widget providing a preview of a GimpDrawable. +
+
+GimpAspectPreview — A widget providing a preview with fixed aspect ratio. +
+
+GimpZoomPreview — A drawable preview with zooming capabilities. +
+
+GimpItemComboBox — Widgets providing popup menus of items. +
+
+GimpImageComboBox — A widget providing a popup menu of images. +
+
+GimpProgressBar — A widget providing a progress bar. +
+
+gimpmenu — Menus for selecting images, layers, channels +and drawables. +
+
+gimpbrushmenu — A widget for selecting brushes. +
+
+gimpfontmenu — A widget for selecting fonts. +
+
+gimpgradientmenu — A widget for selecting gradients. +
+
+gimppalettemenu — A widget for selecting palettes. +
+
+gimppatternmenu — A widget for selecting patterns. +
+
+GimpProcBrowserDialog — The dialog for the procedure and plugin browsers. +
+
+GimpProcView — A widget showing information about a PDB procedure. +
+
+
Index
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/left-insensitive.png b/devel-docs/libgimp/html/left-insensitive.png new file mode 100644 index 0000000..a214ac6 Binary files /dev/null and b/devel-docs/libgimp/html/left-insensitive.png differ diff --git a/devel-docs/libgimp/html/left.png b/devel-docs/libgimp/html/left.png new file mode 100644 index 0000000..c11c1d0 Binary files /dev/null and b/devel-docs/libgimp/html/left.png differ diff --git a/devel-docs/libgimp/html/libgimp-GimpItemComboBox.html b/devel-docs/libgimp/html/libgimp-GimpItemComboBox.html new file mode 100644 index 0000000..43c10aa --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-GimpItemComboBox.html @@ -0,0 +1,368 @@ + + + + +GimpItemComboBox: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

GimpItemComboBox

+

GimpItemComboBox — Widgets providing popup menus of items.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+gboolean + +(*GimpItemConstraintFunc) () +
+GtkWidget * + +gimp_drawable_combo_box_new () +
+GtkWidget * + +gimp_channel_combo_box_new () +
+GtkWidget * + +gimp_layer_combo_box_new () +
+GtkWidget * + +gimp_vectors_combo_box_new () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
 GimpDrawableComboBox
typedefGimpDrawableConstraintFunc
 GimpChannelComboBox
 GimpLayerComboBox
 GimpVectorsComboBox
typedefGimpVectorsConstraintFunc
+
+
+

Object Hierarchy

+
    GObject
+    ╰── GInitiallyUnowned
+        ╰── GtkObject
+            ╰── GtkWidget
+                ╰── GtkContainer
+                    ╰── GtkBin
+                        ╰── GtkComboBox
+                            ╰── GimpIntComboBox
+                                ├── GimpChannelComboBox
+                                ├── GimpDrawableComboBox
+                                ├── GimpLayerComboBox
+                                ╰── GimpVectorsComboBox
+
+
+
+

Implemented Interfaces

+

+GimpDrawableComboBox implements + AtkImplementorIface, GtkBuildable, GtkCellLayout and GtkCellEditable.

+

+GimpChannelComboBox implements + AtkImplementorIface, GtkBuildable, GtkCellLayout and GtkCellEditable.

+

+GimpLayerComboBox implements + AtkImplementorIface, GtkBuildable, GtkCellLayout and GtkCellEditable.

+

+GimpVectorsComboBox implements + AtkImplementorIface, GtkBuildable, GtkCellLayout and GtkCellEditable.

+
+
+

Description

+

Widgets providing popup menus of items (layers, channels, +drawables, vectors).

+
+
+

Functions

+
+

GimpItemConstraintFunc ()

+
gboolean
+(*GimpItemConstraintFunc) (gint32 image_id,
+                           gint32 item_id,
+                           gpointer data);
+
+
+
+

gimp_drawable_combo_box_new ()

+
GtkWidget *
+gimp_drawable_combo_box_new (GimpDrawableConstraintFunc constraint,
+                             gpointer data);
+

Creates a new GimpIntComboBox filled with all currently opened +drawables. If a constraint + function is specified, it is called for +each drawable and only if the function returns TRUE, the drawable +is added to the combobox.

+

You should use gimp_int_combo_box_connect() to initialize and connect +the combo. Use gimp_int_combo_box_set_active() to get the active +drawable ID and gimp_int_combo_box_get_active() to retrieve the ID +of the selected drawable.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

constraint

a GimpDrawableConstraintFunc or NULL

 

data

a pointer that is passed to constraint +

 
+
+
+

Returns

+

a new GimpIntComboBox.

+
+

Since: 2.2

+
+
+
+

gimp_channel_combo_box_new ()

+
GtkWidget *
+gimp_channel_combo_box_new (GimpDrawableConstraintFunc constraint,
+                            gpointer data);
+

Creates a new GimpIntComboBox filled with all currently opened +channels. See gimp_drawable_combo_box_new() for more information.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

constraint

a GimpDrawableConstraintFunc or NULL

 

data

a pointer that is passed to constraint +

 
+
+
+

Returns

+

a new GimpIntComboBox.

+
+

Since: 2.2

+
+
+
+

gimp_layer_combo_box_new ()

+
GtkWidget *
+gimp_layer_combo_box_new (GimpDrawableConstraintFunc constraint,
+                          gpointer data);
+

Creates a new GimpIntComboBox filled with all currently opened +layers. See gimp_drawable_combo_box_new() for more information.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

constraint

a GimpDrawableConstraintFunc or NULL

 

data

a pointer that is passed to constraint +

 
+
+
+

Returns

+

a new GimpIntComboBox.

+
+

Since: 2.2

+
+
+
+

gimp_vectors_combo_box_new ()

+
GtkWidget *
+gimp_vectors_combo_box_new (GimpVectorsConstraintFunc constraint,
+                            gpointer data);
+

Creates a new GimpIntComboBox filled with all currently opened +vectors objects. If a constraint + function is specified, it is called for +each vectors object and only if the function returns TRUE, the vectors +object is added to the combobox.

+

You should use gimp_int_combo_box_connect() to initialize and connect +the combo. Use gimp_int_combo_box_set_active() to set the active +vectors ID and gimp_int_combo_box_get_active() to retrieve the ID +of the selected vectors object.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

constraint

a GimpVectorsConstraintFunc or NULL

 

data

a pointer that is passed to constraint +

 
+
+
+

Returns

+

a new GimpIntComboBox.

+
+

Since: 2.4

+
+
+
+

Types and Values

+
+

GimpDrawableComboBox

+
typedef struct _GimpDrawableComboBox GimpDrawableComboBox;
+
+
+
+

GimpDrawableConstraintFunc

+
typedef GimpItemConstraintFunc GimpDrawableConstraintFunc;
+
+
+
+
+

GimpChannelComboBox

+
typedef struct _GimpChannelComboBox GimpChannelComboBox;
+
+
+
+

GimpLayerComboBox

+
typedef struct _GimpLayerComboBox GimpLayerComboBox;
+
+
+
+

GimpVectorsComboBox

+
typedef struct _GimpVectorsComboBox GimpVectorsComboBox;
+
+
+
+

GimpVectorsConstraintFunc

+
typedef GimpItemConstraintFunc GimpVectorsConstraintFunc;
+
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-GimpProcView.html b/devel-docs/libgimp/html/libgimp-GimpProcView.html new file mode 100644 index 0000000..56a314a --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-GimpProcView.html @@ -0,0 +1,84 @@ + + + + +GimpProcView: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

GimpProcView

+

GimpProcView — A widget showing information about a PDB procedure.

+
+
+

Functions

+
++++ + + + + +
+GtkWidget * + +gimp_proc_view_new () +
+
+
+

Description

+

A widget showing information about a PDB procedure, mainly for the +procedure and plug-in browsers.

+
+
+

Functions

+
+

gimp_proc_view_new ()

+
GtkWidget *
+gimp_proc_view_new (const gchar *name,
+                    const gchar *menu_path,
+                    const gchar *blurb,
+                    const gchar *help,
+                    const gchar *author,
+                    const gchar *copyright,
+                    const gchar *date,
+                    GimpPDBProcType type,
+                    gint n_params,
+                    gint n_return_vals,
+                    const GimpParamDef *params,
+                    const GimpParamDef *return_vals);
+
+

Returns

+

a new widget providing a view on a GIMP procedure

+
+

Since: 2.4

+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-data.html b/devel-docs/libgimp/html/libgimp-data.html new file mode 100644 index 0000000..e3ffb3e --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-data.html @@ -0,0 +1,61 @@ + + + + +Data Objects: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+

+Data Objects

+
+
+gimpbrush — Functions operating on a single brush. +
+
+gimpbrushes — Functions for manipulating brushes. +
+
+gimpdynamics — Operations related to paint dynamics. +
+
+gimpfonts — Operations related to fonts. +
+
+gimpgradient — Functions operating on a single gradient. +
+
+gimpgradients — Operations related to gradients. +
+
+gimppalette — Functions operating on a single palette. +
+
+gimppalettes — Operations related to palettes. +
+
+gimppattern — Functions operating on a single pattern. +
+
+gimppatterns — Functions relating to patterns. +
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-general.html b/devel-docs/libgimp/html/libgimp-general.html new file mode 100644 index 0000000..a7ee395 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-general.html @@ -0,0 +1,64 @@ + + + + +Functions not Related to Specific Images: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+

+Functions not Related to Specific Images

+
+
+gimp — Miscellaneous procedures +
+
+gimpenums +
+
+gimpbuffer — Functions for manipulating cut buffers. +
+
+gimpcontext — Functions to manipulate a plug-in's context. +
+
+gimpgimprc — Interactions with settings from gimprc. +
+
+gimphelp — Loading help pages using gimp_help. +
+
+gimpmessage — Display a dialog box with a message. +
+
+gimpplugin — Functions useful for plug-ins, e.g. registration and progress indicators. +
+
+gimpproceduraldb — Functions for querying and changing procedural database (PDB) entries. +
+
+gimpprogress — Functions for embedding the progress bar into a plug-in's GUI. +
+
+gimpdebug — Debug utility functions +
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimp.html b/devel-docs/libgimp/html/libgimp-gimp.html new file mode 100644 index 0000000..756161a --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimp.html @@ -0,0 +1,1857 @@ + + + + +gimp: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimp

+

gimp — Miscellaneous procedures

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+gchar * + +gimp_version () +
+gint + +gimp_getpid () +
+void + +(*GimpInitProc) () +
+void + +(*GimpQuitProc) () +
+void + +(*GimpQueryProc) () +
+void + +(*GimpRunProc) () +
#defineMAIN
+gint + +gimp_main () +
+void + +gimp_quit () +
+void + +gimp_install_procedure () +
+void + +gimp_install_temp_proc () +
+void + +gimp_uninstall_temp_proc () +
+GimpParam * + +gimp_run_procedure () +
+GimpParam * + +gimp_run_procedure2 () +
+void + +gimp_destroy_params () +
+void + +gimp_destroy_paramdefs () +
const gchar * + +gimp_get_pdb_error () +
+GimpPDBStatusType + +gimp_get_pdb_status () +
+guint + +gimp_tile_width () +
+guint + +gimp_tile_height () +
+gint + +gimp_shm_ID () +
+guchar * + +gimp_shm_addr () +
+gdouble + +gimp_gamma () +
+gboolean + +gimp_install_cmap () +
+gint + +gimp_min_colors () +
+gboolean + +gimp_show_tool_tips () +
+gboolean + +gimp_show_help_button () +
+gboolean + +gimp_export_color_profile () +
+gboolean + +gimp_export_exif () +
+gboolean + +gimp_export_iptc () +
+gboolean + +gimp_export_xmp () +
+GimpCheckSize + +gimp_check_size () +
+GimpCheckType + +gimp_check_type () +
+gint32 + +gimp_default_display () +
const gchar * + +gimp_wm_class () +
const gchar * + +gimp_display_name () +
+gint + +gimp_monitor_number () +
+guint32 + +gimp_user_time () +
const gchar * + +gimp_icon_theme_dir () +
const gchar * + +gimp_get_progname () +
+void + +gimp_extension_enable () +
+void + +gimp_extension_ack () +
+void + +gimp_extension_process () +
+gboolean + +gimp_attach_parasite () +
+gboolean + +gimp_detach_parasite () +
+GimpParasite * + +gimp_parasite_find () +
+gboolean + +gimp_parasite_list () +
+GimpParasite * + +gimp_get_parasite () +
+gchar ** + +gimp_get_parasite_list () +
+gboolean + +gimp_parasite_attach () +
+gboolean + +gimp_parasite_detach () +
+gboolean + +gimp_attach_new_parasite () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#definegimp_get_data
#definegimp_get_data_size
#definegimp_set_data
 GimpPlugInInfo
 GimpParamDef
 GimpParamRegion
 GimpParamData
 GimpParam
+
+
+

Description

+

Miscellaneous procedures not fitting in any category.

+
+
+

Functions

+
+

gimp_version ()

+
gchar *
+gimp_version (void);
+

Returns the host GIMP version.

+

This procedure returns the version number of the currently running +GIMP.

+
+

Returns

+

GIMP version number.

+
+
+
+
+

gimp_getpid ()

+
gint
+gimp_getpid (void);
+

Returns the PID of the host GIMP process.

+

This procedure returns the process ID of the currently running GIMP.

+
+

Returns

+

The PID.

+
+

Since: 2.4

+
+
+
+

GimpInitProc ()

+
void
+(*GimpInitProc) (void);
+
+
+
+

GimpQuitProc ()

+
void
+(*GimpQuitProc) (void);
+
+
+
+

GimpQueryProc ()

+
void
+(*GimpQueryProc) (void);
+
+
+
+

GimpRunProc ()

+
void
+(*GimpRunProc) (const gchar *name,
+                gint n_params,
+                const GimpParam *param,
+                gint *n_return_vals,
+                GimpParam **return_vals);
+
+
+
+

MAIN

+
#define             MAIN()
+

A macro that expands to the appropriate main() function for the +platform being compiled for.

+

To use this macro, simply place a line that contains just the code +MAIN() at the toplevel of your file. No semicolon should be used.

+
+
+
+

gimp_main ()

+
gint
+gimp_main (const GimpPlugInInfo *info,
+           gint argc,
+           gchar *argv[]);
+

The main procedure that must be called with the PLUG_IN_INFO structure +and the 'argc' and 'argv' that are passed to "main".

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

info

the PLUG_IN_INFO structure

 

argc

the number of arguments

 

argv

the arguments

 
+
+
+

Returns

+

an exit status as defined by the C library, +on success EXIT_SUCCESS.

+
+
+
+
+

gimp_quit ()

+
void
+gimp_quit (void);
+

Forcefully causes the GIMP library to exit and close down its +connection to main gimp application. This function never returns.

+
+
+
+

gimp_install_procedure ()

+
void
+gimp_install_procedure (const gchar *name,
+                        const gchar *blurb,
+                        const gchar *help,
+                        const gchar *author,
+                        const gchar *copyright,
+                        const gchar *date,
+                        const gchar *menu_label,
+                        const gchar *image_types,
+                        GimpPDBProcType type,
+                        gint n_params,
+                        gint n_return_vals,
+                        const GimpParamDef *params,
+                        const GimpParamDef *return_vals);
+

Installs a new procedure with the PDB (procedural database).

+

Call this function from within your plug-in's query() function for +each procedure your plug-in implements.

+

The name + parameter is mandatory and should be unique, or it will +overwrite an already existing procedure (overwrite procedures only +if you know what you're doing).

+

The blurb +, help +, author +, copyright + and date + parameters are +optional but then you shouldn't write procedures without proper +documentation, should you.

+

menu_label + defines the label that should be used for the +procedure's menu entry. The position where to register in the menu +hierarchy is chosen using gimp_plugin_menu_register(). This +function also still accepts the old (pre-2.2) way of registering a +menu entry and takes a string in the form +"<Domain>/Path/To/My/Menu" +(e.g. "<Image>/Filters/Render/Useless").

+

Note that registering a full (pre-2.2-style) menu path is +deprecated and will cause a failure in GIMP 3.0 and newer.

+

It is possible to register a procedure only for keyboard-shortcut +activation by passing a menu_label + to gimp_install_procedure() but +not registering any menu path with gimp_plugin_menu_register(). In +this case, the given menu_label + will only be used as the +procedure's user-visible name in the keyboard shortcut editor.

+

image_types + is a comma separated list of image types, or actually +drawable types, that this procedure can deal with. Wildcards are +possible here, so you could say "RGB*" instead of "RGB, RGBA" or +"*" for all image types. If the procedure doesn't need an image to +run, use the empty string.

+

type + must be one of GIMP_PLUGIN or GIMP_EXTENSION. Note that +temporary procedures must be installed using +gimp_install_temp_proc().

+

NOTE: Unlike the GIMP 1.2 API, GIMP_EXTENSION no longer means +that the procedure's menu prefix is <Toolbox>, but that +it will install temporary procedures. Therefore, the GIMP core +will wait until the GIMP_EXTENSION procedure has called +gimp_extension_ack(), which means that the procedure has done +its initialization, installed its temporary procedures and is +ready to run.

+

Not calling gimp_extension_ack() from a GIMP_EXTENSION +procedure will cause the GIMP core to lock up.

+

Additionally, a GIMP_EXTENSION procedure with no parameters +(n_params + == 0 and params + == NULL) is an "automatic" extension +that will be automatically started on each GIMP startup.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

name

the procedure's name.

 

blurb

a short text describing what the procedure does.

 

help

the help text for the procedure (usually considerably +longer than blurb +).

 

author

the procedure's author(s).

 

copyright

the procedure's copyright.

 

date

the date the procedure was added.

 

menu_label

the label to use for the procedure's menu entry, +or NULL if the procedure has no menu entry.

 

image_types

the drawable types the procedure can handle.

 

type

the type of the procedure.

 

n_params

the number of parameters the procedure takes.

 

n_return_vals

the number of return values the procedure returns.

 

params

the procedure's parameters.

 

return_vals

the procedure's return values.

 
+
+
+
+
+

gimp_install_temp_proc ()

+
void
+gimp_install_temp_proc (const gchar *name,
+                        const gchar *blurb,
+                        const gchar *help,
+                        const gchar *author,
+                        const gchar *copyright,
+                        const gchar *date,
+                        const gchar *menu_label,
+                        const gchar *image_types,
+                        GimpPDBProcType type,
+                        gint n_params,
+                        gint n_return_vals,
+                        const GimpParamDef *params,
+                        const GimpParamDef *return_vals,
+                        GimpRunProc run_proc);
+

Installs a new temporary procedure with the PDB (procedural database).

+

A temporary procedure is a procedure which is only available while +one of your plug-in's "real" procedures is running.

+

See gimp_install_procedure() for most details.

+

type + must be GIMP_TEMPORARY or the function +will fail.

+

run_proc + is the function which will be called to execute the +procedure.

+

NOTE: Normally, plug-in communication is triggered by the plug-in +and the GIMP core only responds to the plug-in's requests. You must +explicitly enable receiving of temporary procedure run requests +using either gimp_extension_enable() or +gimp_extension_process(). See this functions' documentation for +details.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

name

the procedure's name.

 

blurb

a short text describing what the procedure does.

 

help

the help text for the procedure (usually considerably +longer than blurb +).

 

author

the procedure's author(s).

 

copyright

the procedure's copyright.

 

date

the date the procedure was added.

 

menu_label

the procedure's menu label, or NULL if the procedure has +no menu entry.

 

image_types

the drawable types the procedure can handle.

 

type

the type of the procedure.

 

n_params

the number of parameters the procedure takes.

 

n_return_vals

the number of return values the procedure returns.

 

params

the procedure's parameters.

 

return_vals

the procedure's return values.

 

run_proc

the function to call for executing the procedure.

 
+
+
+
+
+

gimp_uninstall_temp_proc ()

+
void
+gimp_uninstall_temp_proc (const gchar *name);
+

Uninstalls a temporary procedure which has previously been +installed using gimp_install_temp_proc().

+
+

Parameters

+
+++++ + + + + + +

name

the procedure's name

 
+
+
+
+
+

gimp_run_procedure ()

+
GimpParam *
+gimp_run_procedure (const gchar *name,
+                    gint *n_return_vals,
+                    ...);
+

This function calls a GIMP procedure and returns its return values.

+

The procedure's parameters are given by a va_list in the format +(type, value, type, value) and must be terminated by GIMP_PDB_END.

+

This function converts the va_list of parameters into an array and +passes them to gimp_run_procedure2(). Please look there for further +information.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

name

the name of the procedure to run

 

n_return_vals

return location for the number of return values

 

...

list of procedure parameters

 
+
+
+

Returns

+

the procedure's return values unless there was an error, +in which case the zero-th return value will be the error status, and +the first return value will be a string detailing the error.

+
+
+
+
+

gimp_run_procedure2 ()

+
GimpParam *
+gimp_run_procedure2 (const gchar *name,
+                     gint *n_return_vals,
+                     gint n_params,
+                     const GimpParam *params);
+

This function calls a GIMP procedure and returns its return values. +To get more information about the available procedures and the +parameters they expect, please have a look at the Procedure Browser +as found in the Xtns menu in GIMP's toolbox.

+

As soon as you don't need the return values any longer, you should +free them using gimp_destroy_params().

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

name

the name of the procedure to run

 

n_return_vals

return location for the number of return values

 

n_params

the number of parameters the procedure takes.

 

params

the procedure's parameters array.

 
+
+
+

Returns

+

the procedure's return values unless there was an error, +in which case the zero-th return value will be the error status, and +if there are two values returned, the other return value will be a +string detailing the error.

+
+
+
+
+

gimp_destroy_params ()

+
void
+gimp_destroy_params (GimpParam *params,
+                     gint n_params);
+

Destroys a GimpParam array as returned by gimp_run_procedure() or +gimp_run_procedure2().

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

params

the GimpParam array to destroy

 

n_params

the number of elements in the array

 
+
+
+
+
+

gimp_destroy_paramdefs ()

+
void
+gimp_destroy_paramdefs (GimpParamDef *paramdefs,
+                        gint n_params);
+

Destroys a GimpParamDef array as returned by +gimp_procedural_db_proc_info().

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

paramdefs

the GimpParamDef array to destroy

 

n_params

the number of elements in the array

 
+
+
+
+
+

gimp_get_pdb_error ()

+
const gchar *
+gimp_get_pdb_error (void);
+

Retrieves the error message from the last procedure call.

+

If a procedure call fails, then it might pass an error message with +the return values. Plug-ins that are using the libgimp C wrappers +don't access the procedure return values directly. Thus libgimp +stores the error message and makes it available with this +function. The next procedure call unsets the error message again.

+

The returned string is owned by libgimp and must not be freed or +modified.

+
+

Returns

+

the error message

+
+

Since: 2.6

+
+
+
+

gimp_get_pdb_status ()

+
GimpPDBStatusType
+gimp_get_pdb_status (void);
+

Retrieves the status from the last procedure call.

+
+

Returns

+

the GimpPDBStatusType.

+
+

Since: 2.10

+
+
+
+

gimp_tile_width ()

+
guint
+gimp_tile_width (void);
+

Returns the tile width GIMP is using.

+

This is a constant value given at plug-in configuration time.

+
+

Returns

+

the tile_width

+
+
+
+
+

gimp_tile_height ()

+
guint
+gimp_tile_height (void);
+

Returns the tile height GIMP is using.

+

This is a constant value given at plug-in configuration time.

+
+

Returns

+

the tile_height

+
+
+
+
+

gimp_shm_ID ()

+
gint
+gimp_shm_ID (void);
+

Returns the shared memory ID used for passing tile data between the +GIMP core and the plug-in.

+

This is a constant value given at plug-in configuration time.

+
+

Returns

+

the shared memory ID

+
+
+
+
+

gimp_shm_addr ()

+
guchar *
+gimp_shm_addr (void);
+

Returns the address of the shared memory segment used for passing +tile data between the GIMP core and the plug-in.

+

This is a constant value given at plug-in configuration time.

+
+

Returns

+

the shared memory address

+
+
+
+
+

gimp_gamma ()

+
gdouble
+gimp_gamma (void);
+

gimp_gamma is deprecated and should not be used in newly-written code.

+

Returns the global gamma value GIMP and all its plug-ins should +use.

+

This is a constant value.

+

NOTE: This function will always return 2.2, the gamma value for +sRGB. If you need the actual gamma value of a drawable, look at its +format.

+

See also: gimp_drawable_get_format().

+

Deprecated +: 2.8.4

+
+

Returns

+

the gamma value

+
+
+
+
+

gimp_install_cmap ()

+
gboolean
+gimp_install_cmap (void);
+

gimp_install_cmap is deprecated and should not be used in newly-written code.

+

Returns whether or not the plug-in should allocate an own colormap +when running on an 8 bit display. See also: gimp_min_colors().

+

This is a constant value given at plug-in configuration time.

+

Deprecated +: 2.8

+
+

Returns

+

the install_cmap boolean

+
+
+
+
+

gimp_min_colors ()

+
gint
+gimp_min_colors (void);
+

gimp_min_colors is deprecated and should not be used in newly-written code.

+

Returns the minimum number of colors to use when allocating an own +colormap on 8 bit displays.

+

This is a constant value given at plug-in configuration time.

+

See also: gimp_install_cmap()

+

Deprecated +: 2.8

+
+

Returns

+

the minimum number of colors to allocate

+
+
+
+
+

gimp_show_tool_tips ()

+
gboolean
+gimp_show_tool_tips (void);
+

Returns whether or not the plug-in should show tool-tips.

+

This is a constant value given at plug-in configuration time.

+
+

Returns

+

the show_tool_tips boolean

+
+
+
+
+

gimp_show_help_button ()

+
gboolean
+gimp_show_help_button (void);
+

Returns whether or not GimpDialog should automatically add a help +button if help_func and help_id are given.

+

This is a constant value given at plug-in configuration time.

+
+

Returns

+

the show_help_button boolean

+
+

Since: 2.2

+
+
+
+

gimp_export_color_profile ()

+
gboolean
+gimp_export_color_profile (void);
+

Returns whether file plug-ins should default to exporting the +image's color profile.

+
+

Returns

+

TRUE if preferences are set to export the color profile.

+
+

Since: 2.10.4

+
+
+
+

gimp_export_exif ()

+
gboolean
+gimp_export_exif (void);
+

Returns whether file plug-ins should default to exporting Exif +metadata, according preferences (original settings is FALSE since +metadata can contain sensitive information).

+
+

Returns

+

TRUE if preferences are set to export Exif.

+
+

Since: 2.10

+
+
+
+

gimp_export_iptc ()

+
gboolean
+gimp_export_iptc (void);
+

Returns whether file plug-ins should default to exporting IPTC +metadata, according preferences (original settings is FALSE since +metadata can contain sensitive information).

+
+

Returns

+

TRUE if preferences are set to export IPTC.

+
+

Since: 2.10

+
+
+
+

gimp_export_xmp ()

+
gboolean
+gimp_export_xmp (void);
+

Returns whether file plug-ins should default to exporting XMP +metadata, according preferences (original settings is FALSE since +metadata can contain sensitive information).

+
+

Returns

+

TRUE if preferences are set to export XMP.

+
+

Since: 2.10

+
+
+
+

gimp_check_size ()

+
GimpCheckSize
+gimp_check_size (void);
+

Returns the size of the checkerboard to be used in previews.

+

This is a constant value given at plug-in configuration time.

+
+

Returns

+

the check_size value

+
+

Since: 2.2

+
+
+
+

gimp_check_type ()

+
GimpCheckType
+gimp_check_type (void);
+

Returns the type of the checkerboard to be used in previews.

+

This is a constant value given at plug-in configuration time.

+
+

Returns

+

the check_type value

+
+

Since: 2.2

+
+
+
+

gimp_default_display ()

+
gint32
+gimp_default_display (void);
+

Returns the default display ID. This corresponds to the display the +running procedure's menu entry was invoked from.

+

This is a constant value given at plug-in configuration time.

+
+

Returns

+

the default display ID

+
+
+
+
+

gimp_wm_class ()

+
const gchar *
+gimp_wm_class (void);
+

Returns the window manager class to be used for plug-in windows.

+

This is a constant value given at plug-in configuration time.

+
+

Returns

+

the window manager class

+
+
+
+
+

gimp_display_name ()

+
const gchar *
+gimp_display_name (void);
+

Returns the display to be used for plug-in windows.

+

This is a constant value given at plug-in configuration time. +Will return NULL if GIMP has been started with no GUI, either +via "--no-interface" flag, or a console build.

+
+

Returns

+

the display name

+
+
+
+
+

gimp_monitor_number ()

+
gint
+gimp_monitor_number (void);
+

Returns the monitor number to be used for plug-in windows.

+

This is a constant value given at plug-in configuration time.

+
+

Returns

+

the monitor number

+
+
+
+
+

gimp_user_time ()

+
guint32
+gimp_user_time (void);
+

Returns the timestamp of the user interaction that should be set on +the plug-in window. This is handled transparently, plug-in authors +do not have to care about it.

+

This is a constant value given at plug-in configuration time.

+
+

Returns

+

timestamp for plug-in window

+
+

Since: 2.6

+
+
+
+

gimp_icon_theme_dir ()

+
const gchar *
+gimp_icon_theme_dir (void);
+
+
+
+

gimp_get_progname ()

+
const gchar *
+gimp_get_progname (void);
+

Returns the plug-in's executable name.

+
+

Returns

+

the executable name

+
+
+
+
+

gimp_extension_enable ()

+
void
+gimp_extension_enable (void);
+

Enables asynchronous processing of messages from the main GIMP +application.

+

Normally, a plug-in is not called by GIMP except for the call to +the procedure it implements. All subsequent communication is +triggered by the plug-in and all messages sent from GIMP to the +plug-in are just answers to requests the plug-in made.

+

If the plug-in however registered temporary procedures using +gimp_install_temp_proc(), it needs to be able to receive requests +to execute them. Usually this will be done by running +gimp_extension_process() in an endless loop.

+

If the plug-in cannot use gimp_extension_process(), i.e. if it has +a GUI and is hanging around in a GMainLoop, it must call +gimp_extension_enable().

+

Note that the plug-in does not need to be a GIMP_EXTENSION to +register temporary procedures.

+

See also: gimp_install_procedure(), gimp_install_temp_proc()

+
+
+
+

gimp_extension_ack ()

+
void
+gimp_extension_ack (void);
+

Notify the main GIMP application that the extension has been properly +initialized and is ready to run.

+

This function must be called from every +procedure that was registered as GIMP_EXTENSION.

+

Subsequently, extensions can process temporary procedure run +requests using either gimp_extension_enable() or +gimp_extension_process().

+

See also: gimp_install_procedure(), gimp_install_temp_proc()

+
+
+
+

gimp_extension_process ()

+
void
+gimp_extension_process (guint timeout);
+

Processes one message sent by GIMP and returns.

+

Call this function in an endless loop after calling +gimp_extension_ack() to process requests for running temporary +procedures.

+

See gimp_extension_enable() for an asynchronous way of doing the +same if running an endless loop is not an option.

+

See also: gimp_install_procedure(), gimp_install_temp_proc()

+
+

Parameters

+
+++++ + + + + + +

timeout

The timeout (in ms) to use for the select() call.

 
+
+
+
+
+

gimp_attach_parasite ()

+
gboolean
+gimp_attach_parasite (const GimpParasite *parasite);
+

Add a global parasite.

+

This procedure attaches a global parasite. It has no return values.

+
+

Parameters

+
+++++ + + + + + +

parasite

The parasite to attach.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_detach_parasite ()

+
gboolean
+gimp_detach_parasite (const gchar *name);
+

Removes a global parasite.

+

This procedure detaches a global parasite from. It has no return +values.

+
+

Parameters

+
+++++ + + + + + +

name

The name of the parasite to detach.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_parasite_find ()

+
GimpParasite *
+gimp_parasite_find (const gchar *name);
+
+

gimp_parasite_find is deprecated and should not be used in newly-written code.

+

Use gimp_get_parasite() instead.

+
+
+

Parameters

+
+++++ + + + + + +

name

The name of the parasite to find.

 
+
+
+

Returns

+

The found parasite.

+
+
+
+
+

gimp_parasite_list ()

+
gboolean
+gimp_parasite_list (gint *num_parasites,
+                    gchar ***parasites);
+
+

gimp_parasite_list is deprecated and should not be used in newly-written code.

+

Use gimp_get_parasite_list() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

num_parasites

The number of attached parasites.

 

parasites

The names of currently attached parasites.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_get_parasite ()

+
GimpParasite *
+gimp_get_parasite (const gchar *name);
+

Look up a global parasite.

+

Finds and returns the global parasite that was previously attached.

+
+

Parameters

+
+++++ + + + + + +

name

The name of the parasite to find.

 
+
+
+

Returns

+

The found parasite.

+
+

Since: 2.8

+
+
+
+

gimp_get_parasite_list ()

+
gchar **
+gimp_get_parasite_list (gint *num_parasites);
+

List all parasites.

+

Returns a list of all currently attached global parasites.

+
+

Parameters

+
+++++ + + + + + +

num_parasites

The number of attached parasites.

 
+
+
+

Returns

+

The names of currently attached parasites. The returned +value must be freed with g_strfreev().

+
+

Since: 2.8

+
+
+
+

gimp_parasite_attach ()

+
gboolean
+gimp_parasite_attach (const GimpParasite *parasite);
+
+

gimp_parasite_attach is deprecated and should not be used in newly-written code.

+

Use gimp_attach_parasite() instead.

+
+
+

Parameters

+
+++++ + + + + + +

parasite

The parasite to attach.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_parasite_detach ()

+
gboolean
+gimp_parasite_detach (const gchar *name);
+
+

gimp_parasite_detach is deprecated and should not be used in newly-written code.

+

Use gimp_detach_parasite() instead.

+
+
+

Parameters

+
+++++ + + + + + +

name

The name of the parasite to detach.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_attach_new_parasite ()

+
gboolean
+gimp_attach_new_parasite (const gchar *name,
+                          gint flags,
+                          gint size,
+                          gconstpointer data);
+
+

gimp_attach_new_parasite is deprecated and should not be used in newly-written code.

+

Use gimp_attach_parasite() instead.

+
+

Convenience function that creates a parasite and attaches it +to GIMP.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

name

the name of the GimpParasite to create and attach.

 

flags

the flags set on the GimpParasite.

 

size

the size of the parasite data in bytes.

 

data

a pointer to the data attached with the GimpParasite.

 
+
+
+

Returns

+

TRUE on successful creation and attachment of +the new parasite.

+

See Also: gimp_attach_parasite()

+
+
+
+
+

Types and Values

+
+

gimp_get_data

+
#define gimp_get_data         gimp_procedural_db_get_data
+
+
+
+
+

gimp_get_data_size

+
#define gimp_get_data_size    gimp_procedural_db_get_data_size
+
+
+
+
+

gimp_set_data

+
#define gimp_set_data         gimp_procedural_db_set_data
+
+
+
+
+

GimpPlugInInfo

+
typedef struct {
+  GimpInitProc  init_proc;
+  GimpQuitProc  quit_proc;
+  GimpQueryProc query_proc;
+  GimpRunProc   run_proc;
+} GimpPlugInInfo;
+
+
+

Members

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

GimpInitProc init_proc;

called when the gimp application initially starts up

 

GimpQuitProc quit_proc;

called when the gimp application exits

 

GimpQueryProc query_proc;

called by gimp so that the plug-in can inform the +gimp of what it does. (ie. installing a procedure database +procedure).

 

GimpRunProc run_proc;

called to run a procedure the plug-in installed in the +procedure database.

 
+
+
+
+
+

GimpParamDef

+
typedef struct {
+  GimpPDBArgType  type;
+  gchar          *name;
+  gchar          *description;
+} GimpParamDef;
+
+
+
+
+

GimpParamRegion

+
typedef struct {
+  gint32 x;
+  gint32 y;
+  gint32 width;
+  gint32 height;
+} GimpParamRegion;
+
+
+
+
+

GimpParamData

+
+
+
+

GimpParam

+
typedef struct {
+  GimpPDBArgType type;
+  GimpParamData  data;
+} GimpParam;
+
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpbrush.html b/devel-docs/libgimp/html/libgimp-gimpbrush.html new file mode 100644 index 0000000..0359807 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpbrush.html @@ -0,0 +1,1028 @@ + + + + +gimpbrush: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpbrush

+

gimpbrush — Functions operating on a single brush.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+gchar * + +gimp_brush_new () +
+gchar * + +gimp_brush_duplicate () +
+gchar * + +gimp_brush_rename () +
+gboolean + +gimp_brush_delete () +
+gboolean + +gimp_brush_get_info () +
+gboolean + +gimp_brush_get_pixels () +
+gboolean + +gimp_brush_get_spacing () +
+gboolean + +gimp_brush_set_spacing () +
+GimpBrushGeneratedShape + +gimp_brush_get_shape () +
+GimpBrushGeneratedShape + +gimp_brush_set_shape () +
+gint + +gimp_brush_get_spikes () +
+gint + +gimp_brush_set_spikes () +
+gdouble + +gimp_brush_get_angle () +
+gdouble + +gimp_brush_set_angle () +
+gdouble + +gimp_brush_get_radius () +
+gdouble + +gimp_brush_set_radius () +
+gdouble + +gimp_brush_get_aspect_ratio () +
+gdouble + +gimp_brush_set_aspect_ratio () +
+gdouble + +gimp_brush_get_hardness () +
+gdouble + +gimp_brush_set_hardness () +
+gboolean + +gimp_brush_is_generated () +
+gboolean + +gimp_brush_is_editable () +
+
+
+

Description

+

Functions operating on a single brush.

+
+
+

Functions

+
+

gimp_brush_new ()

+
gchar *
+gimp_brush_new (const gchar *name);
+

Creates a new brush.

+

This procedure creates a new, uninitialized brush.

+
+

Parameters

+
+++++ + + + + + +

name

The requested name of the new brush.

 
+
+
+

Returns

+

The actual new brush name. The returned value must be freed +with g_free().

+
+

Since: 2.2

+
+
+
+

gimp_brush_duplicate ()

+
gchar *
+gimp_brush_duplicate (const gchar *name);
+

Duplicates a brush.

+

This procedure creates an identical brush by a different name.

+
+

Parameters

+
+++++ + + + + + +

name

The brush name.

 
+
+
+

Returns

+

The name of the brush's copy. The returned value must be +freed with g_free().

+
+

Since: 2.2

+
+
+
+

gimp_brush_rename ()

+
gchar *
+gimp_brush_rename (const gchar *name,
+                   const gchar *new_name);
+

Renames a brush.

+

This procedure renames a brush.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

name

The brush name.

 

new_name

The new name of the brush.

 
+
+
+

Returns

+

The actual new name of the brush. The returned value must +be freed with g_free().

+
+

Since: 2.2

+
+
+
+

gimp_brush_delete ()

+
gboolean
+gimp_brush_delete (const gchar *name);
+

Deletes a brush.

+

This procedure deletes a brush.

+
+

Parameters

+
+++++ + + + + + +

name

The brush name.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_brush_get_info ()

+
gboolean
+gimp_brush_get_info (const gchar *name,
+                     gint *width,
+                     gint *height,
+                     gint *mask_bpp,
+                     gint *color_bpp);
+

Retrieves information about the specified brush.

+

This procedure retrieves information about the specified brush: +brush extents (width and height), color depth and mask depth.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

name

The brush name.

 

width

The brush width.

 

height

The brush height.

 

mask_bpp

The brush mask bpp.

 

color_bpp

The brush color bpp.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_brush_get_pixels ()

+
gboolean
+gimp_brush_get_pixels (const gchar *name,
+                       gint *width,
+                       gint *height,
+                       gint *mask_bpp,
+                       gint *num_mask_bytes,
+                       guint8 **mask_bytes,
+                       gint *color_bpp,
+                       gint *num_color_bytes,
+                       guint8 **color_bytes);
+

Retrieves information about the specified brush.

+

This procedure retrieves information about the specified brush. This +includes the brush extents (width and height) and its pixels data.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

name

The brush name.

 

width

The brush width.

 

height

The brush height.

 

mask_bpp

The brush mask bpp.

 

num_mask_bytes

Length of brush mask data.

 

mask_bytes

The brush mask data.

 

color_bpp

The brush color bpp.

 

num_color_bytes

Length of brush color data.

 

color_bytes

The brush color data.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_brush_get_spacing ()

+
gboolean
+gimp_brush_get_spacing (const gchar *name,
+                        gint *spacing);
+

Gets the brush spacing.

+

This procedure returns the spacing setting for the specified brush. +The return value is an integer between 0 and 1000 which represents +percentage of the maximum of the width and height of the mask.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

name

The brush name.

 

spacing

The brush spacing.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_brush_set_spacing ()

+
gboolean
+gimp_brush_set_spacing (const gchar *name,
+                        gint spacing);
+

Sets the brush spacing.

+

This procedure modifies the spacing setting for the specified brush. +The value should be a integer between 0 and 1000.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

name

The brush name.

 

spacing

The brush spacing.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_brush_get_shape ()

+
GimpBrushGeneratedShape
+gimp_brush_get_shape (const gchar *name);
+

Gets the shape of a generated brush.

+

This procedure gets the shape value for a generated brush. If called +for any other type of brush, it does not succeed. The current +possibilities are Circle (GIMP_BRUSH_GENERATED_CIRCLE), Square +(GIMP_BRUSH_GENERATED_SQUARE), and Diamond +(GIMP_BRUSH_GENERATED_DIAMOND). Other shapes are likely to be added +in the future.

+
+

Parameters

+
+++++ + + + + + +

name

The brush name.

 
+
+
+

Returns

+

The brush shape.

+
+

Since: 2.4

+
+
+
+

gimp_brush_set_shape ()

+
GimpBrushGeneratedShape
+gimp_brush_set_shape (const gchar *name,
+                      GimpBrushGeneratedShape shape_in);
+

Sets the shape of a generated brush.

+

This procedure sets the shape value for a generated brush. If called +for any other type of brush, it does not succeed. The current +possibilities are Circle (GIMP_BRUSH_GENERATED_CIRCLE), Square +(GIMP_BRUSH_GENERATED_SQUARE), and Diamond +(GIMP_BRUSH_GENERATED_DIAMOND). Other shapes are likely to be added +in the future.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

name

The brush name.

 

shape_in

The brush shape.

 
+
+
+

Returns

+

The brush shape actually assigned.

+
+

Since: 2.4

+
+
+
+

gimp_brush_get_spikes ()

+
gint
+gimp_brush_get_spikes (const gchar *name);
+

Gets the number of spikes for a generated brush.

+

This procedure gets the number of spikes for a generated brush. If +called for any other type of brush, it does not succeed.

+
+

Parameters

+
+++++ + + + + + +

name

The brush name.

 
+
+
+

Returns

+

The number of spikes on the brush.

+
+

Since: 2.4

+
+
+
+

gimp_brush_set_spikes ()

+
gint
+gimp_brush_set_spikes (const gchar *name,
+                       gint spikes_in);
+

Sets the number of spikes for a generated brush.

+

This procedure sets the number of spikes for a generated brush. If +called for any other type of brush, it does not succeed.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

name

The brush name.

 

spikes_in

The desired number of spikes.

 
+
+
+

Returns

+

The number of spikes actually assigned.

+
+

Since: 2.4

+
+
+
+

gimp_brush_get_angle ()

+
gdouble
+gimp_brush_get_angle (const gchar *name);
+

Gets the rotation angle of a generated brush.

+

This procedure gets the angle of rotation for a generated brush. If +called for any other type of brush, it does not succeed.

+
+

Parameters

+
+++++ + + + + + +

name

The brush name.

 
+
+
+

Returns

+

The rotation angle of the brush in degree.

+
+

Since: 2.4

+
+
+
+

gimp_brush_set_angle ()

+
gdouble
+gimp_brush_set_angle (const gchar *name,
+                      gdouble angle_in);
+

Sets the rotation angle of a generated brush.

+

This procedure sets the rotation angle for a generated brush. If +called for any other type of brush, it does not succeed.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

name

The brush name.

 

angle_in

The desired brush rotation angle in degree.

 
+
+
+

Returns

+

The brush rotation angle actually assigned.

+
+

Since: 2.4

+
+
+
+

gimp_brush_get_radius ()

+
gdouble
+gimp_brush_get_radius (const gchar *name);
+

Gets the radius of a generated brush.

+

This procedure gets the radius value for a generated brush. If +called for any other type of brush, it does not succeed.

+
+

Parameters

+
+++++ + + + + + +

name

The brush name.

 
+
+
+

Returns

+

The radius of the brush in pixels.

+
+

Since: 2.4

+
+
+
+

gimp_brush_set_radius ()

+
gdouble
+gimp_brush_set_radius (const gchar *name,
+                       gdouble radius_in);
+

Sets the radius of a generated brush.

+

This procedure sets the radius for a generated brush. If called for +any other type of brush, it does not succeed.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

name

The brush name.

 

radius_in

The desired brush radius in pixel.

 
+
+
+

Returns

+

The brush radius actually assigned.

+
+

Since: 2.4

+
+
+
+

gimp_brush_get_aspect_ratio ()

+
gdouble
+gimp_brush_get_aspect_ratio (const gchar *name);
+

Gets the aspect ratio of a generated brush.

+

This procedure gets the aspect ratio of a generated brush. If called +for any other type of brush, it does not succeed. The return value +is a float between 0.0 and 1000.0.

+
+

Parameters

+
+++++ + + + + + +

name

The brush name.

 
+
+
+

Returns

+

The aspect ratio of the brush.

+
+

Since: 2.4

+
+
+
+

gimp_brush_set_aspect_ratio ()

+
gdouble
+gimp_brush_set_aspect_ratio (const gchar *name,
+                             gdouble aspect_ratio_in);
+

Sets the aspect ratio of a generated brush.

+

This procedure sets the aspect ratio for a generated brush. If +called for any other type of brush, it does not succeed. The value +should be a float between 0.0 and 1000.0.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

name

The brush name.

 

aspect_ratio_in

The desired brush aspect ratio.

 
+
+
+

Returns

+

The brush aspect ratio actually assigned.

+
+

Since: 2.4

+
+
+
+

gimp_brush_get_hardness ()

+
gdouble
+gimp_brush_get_hardness (const gchar *name);
+

Gets the hardness of a generated brush.

+

This procedure gets the hardness of a generated brush. The hardness +of a brush is the amount its intensity fades at the outside edge, as +a float between 0.0 and 1.0. If called for any other type of brush, +the function does not succeed.

+
+

Parameters

+
+++++ + + + + + +

name

The brush name.

 
+
+
+

Returns

+

The hardness of the brush.

+
+

Since: 2.4

+
+
+
+

gimp_brush_set_hardness ()

+
gdouble
+gimp_brush_set_hardness (const gchar *name,
+                         gdouble hardness_in);
+

Sets the hardness of a generated brush.

+

This procedure sets the hardness for a generated brush. If called +for any other type of brush, it does not succeed. The value should +be a float between 0.0 and 1.0.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

name

The brush name.

 

hardness_in

The desired brush hardness.

 
+
+
+

Returns

+

The brush hardness actually assigned.

+
+

Since: 2.4

+
+
+
+

gimp_brush_is_generated ()

+
gboolean
+gimp_brush_is_generated (const gchar *name);
+

Tests if brush is generated.

+

Returns TRUE if this brush is parametric, FALSE for other types.

+
+

Parameters

+
+++++ + + + + + +

name

The brush name.

 
+
+
+

Returns

+

TRUE if the brush is generated.

+
+

Since: 2.4

+
+
+
+

gimp_brush_is_editable ()

+
gboolean
+gimp_brush_is_editable (const gchar *name);
+

Tests if brush can be edited.

+

Returns TRUE if you have permission to change the brush.

+
+

Parameters

+
+++++ + + + + + +

name

The brush name.

 
+
+
+

Returns

+

TRUE if the brush can be edited.

+
+

Since: 2.4

+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpbrushes.html b/devel-docs/libgimp/html/libgimp-gimpbrushes.html new file mode 100644 index 0000000..115c358 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpbrushes.html @@ -0,0 +1,458 @@ + + + + +gimpbrushes: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpbrushes

+

gimpbrushes — Functions for manipulating brushes.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+gboolean + +gimp_brushes_refresh () +
+gchar ** + +gimp_brushes_get_list () +
+gchar * + +gimp_brushes_get_brush () +
+gboolean + +gimp_brushes_set_brush () +
+gdouble + +gimp_brushes_get_opacity () +
+gboolean + +gimp_brushes_set_opacity () +
+GimpLayerMode + +gimp_brushes_get_paint_mode () +
+gboolean + +gimp_brushes_set_paint_mode () +
+gint + +gimp_brushes_get_spacing () +
+gboolean + +gimp_brushes_set_spacing () +
+gchar * + +gimp_brushes_get_brush_data () +
+
+
+

Description

+

Functions related to getting and setting brushes.

+
+
+

Functions

+
+

gimp_brushes_refresh ()

+
gboolean
+gimp_brushes_refresh (void);
+

Refresh current brushes. This function always succeeds.

+

This procedure retrieves all brushes currently in the user's brush +path and updates the brush dialogs accordingly.

+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_brushes_get_list ()

+
gchar **
+gimp_brushes_get_list (const gchar *filter,
+                       gint *num_brushes);
+

Retrieve a complete listing of the available brushes.

+

This procedure returns a complete listing of available GIMP brushes. +Each name returned can be used as input to the +gimp_context_set_brush() procedure.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

filter

An optional regular expression used to filter the list.

 

num_brushes

The number of brushes in the brush list.

 
+
+
+

Returns

+

The list of brush names. The returned value must be freed +with g_strfreev().

+
+
+
+
+

gimp_brushes_get_brush ()

+
gchar *
+gimp_brushes_get_brush (gint *width,
+                        gint *height,
+                        gint *spacing);
+
+

gimp_brushes_get_brush is deprecated and should not be used in newly-written code.

+

Use gimp_context_get_brush() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

width

The brush width.

 

height

The brush height.

 

spacing

The brush spacing.

 
+
+
+

Returns

+

The brush name.

+
+
+
+
+

gimp_brushes_set_brush ()

+
gboolean
+gimp_brushes_set_brush (const gchar *name);
+

gimp_brushes_set_brush is deprecated and should not be used in newly-written code.

+

This procedure is deprecated! Use gimp_context_set_brush() instead.

+
+

Parameters

+
+++++ + + + + + +

name

The brush name.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_brushes_get_opacity ()

+
gdouble
+gimp_brushes_get_opacity (void);
+

gimp_brushes_get_opacity is deprecated and should not be used in newly-written code.

+

This procedure is deprecated! Use gimp_context_get_opacity() instead.

+
+

Returns

+

The brush opacity.

+
+
+
+
+

gimp_brushes_set_opacity ()

+
gboolean
+gimp_brushes_set_opacity (gdouble opacity);
+

gimp_brushes_set_opacity is deprecated and should not be used in newly-written code.

+

This procedure is deprecated! Use gimp_context_set_opacity() instead.

+
+

Parameters

+
+++++ + + + + + +

opacity

The brush opacity.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_brushes_get_paint_mode ()

+
GimpLayerMode
+gimp_brushes_get_paint_mode (void);
+

gimp_brushes_get_paint_mode is deprecated and should not be used in newly-written code.

+

This procedure is deprecated! Use gimp_context_get_paint_mode() instead.

+
+

Returns

+

The paint mode.

+
+
+
+
+

gimp_brushes_set_paint_mode ()

+
gboolean
+gimp_brushes_set_paint_mode (GimpLayerMode paint_mode);
+

gimp_brushes_set_paint_mode is deprecated and should not be used in newly-written code.

+

This procedure is deprecated! Use gimp_context_set_paint_mode() instead.

+
+

Parameters

+
+++++ + + + + + +

paint_mode

The paint mode.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_brushes_get_spacing ()

+
gint
+gimp_brushes_get_spacing (void);
+
+

gimp_brushes_get_spacing is deprecated and should not be used in newly-written code.

+

Use gimp_brush_get_spacing() instead.

+
+
+

Returns

+

The brush spacing.

+
+
+
+
+

gimp_brushes_set_spacing ()

+
gboolean
+gimp_brushes_set_spacing (gint spacing);
+
+

gimp_brushes_set_spacing is deprecated and should not be used in newly-written code.

+

Use gimp_brush_set_spacing() instead.

+
+
+

Parameters

+
+++++ + + + + + +

spacing

The brush spacing.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_brushes_get_brush_data ()

+
gchar *
+gimp_brushes_get_brush_data (const gchar *name,
+                             gdouble *opacity,
+                             gint *spacing,
+                             GimpLayerMode *paint_mode,
+                             gint *width,
+                             gint *height,
+                             gint *length,
+                             guint8 **mask_data);
+
+

gimp_brushes_get_brush_data is deprecated and should not be used in newly-written code.

+

Use gimp_brush_get_pixels() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

name

The brush name (\"\" means current active brush).

 

opacity

The brush opacity.

 

spacing

The brush spacing.

 

paint_mode

The paint mode.

 

width

The brush width.

 

height

The brush height.

 

length

Length of brush mask data.

 

mask_data

The brush mask data.

 
+
+
+

Returns

+

The brush name.

+
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpbrushmenu.html b/devel-docs/libgimp/html/libgimp-gimpbrushmenu.html new file mode 100644 index 0000000..5e8c033 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpbrushmenu.html @@ -0,0 +1,222 @@ + + + + +gimpbrushmenu: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpbrushmenu

+

gimpbrushmenu — A widget for selecting brushes.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + +
+GtkWidget * + +gimp_brush_select_widget_new () +
+void + +gimp_brush_select_widget_close () +
+void + +gimp_brush_select_widget_set () +
+
+
+

Description

+

A widget for selecting brushes.

+
+
+

Functions

+
+

gimp_brush_select_widget_new ()

+
GtkWidget *
+gimp_brush_select_widget_new (const gchar *title,
+                              const gchar *brush_name,
+                              gdouble opacity,
+                              gint spacing,
+                              GimpLayerMode paint_mode,
+                              GimpRunBrushCallback callback,
+                              gpointer data);
+

gimp_brush_select_widget_new is deprecated and should not be used in newly-written code.

+

Creates a new GtkWidget that completely controls the selection of +a GimpBrush. This widget is suitable for placement in a table in +a plug-in dialog.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

title

Title of the dialog to use or NULL to use the default title.

 

brush_name

Initial brush name or NULL to use current selection.

 

opacity

Initial opacity. -1 means to use current opacity.

 

spacing

Initial spacing. -1 means to use current spacing.

 

paint_mode

Initial paint mode. -1 means to use current paint mode.

 

callback

A function to call when the selected brush changes.

 

data

A pointer to arbitrary data to be used in the call to callback +.

 
+
+
+

Returns

+

A GtkWidget that you can use in your UI.

+
+
+
+
+

gimp_brush_select_widget_close ()

+
void
+gimp_brush_select_widget_close (GtkWidget *widget);
+

gimp_brush_select_widget_close is deprecated and should not be used in newly-written code.

+

Closes the popup window associated with widget +.

+
+

Parameters

+
+++++ + + + + + +

widget

A brush select widget.

 
+
+
+
+
+

gimp_brush_select_widget_set ()

+
void
+gimp_brush_select_widget_set (GtkWidget *widget,
+                              const gchar *brush_name,
+                              gdouble opacity,
+                              gint spacing,
+                              GimpLayerMode paint_mode);
+

gimp_brush_select_widget_set is deprecated and should not be used in newly-written code.

+

Sets the current brush and other values for the brush select +widget. Calls the callback function if one was supplied in the +call to gimp_brush_select_widget_new().

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

widget

A brush select widget.

 

brush_name

Brush name to set; NULL means no change.

 

opacity

Opacity to set. -1.0 means no change.

 

spacing

Spacing to set. -1 means no change.

 

paint_mode

Paint mode to set. -1 means no change.

 
+
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpbrushselect.html b/devel-docs/libgimp/html/libgimp-gimpbrushselect.html new file mode 100644 index 0000000..9c54692 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpbrushselect.html @@ -0,0 +1,273 @@ + + + + +gimpbrushselect: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpbrushselect

+

gimpbrushselect — Functions providing a brush selection dialog.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+void + +(*GimpRunBrushCallback) () +
const gchar * + +gimp_brush_select_new () +
+void + +gimp_brush_select_destroy () +
+gboolean + +gimp_brushes_popup () +
+gboolean + +gimp_brushes_close_popup () +
+gboolean + +gimp_brushes_set_popup () +
+
+
+

Description

+

Functions providing a brush selection dialog.

+
+
+

Functions

+
+

GimpRunBrushCallback ()

+
void
+(*GimpRunBrushCallback) (const gchar *brush_name,
+                         gdouble opacity,
+                         gint spacing,
+                         GimpLayerMode paint_mode,
+                         gint width,
+                         gint height,
+                         const guchar *mask_data,
+                         gboolean dialog_closing,
+                         gpointer user_data);
+
+
+
+

gimp_brush_select_new ()

+
const gchar *
+gimp_brush_select_new (const gchar *title,
+                       const gchar *brush_name,
+                       gdouble opacity,
+                       gint spacing,
+                       GimpLayerMode paint_mode,
+                       GimpRunBrushCallback callback,
+                       gpointer data);
+
+
+
+

gimp_brush_select_destroy ()

+
void
+gimp_brush_select_destroy (const gchar *brush_callback);
+
+
+
+

gimp_brushes_popup ()

+
gboolean
+gimp_brushes_popup (const gchar *brush_callback,
+                    const gchar *popup_title,
+                    const gchar *initial_brush,
+                    gdouble opacity,
+                    gint spacing,
+                    GimpLayerMode paint_mode);
+

Invokes the Gimp brush selection.

+

This procedure opens the brush selection dialog.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

brush_callback

The callback PDB proc to call when brush selection is made.

 

popup_title

Title of the brush selection dialog.

 

initial_brush

The name of the brush to set as the first selected.

 

opacity

The initial opacity of the brush.

 

spacing

The initial spacing of the brush (if < 0 then use brush default spacing).

 

paint_mode

The initial paint mode.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_brushes_close_popup ()

+
gboolean
+gimp_brushes_close_popup (const gchar *brush_callback);
+

Close the brush selection dialog.

+

This procedure closes an opened brush selection dialog.

+
+

Parameters

+
+++++ + + + + + +

brush_callback

The name of the callback registered for this pop-up.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_brushes_set_popup ()

+
gboolean
+gimp_brushes_set_popup (const gchar *brush_callback,
+                        const gchar *brush_name,
+                        gdouble opacity,
+                        gint spacing,
+                        GimpLayerMode paint_mode);
+

Sets the current brush in a brush selection dialog.

+

Sets the current brush in a brush selection dialog.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

brush_callback

The name of the callback registered for this pop-up.

 

brush_name

The name of the brush to set as selected.

 

opacity

The initial opacity of the brush.

 

spacing

The initial spacing of the brush (if < 0 then use brush default spacing).

 

paint_mode

The initial paint mode.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpbuffer.html b/devel-docs/libgimp/html/libgimp-gimpbuffer.html new file mode 100644 index 0000000..fca6ab0 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpbuffer.html @@ -0,0 +1,325 @@ + + + + +gimpbuffer: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpbuffer

+

gimpbuffer — Functions for manipulating cut buffers.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+gchar ** + +gimp_buffers_get_list () +
+gchar * + +gimp_buffer_rename () +
+gboolean + +gimp_buffer_delete () +
+gint + +gimp_buffer_get_width () +
+gint + +gimp_buffer_get_height () +
+gint + +gimp_buffer_get_bytes () +
+GimpImageBaseType + +gimp_buffer_get_image_type () +
+
+
+

Description

+

Functions related to named cut buffers.

+
+
+

Functions

+
+

gimp_buffers_get_list ()

+
gchar **
+gimp_buffers_get_list (const gchar *filter,
+                       gint *num_buffers);
+

Retrieve a complete listing of the available buffers.

+

This procedure returns a complete listing of available named +buffers.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

filter

An optional regular expression used to filter the list.

 

num_buffers

The number of buffers.

 
+
+
+

Returns

+

The list of buffer names. The returned value must be freed +with g_strfreev().

+
+

Since: 2.4

+
+
+
+

gimp_buffer_rename ()

+
gchar *
+gimp_buffer_rename (const gchar *buffer_name,
+                    const gchar *new_name);
+

Renames a named buffer.

+

This procedure renames a named buffer.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

buffer_name

The buffer name.

 

new_name

The buffer's new name.

 
+
+
+

Returns

+

The real name given to the buffer.

+
+

Since: 2.4

+
+
+
+

gimp_buffer_delete ()

+
gboolean
+gimp_buffer_delete (const gchar *buffer_name);
+

Deletes a named buffer.

+

This procedure deletes a named buffer.

+
+

Parameters

+
+++++ + + + + + +

buffer_name

The buffer name.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_buffer_get_width ()

+
gint
+gimp_buffer_get_width (const gchar *buffer_name);
+

Retrieves the specified buffer's width.

+

This procedure retrieves the specified named buffer's width.

+
+

Parameters

+
+++++ + + + + + +

buffer_name

The buffer name.

 
+
+
+

Returns

+

The buffer width.

+
+

Since: 2.4

+
+
+
+

gimp_buffer_get_height ()

+
gint
+gimp_buffer_get_height (const gchar *buffer_name);
+

Retrieves the specified buffer's height.

+

This procedure retrieves the specified named buffer's height.

+
+

Parameters

+
+++++ + + + + + +

buffer_name

The buffer name.

 
+
+
+

Returns

+

The buffer height.

+
+

Since: 2.4

+
+
+
+

gimp_buffer_get_bytes ()

+
gint
+gimp_buffer_get_bytes (const gchar *buffer_name);
+

Retrieves the specified buffer's bytes.

+

This procedure retrieves the specified named buffer's bytes.

+
+

Parameters

+
+++++ + + + + + +

buffer_name

The buffer name.

 
+
+
+

Returns

+

The buffer bpp.

+
+

Since: 2.4

+
+
+
+

gimp_buffer_get_image_type ()

+
GimpImageBaseType
+gimp_buffer_get_image_type (const gchar *buffer_name);
+

Retrieves the specified buffer's image type.

+

This procedure retrieves the specified named buffer's image type.

+
+

Parameters

+
+++++ + + + + + +

buffer_name

The buffer name.

 
+
+
+

Returns

+

The buffer image type.

+
+

Since: 2.4

+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpchannel.html b/devel-docs/libgimp/html/libgimp-gimpchannel.html new file mode 100644 index 0000000..c5aa9a5 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpchannel.html @@ -0,0 +1,527 @@ + + + + +gimpchannel: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpchannel

+

gimpchannel — Functions for manipulating channels.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+gint32 + +gimp_channel_new () +
+gint32 + +gimp_channel_new_from_component () +
+gint32 + +gimp_channel_copy () +
+gboolean + +gimp_channel_get_show_masked () +
+gboolean + +gimp_channel_set_show_masked () +
+gdouble + +gimp_channel_get_opacity () +
+gboolean + +gimp_channel_set_opacity () +
+gboolean + +gimp_channel_get_color () +
+gboolean + +gimp_channel_set_color () +
+gboolean + +gimp_channel_combine_masks () +
+
+
+

Description

+

Functions for manipulating channels.

+
+
+

Functions

+
+

gimp_channel_new ()

+
gint32
+gimp_channel_new (gint32 image_ID,
+                  const gchar *name,
+                  guint width,
+                  guint height,
+                  gdouble opacity,
+                  const GimpRGB *color);
+

Create a new channel.

+

This procedure creates a new channel with the specified width and +height. Name, opacity, and color are also supplied parameters. The +new channel still needs to be added to the image, as this is not +automatic. Add the new channel with the gimp_image_insert_channel() +command. Other attributes such as channel show masked, should be +set with explicit procedure calls. The channel's contents are +undefined initially.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

image_ID

The image to which to add the channel.

 

name

The channel name.

 

width

The channel width.

 

height

The channel height.

 

opacity

The channel opacity.

 

color

The channel compositing color.

 
+
+
+

Returns

+

The newly created channel.

+
+
+
+
+

gimp_channel_new_from_component ()

+
gint32
+gimp_channel_new_from_component (gint32 image_ID,
+                                 GimpChannelType component,
+                                 const gchar *name);
+

Create a new channel from a color component

+

This procedure creates a new channel from a color component. +The new channel still needs to be added to the image, as this is not +automatic. Add the new channel with gimp_image_insert_channel(). +Other attributes, such as channel visibility, should be set with +explicit procedure calls.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

image_ID

The image to which to add the channel.

 

component

The image component.

 

name

The channel name.

 
+
+
+

Returns

+

The newly created channel.

+
+

Since: 2.4

+
+
+
+

gimp_channel_copy ()

+
gint32
+gimp_channel_copy (gint32 channel_ID);
+

Copy a channel.

+

This procedure copies the specified channel and returns the copy. +The new channel still needs to be added to the image, as this is not +automatic. Add the new channel with gimp_image_insert_channel().

+
+

Parameters

+
+++++ + + + + + +

channel_ID

The channel to copy.

 
+
+
+

Returns

+

The newly copied channel.

+
+
+
+
+

gimp_channel_get_show_masked ()

+
gboolean
+gimp_channel_get_show_masked (gint32 channel_ID);
+

Get the composite method of the specified channel.

+

This procedure returns the specified channel's composite method. If +it is TRUE, then the channel is composited with the image so that +masked regions are shown. Otherwise, selected regions are shown.

+
+

Parameters

+
+++++ + + + + + +

channel_ID

The channel.

 
+
+
+

Returns

+

The channel composite method.

+
+
+
+
+

gimp_channel_set_show_masked ()

+
gboolean
+gimp_channel_set_show_masked (gint32 channel_ID,
+                              gboolean show_masked);
+

Set the composite method of the specified channel.

+

This procedure sets the specified channel's composite method. If it +is TRUE, then the channel is composited with the image so that +masked regions are shown. Otherwise, selected regions are shown.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

channel_ID

The channel.

 

show_masked

The new channel composite method.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_channel_get_opacity ()

+
gdouble
+gimp_channel_get_opacity (gint32 channel_ID);
+

Get the opacity of the specified channel.

+

This procedure returns the specified channel's opacity.

+
+

Parameters

+
+++++ + + + + + +

channel_ID

The channel.

 
+
+
+

Returns

+

The channel opacity.

+
+
+
+
+

gimp_channel_set_opacity ()

+
gboolean
+gimp_channel_set_opacity (gint32 channel_ID,
+                          gdouble opacity);
+

Set the opacity of the specified channel.

+

This procedure sets the specified channel's opacity.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

channel_ID

The channel.

 

opacity

The new channel opacity.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_channel_get_color ()

+
gboolean
+gimp_channel_get_color (gint32 channel_ID,
+                        GimpRGB *color);
+

Get the compositing color of the specified channel.

+

This procedure returns the specified channel's compositing color.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

channel_ID

The channel.

 

color

The channel compositing color.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_channel_set_color ()

+
gboolean
+gimp_channel_set_color (gint32 channel_ID,
+                        const GimpRGB *color);
+

Set the compositing color of the specified channel.

+

This procedure sets the specified channel's compositing color.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

channel_ID

The channel.

 

color

The new channel compositing color.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_channel_combine_masks ()

+
gboolean
+gimp_channel_combine_masks (gint32 channel1_ID,
+                            gint32 channel2_ID,
+                            GimpChannelOps operation,
+                            gint offx,
+                            gint offy);
+

Combine two channel masks.

+

This procedure combines two channel masks. The result is stored in +the first channel.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

channel1_ID

The channel1.

 

channel2_ID

The channel2.

 

operation

The selection operation.

 

offx

x offset between upper left corner of channels: (second - first).

 

offy

y offset between upper left corner of channels: (second - first).

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpcolor.html b/devel-docs/libgimp/html/libgimp-gimpcolor.html new file mode 100644 index 0000000..9333d1e --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpcolor.html @@ -0,0 +1,921 @@ + + + + +gimpcolor: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpcolor

+

gimpcolor — Functions for manipulating color.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+gboolean + +gimp_brightness_contrast () +
+gboolean + +gimp_levels () +
+gboolean + +gimp_levels_auto () +
+gboolean + +gimp_levels_stretch () +
+gboolean + +gimp_posterize () +
+gboolean + +gimp_desaturate () +
+gboolean + +gimp_desaturate_full () +
+gboolean + +gimp_equalize () +
+gboolean + +gimp_invert () +
+gboolean + +gimp_curves_spline () +
+gboolean + +gimp_curves_explicit () +
+gboolean + +gimp_color_balance () +
+gboolean + +gimp_colorize () +
+gboolean + +gimp_histogram () +
+gboolean + +gimp_hue_saturation () +
+gboolean + +gimp_threshold () +
+
+
+

Description

+

Functions for manipulating color, including curves and histograms.

+
+
+

Functions

+
+

gimp_brightness_contrast ()

+
gboolean
+gimp_brightness_contrast (gint32 drawable_ID,
+                          gint brightness,
+                          gint contrast);
+
+

gimp_brightness_contrast is deprecated and should not be used in newly-written code.

+

Use gimp_drawable_brightness_contrast() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

drawable_ID

The drawable.

 

brightness

Brightness adjustment.

 

contrast

Contrast adjustment.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_levels ()

+
gboolean
+gimp_levels (gint32 drawable_ID,
+             GimpHistogramChannel channel,
+             gint low_input,
+             gint high_input,
+             gdouble gamma,
+             gint low_output,
+             gint high_output);
+
+

gimp_levels is deprecated and should not be used in newly-written code.

+

Use gimp_drawable_levels() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The drawable.

 

channel

The channel to modify.

 

low_input

Intensity of lowest input.

 

high_input

Intensity of highest input.

 

gamma

Gamma adjustment factor.

 

low_output

Intensity of lowest output.

 

high_output

Intensity of highest output.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_levels_auto ()

+
gboolean
+gimp_levels_auto (gint32 drawable_ID);
+
+

gimp_levels_auto is deprecated and should not be used in newly-written code.

+

Use gimp_drawable_levels_stretch() instead.

+
+
+

Parameters

+
+++++ + + + + + +

drawable_ID

The drawable.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_levels_stretch ()

+
gboolean
+gimp_levels_stretch (gint32 drawable_ID);
+
+

gimp_levels_stretch is deprecated and should not be used in newly-written code.

+

Use gimp_drawable_levels_stretch() instead.

+
+
+

Parameters

+
+++++ + + + + + +

drawable_ID

The drawable.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_posterize ()

+
gboolean
+gimp_posterize (gint32 drawable_ID,
+                gint levels);
+
+

gimp_posterize is deprecated and should not be used in newly-written code.

+

Use gimp_drawable_posterize() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

drawable_ID

The drawable.

 

levels

Levels of posterization.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_desaturate ()

+
gboolean
+gimp_desaturate (gint32 drawable_ID);
+
+

gimp_desaturate is deprecated and should not be used in newly-written code.

+

Use gimp_drawable_desaturate() instead.

+
+
+

Parameters

+
+++++ + + + + + +

drawable_ID

The drawable.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_desaturate_full ()

+
gboolean
+gimp_desaturate_full (gint32 drawable_ID,
+                      GimpDesaturateMode desaturate_mode);
+
+

gimp_desaturate_full is deprecated and should not be used in newly-written code.

+

Use gimp_drawable_desaturate() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

drawable_ID

The drawable.

 

desaturate_mode

The formula to use to desaturate.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_equalize ()

+
gboolean
+gimp_equalize (gint32 drawable_ID,
+               gboolean mask_only);
+
+

gimp_equalize is deprecated and should not be used in newly-written code.

+

Use gimp_drawable_equalize() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

drawable_ID

The drawable.

 

mask_only

Equalization option.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_invert ()

+
gboolean
+gimp_invert (gint32 drawable_ID);
+
+

gimp_invert is deprecated and should not be used in newly-written code.

+

Use gimp_drawable_invert() instead.

+
+
+

Parameters

+
+++++ + + + + + +

drawable_ID

The drawable.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_curves_spline ()

+
gboolean
+gimp_curves_spline (gint32 drawable_ID,
+                    GimpHistogramChannel channel,
+                    gint num_points,
+                    const guint8 *control_pts);
+
+

gimp_curves_spline is deprecated and should not be used in newly-written code.

+

Use gimp_drawable_curves_spline() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The drawable.

 

channel

The channel to modify.

 

num_points

The number of values in the control point array.

 

control_pts

The spline control points: { cp1.x, cp1.y, cp2.x, cp2.y, ... }.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_curves_explicit ()

+
gboolean
+gimp_curves_explicit (gint32 drawable_ID,
+                      GimpHistogramChannel channel,
+                      gint num_bytes,
+                      const guint8 *curve);
+
+

gimp_curves_explicit is deprecated and should not be used in newly-written code.

+

Use gimp_drawable_curves_explicit() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The drawable.

 

channel

The channel to modify.

 

num_bytes

The number of bytes in the new curve (always 256).

 

curve

The explicit curve.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_color_balance ()

+
gboolean
+gimp_color_balance (gint32 drawable_ID,
+                    GimpTransferMode transfer_mode,
+                    gboolean preserve_lum,
+                    gdouble cyan_red,
+                    gdouble magenta_green,
+                    gdouble yellow_blue);
+
+

gimp_color_balance is deprecated and should not be used in newly-written code.

+

Use gimp_drawable_color_color_balance() instead.

+
+

Modify the color balance of the specified drawable.

+

Modify the color balance of the specified drawable. There are three +axis which can be modified: cyan-red, magenta-green, and +yellow-blue. Negative values increase the amount of the former, +positive values increase the amount of the latter. Color balance can +be controlled with the 'transfer_mode' setting, which allows +shadows, mid-tones, and highlights in an image to be affected +differently. The 'preserve-lum' parameter, if TRUE, ensures that the +luminosity of each pixel remains fixed.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The drawable.

 

transfer_mode

Transfer mode.

 

preserve_lum

Preserve luminosity values at each pixel.

 

cyan_red

Cyan-Red color balance.

 

magenta_green

Magenta-Green color balance.

 

yellow_blue

Yellow-Blue color balance.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_colorize ()

+
gboolean
+gimp_colorize (gint32 drawable_ID,
+               gdouble hue,
+               gdouble saturation,
+               gdouble lightness);
+
+

gimp_colorize is deprecated and should not be used in newly-written code.

+

Use gimp_drawable_colorize_hsl() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The drawable.

 

hue

Hue in degrees.

 

saturation

Saturation in percent.

 

lightness

Lightness in percent.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_histogram ()

+
gboolean
+gimp_histogram (gint32 drawable_ID,
+                GimpHistogramChannel channel,
+                gint start_range,
+                gint end_range,
+                gdouble *mean,
+                gdouble *std_dev,
+                gdouble *median,
+                gdouble *pixels,
+                gdouble *count,
+                gdouble *percentile);
+
+

gimp_histogram is deprecated and should not be used in newly-written code.

+

Use gimp_drawable_histogram() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The drawable.

 

channel

The channel to modify.

 

start_range

Start of the intensity measurement range.

 

end_range

End of the intensity measurement range.

 

mean

Mean intensity value.

 

std_dev

Standard deviation of intensity values.

 

median

Median intensity value.

 

pixels

Alpha-weighted pixel count for entire image.

 

count

Alpha-weighted pixel count for range.

 

percentile

Percentile that range falls under.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_hue_saturation ()

+
gboolean
+gimp_hue_saturation (gint32 drawable_ID,
+                     GimpHueRange hue_range,
+                     gdouble hue_offset,
+                     gdouble lightness,
+                     gdouble saturation);
+
+

gimp_hue_saturation is deprecated and should not be used in newly-written code.

+

Use gimp_drawable_hue_saturation() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The drawable.

 

hue_range

Range of affected hues.

 

hue_offset

Hue offset in degrees.

 

lightness

Lightness modification.

 

saturation

Saturation modification.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_threshold ()

+
gboolean
+gimp_threshold (gint32 drawable_ID,
+                gint low_threshold,
+                gint high_threshold);
+
+

gimp_threshold is deprecated and should not be used in newly-written code.

+

Use gimp_drawable_threshold() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

drawable_ID

The drawable.

 

low_threshold

The low threshold value.

 

high_threshold

The high threshold value.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpcontext.html b/devel-docs/libgimp/html/libgimp-gimpcontext.html new file mode 100644 index 0000000..8ad9ad0 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpcontext.html @@ -0,0 +1,3583 @@ + + + + +gimpcontext: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpcontext

+

gimpcontext — Functions to manipulate a plug-in's context.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+gboolean + +gimp_context_push () +
+gboolean + +gimp_context_pop () +
+gboolean + +gimp_context_set_defaults () +
+gboolean + +gimp_context_get_foreground () +
+gboolean + +gimp_context_set_foreground () +
+gboolean + +gimp_context_get_background () +
+gboolean + +gimp_context_set_background () +
+gboolean + +gimp_context_set_default_colors () +
+gboolean + +gimp_context_swap_colors () +
+gdouble + +gimp_context_get_opacity () +
+gboolean + +gimp_context_set_opacity () +
+GimpLayerMode + +gimp_context_get_paint_mode () +
+gboolean + +gimp_context_set_paint_mode () +
+gboolean + +gimp_context_list_paint_methods () +
+gchar * + +gimp_context_get_paint_method () +
+gboolean + +gimp_context_set_paint_method () +
+GimpStrokeMethod + +gimp_context_get_stroke_method () +
+gboolean + +gimp_context_set_stroke_method () +
+gdouble + +gimp_context_get_line_width () +
+gboolean + +gimp_context_set_line_width () +
+GimpUnit + +gimp_context_get_line_width_unit () +
+gboolean + +gimp_context_set_line_width_unit () +
+GimpCapStyle + +gimp_context_get_line_cap_style () +
+gboolean + +gimp_context_set_line_cap_style () +
+GimpJoinStyle + +gimp_context_get_line_join_style () +
+gboolean + +gimp_context_set_line_join_style () +
+gdouble + +gimp_context_get_line_miter_limit () +
+gboolean + +gimp_context_set_line_miter_limit () +
+gdouble + +gimp_context_get_line_dash_offset () +
+gboolean + +gimp_context_set_line_dash_offset () +
+gboolean + +gimp_context_get_line_dash_pattern () +
+gboolean + +gimp_context_set_line_dash_pattern () +
+gchar * + +gimp_context_get_brush () +
+gboolean + +gimp_context_set_brush () +
+gdouble + +gimp_context_get_brush_size () +
+gboolean + +gimp_context_set_brush_size () +
+gboolean + +gimp_context_set_brush_default_size () +
+gdouble + +gimp_context_get_brush_aspect_ratio () +
+gboolean + +gimp_context_set_brush_aspect_ratio () +
+gdouble + +gimp_context_get_brush_angle () +
+gboolean + +gimp_context_set_brush_angle () +
+gdouble + +gimp_context_get_brush_spacing () +
+gboolean + +gimp_context_set_brush_spacing () +
+gboolean + +gimp_context_set_brush_default_spacing () +
+gdouble + +gimp_context_get_brush_hardness () +
+gboolean + +gimp_context_set_brush_hardness () +
+gboolean + +gimp_context_set_brush_default_hardness () +
+gdouble + +gimp_context_get_brush_force () +
+gboolean + +gimp_context_set_brush_force () +
+gchar * + +gimp_context_get_dynamics () +
+gboolean + +gimp_context_set_dynamics () +
+gchar * + +gimp_context_get_mypaint_brush () +
+gboolean + +gimp_context_set_mypaint_brush () +
+gchar * + +gimp_context_get_pattern () +
+gboolean + +gimp_context_set_pattern () +
+gchar * + +gimp_context_get_gradient () +
+gboolean + +gimp_context_set_gradient () +
+gboolean + +gimp_context_set_gradient_fg_bg_hsv_ccw () +
+gboolean + +gimp_context_set_gradient_fg_bg_hsv_cw () +
+gboolean + +gimp_context_set_gradient_fg_bg_rgb () +
+gboolean + +gimp_context_set_gradient_fg_transparent () +
+GimpGradientBlendColorSpace + +gimp_context_get_gradient_blend_color_space () +
+gboolean + +gimp_context_set_gradient_blend_color_space () +
+GimpRepeatMode + +gimp_context_get_gradient_repeat_mode () +
+gboolean + +gimp_context_set_gradient_repeat_mode () +
+gboolean + +gimp_context_get_gradient_reverse () +
+gboolean + +gimp_context_set_gradient_reverse () +
+gchar * + +gimp_context_get_palette () +
+gboolean + +gimp_context_set_palette () +
+gchar * + +gimp_context_get_font () +
+gboolean + +gimp_context_set_font () +
+gboolean + +gimp_context_get_antialias () +
+gboolean + +gimp_context_set_antialias () +
+gboolean + +gimp_context_get_feather () +
+gboolean + +gimp_context_set_feather () +
+gboolean + +gimp_context_get_feather_radius () +
+gboolean + +gimp_context_set_feather_radius () +
+gboolean + +gimp_context_get_sample_merged () +
+gboolean + +gimp_context_set_sample_merged () +
+GimpSelectCriterion + +gimp_context_get_sample_criterion () +
+gboolean + +gimp_context_set_sample_criterion () +
+gdouble + +gimp_context_get_sample_threshold () +
+gboolean + +gimp_context_set_sample_threshold () +
+gint + +gimp_context_get_sample_threshold_int () +
+gboolean + +gimp_context_set_sample_threshold_int () +
+gboolean + +gimp_context_get_sample_transparent () +
+gboolean + +gimp_context_set_sample_transparent () +
+gboolean + +gimp_context_get_diagonal_neighbors () +
+gboolean + +gimp_context_set_diagonal_neighbors () +
+GeglDistanceMetric + +gimp_context_get_distance_metric () +
+gboolean + +gimp_context_set_distance_metric () +
+GimpInterpolationType + +gimp_context_get_interpolation () +
+gboolean + +gimp_context_set_interpolation () +
+GimpTransformDirection + +gimp_context_get_transform_direction () +
+gboolean + +gimp_context_set_transform_direction () +
+GimpTransformResize + +gimp_context_get_transform_resize () +
+gboolean + +gimp_context_set_transform_resize () +
+gint + +gimp_context_get_transform_recursion () +
+gboolean + +gimp_context_set_transform_recursion () +
+gdouble + +gimp_context_get_ink_angle () +
+gboolean + +gimp_context_set_ink_angle () +
+gdouble + +gimp_context_get_ink_blob_angle () +
+gboolean + +gimp_context_set_ink_blob_angle () +
+gdouble + +gimp_context_get_ink_blob_aspect_ratio () +
+gboolean + +gimp_context_set_ink_blob_aspect_ratio () +
+GimpInkBlobType + +gimp_context_get_ink_blob_type () +
+gboolean + +gimp_context_set_ink_blob_type () +
+gdouble + +gimp_context_get_ink_size () +
+gboolean + +gimp_context_set_ink_size () +
+gdouble + +gimp_context_get_ink_size_sensitivity () +
+gboolean + +gimp_context_set_ink_size_sensitivity () +
+gdouble + +gimp_context_get_ink_speed_sensitivity () +
+gboolean + +gimp_context_set_ink_speed_sensitivity () +
+gdouble + +gimp_context_get_ink_tilt_sensitivity () +
+gboolean + +gimp_context_set_ink_tilt_sensitivity () +
+
+
+

Description

+

Functions to manipulate a plug-in's context.

+
+
+

Functions

+
+

gimp_context_push ()

+
gboolean
+gimp_context_push (void);
+

Pushes a context to the top of the plug-in's context stack.

+

This procedure creates a new context by copying the current context. +This copy becomes the new current context for the calling plug-in +until it is popped again using gimp_context_pop().

+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_context_pop ()

+
gboolean
+gimp_context_pop (void);
+

Pops the topmost context from the plug-in's context stack.

+

This procedure removes the topmost context from the plug-in's +context stack. The context that was active before the corresponding +call to gimp_context_push() becomes the new current context of the +plug-in.

+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_context_set_defaults ()

+
gboolean
+gimp_context_set_defaults (void);
+

Reset context settings to their default values.

+

This procedure resets context settings used by various procedures to +their default value. This procedure will usually be called after a +context push so that a script which calls procedures affected by +context settings will not be affected by changes in the global +context.

+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_context_get_foreground ()

+
gboolean
+gimp_context_get_foreground (GimpRGB *foreground);
+

Get the current GIMP foreground color.

+

This procedure returns the current GIMP foreground color. The +foreground color is used in a variety of tools such as paint tools, +blending, and bucket fill.

+
+

Parameters

+
+++++ + + + + + +

foreground

The foreground color.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_context_set_foreground ()

+
gboolean
+gimp_context_set_foreground (const GimpRGB *foreground);
+

Set the current GIMP foreground color.

+

This procedure sets the current GIMP foreground color. After this is +set, operations which use foreground such as paint tools, blending, +and bucket fill will use the new value.

+
+

Parameters

+
+++++ + + + + + +

foreground

The foreground color.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_context_get_background ()

+
gboolean
+gimp_context_get_background (GimpRGB *background);
+

Get the current GIMP background color.

+

This procedure returns the current GIMP background color. The +background color is used in a variety of tools such as blending, +erasing (with non-alpha images), and image filling.

+
+

Parameters

+
+++++ + + + + + +

background

The background color.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_context_set_background ()

+
gboolean
+gimp_context_set_background (const GimpRGB *background);
+

Set the current GIMP background color.

+

This procedure sets the current GIMP background color. After this is +set, operations which use background such as blending, filling +images, clearing, and erasing (in non-alpha images) will use the new +value.

+
+

Parameters

+
+++++ + + + + + +

background

The background color.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_context_set_default_colors ()

+
gboolean
+gimp_context_set_default_colors (void);
+

Set the current GIMP foreground and background colors to black and +white.

+

This procedure sets the current GIMP foreground and background +colors to their initial default values, black and white.

+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_context_swap_colors ()

+
gboolean
+gimp_context_swap_colors (void);
+

Swap the current GIMP foreground and background colors.

+

This procedure swaps the current GIMP foreground and background +colors, so that the new foreground color becomes the old background +color and vice versa.

+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_context_get_opacity ()

+
gdouble
+gimp_context_get_opacity (void);
+

Get the opacity.

+

This procedure returns the opacity setting. The return value is a +floating point number between 0 and 100.

+
+

Returns

+

The opacity.

+
+

Since: 2.2

+
+
+
+

gimp_context_set_opacity ()

+
gboolean
+gimp_context_set_opacity (gdouble opacity);
+

Set the opacity.

+

This procedure modifies the opacity setting. The value should be a +floating point number between 0 and 100.

+
+

Parameters

+
+++++ + + + + + +

opacity

The opacity.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_context_get_paint_mode ()

+
GimpLayerMode
+gimp_context_get_paint_mode (void);
+

Get the paint mode.

+

This procedure returns the paint-mode setting. The return value is +an integer which corresponds to the values listed in the argument +description.

+
+

Returns

+

The paint mode.

+
+

Since: 2.2

+
+
+
+

gimp_context_set_paint_mode ()

+
gboolean
+gimp_context_set_paint_mode (GimpLayerMode paint_mode);
+

Set the paint mode.

+

This procedure modifies the paint_mode setting.

+
+

Parameters

+
+++++ + + + + + +

paint_mode

The paint mode.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_context_list_paint_methods ()

+
gboolean
+gimp_context_list_paint_methods (gint *num_paint_methods,
+                                 gchar ***paint_methods);
+

Lists the available paint methods.

+

This procedure lists the names of the available paint methods. Any +of the results can be used for gimp_context_set_paint_method().

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

num_paint_methods

The number of the available paint methods.

 

paint_methods

The names of the available paint methods.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_context_get_paint_method ()

+
gchar *
+gimp_context_get_paint_method (void);
+

Retrieve the currently active paint method.

+

This procedure returns the name of the currently active paint +method.

+
+

Returns

+

The name of the active paint method.

+
+

Since: 2.4

+
+
+
+

gimp_context_set_paint_method ()

+
gboolean
+gimp_context_set_paint_method (const gchar *name);
+

Set the specified paint method as the active paint method.

+

This procedure allows the active paint method to be set by +specifying its name. The name is simply a string which corresponds +to one of the names of the available paint methods. If there is no +matching method found, this procedure will return an error. +Otherwise, the specified method becomes active and will be used in +all subsequent paint operations.

+
+

Parameters

+
+++++ + + + + + +

name

The name of the paint method.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_context_get_stroke_method ()

+
GimpStrokeMethod
+gimp_context_get_stroke_method (void);
+

Retrieve the currently active stroke method.

+

This procedure returns the currently active stroke method.

+
+

Returns

+

The active stroke method.

+
+

Since: 2.10

+
+
+
+

gimp_context_set_stroke_method ()

+
gboolean
+gimp_context_set_stroke_method (GimpStrokeMethod stroke_method);
+

Set the specified stroke method as the active stroke method.

+

This procedure set the specified stroke method as the active stroke +method. The new method will be used in all subsequent stroke +operations.

+
+

Parameters

+
+++++ + + + + + +

stroke_method

The new stroke method.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_context_get_line_width ()

+
gdouble
+gimp_context_get_line_width (void);
+

Get the line width setting.

+

This procedure returns the line width setting.

+
+

Returns

+

The line width setting.

+
+

Since: 2.10

+
+
+
+

gimp_context_set_line_width ()

+
gboolean
+gimp_context_set_line_width (gdouble line_width);
+

Set the line width setting.

+

This procedure modifies the line width setting for stroking lines.

+

This setting affects the following procedures: +gimp_drawable_edit_stroke_selection(), +gimp_drawable_edit_stroke_item().

+
+

Parameters

+
+++++ + + + + + +

line_width

The line width setting.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_context_get_line_width_unit ()

+
GimpUnit
+gimp_context_get_line_width_unit (void);
+

Get the line width unit setting.

+

This procedure returns the line width unit setting.

+
+

Returns

+

The line width unit setting.

+
+

Since: 2.10

+
+
+
+

gimp_context_set_line_width_unit ()

+
gboolean
+gimp_context_set_line_width_unit (GimpUnit line_width_unit);
+

Set the line width unit setting.

+

This procedure modifies the line width unit setting for stroking +lines.

+

This setting affects the following procedures: +gimp_drawable_edit_stroke_selection(), +gimp_drawable_edit_stroke_item().

+
+

Parameters

+
+++++ + + + + + +

line_width_unit

The line width setting unit.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_context_get_line_cap_style ()

+
GimpCapStyle
+gimp_context_get_line_cap_style (void);
+

Get the line cap style setting.

+

This procedure returns the line cap style setting.

+
+

Returns

+

The line cap style setting.

+
+

Since: 2.10

+
+
+
+

gimp_context_set_line_cap_style ()

+
gboolean
+gimp_context_set_line_cap_style (GimpCapStyle cap_style);
+

Set the line cap style setting.

+

This procedure modifies the line cap style setting for stroking +lines.

+

This setting affects the following procedures: +gimp_drawable_edit_stroke_selection(), +gimp_drawable_edit_stroke_item().

+
+

Parameters

+
+++++ + + + + + +

cap_style

The line cap style setting.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_context_get_line_join_style ()

+
GimpJoinStyle
+gimp_context_get_line_join_style (void);
+

Get the line join style setting.

+

This procedure returns the line join style setting.

+
+

Returns

+

The line join style setting.

+
+

Since: 2.10

+
+
+
+

gimp_context_set_line_join_style ()

+
gboolean
+gimp_context_set_line_join_style (GimpJoinStyle join_style);
+

Set the line join style setting.

+

This procedure modifies the line join style setting for stroking +lines.

+

This setting affects the following procedures: +gimp_drawable_edit_stroke_selection(), +gimp_drawable_edit_stroke_item().

+
+

Parameters

+
+++++ + + + + + +

join_style

The line join style setting.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_context_get_line_miter_limit ()

+
gdouble
+gimp_context_get_line_miter_limit (void);
+

Get the line miter limit setting.

+

This procedure returns the line miter limit setting.

+
+

Returns

+

The line miter limit setting.

+
+

Since: 2.10

+
+
+
+

gimp_context_set_line_miter_limit ()

+
gboolean
+gimp_context_set_line_miter_limit (gdouble miter_limit);
+

Set the line miter limit setting.

+

This procedure modifies the line miter limit setting for stroking +lines. +A mitered join is converted to a bevelled join if the miter would +extend to a distance of more than (miter-limit * line-width) from +the actual join point.

+

This setting affects the following procedures: +gimp_drawable_edit_stroke_selection(), +gimp_drawable_edit_stroke_item().

+
+

Parameters

+
+++++ + + + + + +

miter_limit

The line miter limit setting.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_context_get_line_dash_offset ()

+
gdouble
+gimp_context_get_line_dash_offset (void);
+

Get the line dash offset setting.

+

This procedure returns the line dash offset setting.

+
+

Returns

+

The line dash offset setting.

+
+

Since: 2.10

+
+
+
+

gimp_context_set_line_dash_offset ()

+
gboolean
+gimp_context_set_line_dash_offset (gdouble dash_offset);
+

Set the line dash offset setting.

+

This procedure modifies the line dash offset setting for stroking +lines.

+

This setting affects the following procedures: +gimp_drawable_edit_stroke_selection(), +gimp_drawable_edit_stroke_item().

+
+

Parameters

+
+++++ + + + + + +

dash_offset

The line dash offset setting.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_context_get_line_dash_pattern ()

+
gboolean
+gimp_context_get_line_dash_pattern (gint *num_dashes,
+                                    gdouble **dashes);
+

Get the line dash pattern setting.

+

This procedure returns the line dash pattern setting.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

num_dashes

The number of dashes in the dash_pattern array.

 

dashes

The line dash pattern setting.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_context_set_line_dash_pattern ()

+
gboolean
+gimp_context_set_line_dash_pattern (gint num_dashes,
+                                    const gdouble *dashes);
+

Set the line dash pattern setting.

+

This procedure modifies the line dash pattern setting for stroking +lines.

+

The unit of the dash pattern segments is the actual line width used +for the stroke operation, in other words a segment length of 1.0 +results in a square segment shape (or gap shape).

+

This setting affects the following procedures: +gimp_drawable_edit_stroke_selection_(), +gimp_drawable_edit_stroke_item().

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

num_dashes

The number of dashes in the dash_pattern array.

 

dashes

The line dash pattern setting.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_context_get_brush ()

+
gchar *
+gimp_context_get_brush (void);
+

Retrieve the currently active brush.

+

This procedure returns the name of the currently active brush. All +paint operations and stroke operations use this brush to control the +application of paint to the image.

+
+

Returns

+

The name of the active brush.

+
+

Since: 2.2

+
+
+
+

gimp_context_set_brush ()

+
gboolean
+gimp_context_set_brush (const gchar *name);
+

Set the specified brush as the active brush.

+

This procedure allows the active brush to be set by specifying its +name. The name is simply a string which corresponds to one of the +names of the installed brushes. If there is no matching brush found, +this procedure will return an error. Otherwise, the specified brush +becomes active and will be used in all subsequent paint operations.

+
+

Parameters

+
+++++ + + + + + +

name

The name of the brush.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_context_get_brush_size ()

+
gdouble
+gimp_context_get_brush_size (void);
+

Get brush size in pixels.

+

Get the brush size in pixels for brush based paint tools.

+
+

Returns

+

Brush size in pixels.

+
+

Since: 2.8

+
+
+
+

gimp_context_set_brush_size ()

+
gboolean
+gimp_context_set_brush_size (gdouble size);
+

Set brush size in pixels.

+

Set the brush size in pixels for brush based paint tools.

+
+

Parameters

+
+++++ + + + + + +

size

Brush size in pixels.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_context_set_brush_default_size ()

+
gboolean
+gimp_context_set_brush_default_size (void);
+

Set brush size to its default.

+

Set the brush size to the default (max of width and height) for +paintbrush, airbrush, or pencil tools.

+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_context_get_brush_aspect_ratio ()

+
gdouble
+gimp_context_get_brush_aspect_ratio (void);
+

Get brush aspect ratio.

+

Set the aspect ratio for brush based paint tools.

+
+

Returns

+

Aspect ratio.

+
+

Since: 2.8

+
+
+
+

gimp_context_set_brush_aspect_ratio ()

+
gboolean
+gimp_context_set_brush_aspect_ratio (gdouble aspect);
+

Set brush aspect ratio.

+

Set the aspect ratio for brush based paint tools.

+
+

Parameters

+
+++++ + + + + + +

aspect

Aspect ratio.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_context_get_brush_angle ()

+
gdouble
+gimp_context_get_brush_angle (void);
+

Get brush angle in degrees.

+

Set the angle in degrees for brush based paint tools.

+
+

Returns

+

Angle in degrees.

+
+

Since: 2.8

+
+
+
+

gimp_context_set_brush_angle ()

+
gboolean
+gimp_context_set_brush_angle (gdouble angle);
+

Set brush angle in degrees.

+

Set the angle in degrees for brush based paint tools.

+
+

Parameters

+
+++++ + + + + + +

angle

Angle in degrees.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_context_get_brush_spacing ()

+
gdouble
+gimp_context_get_brush_spacing (void);
+

Get brush spacing as percent of size.

+

Get the brush spacing as percent of size for brush based paint +tools.

+
+

Returns

+

Brush spacing as fraction of size.

+
+

Since: 2.10

+
+
+
+

gimp_context_set_brush_spacing ()

+
gboolean
+gimp_context_set_brush_spacing (gdouble spacing);
+

Set brush spacing as percent of size.

+

Set the brush spacing as percent of size for brush based paint +tools.

+
+

Parameters

+
+++++ + + + + + +

spacing

Brush spacing as fraction of size.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_context_set_brush_default_spacing ()

+
gboolean
+gimp_context_set_brush_default_spacing
+                               (void);
+

Set brush spacing to its default.

+

Set the brush spacing to the default for paintbrush, airbrush, or +pencil tools.

+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_context_get_brush_hardness ()

+
gdouble
+gimp_context_get_brush_hardness (void);
+

Get brush hardness in paint options.

+

Get the brush hardness for brush based paint tools.

+
+

Returns

+

Brush hardness.

+
+

Since: 2.10

+
+
+
+

gimp_context_set_brush_hardness ()

+
gboolean
+gimp_context_set_brush_hardness (gdouble hardness);
+

Set brush hardness.

+

Set the brush hardness for brush based paint tools.

+
+

Parameters

+
+++++ + + + + + +

hardness

Brush hardness.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_context_set_brush_default_hardness ()

+
gboolean
+gimp_context_set_brush_default_hardness
+                               (void);
+

Set brush spacing to its default.

+

Set the brush spacing to the default for paintbrush, airbrush, or +pencil tools.

+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_context_get_brush_force ()

+
gdouble
+gimp_context_get_brush_force (void);
+

Get brush force in paint options.

+

Get the brush application force for brush based paint tools.

+
+

Returns

+

Brush application force.

+
+

Since: 2.10

+
+
+
+

gimp_context_set_brush_force ()

+
gboolean
+gimp_context_set_brush_force (gdouble force);
+

Set brush application force.

+

Set the brush application force for brush based paint tools.

+
+

Parameters

+
+++++ + + + + + +

force

Brush application force.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_context_get_dynamics ()

+
gchar *
+gimp_context_get_dynamics (void);
+

Retrieve the currently active paint dynamics.

+

This procedure returns the name of the currently active paint +dynamics. All paint operations and stroke operations use this paint +dynamics to control the application of paint to the image.

+
+

Returns

+

The name of the active paint dynamics.

+
+

Since: 2.8

+
+
+
+

gimp_context_set_dynamics ()

+
gboolean
+gimp_context_set_dynamics (const gchar *name);
+

Set the specified paint dynamics as the active paint dynamics.

+

This procedure allows the active paint dynamics to be set by +specifying its name. The name is simply a string which corresponds +to one of the names of the installed paint dynamics. If there is no +matching paint dynamics found, this procedure will return an error. +Otherwise, the specified paint dynamics becomes active and will be +used in all subsequent paint operations.

+
+

Parameters

+
+++++ + + + + + +

name

The name of the paint dynamics.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_context_get_mypaint_brush ()

+
gchar *
+gimp_context_get_mypaint_brush (void);
+

Retrieve the currently active MyPaint brush.

+

This procedure returns the name of the currently active MyPaint +brush.

+
+

Returns

+

The name of the active MyPaint brush.

+
+

Since: 2.10

+
+
+
+

gimp_context_set_mypaint_brush ()

+
gboolean
+gimp_context_set_mypaint_brush (const gchar *name);
+

Set the specified MyPaint brush as the active MyPaint brush.

+

This procedure allows the active MyPaint brush to be set by +specifying its name. The name is simply a string which corresponds +to one of the names of the installed MyPaint brushes. If there is no +matching MyPaint brush found, this procedure will return an error. +Otherwise, the specified MyPaint brush becomes active and will be +used in all subsequent MyPaint paint operations.

+
+

Parameters

+
+++++ + + + + + +

name

The name of the MyPaint brush.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_context_get_pattern ()

+
gchar *
+gimp_context_get_pattern (void);
+

Retrieve the currently active pattern.

+

This procedure returns name of the the currently active pattern. All +clone and bucket-fill operations with patterns will use this pattern +to control the application of paint to the image.

+
+

Returns

+

The name of the active pattern.

+
+

Since: 2.2

+
+
+
+

gimp_context_set_pattern ()

+
gboolean
+gimp_context_set_pattern (const gchar *name);
+

Set the specified pattern as the active pattern.

+

This procedure allows the active pattern to be set by specifying its +name. The name is simply a string which corresponds to one of the +names of the installed patterns. If there is no matching pattern +found, this procedure will return an error. Otherwise, the specified +pattern becomes active and will be used in all subsequent paint +operations.

+
+

Parameters

+
+++++ + + + + + +

name

The name of the pattern.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_context_get_gradient ()

+
gchar *
+gimp_context_get_gradient (void);
+

Retrieve the currently active gradient.

+

This procedure returns the name of the currently active gradient.

+
+

Returns

+

The name of the active gradient.

+
+

Since: 2.2

+
+
+
+

gimp_context_set_gradient ()

+
gboolean
+gimp_context_set_gradient (const gchar *name);
+

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. 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.

+
+

Parameters

+
+++++ + + + + + +

name

The name of the gradient.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_context_set_gradient_fg_bg_hsv_ccw ()

+
gboolean
+gimp_context_set_gradient_fg_bg_hsv_ccw
+                               (void);
+

Sets the built-in FG-BG HSV (ccw) gradient as the active gradient.

+

This procedure sets the built-in FG-BG HSV (ccw) gradient as the +active gradient. The gradient will be used for subsequent gradient +operations.

+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_context_set_gradient_fg_bg_hsv_cw ()

+
gboolean
+gimp_context_set_gradient_fg_bg_hsv_cw
+                               (void);
+

Sets the built-in FG-BG HSV (cw) gradient as the active gradient.

+

This procedure sets the built-in FG-BG HSV (cw) gradient as the +active gradient. The gradient will be used for subsequent gradient +operations.

+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_context_set_gradient_fg_bg_rgb ()

+
gboolean
+gimp_context_set_gradient_fg_bg_rgb (void);
+

Sets the built-in FG-BG RGB gradient as the active gradient.

+

This procedure sets the built-in FG-BG RGB gradient as the active +gradient. The gradient will be used for subsequent gradient +operations.

+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_context_set_gradient_fg_transparent ()

+
gboolean
+gimp_context_set_gradient_fg_transparent
+                               (void);
+

Sets the built-in FG-Transparent gradient as the active gradient.

+

This procedure sets the built-in FG-Transparent gradient as the +active gradient. The gradient will be used for subsequent gradient +operations.

+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_context_get_gradient_blend_color_space ()

+
GimpGradientBlendColorSpace
+gimp_context_get_gradient_blend_color_space
+                               (void);
+

Get the gradient blend color space.

+

Get the gradient blend color space for paint tools and the gradient +tool.

+
+

Returns

+

Color blend space.

+
+

Since: 2.10

+
+
+
+

gimp_context_set_gradient_blend_color_space ()

+
gboolean
+gimp_context_set_gradient_blend_color_space
+                               (GimpGradientBlendColorSpace blend_color_space);
+

Set the gradient blend color space.

+

Set the gradient blend color space for paint tools and the gradient +tool.

+
+

Parameters

+
+++++ + + + + + +

blend_color_space

Blend color space.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_context_get_gradient_repeat_mode ()

+
GimpRepeatMode
+gimp_context_get_gradient_repeat_mode (void);
+

Get the gradient repeat mode.

+

Get the gradient repeat mode for paint tools and the gradient tool.

+
+

Returns

+

Repeat mode.

+
+

Since: 2.10

+
+
+
+

gimp_context_set_gradient_repeat_mode ()

+
gboolean
+gimp_context_set_gradient_repeat_mode (GimpRepeatMode repeat_mode);
+

Set the gradient repeat mode.

+

Set the gradient repeat mode for paint tools and the gradient tool.

+
+

Parameters

+
+++++ + + + + + +

repeat_mode

Repeat mode.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_context_get_gradient_reverse ()

+
gboolean
+gimp_context_get_gradient_reverse (void);
+

Get the gradient reverse setting.

+

Get the gradient reverse setting for paint tools and the gradient +tool.

+
+

Returns

+

Reverse.

+
+

Since: 2.10

+
+
+
+

gimp_context_set_gradient_reverse ()

+
gboolean
+gimp_context_set_gradient_reverse (gboolean reverse);
+

Set the gradient reverse setting.

+

Set the gradient reverse setting for paint tools and the gradient +tool.

+
+

Parameters

+
+++++ + + + + + +

reverse

Reverse.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_context_get_palette ()

+
gchar *
+gimp_context_get_palette (void);
+

Retrieve the currently active palette.

+

This procedure returns the name of the the currently active palette.

+
+

Returns

+

The name of the active palette.

+
+

Since: 2.2

+
+
+
+

gimp_context_set_palette ()

+
gboolean
+gimp_context_set_palette (const gchar *name);
+

Set the specified palette as the active palette.

+

This procedure allows the active palette to be set by specifying its +name. The name is simply a string which corresponds to one of the +names of the installed palettes. If no matching palette is found, +this procedure will return an error. Otherwise, the specified +palette becomes active and will be used in all subsequent palette +operations.

+
+

Parameters

+
+++++ + + + + + +

name

The name of the palette.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_context_get_font ()

+
gchar *
+gimp_context_get_font (void);
+

Retrieve the currently active font.

+

This procedure returns the name of the currently active font.

+
+

Returns

+

The name of the active font.

+
+

Since: 2.2

+
+
+
+

gimp_context_set_font ()

+
gboolean
+gimp_context_set_font (const gchar *name);
+

Set the specified font as the active font.

+

This procedure allows the active font to be set by specifying its +name. The name is simply a string which corresponds to one of the +names of the installed fonts. If no matching font is found, this +procedure will return an error. Otherwise, the specified font +becomes active and will be used in all subsequent font operations.

+
+

Parameters

+
+++++ + + + + + +

name

The name of the font.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_context_get_antialias ()

+
gboolean
+gimp_context_get_antialias (void);
+

Get the antialias setting.

+

This procedure returns the antialias setting.

+
+

Returns

+

The antialias setting.

+
+

Since: 2.8

+
+
+
+

gimp_context_set_antialias ()

+
gboolean
+gimp_context_set_antialias (gboolean antialias);
+

Set the antialias setting.

+

This procedure modifies the antialias setting. If antialiasing is +turned on, the edges of selected region will contain intermediate +values which give the appearance of a sharper, less pixelized edge. +This should be set as TRUE most of the time unless a binary-only +selection is wanted.

+

This setting affects the following procedures: +gimp_image_select_color(), gimp_image_select_contiguous_color(), +gimp_image_select_round_rectangle(), gimp_image_select_ellipse(), +gimp_image_select_polygon(), gimp_image_select_item(), +gimp_drawable_edit_bucket_fill(), gimp_drawable_edit_stroke_item(), +gimp_drawable_edit_stroke_selection().

+
+

Parameters

+
+++++ + + + + + +

antialias

The antialias setting.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_context_get_feather ()

+
gboolean
+gimp_context_get_feather (void);
+

Get the feather setting.

+

This procedure returns the feather setting.

+
+

Returns

+

The feather setting.

+
+

Since: 2.8

+
+
+
+

gimp_context_set_feather ()

+
gboolean
+gimp_context_set_feather (gboolean feather);
+

Set the feather setting.

+

This procedure modifies the feather setting. If the feather option +is enabled, selections will be blurred before combining. The blur is +a gaussian blur; its radii can be controlled using +gimp_context_set_feather_radius().

+

This setting affects the following procedures: +gimp_image_select_color(), gimp_image_select_contiguous_color(), +gimp_image_select_rectangle(), gimp_image_select_round_rectangle(), +gimp_image_select_ellipse(), gimp_image_select_polygon(), +gimp_image_select_item().

+
+

Parameters

+
+++++ + + + + + +

feather

The feather setting.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_context_get_feather_radius ()

+
gboolean
+gimp_context_get_feather_radius (gdouble *feather_radius_x,
+                                 gdouble *feather_radius_y);
+

Get the feather radius setting.

+

This procedure returns the feather radius setting.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

feather_radius_x

The horizontal feather radius.

 

feather_radius_y

The vertical feather radius.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_context_set_feather_radius ()

+
gboolean
+gimp_context_set_feather_radius (gdouble feather_radius_x,
+                                 gdouble feather_radius_y);
+

Set the feather radius setting.

+

This procedure modifies the feather radius setting.

+

This setting affects all procedures that are affected by +gimp_context_set_feather().

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

feather_radius_x

The horizontal feather radius.

 

feather_radius_y

The vertical feather radius.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_context_get_sample_merged ()

+
gboolean
+gimp_context_get_sample_merged (void);
+

Get the sample merged setting.

+

This procedure returns the sample merged setting.

+
+

Returns

+

The sample merged setting.

+
+

Since: 2.8

+
+
+
+

gimp_context_set_sample_merged ()

+
gboolean
+gimp_context_set_sample_merged (gboolean sample_merged);
+

Set the sample merged setting.

+

This procedure modifies the sample merged setting. If an operation +depends on the colors of the pixels present in a drawable, like when +doing a seed fill, this setting controls whether the pixel data from +the specified drawable is used ('sample-merged' is FALSE), or the +pixel data from the composite image ('sample-merged' is TRUE. This +is equivalent to sampling for colors after merging all visible +layers).

+

This setting affects the following procedures: +gimp_image_select_color(), gimp_image_select_contiguous_color(), +gimp_drawable_edit_bucket_fill().

+
+

Parameters

+
+++++ + + + + + +

sample_merged

The sample merged setting.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_context_get_sample_criterion ()

+
GimpSelectCriterion
+gimp_context_get_sample_criterion (void);
+

Get the sample criterion setting.

+

This procedure returns the sample criterion setting.

+
+

Returns

+

The sample criterion setting.

+
+

Since: 2.8

+
+
+
+

gimp_context_set_sample_criterion ()

+
gboolean
+gimp_context_set_sample_criterion (GimpSelectCriterion sample_criterion);
+

Set the sample criterion setting.

+

This procedure modifies the sample criterion setting. If an +operation depends on the colors of the pixels present in a drawable, +like when doing a seed fill, this setting controls how color +similarity is determined. SELECT_CRITERION_COMPOSITE is the default +value.

+

This setting affects the following procedures: +gimp_image_select_color(), gimp_image_select_contiguous_color(), +gimp_drawable_edit_bucket_fill().

+
+

Parameters

+
+++++ + + + + + +

sample_criterion

The sample criterion setting.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_context_get_sample_threshold ()

+
gdouble
+gimp_context_get_sample_threshold (void);
+

Get the sample threshold setting.

+

This procedure returns the sample threshold setting.

+
+

Returns

+

The sample threshold setting.

+
+

Since: 2.8

+
+
+
+

gimp_context_set_sample_threshold ()

+
gboolean
+gimp_context_set_sample_threshold (gdouble sample_threshold);
+

Set the sample threshold setting.

+

This procedure modifies the sample threshold setting. If an +operation depends on the colors of the pixels present in a drawable, +like when doing a seed fill, this setting controls what is +\"sufficiently close\" to be considered a similar color. If the +sample threshold has not been set explicitly, the default threshold +set in gimprc will be used.

+

This setting affects the following procedures: +gimp_image_select_color(), gimp_image_select_contiguous_color(), +gimp_drawable_edit_bucket_fill().

+
+

Parameters

+
+++++ + + + + + +

sample_threshold

The sample threshold setting.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_context_get_sample_threshold_int ()

+
gint
+gimp_context_get_sample_threshold_int (void);
+

Get the sample threshold setting as an integer value.

+

This procedure returns the sample threshold setting as an integer +value. See gimp_context_get_sample_threshold().

+
+

Returns

+

The sample threshold setting.

+
+

Since: 2.8

+
+
+
+

gimp_context_set_sample_threshold_int ()

+
gboolean
+gimp_context_set_sample_threshold_int (gint sample_threshold);
+

Set the sample threshold setting as an integer value.

+

This procedure modifies the sample threshold setting as an integer +value. See gimp_context_set_sample_threshold().

+
+

Parameters

+
+++++ + + + + + +

sample_threshold

The sample threshold setting.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_context_get_sample_transparent ()

+
gboolean
+gimp_context_get_sample_transparent (void);
+

Get the sample transparent setting.

+

This procedure returns the sample transparent setting.

+
+

Returns

+

The sample transparent setting.

+
+

Since: 2.8

+
+
+
+

gimp_context_set_sample_transparent ()

+
gboolean
+gimp_context_set_sample_transparent (gboolean sample_transparent);
+

Set the sample transparent setting.

+

This procedure modifies the sample transparent setting. If an +operation depends on the colors of the pixels present in a drawable, +like when doing a seed fill, this setting controls whether +transparency is considered to be a unique selectable color. When +this setting is TRUE, transparent areas can be selected or filled.

+

This setting affects the following procedures: +gimp_image_select_color(), gimp_image_select_contiguous_color(), +gimp_drawable_edit_bucket_fill().

+
+

Parameters

+
+++++ + + + + + +

sample_transparent

The sample transparent setting.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_context_get_diagonal_neighbors ()

+
gboolean
+gimp_context_get_diagonal_neighbors (void);
+

Get the diagonal neighbors setting.

+

This procedure returns the diagonal neighbors setting.

+
+

Returns

+

The diagonal neighbors setting.

+
+

Since: 2.10

+
+
+
+

gimp_context_set_diagonal_neighbors ()

+
gboolean
+gimp_context_set_diagonal_neighbors (gboolean diagonal_neighbors);
+

Set the diagonal neighbors setting.

+

This procedure modifies the diagonal neighbors setting. If the +affected region of an operation is based on a seed point, like when +doing a seed fill, then, when this setting is TRUE, all eight +neighbors of each pixel are considered when calculating the affected +region; in contrast, when this setting is FALSE, only the four +orthogonal neighbors of each pixel are considered.

+

This setting affects the following procedures: +gimp_image_select_contiguous_color(), +gimp_drawable_edit_bucket_fill().

+
+

Parameters

+
+++++ + + + + + +

diagonal_neighbors

The diagonal neighbors setting.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_context_get_distance_metric ()

+
GeglDistanceMetric
+gimp_context_get_distance_metric (void);
+

Get the distance metric used in some computations.

+

This procedure returns the distance metric in the current context. +See gimp_context_set_distance_metric() to know more about its usage.

+
+

Returns

+

The distance metric.

+
+

Since: 2.10

+
+
+
+

gimp_context_set_distance_metric ()

+
gboolean
+gimp_context_set_distance_metric (GeglDistanceMetric metric);
+

Set the distance metric used in some computations.

+

This procedure modifies the distance metric used in some +computations, such as gimp_drawable_edit_gradient_fill(). In +particular, it does not change the metric used in generic distance +computation on canvas, as in the Measure tool.

+

This setting affects the following procedures: +gimp_drawable_edit_gradient_fill().

+
+

Parameters

+
+++++ + + + + + +

metric

The distance metric.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_context_get_interpolation ()

+
GimpInterpolationType
+gimp_context_get_interpolation (void);
+

Get the interpolation type.

+

This procedure returns the interpolation setting. The return value +is an integer which corresponds to the values listed in the argument +description. If the interpolation has not been set explicitly by +gimp_context_set_interpolation(), the default interpolation set in +gimprc will be used.

+
+

Returns

+

The interpolation type.

+
+

Since: 2.8

+
+
+
+

gimp_context_set_interpolation ()

+
gboolean
+gimp_context_set_interpolation (GimpInterpolationType interpolation);
+

Set the interpolation type.

+

This procedure modifies the interpolation setting.

+

This setting affects affects the following procedures: +gimp_item_transform_flip(), gimp_item_transform_perspective(), +gimp_item_transform_rotate(), gimp_item_transform_scale(), +gimp_item_transform_shear(), gimp_item_transform_2d(), +gimp_item_transform_matrix(), gimp_image_scale(), +gimp_layer_scale().

+
+

Parameters

+
+++++ + + + + + +

interpolation

The interpolation type.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_context_get_transform_direction ()

+
GimpTransformDirection
+gimp_context_get_transform_direction (void);
+

Get the transform direction.

+

This procedure returns the transform direction. The return value is +an integer which corresponds to the values listed in the argument +description.

+
+

Returns

+

The transform direction.

+
+

Since: 2.8

+
+
+
+

gimp_context_set_transform_direction ()

+
gboolean
+gimp_context_set_transform_direction (GimpTransformDirection transform_direction);
+

Set the transform direction.

+

This procedure modifies the transform direction setting.

+

This setting affects affects the following procedures: +gimp_item_transform_flip(), gimp_item_transform_perspective(), +gimp_item_transform_rotate(), gimp_item_transform_scale(), +gimp_item_transform_shear(), gimp_item_transform_2d(), +gimp_item_transform_matrix().

+
+

Parameters

+
+++++ + + + + + +

transform_direction

The transform direction.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_context_get_transform_resize ()

+
GimpTransformResize
+gimp_context_get_transform_resize (void);
+

Get the transform resize type.

+

This procedure returns the transform resize setting. The return +value is an integer which corresponds to the values listed in the +argument description.

+
+

Returns

+

The transform resize type.

+
+

Since: 2.8

+
+
+
+

gimp_context_set_transform_resize ()

+
gboolean
+gimp_context_set_transform_resize (GimpTransformResize transform_resize);
+

Set the transform resize type.

+

This procedure modifies the transform resize setting. When +transforming pixels, if the result of a transform operation has a +different size than the original area, this setting determines how +the resulting area is sized.

+

This setting affects affects the following procedures: +gimp_item_transform_flip(), gimp_item_transform_flip_simple(), +gimp_item_transform_perspective(), gimp_item_transform_rotate(), +gimp_item_transform_rotate_simple(), gimp_item_transform_scale(), +gimp_item_transform_shear(), gimp_item_transform_2d(), +gimp_item_transform_matrix().

+
+

Parameters

+
+++++ + + + + + +

transform_resize

The transform resize type.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_context_get_transform_recursion ()

+
gint
+gimp_context_get_transform_recursion (void);
+
+

gimp_context_get_transform_recursion is deprecated and should not be used in newly-written code.

+

There is no replacement for this procedure.

+
+
+

Returns

+

This returns always 3 and is meaningless.

+
+
+
+
+

gimp_context_set_transform_recursion ()

+
gboolean
+gimp_context_set_transform_recursion (gint transform_recursion);
+
+

gimp_context_set_transform_recursion is deprecated and should not be used in newly-written code.

+

There is no replacement for this procedure.

+
+
+

Parameters

+
+++++ + + + + + +

transform_recursion

This parameter is ignored.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_context_get_ink_angle ()

+
gdouble
+gimp_context_get_ink_angle (void);
+

Get ink angle in degrees.

+

Get the ink angle in degrees for ink tool.

+
+

Returns

+

ink angle in degrees.

+
+

Since: 2.8

+
+
+
+

gimp_context_set_ink_angle ()

+
gboolean
+gimp_context_set_ink_angle (gdouble angle);
+

Set ink angle in degrees.

+

Set the ink angle in degrees for ink tool.

+
+

Parameters

+
+++++ + + + + + +

angle

ink angle in degrees.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_context_get_ink_blob_angle ()

+
gdouble
+gimp_context_get_ink_blob_angle (void);
+

Get ink blob angle in degrees.

+

Get the ink blob angle in degrees for ink tool.

+
+

Returns

+

ink blob angle in degrees.

+
+

Since: 2.8

+
+
+
+

gimp_context_set_ink_blob_angle ()

+
gboolean
+gimp_context_set_ink_blob_angle (gdouble angle);
+

Set ink blob angle in degrees.

+

Set the ink blob angle in degrees for ink tool.

+
+

Parameters

+
+++++ + + + + + +

angle

ink blob angle in degrees.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_context_get_ink_blob_aspect_ratio ()

+
gdouble
+gimp_context_get_ink_blob_aspect_ratio
+                               (void);
+

Get ink blob aspect ratio.

+

Get the ink blob aspect ratio for ink tool.

+
+

Returns

+

ink blob aspect ratio.

+
+

Since: 2.8

+
+
+
+

gimp_context_set_ink_blob_aspect_ratio ()

+
gboolean
+gimp_context_set_ink_blob_aspect_ratio
+                               (gdouble aspect);
+

Set ink blob aspect ratio.

+

Set the ink blob aspect ratio for ink tool.

+
+

Parameters

+
+++++ + + + + + +

aspect

ink blob aspect ratio.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_context_get_ink_blob_type ()

+
GimpInkBlobType
+gimp_context_get_ink_blob_type (void);
+

Get ink blob type.

+

Get the ink blob type for ink tool.

+
+

Returns

+

Ink blob type.

+
+

Since: 2.8

+
+
+
+

gimp_context_set_ink_blob_type ()

+
gboolean
+gimp_context_set_ink_blob_type (GimpInkBlobType type);
+

Set ink blob type.

+

Set the ink blob type for ink tool.

+
+

Parameters

+
+++++ + + + + + +

type

Ink blob type.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_context_get_ink_size ()

+
gdouble
+gimp_context_get_ink_size (void);
+

Get ink blob size in pixels.

+

Get the ink blob size in pixels for ink tool.

+
+

Returns

+

ink blob size in pixels.

+
+

Since: 2.8

+
+
+
+

gimp_context_set_ink_size ()

+
gboolean
+gimp_context_set_ink_size (gdouble size);
+

Set ink blob size in pixels.

+

Set the ink blob size in pixels for ink tool.

+
+

Parameters

+
+++++ + + + + + +

size

ink blob size in pixels.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_context_get_ink_size_sensitivity ()

+
gdouble
+gimp_context_get_ink_size_sensitivity (void);
+

Get ink size sensitivity.

+

Get the ink size sensitivity for ink tool.

+
+

Returns

+

ink size sensitivity.

+
+

Since: 2.8

+
+
+
+

gimp_context_set_ink_size_sensitivity ()

+
gboolean
+gimp_context_set_ink_size_sensitivity (gdouble size);
+

Set ink size sensitivity.

+

Set the ink size sensitivity for ink tool.

+
+

Parameters

+
+++++ + + + + + +

size

ink size sensitivity.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_context_get_ink_speed_sensitivity ()

+
gdouble
+gimp_context_get_ink_speed_sensitivity
+                               (void);
+

Get ink speed sensitivity.

+

Get the ink speed sensitivity for ink tool.

+
+

Returns

+

ink speed sensitivity.

+
+

Since: 2.8

+
+
+
+

gimp_context_set_ink_speed_sensitivity ()

+
gboolean
+gimp_context_set_ink_speed_sensitivity
+                               (gdouble speed);
+

Set ink speed sensitivity.

+

Set the ink speed sensitivity for ink tool.

+
+

Parameters

+
+++++ + + + + + +

speed

ink speed sensitivity.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_context_get_ink_tilt_sensitivity ()

+
gdouble
+gimp_context_get_ink_tilt_sensitivity (void);
+

Get ink tilt sensitivity.

+

Get the ink tilt sensitivity for ink tool.

+
+

Returns

+

ink tilt sensitivity.

+
+

Since: 2.8

+
+
+
+

gimp_context_set_ink_tilt_sensitivity ()

+
gboolean
+gimp_context_set_ink_tilt_sensitivity (gdouble tilt);
+

Set ink tilt sensitivity.

+

Set the ink tilt sensitivity for ink tool.

+
+

Parameters

+
+++++ + + + + + +

tilt

ink tilt sensitivity.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpdebug.html b/devel-docs/libgimp/html/libgimp-gimpdebug.html new file mode 100644 index 0000000..49a38e3 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpdebug.html @@ -0,0 +1,108 @@ + + + + +gimpdebug: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpdebug

+

gimpdebug — Debug utility functions

+
+
+

Functions

+
++++ + + + + + + + + + + +
+gboolean + +gimp_debug_timer_start () +
+gdouble + +gimp_debug_timer_end () +
+
+
+

Description

+

Miscellaneous debug utility functions. Not part of the stable +library interface.

+
+
+

Functions

+
+

gimp_debug_timer_start ()

+
gboolean
+gimp_debug_timer_start (void);
+

Starts measuring elapsed time.

+

This procedure starts a timer, measuring the elapsed time since the +call. Each call to this procedure should be matched by a call to +gimp_debug_timer_end(), which returns the elapsed time. +If there is already an active timer, it is not affected by the call, +however, a matching gimp_debug_timer_end() call is still required.

+

This is a debug utility procedure. It is subject to change at any +point, and should not be used in production.

+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_debug_timer_end ()

+
gdouble
+gimp_debug_timer_end (void);
+

Finishes measuring elapsed time.

+

This procedure stops the timer started by a previous +gimp_debug_timer_start() call, and prints and returns the elapsed +time. +If there was already an active timer at the time of corresponding +call to gimp_debug_timer_start(), a dummy value is returned.

+

This is a debug utility procedure. It is subject to change at any +point, and should not be used in production.

+
+

Returns

+

The elapsed time, in seconds.

+
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpdisplay.html b/devel-docs/libgimp/html/libgimp-gimpdisplay.html new file mode 100644 index 0000000..2d56fab --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpdisplay.html @@ -0,0 +1,280 @@ + + + + +gimpdisplay: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpdisplay

+

gimpdisplay — Functions to create, delete and flush displays (views) on an image.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+gint32 + +gimp_display_new () +
+gboolean + +gimp_display_delete () +
+gboolean + +gimp_display_is_valid () +
+gint + +gimp_display_get_window_handle () +
+gboolean + +gimp_displays_flush () +
+gboolean + +gimp_displays_reconnect () +
+
+
+

Description

+

Functions to create, delete and flush displays (views) on an image.

+
+
+

Functions

+
+

gimp_display_new ()

+
gint32
+gimp_display_new (gint32 image_ID);
+

Create a new display for the specified image.

+

Creates a new display for the specified image. If the image already +has a display, another is added. Multiple displays are handled +transparently by GIMP. The newly created display is returned and can +be subsequently destroyed with a call to gimp_display_delete(). This +procedure only makes sense for use with the GIMP UI, and will result +in an execution error if called when GIMP has no UI.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

The new display.

+
+
+
+
+

gimp_display_delete ()

+
gboolean
+gimp_display_delete (gint32 display_ID);
+

Delete the specified display.

+

This procedure removes the specified display. If this is the last +remaining display for the underlying image, then the image is +deleted also. Note that the display is closed no matter if the image +is dirty or not. Better save the image before calling this +procedure.

+
+

Parameters

+
+++++ + + + + + +

display_ID

The display to delete.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_display_is_valid ()

+
gboolean
+gimp_display_is_valid (gint32 display_ID);
+

Returns TRUE if the display is valid.

+

This procedure checks if the given display ID is valid and refers to +an existing display.

+
+

Parameters

+
+++++ + + + + + +

display_ID

The display to check.

 
+
+
+

Returns

+

Whether the display ID is valid.

+
+

Since: 2.4

+
+
+
+

gimp_display_get_window_handle ()

+
gint
+gimp_display_get_window_handle (gint32 display_ID);
+

Get a handle to the native window for an image display.

+

This procedure returns a handle to the native window for a given +image display. For example in the X backend of GDK, a native window +handle is an Xlib XID. A value of 0 is returned for an invalid +display or if this function is unimplemented for the windowing +system that is being used.

+
+

Parameters

+
+++++ + + + + + +

display_ID

The display to get the window handle from.

 
+
+
+

Returns

+

The native window handle or 0.

+
+

Since: 2.4

+
+
+
+

gimp_displays_flush ()

+
gboolean
+gimp_displays_flush (void);
+

Flush all internal changes to the user interface

+

This procedure takes no arguments and returns nothing except a +success status. Its purpose is to flush all pending updates of image +manipulations to the user interface. It should be called whenever +appropriate.

+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_displays_reconnect ()

+
gboolean
+gimp_displays_reconnect (gint32 old_image_ID,
+                         gint32 new_image_ID);
+

Reconnect displays from one image to another image.

+

This procedure connects all displays of the old_image to the +new_image. If the old_image has no display or new_image already has +a display the reconnect is not performed and the procedure returns +without success. You should rarely need to use this function.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

old_image_ID

The old image (must have at least one display).

 

new_image_ID

The new image (must not have a display).

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpdrawable.html b/devel-docs/libgimp/html/libgimp-gimpdrawable.html new file mode 100644 index 0000000..4164762 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpdrawable.html @@ -0,0 +1,2286 @@ + + + + +gimpdrawable: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpdrawable

+

gimpdrawable — Functions to manipulate drawables.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+GeglBuffer * + +gimp_drawable_get_buffer () +
+GeglBuffer * + +gimp_drawable_get_shadow_buffer () +
const Babl * + +gimp_drawable_get_format () +
const Babl * + +gimp_drawable_get_thumbnail_format () +
+GimpDrawable * + +gimp_drawable_get () +
+void + +gimp_drawable_detach () +
+void + +gimp_drawable_flush () +
+gboolean + +gimp_drawable_delete () +
+gboolean + +gimp_drawable_is_valid () +
+gchar * + +gimp_drawable_get_name () +
+gboolean + +gimp_drawable_set_name () +
+gboolean + +gimp_drawable_get_visible () +
+gboolean + +gimp_drawable_set_visible () +
+gboolean + +gimp_drawable_get_linked () +
+gboolean + +gimp_drawable_set_linked () +
+gint + +gimp_drawable_get_tattoo () +
+gboolean + +gimp_drawable_set_tattoo () +
+guint8 * + +gimp_drawable_get_pixel () +
+gboolean + +gimp_drawable_set_pixel () +
+GimpTile * + +gimp_drawable_get_tile () +
+GimpTile * + +gimp_drawable_get_tile2 () +
+guchar * + +gimp_drawable_get_thumbnail_data () +
+guchar * + +gimp_drawable_get_sub_thumbnail_data () +
+void + +gimp_drawable_get_color_uchar () +
+gboolean + +gimp_drawable_merge_shadow () +
+gboolean + +gimp_drawable_free_shadow () +
+gboolean + +gimp_drawable_fill () +
+gboolean + +gimp_drawable_update () +
+gboolean + +gimp_drawable_mask_bounds () +
+gboolean + +gimp_drawable_mask_intersect () +
+gint32 + +gimp_drawable_get_image () +
+gboolean + +gimp_drawable_set_image () +
+gboolean + +gimp_drawable_has_alpha () +
+GimpImageType + +gimp_drawable_type_with_alpha () +
+GimpImageType + +gimp_drawable_type () +
+gboolean + +gimp_drawable_is_rgb () +
+gboolean + +gimp_drawable_is_gray () +
+gboolean + +gimp_drawable_is_indexed () +
+gint + +gimp_drawable_bpp () +
+gint + +gimp_drawable_width () +
+gint + +gimp_drawable_height () +
+gboolean + +gimp_drawable_offsets () +
+gboolean + +gimp_drawable_is_channel () +
+gboolean + +gimp_drawable_is_layer () +
+gboolean + +gimp_drawable_is_layer_mask () +
+gboolean + +gimp_drawable_is_text_layer () +
+gboolean + +gimp_drawable_offset () +
+gboolean + +gimp_drawable_foreground_extract () +
+GimpParasite * + +gimp_drawable_parasite_find () +
+gboolean + +gimp_drawable_parasite_list () +
+gboolean + +gimp_drawable_parasite_attach () +
+gboolean + +gimp_drawable_parasite_detach () +
+gboolean + +gimp_drawable_attach_new_parasite () +
+
+
+

Types and Values

+
++++ + + + + +
 GimpDrawable
+
+
+

Description

+

Functions to manipulate drawables.

+
+
+

Functions

+
+

gimp_drawable_get_buffer ()

+
GeglBuffer *
+gimp_drawable_get_buffer (gint32 drawable_ID);
+

Returns a GeglBuffer of a specified drawable. The buffer can be used +like any other GEGL buffer. Its data will we synced back with the core +drawable when the buffer gets destroyed, or when gegl_buffer_flush() +is called.

+
+

Parameters

+
+++++ + + + + + +

drawable_ID

the ID of the GimpDrawable to get the buffer for.

 
+
+
+

Returns

+

The GeglBuffer.

+

See Also: gimp_drawable_get_shadow_buffer()

+
+

Since: 2.10

+
+
+
+

gimp_drawable_get_shadow_buffer ()

+
GeglBuffer *
+gimp_drawable_get_shadow_buffer (gint32 drawable_ID);
+

Returns a GeglBuffer of a specified drawable's shadow tiles. The +buffer can be used like any other GEGL buffer. Its data will we +synced back with the core drawable's shadow tiles when the buffer +gets destroyed, or when gegl_buffer_flush() is called.

+
+

Parameters

+
+++++ + + + + + +

drawable_ID

the ID of the GimpDrawable to get the buffer for.

 
+
+
+

Returns

+

The GeglBuffer.

+

See Also: gimp_drawable_get_shadow_buffer()

+
+

Since: 2.10

+
+
+
+

gimp_drawable_get_format ()

+
const Babl *
+gimp_drawable_get_format (gint32 drawable_ID);
+

Returns the Babl format of the drawable.

+
+

Parameters

+
+++++ + + + + + +

drawable_ID

the ID of the GimpDrawable to get the format for.

 
+
+
+

Returns

+

The Babl format.

+
+

Since: 2.10

+
+
+
+

gimp_drawable_get_thumbnail_format ()

+
const Babl *
+gimp_drawable_get_thumbnail_format (gint32 drawable_ID);
+

Returns the Babl thumbnail format of the drawable.

+
+

Parameters

+
+++++ + + + + + +

drawable_ID

the ID of the GimpDrawable to get the thumbnail format for.

 
+
+
+

Returns

+

The Babl thumbnail format.

+
+

Since: 2.10.14

+
+
+
+

gimp_drawable_get ()

+
GimpDrawable *
+gimp_drawable_get (gint32 drawable_ID);
+

gimp_drawable_get is deprecated and should not be used in newly-written code.

+

This function creates a GimpDrawable structure for the core +drawable identified by drawable_ID +. The returned structure +contains some basic information about the drawable and can also +hold tile data for transfer to and from the core.

+

Note that the name of this function is somewhat misleading, because +it suggests that it simply returns a handle. This is not the case: +if the function is called multiple times, it creates separate tile +lists each time, which will usually produce undesired results.

+

When a plug-in has finished working with a drawable, before exiting +it should call gimp_drawable_detach() to make sure that all tile data is +transferred back to the core.

+
+

Parameters

+
+++++ + + + + + +

drawable_ID

the ID of the drawable

 
+
+
+

Returns

+

a new GimpDrawable wrapper

+
+
+
+
+

gimp_drawable_detach ()

+
void
+gimp_drawable_detach (GimpDrawable *drawable);
+

gimp_drawable_detach is deprecated and should not be used in newly-written code.

+

This function is called when a plug-in is finished working +with a drawable. It forces all tile data held in the tile +list of the GimpDrawable to be transferred to the core, and +then frees all associated memory. You must not access the +drawable + after having called gimp_drawable_detach().

+
+

Parameters

+
+++++ + + + + + +

drawable

The GimpDrawable to detach from the core

 
+
+
+
+
+

gimp_drawable_flush ()

+
void
+gimp_drawable_flush (GimpDrawable *drawable);
+

gimp_drawable_flush is deprecated and should not be used in newly-written code.

+

This function causes all tile data in the tile list of drawable + to be +transferred to the core. It is usually called in situations where a +plug-in acts on a drawable, and then needs to read the results of its +actions. Data transferred back from the core will not generally be valid +unless gimp_drawable_flush() has been called beforehand.

+
+

Parameters

+
+++++ + + + + + +

drawable

The GimpDrawable whose tile data is to be transferred +to the core.

 
+
+
+
+
+

gimp_drawable_delete ()

+
gboolean
+gimp_drawable_delete (gint32 drawable_ID);
+
+

gimp_drawable_delete is deprecated and should not be used in newly-written code.

+

Use gimp_item_delete() instead.

+
+
+

Parameters

+
+++++ + + + + + +

drawable_ID

The drawable to delete.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_drawable_is_valid ()

+
gboolean
+gimp_drawable_is_valid (gint32 drawable_ID);
+
+

gimp_drawable_is_valid is deprecated and should not be used in newly-written code.

+

Use gimp_item_is_valid() instead.

+
+
+

Parameters

+
+++++ + + + + + +

drawable_ID

The drawable to check.

 
+
+
+

Returns

+

Whether the drawable ID is valid.

+
+

Since: 2.4

+
+
+
+

gimp_drawable_get_name ()

+
gchar *
+gimp_drawable_get_name (gint32 drawable_ID);
+
+

gimp_drawable_get_name is deprecated and should not be used in newly-written code.

+

Use gimp_item_get_name() instead.

+
+
+

Parameters

+
+++++ + + + + + +

drawable_ID

The drawable.

 
+
+
+

Returns

+

The drawable name.

+
+
+
+
+

gimp_drawable_set_name ()

+
gboolean
+gimp_drawable_set_name (gint32 drawable_ID,
+                        const gchar *name);
+
+

gimp_drawable_set_name is deprecated and should not be used in newly-written code.

+

Use gimp_item_set_name() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

drawable_ID

The drawable.

 

name

The new drawable name.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_drawable_get_visible ()

+
gboolean
+gimp_drawable_get_visible (gint32 drawable_ID);
+
+

gimp_drawable_get_visible is deprecated and should not be used in newly-written code.

+

Use gimp_item_get_visible() instead.

+
+
+

Parameters

+
+++++ + + + + + +

drawable_ID

The drawable.

 
+
+
+

Returns

+

The drawable visibility.

+
+
+
+
+

gimp_drawable_set_visible ()

+
gboolean
+gimp_drawable_set_visible (gint32 drawable_ID,
+                           gboolean visible);
+
+

gimp_drawable_set_visible is deprecated and should not be used in newly-written code.

+

Use gimp_item_set_visible() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

drawable_ID

The drawable.

 

visible

The new drawable visibility.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_drawable_get_linked ()

+
gboolean
+gimp_drawable_get_linked (gint32 drawable_ID);
+
+

gimp_drawable_get_linked is deprecated and should not be used in newly-written code.

+

Use gimp_item_get_linked() instead.

+
+
+

Parameters

+
+++++ + + + + + +

drawable_ID

The drawable.

 
+
+
+

Returns

+

The drawable linked state (for moves).

+
+
+
+
+

gimp_drawable_set_linked ()

+
gboolean
+gimp_drawable_set_linked (gint32 drawable_ID,
+                          gboolean linked);
+
+

gimp_drawable_set_linked is deprecated and should not be used in newly-written code.

+

Use gimp_item_set_linked() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

drawable_ID

The drawable.

 

linked

The new drawable linked state.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_drawable_get_tattoo ()

+
gint
+gimp_drawable_get_tattoo (gint32 drawable_ID);
+
+

gimp_drawable_get_tattoo is deprecated and should not be used in newly-written code.

+

Use gimp_item_get_tattoo() instead.

+
+
+

Parameters

+
+++++ + + + + + +

drawable_ID

The drawable.

 
+
+
+

Returns

+

The drawable tattoo.

+
+
+
+
+

gimp_drawable_set_tattoo ()

+
gboolean
+gimp_drawable_set_tattoo (gint32 drawable_ID,
+                          gint tattoo);
+
+

gimp_drawable_set_tattoo is deprecated and should not be used in newly-written code.

+

Use gimp_item_set_tattoo() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

drawable_ID

The drawable.

 

tattoo

The new drawable tattoo.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_drawable_get_pixel ()

+
guint8 *
+gimp_drawable_get_pixel (gint32 drawable_ID,
+                         gint x_coord,
+                         gint y_coord,
+                         gint *num_channels);
+

Gets the value of the pixel at the specified coordinates.

+

This procedure gets the pixel value at the specified coordinates. +The 'num_channels' argument must always be equal to the +bytes-per-pixel value for the specified drawable.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The drawable.

 

x_coord

The x coordinate.

 

y_coord

The y coordinate.

 

num_channels

The number of channels for the pixel.

 
+
+
+

Returns

+

The pixel value.

+
+
+
+
+

gimp_drawable_set_pixel ()

+
gboolean
+gimp_drawable_set_pixel (gint32 drawable_ID,
+                         gint x_coord,
+                         gint y_coord,
+                         gint num_channels,
+                         const guint8 *pixel);
+

Sets the value of the pixel at the specified coordinates.

+

This procedure sets the pixel value at the specified coordinates. +The 'num_channels' argument must always be equal to the +bytes-per-pixel value for the specified drawable. Note that this +function is not undoable, you should use it only on drawables you +just created yourself.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The drawable.

 

x_coord

The x coordinate.

 

y_coord

The y coordinate.

 

num_channels

The number of channels for the pixel.

 

pixel

The pixel value.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_drawable_get_tile ()

+
GimpTile *
+gimp_drawable_get_tile (GimpDrawable *drawable,
+                        gboolean shadow,
+                        gint row,
+                        gint col);
+

gimp_drawable_get_tile is deprecated and should not be used in newly-written code.

+
+
+
+

gimp_drawable_get_tile2 ()

+
GimpTile *
+gimp_drawable_get_tile2 (GimpDrawable *drawable,
+                         gboolean shadow,
+                         gint x,
+                         gint y);
+

gimp_drawable_get_tile2 is deprecated and should not be used in newly-written code.

+
+
+
+

gimp_drawable_get_thumbnail_data ()

+
guchar *
+gimp_drawable_get_thumbnail_data (gint32 drawable_ID,
+                                  gint *width,
+                                  gint *height,
+                                  gint *bpp);
+
+
+
+

gimp_drawable_get_sub_thumbnail_data ()

+
guchar *
+gimp_drawable_get_sub_thumbnail_data (gint32 drawable_ID,
+                                      gint src_x,
+                                      gint src_y,
+                                      gint src_width,
+                                      gint src_height,
+                                      gint *dest_width,
+                                      gint *dest_height,
+                                      gint *bpp);
+
+
+
+

gimp_drawable_get_color_uchar ()

+
void
+gimp_drawable_get_color_uchar (gint32 drawable_ID,
+                               const GimpRGB *color,
+                               guchar *color_uchar);
+

gimp_drawable_get_color_uchar is deprecated and should not be used in newly-written code.

+
+
+
+

gimp_drawable_merge_shadow ()

+
gboolean
+gimp_drawable_merge_shadow (gint32 drawable_ID,
+                            gboolean undo);
+

Merge the shadow buffer with the specified drawable.

+

This procedure combines the contents of the drawable's shadow buffer +(for temporary processing) with the specified drawable. The 'undo' +parameter specifies whether to add an undo step for the operation. +Requesting no undo is useful for such applications as 'auto-apply'.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

drawable_ID

The drawable.

 

undo

Push merge to undo stack?

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_drawable_free_shadow ()

+
gboolean
+gimp_drawable_free_shadow (gint32 drawable_ID);
+

Free the specified drawable's shadow data (if it exists).

+

This procedure is intended as a memory saving device. If any shadow +memory has been allocated, it will be freed automatically when the +drawable is removed from the image, or when the plug-in procedure +which allocated it returns.

+
+

Parameters

+
+++++ + + + + + +

drawable_ID

The drawable.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.6

+
+
+
+

gimp_drawable_fill ()

+
gboolean
+gimp_drawable_fill (gint32 drawable_ID,
+                    GimpFillType fill_type);
+

Fill the drawable with the specified fill mode.

+

This procedure fills the drawable. If the fill mode is foreground +the current foreground color is used. If the fill mode is +background, the current background color is used. If the fill type +is white, then white is used. Transparent fill only affects layers +with an alpha channel, in which case the alpha channel is set to +transparent. If the drawable has no alpha channel, it is filled to +white. No fill leaves the drawable's contents undefined. +This procedure is unlike gimp_edit_fill() or the bucket fill tool +because it fills regardless of a selection. Its main purpose is to +fill a newly created drawable before adding it to the image. This +operation cannot be undone.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

drawable_ID

The drawable.

 

fill_type

The type of fill.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_drawable_update ()

+
gboolean
+gimp_drawable_update (gint32 drawable_ID,
+                      gint x,
+                      gint y,
+                      gint width,
+                      gint height);
+

Update the specified region of the drawable.

+

This procedure updates the specified region of the drawable. The (x, +y) coordinate pair is relative to the drawable's origin, not to the +image origin. Therefore, the entire drawable can be updated using +(0, 0, width, height).

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The drawable.

 

x

x coordinate of upper left corner of update region.

 

y

y coordinate of upper left corner of update region.

 

width

Width of update region.

 

height

Height of update region.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_drawable_mask_bounds ()

+
gboolean
+gimp_drawable_mask_bounds (gint32 drawable_ID,
+                           gint *x1,
+                           gint *y1,
+                           gint *x2,
+                           gint *y2);
+

Find the bounding box of the current selection in relation to the +specified drawable.

+

This procedure returns whether there is a selection. If there is +one, the upper left and lower right-hand corners of its bounding box +are returned. These coordinates are specified relative to the +drawable's origin, and bounded by the drawable's extents. Please +note that the pixel specified by the lower right-hand coordinate of +the bounding box is not part of the selection. The selection ends at +the upper left corner of this pixel. This means the width of the +selection can be calculated as (x2 - x1), its height as (y2 - y1). +Note that the returned boolean does NOT correspond with the returned +region being empty or not, it always returns whether the selection +is non_empty. See gimp_drawable_mask_intersect() for a boolean +return value which is more useful in most cases.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The drawable.

 

x1

x coordinate of the upper left corner of selection bounds.

 

y1

y coordinate of the upper left corner of selection bounds.

 

x2

x coordinate of the lower right corner of selection bounds.

 

y2

y coordinate of the lower right corner of selection bounds.

 
+
+
+

Returns

+

TRUE if there is a selection.

+
+
+
+
+

gimp_drawable_mask_intersect ()

+
gboolean
+gimp_drawable_mask_intersect (gint32 drawable_ID,
+                              gint *x,
+                              gint *y,
+                              gint *width,
+                              gint *height);
+

Find the bounding box of the current selection in relation to the +specified drawable.

+

This procedure returns whether there is an intersection between the +drawable and the selection. Unlike gimp_drawable_mask_bounds(), the +intersection's bounds are returned as x, y, width, height. +If there is no selection this function returns TRUE and the returned +bounds are the extents of the whole drawable.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The drawable.

 

x

x coordinate of the upper left corner of the intersection.

 

y

y coordinate of the upper left corner of the intersection.

 

width

width of the intersection.

 

height

height of the intersection.

 
+
+
+

Returns

+

TRUE if the returned area is not empty.

+
+

Since: 2.2

+
+
+
+

gimp_drawable_get_image ()

+
gint32
+gimp_drawable_get_image (gint32 drawable_ID);
+
+

gimp_drawable_get_image is deprecated and should not be used in newly-written code.

+

Use gimp_item_get_image() instead.

+
+
+

Parameters

+
+++++ + + + + + +

drawable_ID

The drawable.

 
+
+
+

Returns

+

The drawable's image.

+
+
+
+
+

gimp_drawable_set_image ()

+
gboolean
+gimp_drawable_set_image (gint32 drawable_ID,
+                         gint32 image_ID);
+
+

gimp_drawable_set_image is deprecated and should not be used in newly-written code.

+

There is no replacement for this procedure.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

drawable_ID

The drawable.

 

image_ID

The image.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_drawable_has_alpha ()

+
gboolean
+gimp_drawable_has_alpha (gint32 drawable_ID);
+

Returns TRUE if the drawable has an alpha channel.

+

This procedure returns whether the specified drawable has an alpha +channel. This can only be true for layers, and the associated type +will be one of: { RGBA , GRAYA, INDEXEDA }.

+
+

Parameters

+
+++++ + + + + + +

drawable_ID

The drawable.

 
+
+
+

Returns

+

Does the drawable have an alpha channel?

+
+
+
+
+

gimp_drawable_type_with_alpha ()

+
GimpImageType
+gimp_drawable_type_with_alpha (gint32 drawable_ID);
+

Returns the drawable's type with alpha.

+

This procedure returns the drawable's type as if had an alpha +channel. If the type is currently Gray, for instance, the returned +type would be GrayA. If the drawable already has an alpha channel, +the drawable's type is simply returned.

+
+

Parameters

+
+++++ + + + + + +

drawable_ID

The drawable.

 
+
+
+

Returns

+

The drawable's type with alpha.

+
+
+
+
+

gimp_drawable_type ()

+
GimpImageType
+gimp_drawable_type (gint32 drawable_ID);
+

Returns the drawable's type.

+

This procedure returns the drawable's type.

+
+

Parameters

+
+++++ + + + + + +

drawable_ID

The drawable.

 
+
+
+

Returns

+

The drawable's type.

+
+
+
+
+

gimp_drawable_is_rgb ()

+
gboolean
+gimp_drawable_is_rgb (gint32 drawable_ID);
+

Returns whether the drawable is an RGB type.

+

This procedure returns TRUE if the specified drawable is of type { +RGB, RGBA }.

+
+

Parameters

+
+++++ + + + + + +

drawable_ID

The drawable.

 
+
+
+

Returns

+

TRUE if the drawable is an RGB type.

+
+
+
+
+

gimp_drawable_is_gray ()

+
gboolean
+gimp_drawable_is_gray (gint32 drawable_ID);
+

Returns whether the drawable is a grayscale type.

+

This procedure returns TRUE if the specified drawable is of type { +Gray, GrayA }.

+
+

Parameters

+
+++++ + + + + + +

drawable_ID

The drawable.

 
+
+
+

Returns

+

TRUE if the drawable is a grayscale type.

+
+
+
+
+

gimp_drawable_is_indexed ()

+
gboolean
+gimp_drawable_is_indexed (gint32 drawable_ID);
+

Returns whether the drawable is an indexed type.

+

This procedure returns TRUE if the specified drawable is of type { +Indexed, IndexedA }.

+
+

Parameters

+
+++++ + + + + + +

drawable_ID

The drawable.

 
+
+
+

Returns

+

TRUE if the drawable is an indexed type.

+
+
+
+
+

gimp_drawable_bpp ()

+
gint
+gimp_drawable_bpp (gint32 drawable_ID);
+

Returns the bytes per pixel.

+

This procedure returns the number of bytes per pixel, which +corresponds to the number of components unless +gimp_plugin_enable_precision() was called.

+
+

Parameters

+
+++++ + + + + + +

drawable_ID

The drawable.

 
+
+
+

Returns

+

Bytes per pixel.

+
+
+
+
+

gimp_drawable_width ()

+
gint
+gimp_drawable_width (gint32 drawable_ID);
+

Returns the width of the drawable.

+

This procedure returns the specified drawable's width in pixels.

+
+

Parameters

+
+++++ + + + + + +

drawable_ID

The drawable.

 
+
+
+

Returns

+

Width of drawable.

+
+
+
+
+

gimp_drawable_height ()

+
gint
+gimp_drawable_height (gint32 drawable_ID);
+

Returns the height of the drawable.

+

This procedure returns the specified drawable's height in pixels.

+
+

Parameters

+
+++++ + + + + + +

drawable_ID

The drawable.

 
+
+
+

Returns

+

Height of drawable.

+
+
+
+
+

gimp_drawable_offsets ()

+
gboolean
+gimp_drawable_offsets (gint32 drawable_ID,
+                       gint *offset_x,
+                       gint *offset_y);
+

Returns the offsets for the drawable.

+

This procedure returns the specified drawable's offsets. This only +makes sense if the drawable is a layer since channels are anchored. +The offsets of a channel will be returned as 0.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

drawable_ID

The drawable.

 

offset_x

x offset of drawable.

 

offset_y

y offset of drawable.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_drawable_is_channel ()

+
gboolean
+gimp_drawable_is_channel (gint32 drawable_ID);
+
+

gimp_drawable_is_channel is deprecated and should not be used in newly-written code.

+

Use gimp_item_is_channel() instead.

+
+
+

Parameters

+
+++++ + + + + + +

drawable_ID

The drawable.

 
+
+
+

Returns

+

TRUE if the drawable is a channel, FALSE otherwise.

+
+
+
+
+

gimp_drawable_is_layer ()

+
gboolean
+gimp_drawable_is_layer (gint32 drawable_ID);
+
+

gimp_drawable_is_layer is deprecated and should not be used in newly-written code.

+

Use gimp_item_is_layer() instead.

+
+
+

Parameters

+
+++++ + + + + + +

drawable_ID

The drawable.

 
+
+
+

Returns

+

TRUE if the drawable is a layer, FALSE otherwise.

+
+
+
+
+

gimp_drawable_is_layer_mask ()

+
gboolean
+gimp_drawable_is_layer_mask (gint32 drawable_ID);
+
+

gimp_drawable_is_layer_mask is deprecated and should not be used in newly-written code.

+

Use gimp_item_is_layer_mask() instead.

+
+
+

Parameters

+
+++++ + + + + + +

drawable_ID

The drawable.

 
+
+
+

Returns

+

TRUE if the drawable is a layer mask, FALSE otherwise.

+
+
+
+
+

gimp_drawable_is_text_layer ()

+
gboolean
+gimp_drawable_is_text_layer (gint32 drawable_ID);
+
+

gimp_drawable_is_text_layer is deprecated and should not be used in newly-written code.

+

Use gimp_item_is_text_layer() instead.

+
+
+

Parameters

+
+++++ + + + + + +

drawable_ID

The drawable.

 
+
+
+

Returns

+

TRUE if the drawable is a text layer, FALSE otherwise.

+
+

Since: 2.6

+
+
+
+

gimp_drawable_offset ()

+
gboolean
+gimp_drawable_offset (gint32 drawable_ID,
+                      gboolean wrap_around,
+                      GimpOffsetType fill_type,
+                      gint offset_x,
+                      gint offset_y);
+

Offset the drawable by the specified amounts in the X and Y +directions

+

This procedure offsets the specified drawable by the amounts +specified by 'offset_x' and 'offset_y'. If 'wrap_around' is set to +TRUE, then portions of the drawable which are offset out of bounds +are wrapped around. Alternatively, the undefined regions of the +drawable can be filled with transparency or the background color, as +specified by the 'fill-type' parameter.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The drawable to offset.

 

wrap_around

wrap image around or fill vacated regions.

 

fill_type

fill vacated regions of drawable with background or transparent.

 

offset_x

offset by this amount in X direction.

 

offset_y

offset by this amount in Y direction.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_drawable_foreground_extract ()

+
gboolean
+gimp_drawable_foreground_extract (gint32 drawable_ID,
+                                  GimpForegroundExtractMode mode,
+                                  gint32 mask_ID);
+

Extract the foreground of a drawable using a given trimap.

+

Image Segmentation by Uniform Color Clustering, see +https://www.inf.fu-berlin.de/inst/pubs/tr-b-05-07.pdf

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

drawable_ID

The drawable.

 

mode

The algorithm to use.

 

mask_ID

Tri-Map.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_drawable_parasite_find ()

+
GimpParasite *
+gimp_drawable_parasite_find (gint32 drawable_ID,
+                             const gchar *name);
+
+

gimp_drawable_parasite_find is deprecated and should not be used in newly-written code.

+

Use gimp_item_get_parasite() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

drawable_ID

The drawable.

 

name

The name of the parasite to find.

 
+
+
+

Returns

+

The found parasite.

+
+
+
+
+

gimp_drawable_parasite_list ()

+
gboolean
+gimp_drawable_parasite_list (gint32 drawable_ID,
+                             gint *num_parasites,
+                             gchar ***parasites);
+
+

gimp_drawable_parasite_list is deprecated and should not be used in newly-written code.

+

Use gimp_item_get_parasite_list() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

drawable_ID

The drawable.

 

num_parasites

The number of attached parasites.

 

parasites

The names of currently attached parasites.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_drawable_parasite_attach ()

+
gboolean
+gimp_drawable_parasite_attach (gint32 drawable_ID,
+                               const GimpParasite *parasite);
+
+

gimp_drawable_parasite_attach is deprecated and should not be used in newly-written code.

+

Use gimp_item_attach_parasite() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

drawable_ID

The drawable.

 

parasite

The parasite to attach to a drawable.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_drawable_parasite_detach ()

+
gboolean
+gimp_drawable_parasite_detach (gint32 drawable_ID,
+                               const gchar *name);
+
+

gimp_drawable_parasite_detach is deprecated and should not be used in newly-written code.

+

Use gimp_item_detach_parasite() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

drawable_ID

The drawable.

 

name

The name of the parasite to detach from a drawable.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_drawable_attach_new_parasite ()

+
gboolean
+gimp_drawable_attach_new_parasite (gint32 drawable_ID,
+                                   const gchar *name,
+                                   gint flags,
+                                   gint size,
+                                   gconstpointer data);
+
+

gimp_drawable_attach_new_parasite is deprecated and should not be used in newly-written code.

+

use gimp_item_attach_parasite() instead.

+
+

Convenience function that creates a parasite and attaches it +to GIMP.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

the ID of the GimpDrawable to attach the GimpParasite to.

 

name

the name of the GimpParasite to create and attach.

 

flags

the flags set on the GimpParasite.

 

size

the size of the parasite data in bytes.

 

data

a pointer to the data attached with the GimpParasite.

 
+
+
+

Returns

+

TRUE on successful creation and attachment of +the new parasite.

+

See Also: gimp_drawable_parasite_attach()

+
+
+
+
+

Types and Values

+
+

GimpDrawable

+
typedef struct {
+  gint32    drawable_id;   /* drawable ID */
+  guint     width;         /* width of drawble */
+  guint     height;        /* height of drawble */
+  guint     bpp;           /* bytes per pixel of drawable */
+  guint     ntile_rows;    /* # of tile rows */
+  guint     ntile_cols;    /* # of tile columns */
+  GimpTile *tiles;         /* the normal tiles */
+  GimpTile *shadow_tiles;  /* the shadow tiles */
+} GimpDrawable;
+
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpdrawablecolor.html b/devel-docs/libgimp/html/libgimp-gimpdrawablecolor.html new file mode 100644 index 0000000..a1b40d7 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpdrawablecolor.html @@ -0,0 +1,926 @@ + + + + +gimpdrawablecolor: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpdrawablecolor

+

gimpdrawablecolor — Functions for manipulating a drawable's color.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+gboolean + +gimp_drawable_brightness_contrast () +
+gboolean + +gimp_drawable_color_balance () +
+gboolean + +gimp_drawable_colorize_hsl () +
+gboolean + +gimp_drawable_curves_explicit () +
+gboolean + +gimp_drawable_curves_spline () +
+gboolean + +gimp_drawable_desaturate () +
+gboolean + +gimp_drawable_equalize () +
+gboolean + +gimp_drawable_histogram () +
+gboolean + +gimp_drawable_hue_saturation () +
+gboolean + +gimp_drawable_invert () +
+gboolean + +gimp_drawable_levels () +
+gboolean + +gimp_drawable_levels_stretch () +
+gboolean + +gimp_drawable_posterize () +
+gboolean + +gimp_drawable_threshold () +
+
+
+

Description

+

Functions for manipulating a drawable's color, including curves and +histograms.

+
+
+

Functions

+
+

gimp_drawable_brightness_contrast ()

+
gboolean
+gimp_drawable_brightness_contrast (gint32 drawable_ID,
+                                   gdouble brightness,
+                                   gdouble contrast);
+

Modify brightness/contrast in the specified drawable.

+

This procedures allows the brightness and contrast of the specified +drawable to be modified. Both 'brightness' and 'contrast' parameters +are defined between -0.5 and 0.5.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

drawable_ID

The drawable.

 

brightness

Brightness adjustment.

 

contrast

Contrast adjustment.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_drawable_color_balance ()

+
gboolean
+gimp_drawable_color_balance (gint32 drawable_ID,
+                             GimpTransferMode transfer_mode,
+                             gboolean preserve_lum,
+                             gdouble cyan_red,
+                             gdouble magenta_green,
+                             gdouble yellow_blue);
+

Modify the color balance of the specified drawable.

+

Modify the color balance of the specified drawable. There are three +axis which can be modified: cyan-red, magenta-green, and +yellow-blue. Negative values increase the amount of the former, +positive values increase the amount of the latter. Color balance can +be controlled with the 'transfer_mode' setting, which allows +shadows, mid-tones, and highlights in an image to be affected +differently. The 'preserve-lum' parameter, if TRUE, ensures that the +luminosity of each pixel remains fixed.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The drawable.

 

transfer_mode

Transfer mode.

 

preserve_lum

Preserve luminosity values at each pixel.

 

cyan_red

Cyan-Red color balance.

 

magenta_green

Magenta-Green color balance.

 

yellow_blue

Yellow-Blue color balance.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_drawable_colorize_hsl ()

+
gboolean
+gimp_drawable_colorize_hsl (gint32 drawable_ID,
+                            gdouble hue,
+                            gdouble saturation,
+                            gdouble lightness);
+

Render the drawable as a grayscale image seen through a colored +glass.

+

Desaturates the drawable, then tints it with the specified color. +This tool is only valid on RGB color images. It will not operate on +grayscale drawables.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The drawable.

 

hue

Hue in degrees.

 

saturation

Saturation in percent.

 

lightness

Lightness in percent.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_drawable_curves_explicit ()

+
gboolean
+gimp_drawable_curves_explicit (gint32 drawable_ID,
+                               GimpHistogramChannel channel,
+                               gint num_values,
+                               const gdouble *values);
+

Modifies the intensity curve(s) for specified drawable.

+

Modifies the intensity mapping for one channel in the specified +drawable. The channel can be either an intensity component, or the +value. The 'values' parameter is an array of doubles which +explicitly defines how each pixel value in the drawable will be +modified. Use the gimp_curves_spline() function to modify intensity +levels with Catmull Rom splines.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The drawable.

 

channel

The channel to modify.

 

num_values

The number of values in the new curve.

 

values

The explicit curve.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_drawable_curves_spline ()

+
gboolean
+gimp_drawable_curves_spline (gint32 drawable_ID,
+                             GimpHistogramChannel channel,
+                             gint num_points,
+                             const gdouble *points);
+

Modifies the intensity curve(s) for specified drawable.

+

Modifies the intensity mapping for one channel in the specified +drawable. The channel can be either an intensity component, or the +value. The 'points' parameter is an array of doubles which define a +set of control points which describe a Catmull Rom spline which +yields the final intensity curve. Use the gimp_curves_explicit() +function to explicitly modify intensity levels.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The drawable.

 

channel

The channel to modify.

 

num_points

The number of values in the control point array.

 

points

The spline control points: { cp1.x, cp1.y, cp2.x, cp2.y, ... }.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_drawable_desaturate ()

+
gboolean
+gimp_drawable_desaturate (gint32 drawable_ID,
+                          GimpDesaturateMode desaturate_mode);
+

Desaturate the contents of the specified drawable, with the +specified formula.

+

This procedure desaturates the contents of the specified drawable, +with the specified formula. This procedure only works on drawables +of type RGB color.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

drawable_ID

The drawable.

 

desaturate_mode

The formula to use to desaturate.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_drawable_equalize ()

+
gboolean
+gimp_drawable_equalize (gint32 drawable_ID,
+                        gboolean mask_only);
+

Equalize the contents of the specified drawable.

+

This procedure equalizes the contents of the specified drawable. +Each intensity channel is equalized independently. The equalized +intensity is given as inten' = (255 - inten). The 'mask_only' option +specifies whether to adjust only the area of the image within the +selection bounds, or the entire image based on the histogram of the +selected area. If there is no selection, the entire image is +adjusted based on the histogram for the entire image.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

drawable_ID

The drawable.

 

mask_only

Equalization option.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_drawable_histogram ()

+
gboolean
+gimp_drawable_histogram (gint32 drawable_ID,
+                         GimpHistogramChannel channel,
+                         gdouble start_range,
+                         gdouble end_range,
+                         gdouble *mean,
+                         gdouble *std_dev,
+                         gdouble *median,
+                         gdouble *pixels,
+                         gdouble *count,
+                         gdouble *percentile);
+

Returns information on the intensity histogram for the specified +drawable.

+

This tool makes it possible to gather information about the +intensity histogram of a drawable. A channel to examine is first +specified. This can be either value, red, green, or blue, depending +on whether the drawable is of type color or grayscale. Second, a +range of intensities are specified. The gimp_drawable_histogram() +function returns statistics based on the pixels in the drawable that +fall under this range of values. Mean, standard deviation, median, +number of pixels, and percentile are all returned. Additionally, the +total count of pixels in the image is returned. Counts of pixels are +weighted by any associated alpha values and by the current selection +mask. That is, pixels that lie outside an active selection mask will +not be counted. Similarly, pixels with transparent alpha values will +not be counted. The returned mean, std_dev and median are in the +range (0..255) for 8-bit images or if the plug-in is not +precision-aware, and in the range (0.0..1.0) otherwise.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The drawable.

 

channel

The channel to query.

 

start_range

Start of the intensity measurement range.

 

end_range

End of the intensity measurement range.

 

mean

Mean intensity value.

 

std_dev

Standard deviation of intensity values.

 

median

Median intensity value.

 

pixels

Alpha-weighted pixel count for entire image.

 

count

Alpha-weighted pixel count for range.

 

percentile

Percentile that range falls under.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_drawable_hue_saturation ()

+
gboolean
+gimp_drawable_hue_saturation (gint32 drawable_ID,
+                              GimpHueRange hue_range,
+                              gdouble hue_offset,
+                              gdouble lightness,
+                              gdouble saturation,
+                              gdouble overlap);
+

Modify hue, lightness, and saturation in the specified drawable.

+

This procedure allows the hue, lightness, and saturation in the +specified drawable to be modified. The 'hue-range' parameter +provides the capability to limit range of affected hues. The +'overlap' parameter provides blending into neighboring hue channels +when rendering.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The drawable.

 

hue_range

Range of affected hues.

 

hue_offset

Hue offset in degrees.

 

lightness

Lightness modification.

 

saturation

Saturation modification.

 

overlap

Overlap other hue channels.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_drawable_invert ()

+
gboolean
+gimp_drawable_invert (gint32 drawable_ID,
+                      gboolean linear);
+

Invert the contents of the specified drawable.

+

This procedure inverts the contents of the specified drawable. Each +intensity channel is inverted independently. The inverted intensity +is given as inten' = (255 - inten). If 'linear' is TRUE, the +drawable is inverted in linear space.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

drawable_ID

The drawable.

 

linear

Whether to invert in linear space.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_drawable_levels ()

+
gboolean
+gimp_drawable_levels (gint32 drawable_ID,
+                      GimpHistogramChannel channel,
+                      gdouble low_input,
+                      gdouble high_input,
+                      gboolean clamp_input,
+                      gdouble gamma,
+                      gdouble low_output,
+                      gdouble high_output,
+                      gboolean clamp_output);
+

Modifies intensity levels in the specified drawable.

+

This tool allows intensity levels in the specified drawable to be +remapped according to a set of parameters. The low/high input levels +specify an initial mapping from the source intensities. The gamma +value determines how intensities between the low and high input +intensities are interpolated. A gamma value of 1.0 results in a +linear interpolation. Higher gamma values result in more high-level +intensities. Lower gamma values result in more low-level +intensities. The low/high output levels constrain the final +intensity mapping--that is, no final intensity will be lower than +the low output level and no final intensity will be higher than the +high output level. This tool is only valid on RGB color and +grayscale images.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The drawable.

 

channel

The channel to modify.

 

low_input

Intensity of lowest input.

 

high_input

Intensity of highest input.

 

clamp_input

Clamp input values before applying output levels.

 

gamma

Gamma adjustment factor.

 

low_output

Intensity of lowest output.

 

high_output

Intensity of highest output.

 

clamp_output

Clamp final output values.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_drawable_levels_stretch ()

+
gboolean
+gimp_drawable_levels_stretch (gint32 drawable_ID);
+

Automatically modifies intensity levels in the specified drawable.

+

This procedure allows intensity levels in the specified drawable to +be remapped according to a set of guessed parameters. It is +equivalent to clicking the \"Auto\" button in the Levels tool.

+
+

Parameters

+
+++++ + + + + + +

drawable_ID

The drawable.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_drawable_posterize ()

+
gboolean
+gimp_drawable_posterize (gint32 drawable_ID,
+                         gint levels);
+

Posterize the specified drawable.

+

This procedures reduces the number of shades allows in each +intensity channel to the specified 'levels' parameter.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

drawable_ID

The drawable.

 

levels

Levels of posterization.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_drawable_threshold ()

+
gboolean
+gimp_drawable_threshold (gint32 drawable_ID,
+                         GimpHistogramChannel channel,
+                         gdouble low_threshold,
+                         gdouble high_threshold);
+

Threshold the specified drawable.

+

This procedures generates a threshold map of the specified drawable. +All pixels between the values of 'low_threshold' and +'high_threshold', on the scale of 'channel' are replaced with white, +and all other pixels with black.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The drawable.

 

channel

The channel to base the threshold on.

 

low_threshold

The low threshold value.

 

high_threshold

The high threshold value.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpdrawableedit.html b/devel-docs/libgimp/html/libgimp-gimpdrawableedit.html new file mode 100644 index 0000000..1419143 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpdrawableedit.html @@ -0,0 +1,420 @@ + + + + +gimpdrawableedit: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpdrawableedit

+

gimpdrawableedit — Drawable edit functions (clear, fill, gradient, stroke etc.)

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+gboolean + +gimp_drawable_edit_clear () +
+gboolean + +gimp_drawable_edit_fill () +
+gboolean + +gimp_drawable_edit_bucket_fill () +
+gboolean + +gimp_drawable_edit_gradient_fill () +
+gboolean + +gimp_drawable_edit_stroke_selection () +
+gboolean + +gimp_drawable_edit_stroke_item () +
+
+
+

Description

+

Drawable edit functions (clear, fill, gradient, stroke etc.)

+
+
+

Functions

+
+

gimp_drawable_edit_clear ()

+
gboolean
+gimp_drawable_edit_clear (gint32 drawable_ID);
+

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().

+
+

Parameters

+
+++++ + + + + + +

drawable_ID

The drawable to clear from.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_drawable_edit_fill ()

+
gboolean
+gimp_drawable_edit_fill (gint32 drawable_ID,
+                         GimpFillType fill_type);
+

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().

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

drawable_ID

The drawable to fill to.

 

fill_type

The type of fill.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_drawable_edit_bucket_fill ()

+
gboolean
+gimp_drawable_edit_bucket_fill (gint32 drawable_ID,
+                                GimpFillType fill_type,
+                                gdouble x,
+                                gdouble y);
+

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().

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

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.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_drawable_edit_gradient_fill ()

+
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);
+

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().

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

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.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_drawable_edit_stroke_selection ()

+
gboolean
+gimp_drawable_edit_stroke_selection (gint32 drawable_ID);
+

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().

+
+

Parameters

+
+++++ + + + + + +

drawable_ID

The drawable to stroke to.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_drawable_edit_stroke_item ()

+
gboolean
+gimp_drawable_edit_stroke_item (gint32 drawable_ID,
+                                gint32 item_ID);
+

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().

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

drawable_ID

The drawable to stroke to.

 

item_ID

The item to stroke.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpdrawabletransform.html b/devel-docs/libgimp/html/libgimp-gimpdrawabletransform.html new file mode 100644 index 0000000..e37953e --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpdrawabletransform.html @@ -0,0 +1,1502 @@ + + + + +gimpdrawabletransform: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpdrawabletransform

+

gimpdrawabletransform — Functions to perform transformatrions on drawables.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+gint32 + +gimp_drawable_transform_flip_simple () +
+gint32 + +gimp_drawable_transform_flip () +
+gint32 + +gimp_drawable_transform_flip_default () +
+gint32 + +gimp_drawable_transform_perspective () +
+gint32 + +gimp_drawable_transform_perspective_default () +
+gint32 + +gimp_drawable_transform_rotate_simple () +
+gint32 + +gimp_drawable_transform_rotate () +
+gint32 + +gimp_drawable_transform_rotate_default () +
+gint32 + +gimp_drawable_transform_scale () +
+gint32 + +gimp_drawable_transform_scale_default () +
+gint32 + +gimp_drawable_transform_shear () +
+gint32 + +gimp_drawable_transform_shear_default () +
+gint32 + +gimp_drawable_transform_2d () +
+gint32 + +gimp_drawable_transform_2d_default () +
+gint32 + +gimp_drawable_transform_matrix () +
+gint32 + +gimp_drawable_transform_matrix_default () +
+
+
+

Description

+

Functions to perform transformatrions on drawables.

+
+
+

Functions

+
+

gimp_drawable_transform_flip_simple ()

+
gint32
+gimp_drawable_transform_flip_simple (gint32 drawable_ID,
+                                     GimpOrientationType flip_type,
+                                     gboolean auto_center,
+                                     gdouble axis,
+                                     gboolean clip_result);
+
+

gimp_drawable_transform_flip_simple is deprecated and should not be used in newly-written code.

+

Use gimp_item_transform_flip_simple() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

flip_type

Type of flip.

 

auto_center

Whether to automatically position the axis in the selection center.

 

axis

coord. of flip axis.

 

clip_result

Whether to clip results.

 
+
+
+

Returns

+

The flipped drawable.

+
+

Since: 2.2

+
+
+
+

gimp_drawable_transform_flip ()

+
gint32
+gimp_drawable_transform_flip (gint32 drawable_ID,
+                              gdouble x0,
+                              gdouble y0,
+                              gdouble x1,
+                              gdouble y1,
+                              GimpTransformDirection transform_direction,
+                              GimpInterpolationType interpolation,
+                              gboolean supersample,
+                              gint recursion_level,
+                              gboolean clip_result);
+
+

gimp_drawable_transform_flip is deprecated and should not be used in newly-written code.

+

Use gimp_item_transform_flip() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

x0

horz. coord. of one end of axis.

 

y0

vert. coord. of one end of axis.

 

x1

horz. coord. of other end of axis.

 

y1

vert. coord. of other end of axis.

 

transform_direction

Direction of transformation.

 

interpolation

Type of interpolation.

 

supersample

This parameter is ignored.

 

recursion_level

This parameter is ignored.

 

clip_result

Whether to clip results.

 
+
+
+

Returns

+

The flipped drawable.

+
+

Since: 2.2

+
+
+
+

gimp_drawable_transform_flip_default ()

+
gint32
+gimp_drawable_transform_flip_default (gint32 drawable_ID,
+                                      gdouble x0,
+                                      gdouble y0,
+                                      gdouble x1,
+                                      gdouble y1,
+                                      gboolean interpolate,
+                                      gboolean clip_result);
+
+

gimp_drawable_transform_flip_default is deprecated and should not be used in newly-written code.

+

Use gimp_item_transform_flip() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

x0

horz. coord. of one end of axis.

 

y0

vert. coord. of one end of axis.

 

x1

horz. coord. of other end of axis.

 

y1

vert. coord. of other end of axis.

 

interpolate

Whether to use interpolation and supersampling.

 

clip_result

Whether to clip results.

 
+
+
+

Returns

+

The flipped drawable.

+
+

Since: 2.2

+
+
+
+

gimp_drawable_transform_perspective ()

+
gint32
+gimp_drawable_transform_perspective (gint32 drawable_ID,
+                                     gdouble x0,
+                                     gdouble y0,
+                                     gdouble x1,
+                                     gdouble y1,
+                                     gdouble x2,
+                                     gdouble y2,
+                                     gdouble x3,
+                                     gdouble y3,
+                                     GimpTransformDirection transform_direction,
+                                     GimpInterpolationType interpolation,
+                                     gboolean supersample,
+                                     gint recursion_level,
+                                     GimpTransformResize clip_result);
+
+

gimp_drawable_transform_perspective is deprecated and should not be used in newly-written code.

+

Use gimp_item_transform_perspective() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

x0

The new x coordinate of upper-left corner of original bounding box.

 

y0

The new y coordinate of upper-left corner of original bounding box.

 

x1

The new x coordinate of upper-right corner of original bounding box.

 

y1

The new y coordinate of upper-right corner of original bounding box.

 

x2

The new x coordinate of lower-left corner of original bounding box.

 

y2

The new y coordinate of lower-left corner of original bounding box.

 

x3

The new x coordinate of lower-right corner of original bounding box.

 

y3

The new y coordinate of lower-right corner of original bounding box.

 

transform_direction

Direction of transformation.

 

interpolation

Type of interpolation.

 

supersample

This parameter is ignored.

 

recursion_level

This parameter is ignored.

 

clip_result

How to clip results.

 
+
+
+

Returns

+

The newly mapped drawable.

+
+

Since: 2.2

+
+
+
+

gimp_drawable_transform_perspective_default ()

+
gint32
+gimp_drawable_transform_perspective_default
+                               (gint32 drawable_ID,
+                                gdouble x0,
+                                gdouble y0,
+                                gdouble x1,
+                                gdouble y1,
+                                gdouble x2,
+                                gdouble y2,
+                                gdouble x3,
+                                gdouble y3,
+                                gboolean interpolate,
+                                GimpTransformResize clip_result);
+
+

gimp_drawable_transform_perspective_default is deprecated and should not be used in newly-written code.

+

Use gimp_item_transform_perspective() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

x0

The new x coordinate of upper-left corner of original bounding box.

 

y0

The new y coordinate of upper-left corner of original bounding box.

 

x1

The new x coordinate of upper-right corner of original bounding box.

 

y1

The new y coordinate of upper-right corner of original bounding box.

 

x2

The new x coordinate of lower-left corner of original bounding box.

 

y2

The new y coordinate of lower-left corner of original bounding box.

 

x3

The new x coordinate of lower-right corner of original bounding box.

 

y3

The new y coordinate of lower-right corner of original bounding box.

 

interpolate

Whether to use interpolation and supersampling.

 

clip_result

How to clip results.

 
+
+
+

Returns

+

The newly mapped drawable.

+
+

Since: 2.2

+
+
+
+

gimp_drawable_transform_rotate_simple ()

+
gint32
+gimp_drawable_transform_rotate_simple (gint32 drawable_ID,
+                                       GimpRotationType rotate_type,
+                                       gboolean auto_center,
+                                       gint center_x,
+                                       gint center_y,
+                                       gboolean clip_result);
+
+

gimp_drawable_transform_rotate_simple is deprecated and should not be used in newly-written code.

+

Use gimp_item_transform_rotate_simple() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

rotate_type

Type of rotation.

 

auto_center

Whether to automatically rotate around the selection center.

 

center_x

The hor. coordinate of the center of rotation.

 

center_y

The vert. coordinate of the center of rotation.

 

clip_result

Whether to clip results.

 
+
+
+

Returns

+

The rotated drawable.

+
+

Since: 2.2

+
+
+
+

gimp_drawable_transform_rotate ()

+
gint32
+gimp_drawable_transform_rotate (gint32 drawable_ID,
+                                gdouble angle,
+                                gboolean auto_center,
+                                gint center_x,
+                                gint center_y,
+                                GimpTransformDirection transform_direction,
+                                GimpInterpolationType interpolation,
+                                gboolean supersample,
+                                gint recursion_level,
+                                GimpTransformResize clip_result);
+
+

gimp_drawable_transform_rotate is deprecated and should not be used in newly-written code.

+

Use gimp_item_transform_rotate() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

angle

The angle of rotation (radians).

 

auto_center

Whether to automatically rotate around the selection center.

 

center_x

The hor. coordinate of the center of rotation.

 

center_y

The vert. coordinate of the center of rotation.

 

transform_direction

Direction of transformation.

 

interpolation

Type of interpolation.

 

supersample

This parameter is ignored.

 

recursion_level

This parameter is ignored.

 

clip_result

How to clip results.

 
+
+
+

Returns

+

The rotated drawable.

+
+

Since: 2.2

+
+
+
+

gimp_drawable_transform_rotate_default ()

+
gint32
+gimp_drawable_transform_rotate_default
+                               (gint32 drawable_ID,
+                                gdouble angle,
+                                gboolean auto_center,
+                                gint center_x,
+                                gint center_y,
+                                gboolean interpolate,
+                                GimpTransformResize clip_result);
+
+

gimp_drawable_transform_rotate_default is deprecated and should not be used in newly-written code.

+

Use gimp_item_transform_rotate() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

angle

The angle of rotation (radians).

 

auto_center

Whether to automatically rotate around the selection center.

 

center_x

The hor. coordinate of the center of rotation.

 

center_y

The vert. coordinate of the center of rotation.

 

interpolate

Whether to use interpolation and supersampling.

 

clip_result

How to clip results.

 
+
+
+

Returns

+

The rotated drawable.

+
+

Since: 2.2

+
+
+
+

gimp_drawable_transform_scale ()

+
gint32
+gimp_drawable_transform_scale (gint32 drawable_ID,
+                               gdouble x0,
+                               gdouble y0,
+                               gdouble x1,
+                               gdouble y1,
+                               GimpTransformDirection transform_direction,
+                               GimpInterpolationType interpolation,
+                               gboolean supersample,
+                               gint recursion_level,
+                               GimpTransformResize clip_result);
+
+

gimp_drawable_transform_scale is deprecated and should not be used in newly-written code.

+

Use gimp_item_transform_scale() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

x0

The new x coordinate of the upper-left corner of the scaled region.

 

y0

The new y coordinate of the upper-left corner of the scaled region.

 

x1

The new x coordinate of the lower-right corner of the scaled region.

 

y1

The new y coordinate of the lower-right corner of the scaled region.

 

transform_direction

Direction of transformation.

 

interpolation

Type of interpolation.

 

supersample

This parameter is ignored.

 

recursion_level

This parameter is ignored.

 

clip_result

How to clip results.

 
+
+
+

Returns

+

The scaled drawable.

+
+

Since: 2.2

+
+
+
+

gimp_drawable_transform_scale_default ()

+
gint32
+gimp_drawable_transform_scale_default (gint32 drawable_ID,
+                                       gdouble x0,
+                                       gdouble y0,
+                                       gdouble x1,
+                                       gdouble y1,
+                                       gboolean interpolate,
+                                       GimpTransformResize clip_result);
+
+

gimp_drawable_transform_scale_default is deprecated and should not be used in newly-written code.

+

Use gimp_item_transform_scale() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

x0

The new x coordinate of the upper-left corner of the scaled region.

 

y0

The new y coordinate of the upper-left corner of the scaled region.

 

x1

The new x coordinate of the lower-right corner of the scaled region.

 

y1

The new y coordinate of the lower-right corner of the scaled region.

 

interpolate

Whether to use interpolation and supersampling.

 

clip_result

How to clip results.

 
+
+
+

Returns

+

The scaled drawable.

+
+

Since: 2.2

+
+
+
+

gimp_drawable_transform_shear ()

+
gint32
+gimp_drawable_transform_shear (gint32 drawable_ID,
+                               GimpOrientationType shear_type,
+                               gdouble magnitude,
+                               GimpTransformDirection transform_direction,
+                               GimpInterpolationType interpolation,
+                               gboolean supersample,
+                               gint recursion_level,
+                               GimpTransformResize clip_result);
+
+

gimp_drawable_transform_shear is deprecated and should not be used in newly-written code.

+

Use gimp_item_transform_shear() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

shear_type

Type of shear.

 

magnitude

The magnitude of the shear.

 

transform_direction

Direction of transformation.

 

interpolation

Type of interpolation.

 

supersample

This parameter is ignored.

 

recursion_level

This parameter is ignored.

 

clip_result

How to clip results.

 
+
+
+

Returns

+

The sheared drawable.

+
+

Since: 2.2

+
+
+
+

gimp_drawable_transform_shear_default ()

+
gint32
+gimp_drawable_transform_shear_default (gint32 drawable_ID,
+                                       GimpOrientationType shear_type,
+                                       gdouble magnitude,
+                                       gboolean interpolate,
+                                       GimpTransformResize clip_result);
+
+

gimp_drawable_transform_shear_default is deprecated and should not be used in newly-written code.

+

Use gimp_item_transform_shear() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

shear_type

Type of shear.

 

magnitude

The magnitude of the shear.

 

interpolate

Whether to use interpolation and supersampling.

 

clip_result

How to clip results.

 
+
+
+

Returns

+

The sheared drawable.

+
+

Since: 2.2

+
+
+
+

gimp_drawable_transform_2d ()

+
gint32
+gimp_drawable_transform_2d (gint32 drawable_ID,
+                            gdouble source_x,
+                            gdouble source_y,
+                            gdouble scale_x,
+                            gdouble scale_y,
+                            gdouble angle,
+                            gdouble dest_x,
+                            gdouble dest_y,
+                            GimpTransformDirection transform_direction,
+                            GimpInterpolationType interpolation,
+                            gboolean supersample,
+                            gint recursion_level,
+                            GimpTransformResize clip_result);
+
+

gimp_drawable_transform_2d is deprecated and should not be used in newly-written code.

+

Use gimp_item_transform_2d() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

source_x

X coordinate of the transformation center.

 

source_y

Y coordinate of the transformation center.

 

scale_x

Amount to scale in x direction.

 

scale_y

Amount to scale in y direction.

 

angle

The angle of rotation (radians).

 

dest_x

X coordinate of where the center goes.

 

dest_y

Y coordinate of where the center goes.

 

transform_direction

Direction of transformation.

 

interpolation

Type of interpolation.

 

supersample

This parameter is ignored.

 

recursion_level

This parameter is ignored.

 

clip_result

How to clip results.

 
+
+
+

Returns

+

The transformed drawable.

+
+

Since: 2.2

+
+
+
+

gimp_drawable_transform_2d_default ()

+
gint32
+gimp_drawable_transform_2d_default (gint32 drawable_ID,
+                                    gdouble source_x,
+                                    gdouble source_y,
+                                    gdouble scale_x,
+                                    gdouble scale_y,
+                                    gdouble angle,
+                                    gdouble dest_x,
+                                    gdouble dest_y,
+                                    gboolean interpolate,
+                                    GimpTransformResize clip_result);
+
+

gimp_drawable_transform_2d_default is deprecated and should not be used in newly-written code.

+

Use gimp_item_transform_2d() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

source_x

X coordinate of the transformation center.

 

source_y

Y coordinate of the transformation center.

 

scale_x

Amount to scale in x direction.

 

scale_y

Amount to scale in y direction.

 

angle

The angle of rotation (radians).

 

dest_x

X coordinate of where the center goes.

 

dest_y

Y coordinate of where the center goes.

 

interpolate

Whether to use interpolation and supersampling.

 

clip_result

How to clip results.

 
+
+
+

Returns

+

The transformed drawable.

+
+

Since: 2.2

+
+
+
+

gimp_drawable_transform_matrix ()

+
gint32
+gimp_drawable_transform_matrix (gint32 drawable_ID,
+                                gdouble coeff_0_0,
+                                gdouble coeff_0_1,
+                                gdouble coeff_0_2,
+                                gdouble coeff_1_0,
+                                gdouble coeff_1_1,
+                                gdouble coeff_1_2,
+                                gdouble coeff_2_0,
+                                gdouble coeff_2_1,
+                                gdouble coeff_2_2,
+                                GimpTransformDirection transform_direction,
+                                GimpInterpolationType interpolation,
+                                gboolean supersample,
+                                gint recursion_level,
+                                GimpTransformResize clip_result);
+
+

gimp_drawable_transform_matrix is deprecated and should not be used in newly-written code.

+

Use gimp_item_transform_matrix() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

coeff_0_0

coefficient (0,0) of the transformation matrix.

 

coeff_0_1

coefficient (0,1) of the transformation matrix.

 

coeff_0_2

coefficient (0,2) of the transformation matrix.

 

coeff_1_0

coefficient (1,0) of the transformation matrix.

 

coeff_1_1

coefficient (1,1) of the transformation matrix.

 

coeff_1_2

coefficient (1,2) of the transformation matrix.

 

coeff_2_0

coefficient (2,0) of the transformation matrix.

 

coeff_2_1

coefficient (2,1) of the transformation matrix.

 

coeff_2_2

coefficient (2,2) of the transformation matrix.

 

transform_direction

Direction of transformation.

 

interpolation

Type of interpolation.

 

supersample

This parameter is ignored.

 

recursion_level

This parameter is ignored.

 

clip_result

How to clip results.

 
+
+
+

Returns

+

The transformed drawable.

+
+

Since: 2.2

+
+
+
+

gimp_drawable_transform_matrix_default ()

+
gint32
+gimp_drawable_transform_matrix_default
+                               (gint32 drawable_ID,
+                                gdouble coeff_0_0,
+                                gdouble coeff_0_1,
+                                gdouble coeff_0_2,
+                                gdouble coeff_1_0,
+                                gdouble coeff_1_1,
+                                gdouble coeff_1_2,
+                                gdouble coeff_2_0,
+                                gdouble coeff_2_1,
+                                gdouble coeff_2_2,
+                                gboolean interpolate,
+                                GimpTransformResize clip_result);
+
+

gimp_drawable_transform_matrix_default is deprecated and should not be used in newly-written code.

+

Use gimp_item_transform_matrix() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

coeff_0_0

coefficient (0,0) of the transformation matrix.

 

coeff_0_1

coefficient (0,1) of the transformation matrix.

 

coeff_0_2

coefficient (0,2) of the transformation matrix.

 

coeff_1_0

coefficient (1,0) of the transformation matrix.

 

coeff_1_1

coefficient (1,1) of the transformation matrix.

 

coeff_1_2

coefficient (1,2) of the transformation matrix.

 

coeff_2_0

coefficient (2,0) of the transformation matrix.

 

coeff_2_1

coefficient (2,1) of the transformation matrix.

 

coeff_2_2

coefficient (2,2) of the transformation matrix.

 

interpolate

Whether to use interpolation and supersampling.

 

clip_result

How to clip results.

 
+
+
+

Returns

+

The transformed drawable.

+
+

Since: 2.2

+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpdynamics.html b/devel-docs/libgimp/html/libgimp-gimpdynamics.html new file mode 100644 index 0000000..f2ea5fa --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpdynamics.html @@ -0,0 +1,124 @@ + + + + +gimpdynamics: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpdynamics

+

gimpdynamics — Operations related to paint dynamics.

+
+
+

Functions

+
++++ + + + + + + + + + + +
+gchar ** + +gimp_dynamics_get_list () +
+gboolean + +gimp_dynamics_refresh () +
+
+
+

Description

+

Operations related to paint dynamics.

+
+
+

Functions

+
+

gimp_dynamics_get_list ()

+
gchar **
+gimp_dynamics_get_list (const gchar *filter,
+                        gint *num_dynamics);
+

Retrieve the list of loaded paint dynamics.

+

This procedure returns a list of the paint dynamics that are +currently available.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

filter

An optional regular expression used to filter the list.

 

num_dynamics

The number of available paint dynamics.

 
+
+
+

Returns

+

The list of paint dynamics names. The returned value must +be freed with g_strfreev().

+
+

Since: 2.8

+
+
+
+

gimp_dynamics_refresh ()

+
gboolean
+gimp_dynamics_refresh (void);
+

Refresh current paint dynamics. This function always succeeds.

+

This procedure retrieves all paint dynamics currently in the user's +paint dynamics path and updates the paint dynamics dialogs +accordingly.

+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpedit.html b/devel-docs/libgimp/html/libgimp-gimpedit.html new file mode 100644 index 0000000..50756cc --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpedit.html @@ -0,0 +1,983 @@ + + + + +gimpedit: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpedit

+

gimpedit — Edit menu functions (cut, copy, paste, clear, etc.)

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+gboolean + +gimp_edit_cut () +
+gboolean + +gimp_edit_copy () +
+gboolean + +gimp_edit_copy_visible () +
+gint32 + +gimp_edit_paste () +
+gint32 + +gimp_edit_paste_as_new () +
+gint32 + +gimp_edit_paste_as_new_image () +
+gchar * + +gimp_edit_named_cut () +
+gchar * + +gimp_edit_named_copy () +
+gchar * + +gimp_edit_named_copy_visible () +
+gint32 + +gimp_edit_named_paste () +
+gint32 + +gimp_edit_named_paste_as_new () +
+gint32 + +gimp_edit_named_paste_as_new_image () +
+gboolean + +gimp_edit_clear () +
+gboolean + +gimp_edit_fill () +
+gboolean + +gimp_edit_bucket_fill () +
+gboolean + +gimp_edit_blend () +
+gboolean + +gimp_edit_stroke () +
+gboolean + +gimp_edit_stroke_vectors () +
+
+
+

Description

+

Edit menu functions (cut, copy, paste, clear, etc.)

+
+
+

Functions

+
+

gimp_edit_cut ()

+
gboolean
+gimp_edit_cut (gint32 drawable_ID);
+

Cut from the specified drawable.

+

If there is a selection in the image, then the area specified by the +selection is cut from the specified drawable and placed in an +internal GIMP edit buffer. It can subsequently be retrieved using +the gimp_edit_paste() command. If there is no selection, then the +specified drawable will be removed and its contents stored in the +internal GIMP edit buffer. This procedure will fail if the selected +area lies completely outside the bounds of the current drawable and +there is nothing to copy from.

+
+

Parameters

+
+++++ + + + + + +

drawable_ID

The drawable to cut from.

 
+
+
+

Returns

+

TRUE if the cut was successful, FALSE if there was nothing +to copy from.

+
+
+
+
+

gimp_edit_copy ()

+
gboolean
+gimp_edit_copy (gint32 drawable_ID);
+

Copy from the specified drawable.

+

If there is a selection in the image, then the area specified by the +selection is copied from the specified drawable and placed in an +internal GIMP edit buffer. It can subsequently be retrieved using +the gimp_edit_paste() command. If there is no selection, then the +specified drawable's contents will be stored in the internal GIMP +edit buffer. This procedure will fail if the selected area lies +completely outside the bounds of the current drawable and there is +nothing to copy from.

+
+

Parameters

+
+++++ + + + + + +

drawable_ID

The drawable to copy from.

 
+
+
+

Returns

+

TRUE if the cut was successful, FALSE if there was nothing +to copy from.

+
+
+
+
+

gimp_edit_copy_visible ()

+
gboolean
+gimp_edit_copy_visible (gint32 image_ID);
+

Copy from the projection.

+

If there is a selection in the image, then the area specified by the +selection is copied from the projection and placed in an internal +GIMP edit buffer. It can subsequently be retrieved using the +gimp_edit_paste() command. If there is no selection, then the +projection's contents will be stored in the internal GIMP edit +buffer.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image to copy from.

 
+
+
+

Returns

+

TRUE if the copy was successful.

+
+

Since: 2.2

+
+
+
+

gimp_edit_paste ()

+
gint32
+gimp_edit_paste (gint32 drawable_ID,
+                 gboolean paste_into);
+

Paste buffer to the specified drawable.

+

This procedure pastes a copy of the internal GIMP edit buffer to the +specified drawable. The GIMP edit buffer will be empty unless a call +was previously made to either gimp_edit_cut() or gimp_edit_copy(). +The \"paste_into\" option specifies whether to clear the current +image selection, or to paste the buffer \"behind\" the selection. +This allows the selection to act as a mask for the pasted buffer. +Anywhere that the selection mask is non-zero, the pasted buffer will +show through. The pasted buffer will be a new layer in the image +which is designated as the image floating selection. If the image +has a floating selection at the time of pasting, the old floating +selection will be anchored to its drawable before the new floating +selection is added. This procedure returns the new floating layer. +The resulting floating selection will already be attached to the +specified drawable, and a subsequent call to floating_sel_attach is +not needed.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

drawable_ID

The drawable to paste to.

 

paste_into

Clear selection, or paste behind it?

 
+
+
+

Returns

+

The new floating selection.

+
+
+
+
+

gimp_edit_paste_as_new ()

+
gint32
+gimp_edit_paste_as_new (void);
+
+

gimp_edit_paste_as_new is deprecated and should not be used in newly-written code.

+

Use gimp_edit_paste_as_new_image() instead.

+
+

Paste buffer to a new image.

+

This procedure pastes a copy of the internal GIMP edit buffer to a +new image. The GIMP edit buffer will be empty unless a call was +previously made to either gimp_edit_cut() or gimp_edit_copy(). This +procedure returns the new image or -1 if the edit buffer was empty.

+
+

Returns

+

The new image.

+
+

Since: 2.4

+
+
+
+

gimp_edit_paste_as_new_image ()

+
gint32
+gimp_edit_paste_as_new_image (void);
+

Paste buffer to a new image.

+

This procedure pastes a copy of the internal GIMP edit buffer to a +new image. The GIMP edit buffer will be empty unless a call was +previously made to either gimp_edit_cut() or gimp_edit_copy(). This +procedure returns the new image or -1 if the edit buffer was empty.

+
+

Returns

+

The new image.

+
+

Since: 2.10

+
+
+
+

gimp_edit_named_cut ()

+
gchar *
+gimp_edit_named_cut (gint32 drawable_ID,
+                     const gchar *buffer_name);
+

Cut into a named buffer.

+

This procedure works like gimp_edit_cut(), but additionally stores +the cut buffer into a named buffer that will stay available for +later pasting, regardless of any intermediate copy or cut +operations.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

drawable_ID

The drawable to cut from.

 

buffer_name

The name of the buffer to create.

 
+
+
+

Returns

+

The real name given to the buffer, or NULL if the cut +failed.

+
+

Since: 2.4

+
+
+
+

gimp_edit_named_copy ()

+
gchar *
+gimp_edit_named_copy (gint32 drawable_ID,
+                      const gchar *buffer_name);
+

Copy into a named buffer.

+

This procedure works like gimp_edit_copy(), but additionally stores +the copied buffer into a named buffer that will stay available for +later pasting, regardless of any intermediate copy or cut +operations.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

drawable_ID

The drawable to copy from.

 

buffer_name

The name of the buffer to create.

 
+
+
+

Returns

+

The real name given to the buffer, or NULL if the copy +failed.

+
+

Since: 2.4

+
+
+
+

gimp_edit_named_copy_visible ()

+
gchar *
+gimp_edit_named_copy_visible (gint32 image_ID,
+                              const gchar *buffer_name);
+

Copy from the projection into a named buffer.

+

This procedure works like gimp_edit_copy_visible(), but additionally +stores the copied buffer into a named buffer that will stay +available for later pasting, regardless of any intermediate copy or +cut operations.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image to copy from.

 

buffer_name

The name of the buffer to create.

 
+
+
+

Returns

+

The real name given to the buffer, or NULL if the copy +failed.

+
+

Since: 2.4

+
+
+
+

gimp_edit_named_paste ()

+
gint32
+gimp_edit_named_paste (gint32 drawable_ID,
+                       const gchar *buffer_name,
+                       gboolean paste_into);
+

Paste named buffer to the specified drawable.

+

This procedure works like gimp_edit_paste() but pastes a named +buffer instead of the global buffer.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

drawable_ID

The drawable to paste to.

 

buffer_name

The name of the buffer to paste.

 

paste_into

Clear selection, or paste behind it?

 
+
+
+

Returns

+

The new floating selection.

+
+

Since: 2.4

+
+
+
+

gimp_edit_named_paste_as_new ()

+
gint32
+gimp_edit_named_paste_as_new (const gchar *buffer_name);
+
+

gimp_edit_named_paste_as_new is deprecated and should not be used in newly-written code.

+

Use gimp_edit_named_paste_as_new_image() instead.

+
+

Paste named buffer to a new image.

+

This procedure works like gimp_edit_paste_as_new_image() but pastes a +named buffer instead of the global buffer.

+
+

Parameters

+
+++++ + + + + + +

buffer_name

The name of the buffer to paste.

 
+
+
+

Returns

+

The new image.

+
+

Since: 2.4

+
+
+
+

gimp_edit_named_paste_as_new_image ()

+
gint32
+gimp_edit_named_paste_as_new_image (const gchar *buffer_name);
+

Paste named buffer to a new image.

+

This procedure works like gimp_edit_paste_as_new_image() but pastes +a named buffer instead of the global buffer.

+
+

Parameters

+
+++++ + + + + + +

buffer_name

The name of the buffer to paste.

 
+
+
+

Returns

+

The new image.

+
+

Since: 2.10

+
+
+
+

gimp_edit_clear ()

+
gboolean
+gimp_edit_clear (gint32 drawable_ID);
+
+

gimp_edit_clear is deprecated and should not be used in newly-written code.

+

Use gimp_drawable_edit_clear() instead.

+
+

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.

+
+

Parameters

+
+++++ + + + + + +

drawable_ID

The drawable to clear from.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_edit_fill ()

+
gboolean
+gimp_edit_fill (gint32 drawable_ID,
+                GimpFillType fill_type);
+
+

gimp_edit_fill is deprecated and should not be used in newly-written code.

+

Use gimp_drawable_edit_fill() instead.

+
+

Fill selected area of drawable.

+

This procedure fills the specified drawable with the fill mode. If +the fill mode is foreground, the current foreground color is used. +If the fill mode is background, the current background color is +used. Other fill modes should not be used. 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().

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

drawable_ID

The drawable to fill to.

 

fill_type

The type of fill.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_edit_bucket_fill ()

+
gboolean
+gimp_edit_bucket_fill (gint32 drawable_ID,
+                       GimpBucketFillMode fill_mode,
+                       GimpLayerMode paint_mode,
+                       gdouble opacity,
+                       gdouble threshold,
+                       gboolean sample_merged,
+                       gdouble x,
+                       gdouble y);
+
+

gimp_edit_bucket_fill is deprecated and should not be used in newly-written code.

+

Use gimp_drawable_edit_bucket_fill() instead.

+
+

Fill the area specified either by the current selection if there is +one, or by a seed fill starting at the specified coordinates.

+

This tool requires information on the paint application mode, and +the fill mode, which can either be in the foreground color, or in +the currently active pattern. If there is no selection, a seed fill +is executed at the specified coordinates and extends outward in +keeping with the threshold parameter. If there is a selection in the +target image, the threshold, sample merged, x, and y arguments are +unused. If the sample_merged parameter is TRUE, the data of the +composite image will be used instead of that for the specified +drawable. This is equivalent to sampling for colors after merging +all visible layers. 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.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

fill_mode

The type of fill.

 

paint_mode

The paint application mode.

 

opacity

The opacity of the final bucket fill.

 

threshold

The threshold determines how extensive the seed fill will be. It's value is specified in terms of intensity levels. This parameter is only valid when there is no selection in the specified image.

 

sample_merged

Use the composite image, not the drawable.

 

x

The x coordinate of this bucket fill's application. This parameter is only valid when there is no selection in the specified image.

 

y

The y coordinate of this bucket fill's application. This parameter is only valid when there is no selection in the specified image.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_edit_blend ()

+
gboolean
+gimp_edit_blend (gint32 drawable_ID,
+                 GimpBlendMode blend_mode,
+                 GimpLayerMode paint_mode,
+                 GimpGradientType gradient_type,
+                 gdouble opacity,
+                 gdouble offset,
+                 GimpRepeatMode repeat,
+                 gboolean reverse,
+                 gboolean supersample,
+                 gint max_depth,
+                 gdouble threshold,
+                 gboolean dither,
+                 gdouble x1,
+                 gdouble y1,
+                 gdouble x2,
+                 gdouble y2);
+
+

gimp_edit_blend is deprecated and should not be used in newly-written code.

+

Use gimp_drawable_edit_gradient_fill() instead.

+
+

Blend between the starting and ending coordinates with the specified +blend mode and gradient type.

+

This tool requires information on the paint application mode, the +blend mode, and the gradient type. It creates the specified variety +of blend 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().

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

blend_mode

The type of blend.

 

paint_mode

The paint application mode.

 

gradient_type

The type of gradient.

 

opacity

The opacity of the final blend.

 

offset

Offset relates to the starting and ending coordinates specified for the blend. This parameter is mode dependent.

 

repeat

Repeat mode.

 

reverse

Use the reverse gradient.

 

supersample

Do adaptive supersampling.

 

max_depth

Maximum recursion levels for supersampling.

 

threshold

Supersampling threshold.

 

dither

Use dithering to reduce banding.

 

x1

The x coordinate of this blend's starting point.

 

y1

The y coordinate of this blend's starting point.

 

x2

The x coordinate of this blend's ending point.

 

y2

The y coordinate of this blend's ending point.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_edit_stroke ()

+
gboolean
+gimp_edit_stroke (gint32 drawable_ID);
+
+

gimp_edit_stroke is deprecated and should not be used in newly-written code.

+

Use gimp_drawable_edit_stroke_selection() instead.

+
+

Stroke the current selection

+

This procedure strokes the current selection, painting along the +selection boundary with the active brush and foreground color. The +paint is applied to the specified drawable regardless of the active +selection.

+
+

Parameters

+
+++++ + + + + + +

drawable_ID

The drawable to stroke to.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_edit_stroke_vectors ()

+
gboolean
+gimp_edit_stroke_vectors (gint32 drawable_ID,
+                          gint32 vectors_ID);
+
+

gimp_edit_stroke_vectors is deprecated and should not be used in newly-written code.

+

Use gimp_drawable_edit_stroke_item() instead.

+
+

Stroke the specified vectors object

+

This procedure strokes the specified vectors object, painting along +the path with the active brush and foreground color.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

drawable_ID

The drawable to stroke to.

 

vectors_ID

The vectors object.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpenums.html b/devel-docs/libgimp/html/libgimp-gimpenums.html new file mode 100644 index 0000000..854d545 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpenums.html @@ -0,0 +1,960 @@ + + + + +gimpenums: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpenums

+

gimpenums

+
+
+

Functions

+
++++ + + + + + + + + + + +
+void + +gimp_enums_init () +
const gchar ** + +gimp_enums_get_type_names () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
enumGimpBrushApplicationMode
enumGimpConvertDitherType
enumGimpHistogramChannel
enumGimpLayerColorSpace
enumGimpLayerCompositeMode
enumGimpLayerMode
typedefGimpLayerModeEffects
#defineGIMP_NORMAL_MODE
#defineGIMP_DISSOLVE_MODE
#defineGIMP_BEHIND_MODE
#defineGIMP_MULTIPLY_MODE
#defineGIMP_SCREEN_MODE
#defineGIMP_OVERLAY_MODE
#defineGIMP_DIFFERENCE_MODE
#defineGIMP_ADDITION_MODE
#defineGIMP_SUBTRACT_MODE
#defineGIMP_DARKEN_ONLY_MODE
#defineGIMP_LIGHTEN_ONLY_MODE
#defineGIMP_HUE_MODE
#defineGIMP_SATURATION_MODE
#defineGIMP_COLOR_MODE
#defineGIMP_VALUE_MODE
#defineGIMP_DIVIDE_MODE
#defineGIMP_DODGE_MODE
#defineGIMP_BURN_MODE
#defineGIMP_HARDLIGHT_MODE
#defineGIMP_SOFTLIGHT_MODE
#defineGIMP_GRAIN_EXTRACT_MODE
#defineGIMP_GRAIN_MERGE_MODE
#defineGIMP_COLOR_ERASE_MODE
#defineGIMP_FIXED_DITHER
#defineGIMP_FSLOWBLEED_DITHER
#defineGIMP_FS_DITHER
#defineGIMP_NO_DITHER
+
+
+

Description

+
+
+

Functions

+
+

gimp_enums_init ()

+
void
+gimp_enums_init (void);
+

This function makes sure all the enum types are registered +with the GType system. This is intended for use by language +bindings that need the symbols early, before gimp_main is run. +It's not necessary for plug-ins to call this directly, because +the normal plug-in initialization code will handle it implicitly.

+

Since: 2.4

+
+
+
+

gimp_enums_get_type_names ()

+
const gchar **
+gimp_enums_get_type_names (gint *n_type_names);
+

This function gives access to the list of enums registered by libgimp. +The returned array is static and must not be modified.

+
+

Parameters

+
+++++ + + + + + +

n_type_names

return location for the number of names

 
+
+
+

Returns

+

an array with type names

+
+

Since: 2.2

+
+
+
+

Types and Values

+
+

enum GimpBrushApplicationMode

+
+

Members

+
+++++ + + + + + + + + + + + + +

GIMP_BRUSH_HARD

  

GIMP_BRUSH_SOFT

  
+
+
+
+
+

enum GimpConvertDitherType

+
+

Members

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

GIMP_CONVERT_DITHER_NONE

  

GIMP_CONVERT_DITHER_FS

  

GIMP_CONVERT_DITHER_FS_LOWBLEED

  

GIMP_CONVERT_DITHER_FIXED

  
+
+
+
+
+

enum GimpHistogramChannel

+
+

Members

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

GIMP_HISTOGRAM_VALUE

  

GIMP_HISTOGRAM_RED

  

GIMP_HISTOGRAM_GREEN

  

GIMP_HISTOGRAM_BLUE

  

GIMP_HISTOGRAM_ALPHA

  

GIMP_HISTOGRAM_LUMINANCE

  
+
+
+
+
+

enum GimpLayerColorSpace

+
+

Members

+
+++++ + + + + + + + + + + + + + + + + + +

GIMP_LAYER_COLOR_SPACE_AUTO

  

GIMP_LAYER_COLOR_SPACE_RGB_LINEAR

  

GIMP_LAYER_COLOR_SPACE_RGB_PERCEPTUAL

  
+
+
+
+
+

enum GimpLayerCompositeMode

+
+

Members

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

GIMP_LAYER_COMPOSITE_AUTO

  

GIMP_LAYER_COMPOSITE_UNION

  

GIMP_LAYER_COMPOSITE_CLIP_TO_BACKDROP

  

GIMP_LAYER_COMPOSITE_CLIP_TO_LAYER

  

GIMP_LAYER_COMPOSITE_INTERSECTION

  
+
+
+
+
+

enum GimpLayerMode

+
+

Members

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

GIMP_LAYER_MODE_NORMAL_LEGACY

  

GIMP_LAYER_MODE_DISSOLVE

  

GIMP_LAYER_MODE_BEHIND_LEGACY

  

GIMP_LAYER_MODE_MULTIPLY_LEGACY

  

GIMP_LAYER_MODE_SCREEN_LEGACY

  

GIMP_LAYER_MODE_OVERLAY_LEGACY

  

GIMP_LAYER_MODE_DIFFERENCE_LEGACY

  

GIMP_LAYER_MODE_ADDITION_LEGACY

  

GIMP_LAYER_MODE_SUBTRACT_LEGACY

  

GIMP_LAYER_MODE_DARKEN_ONLY_LEGACY

  

GIMP_LAYER_MODE_LIGHTEN_ONLY_LEGACY

  

GIMP_LAYER_MODE_HSV_HUE_LEGACY

  

GIMP_LAYER_MODE_HSV_SATURATION_LEGACY

  

GIMP_LAYER_MODE_HSL_COLOR_LEGACY

  

GIMP_LAYER_MODE_HSV_VALUE_LEGACY

  

GIMP_LAYER_MODE_DIVIDE_LEGACY

  

GIMP_LAYER_MODE_DODGE_LEGACY

  

GIMP_LAYER_MODE_BURN_LEGACY

  

GIMP_LAYER_MODE_HARDLIGHT_LEGACY

  

GIMP_LAYER_MODE_SOFTLIGHT_LEGACY

  

GIMP_LAYER_MODE_GRAIN_EXTRACT_LEGACY

  

GIMP_LAYER_MODE_GRAIN_MERGE_LEGACY

  

GIMP_LAYER_MODE_COLOR_ERASE_LEGACY

  

GIMP_LAYER_MODE_OVERLAY

  

GIMP_LAYER_MODE_LCH_HUE

  

GIMP_LAYER_MODE_LCH_CHROMA

  

GIMP_LAYER_MODE_LCH_COLOR

  

GIMP_LAYER_MODE_LCH_LIGHTNESS

  

GIMP_LAYER_MODE_NORMAL

  

GIMP_LAYER_MODE_BEHIND

  

GIMP_LAYER_MODE_MULTIPLY

  

GIMP_LAYER_MODE_SCREEN

  

GIMP_LAYER_MODE_DIFFERENCE

  

GIMP_LAYER_MODE_ADDITION

  

GIMP_LAYER_MODE_SUBTRACT

  

GIMP_LAYER_MODE_DARKEN_ONLY

  

GIMP_LAYER_MODE_LIGHTEN_ONLY

  

GIMP_LAYER_MODE_HSV_HUE

  

GIMP_LAYER_MODE_HSV_SATURATION

  

GIMP_LAYER_MODE_HSL_COLOR

  

GIMP_LAYER_MODE_HSV_VALUE

  

GIMP_LAYER_MODE_DIVIDE

  

GIMP_LAYER_MODE_DODGE

  

GIMP_LAYER_MODE_BURN

  

GIMP_LAYER_MODE_HARDLIGHT

  

GIMP_LAYER_MODE_SOFTLIGHT

  

GIMP_LAYER_MODE_GRAIN_EXTRACT

  

GIMP_LAYER_MODE_GRAIN_MERGE

  

GIMP_LAYER_MODE_VIVID_LIGHT

  

GIMP_LAYER_MODE_PIN_LIGHT

  

GIMP_LAYER_MODE_LINEAR_LIGHT

  

GIMP_LAYER_MODE_HARD_MIX

  

GIMP_LAYER_MODE_EXCLUSION

  

GIMP_LAYER_MODE_LINEAR_BURN

  

GIMP_LAYER_MODE_LUMA_DARKEN_ONLY

  

GIMP_LAYER_MODE_LUMA_LIGHTEN_ONLY

  

GIMP_LAYER_MODE_LUMINANCE

  

GIMP_LAYER_MODE_COLOR_ERASE

  

GIMP_LAYER_MODE_ERASE

  

GIMP_LAYER_MODE_MERGE

  

GIMP_LAYER_MODE_SPLIT

  

GIMP_LAYER_MODE_PASS_THROUGH

  
+
+
+
+
+

GimpLayerModeEffects

+
typedef GimpLayerMode GimpLayerModeEffects;
+
+

GimpLayerModeEffects is deprecated and should not be used in newly-written code.

+
+
+
+

GIMP_NORMAL_MODE

+
#define GIMP_NORMAL_MODE        GIMP_LAYER_MODE_NORMAL_LEGACY
+
+

GIMP_NORMAL_MODE is deprecated and should not be used in newly-written code.

+
+
+
+

GIMP_DISSOLVE_MODE

+
#define GIMP_DISSOLVE_MODE      GIMP_LAYER_MODE_DISSOLVE
+
+

GIMP_DISSOLVE_MODE is deprecated and should not be used in newly-written code.

+
+
+
+

GIMP_BEHIND_MODE

+
#define GIMP_BEHIND_MODE        GIMP_LAYER_MODE_BEHIND_LEGACY
+
+

GIMP_BEHIND_MODE is deprecated and should not be used in newly-written code.

+
+
+
+

GIMP_MULTIPLY_MODE

+
#define GIMP_MULTIPLY_MODE      GIMP_LAYER_MODE_MULTIPLY_LEGACY
+
+

GIMP_MULTIPLY_MODE is deprecated and should not be used in newly-written code.

+
+
+
+

GIMP_SCREEN_MODE

+
#define GIMP_SCREEN_MODE        GIMP_LAYER_MODE_SCREEN_LEGACY
+
+

GIMP_SCREEN_MODE is deprecated and should not be used in newly-written code.

+
+
+
+

GIMP_OVERLAY_MODE

+
#define GIMP_OVERLAY_MODE       GIMP_LAYER_MODE_OVERLAY_LEGACY
+
+

GIMP_OVERLAY_MODE is deprecated and should not be used in newly-written code.

+
+
+
+

GIMP_DIFFERENCE_MODE

+
#define GIMP_DIFFERENCE_MODE    GIMP_LAYER_MODE_DIFFERENCE_LEGACY
+
+

GIMP_DIFFERENCE_MODE is deprecated and should not be used in newly-written code.

+
+
+
+

GIMP_ADDITION_MODE

+
#define GIMP_ADDITION_MODE      GIMP_LAYER_MODE_ADDITION_LEGACY
+
+

GIMP_ADDITION_MODE is deprecated and should not be used in newly-written code.

+
+
+
+

GIMP_SUBTRACT_MODE

+
#define GIMP_SUBTRACT_MODE      GIMP_LAYER_MODE_SUBTRACT_LEGACY
+
+

GIMP_SUBTRACT_MODE is deprecated and should not be used in newly-written code.

+
+
+
+

GIMP_DARKEN_ONLY_MODE

+
#define GIMP_DARKEN_ONLY_MODE   GIMP_LAYER_MODE_DARKEN_ONLY_LEGACY
+
+

GIMP_DARKEN_ONLY_MODE is deprecated and should not be used in newly-written code.

+
+
+
+

GIMP_LIGHTEN_ONLY_MODE

+
#define GIMP_LIGHTEN_ONLY_MODE  GIMP_LAYER_MODE_LIGHTEN_ONLY_LEGACY
+
+

GIMP_LIGHTEN_ONLY_MODE is deprecated and should not be used in newly-written code.

+
+
+
+

GIMP_HUE_MODE

+
#define GIMP_HUE_MODE           GIMP_LAYER_MODE_HSV_HUE_LEGACY
+
+

GIMP_HUE_MODE is deprecated and should not be used in newly-written code.

+
+
+
+

GIMP_SATURATION_MODE

+
#define GIMP_SATURATION_MODE    GIMP_LAYER_MODE_HSV_SATURATION_LEGACY
+
+

GIMP_SATURATION_MODE is deprecated and should not be used in newly-written code.

+
+
+
+

GIMP_COLOR_MODE

+
#define GIMP_COLOR_MODE         GIMP_LAYER_MODE_HSL_COLOR_LEGACY
+
+

GIMP_COLOR_MODE is deprecated and should not be used in newly-written code.

+
+
+
+

GIMP_VALUE_MODE

+
#define GIMP_VALUE_MODE         GIMP_LAYER_MODE_HSV_VALUE_LEGACY
+
+

GIMP_VALUE_MODE is deprecated and should not be used in newly-written code.

+
+
+
+

GIMP_DIVIDE_MODE

+
#define GIMP_DIVIDE_MODE        GIMP_LAYER_MODE_DIVIDE_LEGACY
+
+

GIMP_DIVIDE_MODE is deprecated and should not be used in newly-written code.

+
+
+
+

GIMP_DODGE_MODE

+
#define GIMP_DODGE_MODE         GIMP_LAYER_MODE_DODGE_LEGACY
+
+

GIMP_DODGE_MODE is deprecated and should not be used in newly-written code.

+
+
+
+

GIMP_BURN_MODE

+
#define GIMP_BURN_MODE          GIMP_LAYER_MODE_BURN_LEGACY
+
+

GIMP_BURN_MODE is deprecated and should not be used in newly-written code.

+
+
+
+

GIMP_HARDLIGHT_MODE

+
#define GIMP_HARDLIGHT_MODE     GIMP_LAYER_MODE_HARDLIGHT_LEGACY
+
+

GIMP_HARDLIGHT_MODE is deprecated and should not be used in newly-written code.

+
+
+
+

GIMP_SOFTLIGHT_MODE

+
#define GIMP_SOFTLIGHT_MODE     GIMP_LAYER_MODE_SOFTLIGHT_LEGACY
+
+

GIMP_SOFTLIGHT_MODE is deprecated and should not be used in newly-written code.

+
+
+
+

GIMP_GRAIN_EXTRACT_MODE

+
#define GIMP_GRAIN_EXTRACT_MODE GIMP_LAYER_MODE_GRAIN_EXTRACT_LEGACY
+
+

GIMP_GRAIN_EXTRACT_MODE is deprecated and should not be used in newly-written code.

+
+
+
+

GIMP_GRAIN_MERGE_MODE

+
#define GIMP_GRAIN_MERGE_MODE   GIMP_LAYER_MODE_GRAIN_MERGE_LEGACY
+
+

GIMP_GRAIN_MERGE_MODE is deprecated and should not be used in newly-written code.

+
+
+
+

GIMP_COLOR_ERASE_MODE

+
#define GIMP_COLOR_ERASE_MODE   GIMP_LAYER_MODE_COLOR_ERASE_LEGACY
+
+

GIMP_COLOR_ERASE_MODE is deprecated and should not be used in newly-written code.

+
+
+
+

GIMP_FIXED_DITHER

+
#define GIMP_FIXED_DITHER      GIMP_CONVERT_DITHER_FIXED
+
+

GIMP_FIXED_DITHER is deprecated and should not be used in newly-written code.

+
+
+
+

GIMP_FSLOWBLEED_DITHER

+
#define GIMP_FSLOWBLEED_DITHER GIMP_CONVERT_DITHER_FS_LOWBLEED
+
+

GIMP_FSLOWBLEED_DITHER is deprecated and should not be used in newly-written code.

+
+
+
+

GIMP_FS_DITHER

+
#define GIMP_FS_DITHER         GIMP_CONVERT_DITHER_FS
+
+

GIMP_FS_DITHER is deprecated and should not be used in newly-written code.

+
+
+
+

GIMP_NO_DITHER

+
#define GIMP_NO_DITHER         GIMP_CONVERT_DITHER_NONE
+
+

GIMP_NO_DITHER is deprecated and should not be used in newly-written code.

+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpexport.html b/devel-docs/libgimp/html/libgimp-gimpexport.html new file mode 100644 index 0000000..6cdcbbf --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpexport.html @@ -0,0 +1,376 @@ + + + + +gimpexport: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpexport

+

gimpexport — Export an image before it is saved.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + +
+GimpExportReturn + +gimp_export_image () +
+GtkWidget * + +gimp_export_dialog_new () +
+GtkWidget * + +gimp_export_dialog_get_content_area () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + +
enumGimpExportCapabilities
enumGimpExportReturn
+
+
+

Description

+

This function should be called by all save_plugins unless they are +able to save all image formats GIMP knows about. It takes care of +asking the user if she wishes to export the image to a format the +save_plugin can handle. It then performs the necessary conversions +(e.g. Flatten) on a copy of the image so that the image can be +saved without changing the original image.

+

The capabilities of the save_plugin are specified by combining +GimpExportCapabilities using a bitwise OR.

+

Make sure you have initialized GTK+ before you call this function +as it will most probably have to open a dialog.

+
+
+

Functions

+
+

gimp_export_image ()

+
GimpExportReturn
+gimp_export_image (gint32 *image_ID,
+                   gint32 *drawable_ID,
+                   const gchar *format_name,
+                   GimpExportCapabilities capabilities);
+

Takes an image and a drawable to be saved together with a +description of the capabilities of the image_format. If the +type of image doesn't match the capabilities of the format +a dialog is opened that informs the user that the image has +to be exported and offers to do the necessary conversions.

+

If the user chooses to export the image, a copy is created. +This copy is then converted, the image_ID and drawable_ID +are changed to point to the new image and the procedure returns +GIMP_EXPORT_EXPORT. The save_plugin has to take care of deleting the +created image using gimp_image_delete() when it has saved it.

+

If the user chooses to Ignore the export problem, the image_ID +and drawable_ID is not altered, GIMP_EXPORT_IGNORE is returned and +the save_plugin should try to save the original image. If the +user chooses Cancel, GIMP_EXPORT_CANCEL is returned and the +save_plugin should quit itself with status GIMP_PDB_CANCEL.

+

If format_name + is NULL, no dialogs will be shown and this function +will behave as if the user clicked on the 'Export' button, if a +dialog would have been shown.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

image_ID

Pointer to the image_ID.

 

drawable_ID

Pointer to the drawable_ID.

 

format_name

The (short) name of the image_format (e.g. JPEG or GIF).

 

capabilities

What can the image_format do?

 
+
+
+

Returns

+

An enum of GimpExportReturn describing the user_action.

+
+
+
+
+

gimp_export_dialog_new ()

+
GtkWidget *
+gimp_export_dialog_new (const gchar *format_name,
+                        const gchar *role,
+                        const gchar *help_id);
+

Creates a new export dialog. All file plug-ins should use this +dialog to get a consistent look on the export dialogs. Use +gimp_export_dialog_get_content_area() to get a GtkVBox to be +filled with export options. The export dialog is a wrapped +GimpDialog.

+

The dialog response when the user clicks on the Export button is +GTK_RESPONSE_OK, and when the Cancel button is clicked it is +GTK_RESPONSE_CANCEL.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

format_name

The short name of the image_format (e.g. JPEG or PNG).

 

role

The dialog's role +which will be set with +gtk_window_set_role().

 

help_id

The GIMP help id.

 
+
+
+

Returns

+

The new export dialog.

+
+

Since: 2.8

+
+
+
+

gimp_export_dialog_get_content_area ()

+
GtkWidget *
+gimp_export_dialog_get_content_area (GtkWidget *dialog);
+

Returns the GtkVBox of the passed export dialog to be filled with +export options.

+
+

Parameters

+
+++++ + + + + + +

dialog

A dialog created with gimp_export_dialog_new()

 
+
+
+

Returns

+

The GtkVBox to fill with export options.

+
+

Since: 2.8

+
+
+
+

Types and Values

+
+

enum GimpExportCapabilities

+

The types of images and layers an export procedure can handle

+
+

Members

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

GIMP_EXPORT_CAN_HANDLE_RGB

 +

Handles RGB images

+		 

GIMP_EXPORT_CAN_HANDLE_GRAY

 +

Handles grayscale images

+		 

GIMP_EXPORT_CAN_HANDLE_INDEXED

 +

Handles indexed images

+		 

GIMP_EXPORT_CAN_HANDLE_BITMAP

 +

Handles two-color indexed images

+		 

GIMP_EXPORT_CAN_HANDLE_ALPHA

 +

Handles alpha channels

+		 

GIMP_EXPORT_CAN_HANDLE_LAYERS

 +

Hanldes layers

+		 

GIMP_EXPORT_CAN_HANDLE_LAYERS_AS_ANIMATION

 +

Handles aminations of layers

+		 

GIMP_EXPORT_CAN_HANDLE_LAYER_MASKS

 +

Handles layer masks

+		 

GIMP_EXPORT_NEEDS_ALPHA

 +

Needs alpha channels

+		 

GIMP_EXPORT_NEEDS_CROP

 +

Needs to crop content to image bounds

+		 
+
+
+
+
+

enum GimpExportReturn

+

Possible return values of gimp_export_image().

+
+

Members

+
+++++ + + + + + + + + + + + + + + + + + +

GIMP_EXPORT_CANCEL

 +

The export was cancelled

+		 

GIMP_EXPORT_IGNORE

 +

The image is unmodified but export shall continue anyway

+		 

GIMP_EXPORT_EXPORT

 +

The chosen transforms were applied to the image

+		 
+
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpfileops.html b/devel-docs/libgimp/html/libgimp-gimpfileops.html new file mode 100644 index 0000000..037b9d6 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpfileops.html @@ -0,0 +1,753 @@ + + + + +gimpfileops: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpfileops

+

gimpfileops — Image file operations (load, save, etc.)

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+gchar * + +gimp_temp_name () +
+gint32 + +gimp_file_load () +
+gint32 + +gimp_file_load_layer () +
+gint * + +gimp_file_load_layers () +
+gboolean + +gimp_file_save () +
+gboolean + +gimp_file_save_thumbnail () +
+gboolean + +gimp_register_magic_load_handler () +
+gboolean + +gimp_register_load_handler () +
+gboolean + +gimp_register_save_handler () +
+gboolean + +gimp_register_file_handler_priority () +
+gboolean + +gimp_register_file_handler_mime () +
+gboolean + +gimp_register_file_handler_uri () +
+gboolean + +gimp_register_file_handler_raw () +
+gboolean + +gimp_register_thumbnail_loader () +
+
+
+

Description

+

Image file operations (load, save, etc.)

+
+
+

Functions

+
+

gimp_temp_name ()

+
gchar *
+gimp_temp_name (const gchar *extension);
+

Generates a unique filename.

+

Generates a unique filename using the temp path supplied in the +user's gimprc.

+
+

Parameters

+
+++++ + + + + + +

extension

The extension the file will have.

 
+
+
+

Returns

+

The new temp filename.

+
+
+
+
+

gimp_file_load ()

+
gint32
+gimp_file_load (GimpRunMode run_mode,
+                const gchar *filename,
+                const gchar *raw_filename);
+

Loads an image file by invoking the right load handler.

+

This procedure invokes the correct file load handler using magic if +possible, and falling back on the file's extension and/or prefix if +not. The name of the file to load is typically a full pathname, and +the name entered is what the user actually typed before prepending a +directory path. The reason for this is that if the user types +https://www.gimp.org/foo.png he wants to fetch a URL, and the full +pathname will not look like a URL.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

run_mode

The run mode.

 

filename

The name of the file to load.

 

raw_filename

The name as entered by the user.

 
+
+
+

Returns

+

The output image.

+
+
+
+
+

gimp_file_load_layer ()

+
gint32
+gimp_file_load_layer (GimpRunMode run_mode,
+                      gint32 image_ID,
+                      const gchar *filename);
+

Loads an image file as a layer for an existing image.

+

This procedure behaves like the file-load procedure but opens the +specified image as a layer for an existing image. The returned layer +needs to be added to the existing image with +gimp_image_insert_layer().

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

run_mode

The run mode.

 

image_ID

Destination image.

 

filename

The name of the file to load.

 
+
+
+

Returns

+

The layer created when loading the image file.

+
+

Since: 2.4

+
+
+
+

gimp_file_load_layers ()

+
gint *
+gimp_file_load_layers (GimpRunMode run_mode,
+                       gint32 image_ID,
+                       const gchar *filename,
+                       gint *num_layers);
+

Loads an image file as layers for an existing image.

+

This procedure behaves like the file-load procedure but opens the +specified image as layers for an existing image. The returned layers +needs to be added to the existing image with +gimp_image_insert_layer().

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

run_mode

The run mode.

 

image_ID

Destination image.

 

filename

The name of the file to load.

 

num_layers

The number of loaded layers.

 
+
+
+

Returns

+

The list of loaded layers.

+
+

Since: 2.4

+
+
+
+

gimp_file_save ()

+
gboolean
+gimp_file_save (GimpRunMode run_mode,
+                gint32 image_ID,
+                gint32 drawable_ID,
+                const gchar *filename,
+                const gchar *raw_filename);
+

Saves a file by extension.

+

This procedure invokes the correct file save handler according to +the file's extension and/or prefix. The name of the file to save is +typically a full pathname, and the name entered is what the user +actually typed before prepending a directory path. The reason for +this is that if the user types https://www.gimp.org/foo.png she +wants to fetch a URL, and the full pathname will not look like a +URL.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

run_mode

The run mode.

 

image_ID

Input image.

 

drawable_ID

Drawable to save.

 

filename

The name of the file to save the image in.

 

raw_filename

The name as entered by the user.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_file_save_thumbnail ()

+
gboolean
+gimp_file_save_thumbnail (gint32 image_ID,
+                          const gchar *filename);
+

Saves a thumbnail for the given image

+

This procedure saves a thumbnail for the given image according to +the Free Desktop Thumbnail Managing Standard. The thumbnail is saved +so that it belongs to the file with the given filename. This means +you have to save the image under this name first, otherwise this +procedure will fail. This procedure may become useful if you want to +explicitly save a thumbnail with a file.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

filename

The name of the file the thumbnail belongs to.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_register_magic_load_handler ()

+
gboolean
+gimp_register_magic_load_handler (const gchar *procedure_name,
+                                  const gchar *extensions,
+                                  const gchar *prefixes,
+                                  const gchar *magics);
+

Registers a file load handler procedure.

+

Registers a procedural database procedure to be called to load files +of a particular file format using magic file information.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

procedure_name

The name of the procedure to be used for loading.

 

extensions

comma separated list of extensions this handler can load (i.e. \"jpg,jpeg\").

 

prefixes

comma separated list of prefixes this handler can load (i.e. \"http:,ftp:\").

 

magics

comma separated list of magic file information this handler can load (i.e. \"0,string,GIF\").

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_register_load_handler ()

+
gboolean
+gimp_register_load_handler (const gchar *procedure_name,
+                            const gchar *extensions,
+                            const gchar *prefixes);
+

Registers a file load handler procedure.

+

Registers a procedural database procedure to be called to load files +of a particular file format.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

procedure_name

The name of the procedure to be used for loading.

 

extensions

comma separated list of extensions this handler can load (i.e. \"jpg,jpeg\").

 

prefixes

comma separated list of prefixes this handler can load (i.e. \"http:,ftp:\").

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_register_save_handler ()

+
gboolean
+gimp_register_save_handler (const gchar *procedure_name,
+                            const gchar *extensions,
+                            const gchar *prefixes);
+

Registers a file save handler procedure.

+

Registers a procedural database procedure to be called to save files +in a particular file format.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

procedure_name

The name of the procedure to be used for saving.

 

extensions

comma separated list of extensions this handler can save (i.e. \"jpg,jpeg\").

 

prefixes

comma separated list of prefixes this handler can save (i.e. \"http:,ftp:\").

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_register_file_handler_priority ()

+
gboolean
+gimp_register_file_handler_priority (const gchar *procedure_name,
+                                     gint priority);
+

Sets the priority of a file handler procedure.

+

Sets the priority of a file handler procedure. When more than one +procedure matches a given file, the procedure with the lowest +priority is used; if more than one procedure has the lowest +priority, it is unspecified which one of them is used. The default +priority for file handler procedures is 0.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

procedure_name

The name of the procedure to set the priority of.

 

priority

The procedure priority.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10.6

+
+
+
+

gimp_register_file_handler_mime ()

+
gboolean
+gimp_register_file_handler_mime (const gchar *procedure_name,
+                                 const gchar *mime_types);
+

Associates MIME types with a file handler procedure.

+

Registers MIME types for a file handler procedure. This allows GIMP +to determine the MIME type of the file opened or saved using this +procedure. It is recommended that only one MIME type is registered +per file procedure; when registering more than one MIME type, GIMP +will associate the first one with files opened or saved with this +procedure.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

procedure_name

The name of the procedure to associate a MIME type with.

 

mime_types

A comma-separated list of MIME types, such as \"image/jpeg\".

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_register_file_handler_uri ()

+
gboolean
+gimp_register_file_handler_uri (const gchar *procedure_name);
+

Registers a file handler procedure as capable of handling URIs.

+

Registers a file handler procedure as capable of handling URIs. This +allows GIMP to call the procedure directly for all kinds of URIs, +and the 'filename' traditionally passed to file procedures turns +into an URI.

+
+

Parameters

+
+++++ + + + + + +

procedure_name

The name of the procedure to enable URIs for.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_register_file_handler_raw ()

+
gboolean
+gimp_register_file_handler_raw (const gchar *procedure_name);
+

Registers a file handler procedure as capable of handling raw camera +files.

+

Registers a file handler procedure as capable of handling raw +digital camera files. Use this procedure only to register raw load +handlers, calling it on a save handler will generate an error.

+
+

Parameters

+
+++++ + + + + + +

procedure_name

The name of the procedure to enable raw handling for.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_register_thumbnail_loader ()

+
gboolean
+gimp_register_thumbnail_loader (const gchar *load_proc,
+                                const gchar *thumb_proc);
+

Associates a thumbnail loader with a file load procedure.

+

Some file formats allow for embedded thumbnails, other file formats +contain a scalable image or provide the image data in different +resolutions. A file plug-in for such a format may register a special +procedure that allows GIMP to load a thumbnail preview of the image. +This procedure is then associated with the standard load procedure +using this function.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

load_proc

The name of the procedure the thumbnail loader with.

 

thumb_proc

The name of the thumbnail load procedure.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpfloatingsel.html b/devel-docs/libgimp/html/libgimp-gimpfloatingsel.html new file mode 100644 index 0000000..85ebf70 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpfloatingsel.html @@ -0,0 +1,306 @@ + + + + +gimpfloatingsel: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpfloatingsel

+

gimpfloatingsel — Functions for removing or attaching floating selections.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+gboolean + +gimp_floating_sel_remove () +
+gboolean + +gimp_floating_sel_anchor () +
+gboolean + +gimp_floating_sel_to_layer () +
+gboolean + +gimp_floating_sel_attach () +
+gboolean + +gimp_floating_sel_rigor () +
+gboolean + +gimp_floating_sel_relax () +
+
+
+

Description

+

Functions for removing or attaching floating selections.

+
+
+

Functions

+
+

gimp_floating_sel_remove ()

+
gboolean
+gimp_floating_sel_remove (gint32 floating_sel_ID);
+

Remove the specified floating selection from its associated +drawable.

+

This procedure removes the floating selection completely, without +any side effects. The associated drawable is then set to active.

+
+

Parameters

+
+++++ + + + + + +

floating_sel_ID

The floating selection.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_floating_sel_anchor ()

+
gboolean
+gimp_floating_sel_anchor (gint32 floating_sel_ID);
+

Anchor the specified floating selection to its associated drawable.

+

This procedure anchors the floating selection to its associated +drawable. This is similar to merging with a merge type of +ClipToBottomLayer. The floating selection layer is no longer valid +after this operation.

+
+

Parameters

+
+++++ + + + + + +

floating_sel_ID

The floating selection.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_floating_sel_to_layer ()

+
gboolean
+gimp_floating_sel_to_layer (gint32 floating_sel_ID);
+

Transforms the specified floating selection into a layer.

+

This procedure transforms the specified floating selection into a +layer with the same offsets and extents. The composited image will +look precisely the same, but the floating selection layer will no +longer be clipped to the extents of the drawable it was attached to. +The floating selection will become the active layer. This procedure +will not work if the floating selection has a different base type +from the underlying image. This might be the case if the floating +selection is above an auxiliary channel or a layer mask.

+
+

Parameters

+
+++++ + + + + + +

floating_sel_ID

The floating selection.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_floating_sel_attach ()

+
gboolean
+gimp_floating_sel_attach (gint32 layer_ID,
+                          gint32 drawable_ID);
+

Attach the specified layer as floating to the specified drawable.

+

This procedure attaches the layer as floating selection to the +drawable.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

layer_ID

The layer (is attached as floating selection).

 

drawable_ID

The drawable (where to attach the floating selection).

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_floating_sel_rigor ()

+
gboolean
+gimp_floating_sel_rigor (gint32 floating_sel_ID,
+                         gboolean undo);
+
+

gimp_floating_sel_rigor is deprecated and should not be used in newly-written code.

+

There is no replacement for this procedure.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

floating_sel_ID

The floating selection.

 

undo

.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_floating_sel_relax ()

+
gboolean
+gimp_floating_sel_relax (gint32 floating_sel_ID,
+                         gboolean undo);
+
+

gimp_floating_sel_relax is deprecated and should not be used in newly-written code.

+

There is no replacement for this procedure.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

floating_sel_ID

The floating selection.

 

undo

.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpfontmenu.html b/devel-docs/libgimp/html/libgimp-gimpfontmenu.html new file mode 100644 index 0000000..7204928 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpfontmenu.html @@ -0,0 +1,186 @@ + + + + +gimpfontmenu: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpfontmenu

+

gimpfontmenu — A widget for selecting fonts.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + +
+GtkWidget * + +gimp_font_select_widget_new () +
+void + +gimp_font_select_widget_close () +
+void + +gimp_font_select_widget_set () +
+
+
+

Description

+

A widget for selecting fonts.

+
+
+

Functions

+
+

gimp_font_select_widget_new ()

+
GtkWidget *
+gimp_font_select_widget_new (const gchar *title,
+                             const gchar *font_name,
+                             GimpRunFontCallback callback,
+                             gpointer data);
+

gimp_font_select_widget_new is deprecated and should not be used in newly-written code.

+

Creates a new GtkWidget that completely controls the selection of +a font. This widget is suitable for placement in a table in a +plug-in dialog.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

title

Title of the dialog to use or NULL to use the default title.

 

font_name

Initial font name.

 

callback

A function to call when the selected font changes.

 

data

A pointer to arbitrary data to be used in the call to callback +.

 
+
+
+

Returns

+

A GtkWidget that you can use in your UI.

+
+
+
+
+

gimp_font_select_widget_close ()

+
void
+gimp_font_select_widget_close (GtkWidget *widget);
+

gimp_font_select_widget_close is deprecated and should not be used in newly-written code.

+

Closes the popup window associated with widget +.

+
+

Parameters

+
+++++ + + + + + +

widget

A font select widget.

 
+
+
+
+
+

gimp_font_select_widget_set ()

+
void
+gimp_font_select_widget_set (GtkWidget *widget,
+                             const gchar *font_name);
+

gimp_font_select_widget_set is deprecated and should not be used in newly-written code.

+

Sets the current font for the font select widget. Calls the +callback function if one was supplied in the call to +gimp_font_select_widget_new().

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

widget

A font select widget.

 

font_name

Font name to set; NULL means no change.

 
+
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpfonts.html b/devel-docs/libgimp/html/libgimp-gimpfonts.html new file mode 100644 index 0000000..7ca71e4 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpfonts.html @@ -0,0 +1,122 @@ + + + + +gimpfonts: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpfonts

+

gimpfonts — Operations related to fonts.

+
+
+

Functions

+
++++ + + + + + + + + + + +
+gboolean + +gimp_fonts_refresh () +
+gchar ** + +gimp_fonts_get_list () +
+
+
+

Description

+

Operations related to fonts.

+
+
+

Functions

+
+

gimp_fonts_refresh ()

+
gboolean
+gimp_fonts_refresh (void);
+

Refresh current fonts. This function always succeeds.

+

This procedure retrieves all fonts currently in the user's font path +and updates the font dialogs accordingly. Depending on the amount of +fonts on the system, this can take considerable time.

+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_fonts_get_list ()

+
gchar **
+gimp_fonts_get_list (const gchar *filter,
+                     gint *num_fonts);
+

Retrieve the list of loaded fonts.

+

This procedure returns a list of the fonts that are currently +available.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

filter

An optional regular expression used to filter the list.

 

num_fonts

The number of available fonts.

 
+
+
+

Returns

+

The list of font names. The returned value must be freed +with g_strfreev().

+
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpfontselect.html b/devel-docs/libgimp/html/libgimp-gimpfontselect.html new file mode 100644 index 0000000..b414bfe --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpfontselect.html @@ -0,0 +1,228 @@ + + + + +gimpfontselect: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpfontselect

+

gimpfontselect — Functions providing a font selection dialog.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+void + +(*GimpRunFontCallback) () +
const gchar * + +gimp_font_select_new () +
+void + +gimp_font_select_destroy () +
+gboolean + +gimp_fonts_popup () +
+gboolean + +gimp_fonts_close_popup () +
+gboolean + +gimp_fonts_set_popup () +
+
+
+

Description

+

Functions providing a font selection dialog.

+
+
+

Functions

+
+

GimpRunFontCallback ()

+
void
+(*GimpRunFontCallback) (const gchar *font_name,
+                        gboolean dialog_closing,
+                        gpointer user_data);
+
+
+
+

gimp_font_select_new ()

+
const gchar *
+gimp_font_select_new (const gchar *title,
+                      const gchar *font_name,
+                      GimpRunFontCallback callback,
+                      gpointer data);
+
+
+
+

gimp_font_select_destroy ()

+
void
+gimp_font_select_destroy (const gchar *font_callback);
+
+
+
+

gimp_fonts_popup ()

+
gboolean
+gimp_fonts_popup (const gchar *font_callback,
+                  const gchar *popup_title,
+                  const gchar *initial_font);
+

Invokes the Gimp font selection.

+

This procedure opens the font selection dialog.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

font_callback

The callback PDB proc to call when font selection is made.

 

popup_title

Title of the font selection dialog.

 

initial_font

The name of the font to set as the first selected.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_fonts_close_popup ()

+
gboolean
+gimp_fonts_close_popup (const gchar *font_callback);
+

Close the font selection dialog.

+

This procedure closes an opened font selection dialog.

+
+

Parameters

+
+++++ + + + + + +

font_callback

The name of the callback registered for this pop-up.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_fonts_set_popup ()

+
gboolean
+gimp_fonts_set_popup (const gchar *font_callback,
+                      const gchar *font_name);
+

Sets the current font in a font selection dialog.

+

Sets the current font in a font selection dialog.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

font_callback

The name of the callback registered for this pop-up.

 

font_name

The name of the font to set as selected.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpgimprc.html b/devel-docs/libgimp/html/libgimp-gimpgimprc.html new file mode 100644 index 0000000..e41cbd7 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpgimprc.html @@ -0,0 +1,322 @@ + + + + +gimpgimprc: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpgimprc

+

gimpgimprc — Interactions with settings from gimprc.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+gchar * + +gimp_gimprc_query () +
+gboolean + +gimp_gimprc_set () +
+GimpColorConfig * + +gimp_get_color_configuration () +
+gchar * + +gimp_get_default_comment () +
+GimpUnit + +gimp_get_default_unit () +
+gchar * + +gimp_get_module_load_inhibit () +
+gboolean + +gimp_get_monitor_resolution () +
+gchar * + +gimp_get_theme_dir () +
+gchar * + +gimp_get_icon_theme_dir () +
+
+
+

Description

+

Interactions with settings from gimprc.

+
+
+

Functions

+
+

gimp_gimprc_query ()

+
gchar *
+gimp_gimprc_query (const gchar *token);
+

Queries the gimprc file parser for information on a specified token.

+

This procedure is used to locate additional information contained in +the gimprc file considered extraneous to the operation of GIMP. +Plug-ins that need configuration information can expect it will be +stored in the user gimprc file and can use this procedure to +retrieve it. This query procedure will return the value associated +with the specified token. This corresponds _only_ to entries with +the format: (<token> <value>). The value must be a +string. Entries not corresponding to this format will cause warnings +to be issued on gimprc parsing and will not be queryable.

+
+

Parameters

+
+++++ + + + + + +

token

The token to query for.

 
+
+
+

Returns

+

The value associated with the queried token.

+
+
+
+
+

gimp_gimprc_set ()

+
gboolean
+gimp_gimprc_set (const gchar *token,
+                 const gchar *value);
+

Sets a gimprc token to a value and saves it in the gimprc.

+

This procedure is used to add or change additional information in +the gimprc file that is considered extraneous to the operation of +GIMP. Plug-ins that need configuration information can use this +function to store it, and gimp_gimprc_query() to retrieve it. This +will accept _only_ string values in UTF-8 encoding.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

token

The token to add or modify.

 

value

The value to set the token to.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_get_color_configuration ()

+
GimpColorConfig *
+gimp_get_color_configuration (void);
+

Retrieve a copy of the current color management configuration.

+
+

Returns

+

A copy of the core's GimpColorConfig. You should unref +this copy if you don't need it any longer.

+
+

Since: 2.4

+
+
+
+

gimp_get_default_comment ()

+
gchar *
+gimp_get_default_comment (void);
+

Get the default image comment as specified in the Preferences.

+

Returns a copy of the default image comment.

+
+

Returns

+

Default image comment.

+
+
+
+
+

gimp_get_default_unit ()

+
GimpUnit
+gimp_get_default_unit (void);
+

Get the default unit (taken from the user's locale).

+

Returns the default unit's integer ID.

+
+

Returns

+

Default unit.

+
+

Since: 2.4

+
+
+
+

gimp_get_module_load_inhibit ()

+
gchar *
+gimp_get_module_load_inhibit (void);
+

Get the list of modules which should not be loaded.

+

Returns a copy of the list of modules which should not be loaded.

+
+

Returns

+

The list of modules.

+
+
+
+
+

gimp_get_monitor_resolution ()

+
gboolean
+gimp_get_monitor_resolution (gdouble *xres,
+                             gdouble *yres);
+

Get the monitor resolution as specified in the Preferences.

+

Returns the resolution of the monitor in pixels/inch. This value is +taken from the Preferences (or the windowing system if this is set +in the Preferences) and there's no guarantee for the value to be +reasonable.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

xres

X resolution.

 

yres

Y resolution.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_get_theme_dir ()

+
gchar *
+gimp_get_theme_dir (void);
+
+

gimp_get_theme_dir is deprecated and should not be used in newly-written code.

+

There is no replacement for this procedure.

+
+

Get the directory of the current GUI theme.

+

Returns a copy of the current GUI theme dir.

+
+

Returns

+

The GUI theme dir.

+
+
+
+
+

gimp_get_icon_theme_dir ()

+
gchar *
+gimp_get_icon_theme_dir (void);
+
+

gimp_get_icon_theme_dir is deprecated and should not be used in newly-written code.

+

There is no replacement for this procedure.

+
+

Get the directory of the current icon theme.

+

Returns a copy of the current icon theme dir.

+
+

Returns

+

The icon theme dir.

+
+

Since: 2.10

+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpgradient.html b/devel-docs/libgimp/html/libgimp-gimpgradient.html new file mode 100644 index 0000000..98b2ef3 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpgradient.html @@ -0,0 +1,1691 @@ + + + + +gimpgradient: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpgradient

+

gimpgradient — Functions operating on a single gradient.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+gchar * + +gimp_gradient_new () +
+gchar * + +gimp_gradient_duplicate () +
+gchar * + +gimp_gradient_rename () +
+gboolean + +gimp_gradient_delete () +
+gboolean + +gimp_gradient_is_editable () +
+gboolean + +gimp_gradient_get_uniform_samples () +
+gboolean + +gimp_gradient_get_custom_samples () +
+gint + +gimp_gradient_get_number_of_segments () +
+gboolean + +gimp_gradient_segment_get_left_color () +
+gboolean + +gimp_gradient_segment_set_left_color () +
+gboolean + +gimp_gradient_segment_get_right_color () +
+gboolean + +gimp_gradient_segment_set_right_color () +
+gboolean + +gimp_gradient_segment_get_left_pos () +
+gboolean + +gimp_gradient_segment_set_left_pos () +
+gboolean + +gimp_gradient_segment_get_middle_pos () +
+gboolean + +gimp_gradient_segment_set_middle_pos () +
+gboolean + +gimp_gradient_segment_get_right_pos () +
+gboolean + +gimp_gradient_segment_set_right_pos () +
+gboolean + +gimp_gradient_segment_get_blending_function () +
+gboolean + +gimp_gradient_segment_get_coloring_type () +
+gboolean + +gimp_gradient_segment_range_set_blending_function () +
+gboolean + +gimp_gradient_segment_range_set_coloring_type () +
+gboolean + +gimp_gradient_segment_range_flip () +
+gboolean + +gimp_gradient_segment_range_replicate () +
+gboolean + +gimp_gradient_segment_range_split_midpoint () +
+gboolean + +gimp_gradient_segment_range_split_uniform () +
+gboolean + +gimp_gradient_segment_range_delete () +
+gboolean + +gimp_gradient_segment_range_redistribute_handles () +
+gboolean + +gimp_gradient_segment_range_blend_colors () +
+gboolean + +gimp_gradient_segment_range_blend_opacity () +
+gdouble + +gimp_gradient_segment_range_move () +
+
+
+

Description

+

Functions operating on a single gradient.

+
+
+

Functions

+
+

gimp_gradient_new ()

+
gchar *
+gimp_gradient_new (const gchar *name);
+

Creates a new gradient

+

This procedure creates a new, uninitialized gradient

+
+

Parameters

+
+++++ + + + + + +

name

The requested name of the new gradient.

 
+
+
+

Returns

+

The actual new gradient name.

+
+

Since: 2.2

+
+
+
+

gimp_gradient_duplicate ()

+
gchar *
+gimp_gradient_duplicate (const gchar *name);
+

Duplicates a gradient

+

This procedure creates an identical gradient by a different name

+
+

Parameters

+
+++++ + + + + + +

name

The gradient name.

 
+
+
+

Returns

+

The name of the gradient's copy.

+
+

Since: 2.2

+
+
+
+

gimp_gradient_rename ()

+
gchar *
+gimp_gradient_rename (const gchar *name,
+                      const gchar *new_name);
+

Rename a gradient

+

This procedure renames a gradient

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

name

The gradient name.

 

new_name

The new name of the gradient.

 
+
+
+

Returns

+

The actual new name of the gradient.

+
+

Since: 2.2

+
+
+
+

gimp_gradient_delete ()

+
gboolean
+gimp_gradient_delete (const gchar *name);
+

Deletes a gradient

+

This procedure deletes a gradient

+
+

Parameters

+
+++++ + + + + + +

name

The gradient name.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_gradient_is_editable ()

+
gboolean
+gimp_gradient_is_editable (const gchar *name);
+

Tests if gradient can be edited

+

Returns TRUE if you have permission to change the gradient

+
+

Parameters

+
+++++ + + + + + +

name

The gradient name.

 
+
+
+

Returns

+

TRUE if the gradient can be edited.

+
+

Since: 2.4

+
+
+
+

gimp_gradient_get_uniform_samples ()

+
gboolean
+gimp_gradient_get_uniform_samples (const gchar *name,
+                                   gint num_samples,
+                                   gboolean reverse,
+                                   gint *num_color_samples,
+                                   gdouble **color_samples);
+

Sample the specified in uniform parts.

+

This procedure samples the active gradient 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 }.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

name

The gradient name.

 

num_samples

The number of samples to take.

 

reverse

Use the reverse gradient.

 

num_color_samples

Length of the color_samples array (4 * num_samples).

 

color_samples

Color samples: { R1, G1, B1, A1, ..., Rn, Gn, Bn, An }.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_gradient_get_custom_samples ()

+
gboolean
+gimp_gradient_get_custom_samples (const gchar *name,
+                                  gint num_samples,
+                                  const gdouble *positions,
+                                  gboolean reverse,
+                                  gint *num_color_samples,
+                                  gdouble **color_samples);
+

Sample the specified gradient in custom positions.

+

This procedure samples the active gradient 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.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

name

The gradient name.

 

num_samples

The number of samples to take.

 

positions

The list of positions to sample along the gradient.

 

reverse

Use the reverse gradient.

 

num_color_samples

Length of the color_samples array (4 * num_samples).

 

color_samples

Color samples: { R1, G1, B1, A1, ..., Rn, Gn, Bn, An }.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_gradient_get_number_of_segments ()

+
gint
+gimp_gradient_get_number_of_segments (const gchar *name);
+

Returns the number of segments of the specified gradient

+

This procedure returns the number of segments of the specified +gradient.

+
+

Parameters

+
+++++ + + + + + +

name

The gradient name.

 
+
+
+

Returns

+

Number of segments.

+
+

Since: 2.6

+
+
+
+

gimp_gradient_segment_get_left_color ()

+
gboolean
+gimp_gradient_segment_get_left_color (const gchar *name,
+                                      gint segment,
+                                      GimpRGB *color,
+                                      gdouble *opacity);
+

Retrieves the left endpoint color of the specified segment

+

This procedure retrieves the left endpoint color of the specified +segment of the specified gradient.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

name

The gradient name.

 

segment

The index of the segment within the gradient.

 

color

The return color.

 

opacity

The opacity of the endpoint.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_gradient_segment_set_left_color ()

+
gboolean
+gimp_gradient_segment_set_left_color (const gchar *name,
+                                      gint segment,
+                                      const GimpRGB *color,
+                                      gdouble opacity);
+

Sets the left endpoint color of the specified segment

+

This procedure sets the left endpoint color of the specified segment +of the specified gradient.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

name

The gradient name.

 

segment

The index of the segment within the gradient.

 

color

The color to set.

 

opacity

The opacity to set for the endpoint.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_gradient_segment_get_right_color ()

+
gboolean
+gimp_gradient_segment_get_right_color (const gchar *name,
+                                       gint segment,
+                                       GimpRGB *color,
+                                       gdouble *opacity);
+

Retrieves the right endpoint color of the specified segment

+

This procedure retrieves the right endpoint color of the specified +segment of the specified gradient.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

name

The gradient name.

 

segment

The index of the segment within the gradient.

 

color

The return color.

 

opacity

The opacity of the endpoint.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_gradient_segment_set_right_color ()

+
gboolean
+gimp_gradient_segment_set_right_color (const gchar *name,
+                                       gint segment,
+                                       const GimpRGB *color,
+                                       gdouble opacity);
+

Sets the right endpoint color of the specified segment

+

This procedure sets the right endpoint color of the specified +segment of the specified gradient.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

name

The gradient name.

 

segment

The index of the segment within the gradient.

 

color

The color to set.

 

opacity

The opacity to set for the endpoint.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_gradient_segment_get_left_pos ()

+
gboolean
+gimp_gradient_segment_get_left_pos (const gchar *name,
+                                    gint segment,
+                                    gdouble *pos);
+

Retrieves the left endpoint position of the specified segment

+

This procedure retrieves the left endpoint position of the specified +segment of the specified gradient.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

name

The gradient name.

 

segment

The index of the segment within the gradient.

 

pos

The return position.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_gradient_segment_set_left_pos ()

+
gboolean
+gimp_gradient_segment_set_left_pos (const gchar *name,
+                                    gint segment,
+                                    gdouble pos,
+                                    gdouble *final_pos);
+

Sets the left endpoint position of the specified segment

+

This procedure sets the left endpoint position of the specified +segment of the specified gradient. The final position will be +between the position of the middle point to the left to the middle +point of the current segment. +This procedure returns the final position.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

name

The gradient name.

 

segment

The index of the segment within the gradient.

 

pos

The position to set the guidepoint to.

 

final_pos

The return position.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_gradient_segment_get_middle_pos ()

+
gboolean
+gimp_gradient_segment_get_middle_pos (const gchar *name,
+                                      gint segment,
+                                      gdouble *pos);
+

Retrieves the middle point position of the specified segment

+

This procedure retrieves the middle point position of the specified +segment of the specified gradient.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

name

The gradient name.

 

segment

The index of the segment within the gradient.

 

pos

The return position.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_gradient_segment_set_middle_pos ()

+
gboolean
+gimp_gradient_segment_set_middle_pos (const gchar *name,
+                                      gint segment,
+                                      gdouble pos,
+                                      gdouble *final_pos);
+

Sets the middle point position of the specified segment

+

This procedure sets the middle point position of the specified +segment of the specified gradient. The final position will be +between the two endpoints of the segment. +This procedure returns the final position.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

name

The gradient name.

 

segment

The index of the segment within the gradient.

 

pos

The position to set the guidepoint to.

 

final_pos

The return position.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_gradient_segment_get_right_pos ()

+
gboolean
+gimp_gradient_segment_get_right_pos (const gchar *name,
+                                     gint segment,
+                                     gdouble *pos);
+

Retrieves the right endpoint position of the specified segment

+

This procedure retrieves the right endpoint position of the +specified segment of the specified gradient.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

name

The gradient name.

 

segment

The index of the segment within the gradient.

 

pos

The return position.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_gradient_segment_set_right_pos ()

+
gboolean
+gimp_gradient_segment_set_right_pos (const gchar *name,
+                                     gint segment,
+                                     gdouble pos,
+                                     gdouble *final_pos);
+

Sets the right endpoint position of the specified segment

+

This procedure sets the right endpoint position of the specified +segment of the specified gradient. The final position will be +between the position of the middle point of the current segment and +the middle point of the segment to the right. +This procedure returns the final position.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

name

The gradient name.

 

segment

The index of the segment within the gradient.

 

pos

The position to set the guidepoint to.

 

final_pos

The return position.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_gradient_segment_get_blending_function ()

+
gboolean
+gimp_gradient_segment_get_blending_function
+                               (const gchar *name,
+                                gint segment,
+                                GimpGradientSegmentType *blend_func);
+

Retrieves the gradient segment's blending function

+

This procedure retrieves the blending function of the segment at the +specified gradient name and segment index.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

name

The gradient name.

 

segment

The index of the segment within the gradient.

 

blend_func

The blending function of the segment.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_gradient_segment_get_coloring_type ()

+
gboolean
+gimp_gradient_segment_get_coloring_type
+                               (const gchar *name,
+                                gint segment,
+                                GimpGradientSegmentColor *coloring_type);
+

Retrieves the gradient segment's coloring type

+

This procedure retrieves the coloring type of the segment at the +specified gradient name and segment index.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

name

The gradient name.

 

segment

The index of the segment within the gradient.

 

coloring_type

The coloring type of the segment.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_gradient_segment_range_set_blending_function ()

+
gboolean
+gimp_gradient_segment_range_set_blending_function
+                               (const gchar *name,
+                                gint start_segment,
+                                gint end_segment,
+                                GimpGradientSegmentType blending_function);
+

Change the blending function of a segments range

+

This function changes the blending function of a segment range to +the specified blending function.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

name

The gradient name.

 

start_segment

The index of the first segment to operate on.

 

end_segment

The index of the last segment to operate on. If negative, the selection will extend to the end of the string.

 

blending_function

The blending function.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_gradient_segment_range_set_coloring_type ()

+
gboolean
+gimp_gradient_segment_range_set_coloring_type
+                               (const gchar *name,
+                                gint start_segment,
+                                gint end_segment,
+                                GimpGradientSegmentColor coloring_type);
+

Change the coloring type of a segments range

+

This function changes the coloring type of a segment range to the +specified coloring type.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

name

The gradient name.

 

start_segment

The index of the first segment to operate on.

 

end_segment

The index of the last segment to operate on. If negative, the selection will extend to the end of the string.

 

coloring_type

The coloring type.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_gradient_segment_range_flip ()

+
gboolean
+gimp_gradient_segment_range_flip (const gchar *name,
+                                  gint start_segment,
+                                  gint end_segment);
+

Flip the segment range

+

This function flips a segment range.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

name

The gradient name.

 

start_segment

The index of the first segment to operate on.

 

end_segment

The index of the last segment to operate on. If negative, the selection will extend to the end of the string.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_gradient_segment_range_replicate ()

+
gboolean
+gimp_gradient_segment_range_replicate (const gchar *name,
+                                       gint start_segment,
+                                       gint end_segment,
+                                       gint replicate_times);
+

Replicate the segment range

+

This function replicates a segment range a given number of times. +Instead of the original segment range, several smaller scaled copies +of it will appear in equal widths.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

name

The gradient name.

 

start_segment

The index of the first segment to operate on.

 

end_segment

The index of the last segment to operate on. If negative, the selection will extend to the end of the string.

 

replicate_times

The number of times to replicate.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_gradient_segment_range_split_midpoint ()

+
gboolean
+gimp_gradient_segment_range_split_midpoint
+                               (const gchar *name,
+                                gint start_segment,
+                                gint end_segment);
+

Splits each segment in the segment range at midpoint

+

This function splits each segment in the segment range at its +midpoint.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

name

The gradient name.

 

start_segment

The index of the first segment to operate on.

 

end_segment

The index of the last segment to operate on. If negative, the selection will extend to the end of the string.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_gradient_segment_range_split_uniform ()

+
gboolean
+gimp_gradient_segment_range_split_uniform
+                               (const gchar *name,
+                                gint start_segment,
+                                gint end_segment,
+                                gint split_parts);
+

Splits each segment in the segment range uniformly

+

This function splits each segment in the segment range uniformly +according to the number of times specified by the parameter.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

name

The gradient name.

 

start_segment

The index of the first segment to operate on.

 

end_segment

The index of the last segment to operate on. If negative, the selection will extend to the end of the string.

 

split_parts

The number of uniform divisions to split each segment to.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_gradient_segment_range_delete ()

+
gboolean
+gimp_gradient_segment_range_delete (const gchar *name,
+                                    gint start_segment,
+                                    gint end_segment);
+

Delete the segment range

+

This function deletes a segment range.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

name

The gradient name.

 

start_segment

The index of the first segment to operate on.

 

end_segment

The index of the last segment to operate on. If negative, the selection will extend to the end of the string.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_gradient_segment_range_redistribute_handles ()

+
gboolean
+gimp_gradient_segment_range_redistribute_handles
+                               (const gchar *name,
+                                gint start_segment,
+                                gint end_segment);
+

Uniformly redistribute the segment range's handles

+

This function redistributes the handles of the specified segment +range of the specified gradient, so they'll be evenly spaced.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

name

The gradient name.

 

start_segment

The index of the first segment to operate on.

 

end_segment

The index of the last segment to operate on. If negative, the selection will extend to the end of the string.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_gradient_segment_range_blend_colors ()

+
gboolean
+gimp_gradient_segment_range_blend_colors
+                               (const gchar *name,
+                                gint start_segment,
+                                gint end_segment);
+

Blend the colors of the segment range.

+

This function blends the colors (but not the opacity) of the +segments' range of the gradient. Using it, the colors' transition +will be uniform across the range.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

name

The gradient name.

 

start_segment

The index of the first segment to operate on.

 

end_segment

The index of the last segment to operate on. If negative, the selection will extend to the end of the string.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_gradient_segment_range_blend_opacity ()

+
gboolean
+gimp_gradient_segment_range_blend_opacity
+                               (const gchar *name,
+                                gint start_segment,
+                                gint end_segment);
+

Blend the opacity of the segment range.

+

This function blends the opacity (but not the colors) of the +segments' range of the gradient. Using it, the opacity's transition +will be uniform across the range.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

name

The gradient name.

 

start_segment

The index of the first segment to operate on.

 

end_segment

The index of the last segment to operate on. If negative, the selection will extend to the end of the string.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_gradient_segment_range_move ()

+
gdouble
+gimp_gradient_segment_range_move (const gchar *name,
+                                  gint start_segment,
+                                  gint end_segment,
+                                  gdouble delta,
+                                  gboolean control_compress);
+

Move the position of an entire segment range by a delta.

+

This function moves the position of an entire segment range by a +delta. The actual delta (which is returned) will be limited by the +control points of the neighboring segments.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

name

The gradient name.

 

start_segment

The index of the first segment to operate on.

 

end_segment

The index of the last segment to operate on. If negative, the selection will extend to the end of the string.

 

delta

The delta to move the segment range.

 

control_compress

Whether or not to compress the neighboring segments.

 
+
+
+

Returns

+

The final delta by which the range moved.

+
+

Since: 2.2

+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpgradientmenu.html b/devel-docs/libgimp/html/libgimp-gimpgradientmenu.html new file mode 100644 index 0000000..7872bb7 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpgradientmenu.html @@ -0,0 +1,187 @@ + + + + +gimpgradientmenu: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpgradientmenu

+

gimpgradientmenu — A widget for selecting gradients.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + +
+GtkWidget * + +gimp_gradient_select_widget_new () +
+void + +gimp_gradient_select_widget_close () +
+void + +gimp_gradient_select_widget_set () +
+
+
+

Description

+

A widget for selecting gradients.

+
+
+

Functions

+
+

gimp_gradient_select_widget_new ()

+
GtkWidget *
+gimp_gradient_select_widget_new (const gchar *title,
+                                 const gchar *gradient_name,
+                                 GimpRunGradientCallback callback,
+                                 gpointer data);
+

gimp_gradient_select_widget_new is deprecated and should not be used in newly-written code.

+

Creates a new GtkWidget that completely controls the selection of +a gradient. This widget is suitable for placement in a table in a +plug-in dialog.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

title

Title of the dialog to use or NULL to use the default title.

 

gradient_name

Initial gradient name.

 

callback

A function to call when the selected gradient changes.

 

data

A pointer to arbitrary data to be used in the call to callback +.

 
+
+
+

Returns

+

A GtkWidget that you can use in your UI.

+
+

Since: 2.2

+
+
+
+

gimp_gradient_select_widget_close ()

+
void
+gimp_gradient_select_widget_close (GtkWidget *widget);
+

gimp_gradient_select_widget_close is deprecated and should not be used in newly-written code.

+

Closes the popup window associated with widget +.

+
+

Parameters

+
+++++ + + + + + +

widget

A gradient select widget.

 
+
+
+
+
+

gimp_gradient_select_widget_set ()

+
void
+gimp_gradient_select_widget_set (GtkWidget *widget,
+                                 const gchar *gradient_name);
+

gimp_gradient_select_widget_set is deprecated and should not be used in newly-written code.

+

Sets the current gradient for the gradient select widget. Calls the +callback function if one was supplied in the call to +gimp_gradient_select_widget_new().

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

widget

A gradient select widget.

 

gradient_name

Gradient name to set.

 
+
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpgradients.html b/devel-docs/libgimp/html/libgimp-gimpgradients.html new file mode 100644 index 0000000..890d594 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpgradients.html @@ -0,0 +1,336 @@ + + + + +gimpgradients: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpgradients

+

gimpgradients — Operations related to gradients.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+gboolean + +gimp_gradients_refresh () +
+gchar ** + +gimp_gradients_get_list () +
+gchar * + +gimp_gradients_get_gradient () +
+gboolean + +gimp_gradients_set_gradient () +
+gdouble * + +gimp_gradients_sample_uniform () +
+gdouble * + +gimp_gradients_sample_custom () +
+gchar * + +gimp_gradients_get_gradient_data () +
+
+
+

Description

+

Operations related to gradients.

+
+
+

Functions

+
+

gimp_gradients_refresh ()

+
gboolean
+gimp_gradients_refresh (void);
+

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.

+
+
+
+
+

gimp_gradients_get_list ()

+
gchar **
+gimp_gradients_get_list (const gchar *filter,
+                         gint *num_gradients);
+

Retrieve the list of loaded gradients.

+

This procedure returns a list of the gradients that are currently +loaded. You can later use the gimp_context_set_gradient() function +to set the active gradient.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

filter

An optional regular expression used to filter the list.

 

num_gradients

The number of loaded gradients.

 
+
+
+

Returns

+

The list of gradient names. The returned value must be +freed with g_strfreev().

+
+
+
+
+

gimp_gradients_get_gradient ()

+
gchar *
+gimp_gradients_get_gradient (void);
+

gimp_gradients_get_gradient is deprecated and should not be used in newly-written code.

+

This procedure is deprecated! Use gimp_context_get_gradient() instead.

+
+

Returns

+

The name of the active gradient.

+
+
+
+
+

gimp_gradients_set_gradient ()

+
gboolean
+gimp_gradients_set_gradient (const gchar *name);
+

gimp_gradients_set_gradient is deprecated and should not be used in newly-written code.

+

This procedure is deprecated! Use gimp_context_set_gradient() instead.

+
+

Parameters

+
+++++ + + + + + +

name

The name of the gradient to set.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_gradients_sample_uniform ()

+
gdouble *
+gimp_gradients_sample_uniform (gint num_samples,
+                               gboolean reverse);
+
+

gimp_gradients_sample_uniform is deprecated and should not be used in newly-written code.

+

Use gimp_gradient_get_uniform_samples() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

num_samples

The number of samples to take.

 

reverse

Use the reverse gradient.

 
+
+
+

Returns

+

Color samples: { R1, G1, B1, A1, ..., Rn, Gn, Bn, An }.

+
+
+
+
+

gimp_gradients_sample_custom ()

+
gdouble *
+gimp_gradients_sample_custom (gint num_samples,
+                              const gdouble *positions,
+                              gboolean reverse);
+
+

gimp_gradients_sample_custom is deprecated and should not be used in newly-written code.

+

Use gimp_gradient_get_custom_samples() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

num_samples

The number of samples to take.

 

positions

The list of positions to sample along the gradient.

 

reverse

Use the reverse gradient.

 
+
+
+

Returns

+

Color samples: { R1, G1, B1, A1, ..., Rn, Gn, Bn, An }.

+
+
+
+
+

gimp_gradients_get_gradient_data ()

+
gchar *
+gimp_gradients_get_gradient_data (const gchar *name,
+                                  gint sample_size,
+                                  gboolean reverse,
+                                  gint *width,
+                                  gdouble **grad_data);
+
+

gimp_gradients_get_gradient_data is deprecated and should not be used in newly-written code.

+

Use gimp_gradient_get_uniform_samples() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

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.

 
+
+
+

Returns

+

The gradient name.

+
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpgradientselect.html b/devel-docs/libgimp/html/libgimp-gimpgradientselect.html new file mode 100644 index 0000000..49dede6 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpgradientselect.html @@ -0,0 +1,237 @@ + + + + +gimpgradientselect: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpgradientselect

+

gimpgradientselect — Functions providing a gradient selection dialog.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+void + +(*GimpRunGradientCallback) () +
const gchar * + +gimp_gradient_select_new () +
+void + +gimp_gradient_select_destroy () +
+gboolean + +gimp_gradients_popup () +
+gboolean + +gimp_gradients_close_popup () +
+gboolean + +gimp_gradients_set_popup () +
+
+
+

Description

+

Functions providing a gradient selection dialog.

+
+
+

Functions

+
+

GimpRunGradientCallback ()

+
void
+(*GimpRunGradientCallback) (const gchar *gradient_name,
+                            gint width,
+                            const gdouble *grad_data,
+                            gboolean dialog_closing,
+                            gpointer user_data);
+
+
+
+

gimp_gradient_select_new ()

+
const gchar *
+gimp_gradient_select_new (const gchar *title,
+                          const gchar *gradient_name,
+                          gint sample_size,
+                          GimpRunGradientCallback callback,
+                          gpointer data);
+
+
+
+

gimp_gradient_select_destroy ()

+
void
+gimp_gradient_select_destroy (const gchar *gradient_callback);
+
+
+
+

gimp_gradients_popup ()

+
gboolean
+gimp_gradients_popup (const gchar *gradient_callback,
+                      const gchar *popup_title,
+                      const gchar *initial_gradient,
+                      gint sample_size);
+

Invokes the Gimp gradients selection.

+

This procedure opens the gradient selection dialog.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

gradient_callback

The callback PDB proc to call when gradient selection is made.

 

popup_title

Title of the gradient selection dialog.

 

initial_gradient

The name of the gradient to set as the first selected.

 

sample_size

Size of the sample to return when the gradient is changed.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_gradients_close_popup ()

+
gboolean
+gimp_gradients_close_popup (const gchar *gradient_callback);
+

Close the gradient selection dialog.

+

This procedure closes an opened gradient selection dialog.

+
+

Parameters

+
+++++ + + + + + +

gradient_callback

The name of the callback registered for this pop-up.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_gradients_set_popup ()

+
gboolean
+gimp_gradients_set_popup (const gchar *gradient_callback,
+                          const gchar *gradient_name);
+

Sets the current gradient in a gradient selection dialog.

+

Sets the current gradient in a gradient selection dialog.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

gradient_callback

The name of the callback registered for this pop-up.

 

gradient_name

The name of the gradient to set as selected.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimphelp.html b/devel-docs/libgimp/html/libgimp-gimphelp.html new file mode 100644 index 0000000..da1c122 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimphelp.html @@ -0,0 +1,101 @@ + + + + +gimphelp: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimphelp

+

gimphelp — Loading help pages using gimp_help.

+
+
+

Functions

+
++++ + + + + +
+gboolean + +gimp_help () +
+
+
+

Description

+

Loading help pages using gimp_help.

+
+
+

Functions

+
+

gimp_help ()

+
gboolean
+gimp_help (const gchar *help_domain,
+           const gchar *help_id);
+

Load a help page.

+

This procedure loads the specified help page into the helpbrowser or +what ever is configured as help viewer. The help page is identified +by its domain and ID: if help_domain is NULL, we use the help_domain +which was registered using the gimp_plugin_help_register() +procedure. If help_domain is NULL and no help domain was registered, +the help domain of the main GIMP installation is used.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

help_domain

The help domain in which help_id is registered.

 

help_id

The help page's ID.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpimage.html b/devel-docs/libgimp/html/libgimp-gimpimage.html new file mode 100644 index 0000000..1902bcb --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpimage.html @@ -0,0 +1,4857 @@ + + + + +gimpimage: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpimage

+

gimpimage — Operations on complete images.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+gint * + +gimp_image_list () +
+gint32 + +gimp_image_new () +
+gint32 + +gimp_image_new_with_precision () +
+gchar * + +gimp_image_get_uri () +
+gchar * + +gimp_image_get_xcf_uri () +
+gchar * + +gimp_image_get_exported_uri () +
+gchar * + +gimp_image_get_imported_uri () +
+gint32 + +gimp_image_duplicate () +
+gboolean + +gimp_image_delete () +
+gboolean + +gimp_image_is_valid () +
+GimpImageBaseType + +gimp_image_base_type () +
+GimpPrecision + +gimp_image_get_precision () +
+GimpLayerMode + +gimp_image_get_default_new_layer_mode () +
+gint + +gimp_image_width () +
+gint + +gimp_image_height () +
+gboolean + +gimp_image_free_shadow () +
+gint * + +gimp_image_get_layers () +
+gint * + +gimp_image_get_channels () +
+gint32 + +gimp_image_get_active_drawable () +
+gint32 + +gimp_image_get_floating_sel () +
+gint32 + +gimp_image_floating_sel_attached_to () +
+gboolean + +gimp_image_pick_color () +
+gint32 + +gimp_image_pick_correlate_layer () +
+gint + +gimp_image_get_item_position () +
+gboolean + +gimp_image_reorder_item () +
+gboolean + +gimp_image_raise_item () +
+gboolean + +gimp_image_lower_item () +
+gboolean + +gimp_image_raise_item_to_top () +
+gboolean + +gimp_image_lower_item_to_bottom () +
+gboolean + +gimp_image_add_layer () +
+gboolean + +gimp_image_insert_layer () +
+gboolean + +gimp_image_remove_layer () +
+gboolean + +gimp_image_freeze_layers () +
+gboolean + +gimp_image_thaw_layers () +
+gboolean + +gimp_image_raise_layer () +
+gboolean + +gimp_image_lower_layer () +
+gboolean + +gimp_image_raise_layer_to_top () +
+gboolean + +gimp_image_lower_layer_to_bottom () +
+gint + +gimp_image_get_layer_position () +
+gboolean + +gimp_image_add_channel () +
+gboolean + +gimp_image_insert_channel () +
+gboolean + +gimp_image_remove_channel () +
+gboolean + +gimp_image_freeze_channels () +
+gboolean + +gimp_image_thaw_channels () +
+gboolean + +gimp_image_raise_channel () +
+gboolean + +gimp_image_lower_channel () +
+gint + +gimp_image_get_channel_position () +
+gint32 + +gimp_image_flatten () +
+gint32 + +gimp_image_merge_visible_layers () +
+gint32 + +gimp_image_merge_down () +
+gint32 + +gimp_image_merge_layer_group () +
+gboolean + +gimp_image_clean_all () +
+gboolean + +gimp_image_is_dirty () +
+gint32 + +gimp_image_get_active_layer () +
+gboolean + +gimp_image_set_active_layer () +
+gint32 + +gimp_image_get_active_channel () +
+gboolean + +gimp_image_set_active_channel () +
+gboolean + +gimp_image_unset_active_channel () +
+gint32 + +gimp_image_get_selection () +
+gboolean + +gimp_image_get_component_active () +
+gboolean + +gimp_image_set_component_active () +
+gboolean + +gimp_image_get_component_visible () +
+gboolean + +gimp_image_set_component_visible () +
+gchar * + +gimp_image_get_filename () +
+gboolean + +gimp_image_set_filename () +
+gchar * + +gimp_image_get_name () +
+gboolean + +gimp_image_get_resolution () +
+gboolean + +gimp_image_set_resolution () +
+GimpUnit + +gimp_image_get_unit () +
+gboolean + +gimp_image_set_unit () +
+gboolean + +gimp_image_set_tattoo_state () +
+gint + +gimp_image_get_tattoo_state () +
+gint32 + +gimp_image_get_layer_by_tattoo () +
+gint32 + +gimp_image_get_channel_by_tattoo () +
+gint32 + +gimp_image_get_vectors_by_tattoo () +
+gint32 + +gimp_image_get_layer_by_name () +
+gint32 + +gimp_image_get_channel_by_name () +
+gint32 + +gimp_image_get_vectors_by_name () +
+guchar * + +gimp_image_get_cmap () +
+gboolean + +gimp_image_set_cmap () +
+guchar * + +gimp_image_get_colormap () +
+gboolean + +gimp_image_set_colormap () +
+gint * + +gimp_image_get_vectors () +
+guchar * + +gimp_image_get_thumbnail_data () +
+GimpMetadata * + +gimp_image_get_metadata () +
+gboolean + +gimp_image_set_metadata () +
+gboolean + +gimp_image_attach_parasite () +
+gboolean + +gimp_image_detach_parasite () +
+GimpParasite * + +gimp_image_get_parasite () +
+gchar ** + +gimp_image_get_parasite_list () +
+GimpParasite * + +gimp_image_parasite_find () +
+gboolean + +gimp_image_parasite_list () +
+gboolean + +gimp_image_parasite_attach () +
+gboolean + +gimp_image_parasite_detach () +
+gboolean + +gimp_image_attach_new_parasite () +
+gboolean + +gimp_image_add_vectors () +
+gboolean + +gimp_image_insert_vectors () +
+gboolean + +gimp_image_remove_vectors () +
+gboolean + +gimp_image_freeze_vectors () +
+gboolean + +gimp_image_thaw_vectors () +
+gint32 + +gimp_image_get_active_vectors () +
+gboolean + +gimp_image_set_active_vectors () +
+gboolean + +gimp_image_lower_vectors () +
+gboolean + +gimp_image_raise_vectors () +
+gboolean + +gimp_image_lower_vectors_to_bottom () +
+gboolean + +gimp_image_raise_vectors_to_top () +
+gint + +gimp_image_get_vectors_position () +
+
+
+

Description

+

Operations on complete images: creation, resizing/rescaling, and +operations involving multiple layers.

+
+
+

Functions

+
+

gimp_image_list ()

+
gint *
+gimp_image_list (gint *num_images);
+

Returns the list of images currently open.

+

This procedure returns the list of images currently open in GIMP.

+
+

Parameters

+
+++++ + + + + + +

num_images

The number of images currently open.

 
+
+
+

Returns

+

The list of images currently open. The returned value must +be freed with g_free().

+
+
+
+
+

gimp_image_new ()

+
gint32
+gimp_image_new (gint width,
+                gint height,
+                GimpImageBaseType type);
+

Creates a new image with the specified width, height, and type.

+

Creates a new image, undisplayed, with the specified extents and +type. A layer should be created and added before this image is +displayed, or subsequent calls to gimp_display_new() with this image +as an argument will fail. Layers can be created using the +gimp_layer_new() commands. They can be added to an image using the +gimp_image_insert_layer() command.

+

If your image's type if INDEXED, a colormap must also be added with +gimp_image_set_colormap(). An indexed image without a colormap will +output unexpected colors.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

width

The width of the image.

 

height

The height of the image.

 

type

The type of image.

 
+
+
+

Returns

+

The ID of the newly created image.

+
+
+
+
+

gimp_image_new_with_precision ()

+
gint32
+gimp_image_new_with_precision (gint width,
+                               gint height,
+                               GimpImageBaseType type,
+                               GimpPrecision precision);
+

Creates a new image with the specified width, height, type and +precision.

+

Creates a new image, undisplayed with the specified extents, type +and precision. Indexed images can only be created at +GIMP_PRECISION_U8_GAMMA precision. See gimp_image_new() for further +details.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

width

The width of the image.

 

height

The height of the image.

 

type

The type of image.

 

precision

The precision.

 
+
+
+

Returns

+

The ID of the newly created image.

+
+

Since: 2.10

+
+
+
+

gimp_image_get_uri ()

+
gchar *
+gimp_image_get_uri (gint32 image_ID);
+

Returns the URI for the specified image.

+

This procedure returns the URI associated with the specified image. +The image has an URI only if it was loaded or imported from a file +or has since been saved or exported. Otherwise, this function +returns NULL. See also gimp-image-get-imported-uri to get the URI +of the current file if it was imported from a non-GIMP file format +and not yet saved, or gimp-image-get-exported-uri if the image has +been exported to a non-GIMP file format.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

The URI. The returned value must be freed with g_free().

+
+

Since: 2.8

+
+
+
+

gimp_image_get_xcf_uri ()

+
gchar *
+gimp_image_get_xcf_uri (gint32 image_ID);
+

Returns the XCF URI for the specified image.

+

This procedure returns the XCF URI associated with the image. If +there is no such URI, this procedure returns NULL.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

The imported URI. The returned value must be freed with +g_free().

+
+

Since: 2.8

+
+
+
+

gimp_image_get_exported_uri ()

+
gchar *
+gimp_image_get_exported_uri (gint32 image_ID);
+

Returns the exported URI for the specified image.

+

This procedure returns the URI associated with the specified image +if the image was exported a non-native GIMP format. If the image was +not exported, this procedure returns NULL.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

The exported URI. The returned value must be freed with +g_free().

+
+

Since: 2.8

+
+
+
+

gimp_image_get_imported_uri ()

+
gchar *
+gimp_image_get_imported_uri (gint32 image_ID);
+

Returns the imported URI for the specified image.

+

This procedure returns the URI associated with the specified image +if the image was imported from a non-native Gimp format. If the +image was not imported, or has since been saved in the native Gimp +format, this procedure returns NULL.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

The imported URI. The returned value must be freed with +g_free().

+
+

Since: 2.8

+
+
+
+

gimp_image_duplicate ()

+
gint32
+gimp_image_duplicate (gint32 image_ID);
+

Duplicate the specified image

+

This procedure duplicates the specified image, copying all layers, +channels, and image information.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

The new, duplicated image.

+
+
+
+
+

gimp_image_delete ()

+
gboolean
+gimp_image_delete (gint32 image_ID);
+

Delete the specified image.

+

If there are no displays associated with this image it will be +deleted. This means that you can not delete an image through the PDB +that was created by the user. If the associated display was however +created through the PDB and you know the display ID, you may delete +the display. Removal of the last associated display will then delete +the image.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_is_valid ()

+
gboolean
+gimp_image_is_valid (gint32 image_ID);
+

Returns TRUE if the image is valid.

+

This procedure checks if the given image ID is valid and refers to +an existing image.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image to check.

 
+
+
+

Returns

+

Whether the image ID is valid.

+
+

Since: 2.4

+
+
+
+

gimp_image_base_type ()

+
GimpImageBaseType
+gimp_image_base_type (gint32 image_ID);
+

Get the base type of the image.

+

This procedure returns the image's base type. Layers in the image +must be of this subtype, but can have an optional alpha channel.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

The image's base type.

+
+
+
+
+

gimp_image_get_precision ()

+
GimpPrecision
+gimp_image_get_precision (gint32 image_ID);
+

Get the precision of the image.

+

This procedure returns the image's precision.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

The image's precision.

+
+

Since: 2.10

+
+
+
+

gimp_image_get_default_new_layer_mode ()

+
GimpLayerMode
+gimp_image_get_default_new_layer_mode (gint32 image_ID);
+

Get the default mode for newly created layers of this image.

+

Returns the default mode for newly created layers of this image.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

The layer mode.

+
+

Since: 2.10

+
+
+
+

gimp_image_width ()

+
gint
+gimp_image_width (gint32 image_ID);
+

Return the width of the image

+

This procedure returns the image's width. This value is independent +of any of the layers in this image. This is the \"canvas\" width.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

The image's width.

+
+
+
+
+

gimp_image_height ()

+
gint
+gimp_image_height (gint32 image_ID);
+

Return the height of the image

+

This procedure returns the image's height. This value is independent +of any of the layers in this image. This is the \"canvas\" height.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

The image's height.

+
+
+
+
+

gimp_image_free_shadow ()

+
gboolean
+gimp_image_free_shadow (gint32 image_ID);
+
+

gimp_image_free_shadow is deprecated and should not be used in newly-written code.

+

Use gimp_drawable_free_shadow() instead.

+
+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_get_layers ()

+
gint *
+gimp_image_get_layers (gint32 image_ID,
+                       gint *num_layers);
+

Returns the list of layers contained in the specified image.

+

This procedure returns the list of layers contained in the specified +image. The order of layers is from topmost to bottommost.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

num_layers

The number of layers contained in the image.

 
+
+
+

Returns

+

The list of layers contained in the image. The returned +value must be freed with g_free().

+
+
+
+
+

gimp_image_get_channels ()

+
gint *
+gimp_image_get_channels (gint32 image_ID,
+                         gint *num_channels);
+

Returns the list of channels contained in the specified image.

+

This procedure returns the list of channels contained in the +specified image. This does not include the selection mask, or layer +masks. The order is from topmost to bottommost. Note that +\"channels\" are custom channels and do not include the image's +color components.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

num_channels

The number of channels contained in the image.

 
+
+
+

Returns

+

The list of channels contained in the image. The returned +value must be freed with g_free().

+
+
+
+
+

gimp_image_get_active_drawable ()

+
gint32
+gimp_image_get_active_drawable (gint32 image_ID);
+

Get the image's active drawable

+

This procedure returns the ID of the image's active drawable. This +can be either a layer, a channel, or a layer mask. The active +drawable is specified by the active image channel. If that is -1, +then by the active image layer. If the active image layer has a +layer mask and the layer mask is in edit mode, then the layer mask +is the active drawable.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

The active drawable.

+
+
+
+
+

gimp_image_get_floating_sel ()

+
gint32
+gimp_image_get_floating_sel (gint32 image_ID);
+

Return the floating selection of the image.

+

This procedure returns the image's floating selection, if it exists. +If it doesn't exist, -1 is returned as the layer ID.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

The image's floating selection.

+
+
+
+
+

gimp_image_floating_sel_attached_to ()

+
gint32
+gimp_image_floating_sel_attached_to (gint32 image_ID);
+

Return the drawable the floating selection is attached to.

+

This procedure returns the drawable the image's floating selection +is attached to, if it exists. If it doesn't exist, -1 is returned as +the drawable ID.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

The drawable the floating selection is attached to.

+
+
+
+
+

gimp_image_pick_color ()

+
gboolean
+gimp_image_pick_color (gint32 image_ID,
+                       gint32 drawable_ID,
+                       gdouble x,
+                       gdouble y,
+                       gboolean sample_merged,
+                       gboolean sample_average,
+                       gdouble average_radius,
+                       GimpRGB *color);
+

Determine the color at the given drawable coordinates

+

This tool determines the color at the specified coordinates. The +returned color is an RGB triplet even for grayscale and indexed +drawables. If the coordinates lie outside of the extents of the +specified drawable, then an error is returned. If the drawable has +an alpha channel, the algorithm examines the alpha value of the +drawable at the coordinates. If the alpha value is completely +transparent (0), then an error is returned. If the sample_merged +parameter is TRUE, the data of the composite image will be used +instead of that for the specified drawable. This is equivalent to +sampling for colors after merging all visible layers. In the case of +a merged sampling, the supplied drawable is ignored.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

drawable_ID

The drawable to pick from.

 

x

x coordinate of upper-left corner of rectangle.

 

y

y coordinate of upper-left corner of rectangle.

 

sample_merged

Use the composite image, not the drawable.

 

sample_average

Average the color of all the pixels in a specified radius.

 

average_radius

The radius of pixels to average.

 

color

The return color.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_pick_correlate_layer ()

+
gint32
+gimp_image_pick_correlate_layer (gint32 image_ID,
+                                 gint x,
+                                 gint y);
+

Find the layer visible at the specified coordinates.

+

This procedure finds the layer which is visible at the specified +coordinates. Layers which do not qualify are those whose extents do +not pass within the specified coordinates, or which are transparent +at the specified coordinates. This procedure will return -1 if no +layer is found.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

x

The x coordinate for the pick.

 

y

The y coordinate for the pick.

 
+
+
+

Returns

+

The layer found at the specified coordinates.

+
+
+
+
+

gimp_image_get_item_position ()

+
gint
+gimp_image_get_item_position (gint32 image_ID,
+                              gint32 item_ID);
+

Returns the position of the item in its level of its item tree.

+

This procedure determines the position of the specified item in its +level in its item tree in the image. If the item doesn't exist in +the image, or the item is not part of an item tree, an error is +returned.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

item_ID

The item.

 
+
+
+

Returns

+

The position of the item in its level in the item tree.

+
+

Since: 2.8

+
+
+
+

gimp_image_reorder_item ()

+
gboolean
+gimp_image_reorder_item (gint32 image_ID,
+                         gint32 item_ID,
+                         gint32 parent_ID,
+                         gint position);
+

Reorder the specified item within its item tree

+

This procedure reorders the specified item within its item tree.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

item_ID

The item to reorder.

 

parent_ID

The new parent item.

 

position

The new position of the item.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_image_raise_item ()

+
gboolean
+gimp_image_raise_item (gint32 image_ID,
+                       gint32 item_ID);
+

Raise the specified item in its level in its item tree

+

This procedure raises the specified item one step in the item tree. +The procedure call will fail if there is no item above it.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

item_ID

The item to raise.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_image_lower_item ()

+
gboolean
+gimp_image_lower_item (gint32 image_ID,
+                       gint32 item_ID);
+

Lower the specified item in its level in its item tree

+

This procedure lowers the specified item one step in the item tree. +The procedure call will fail if there is no item below it.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

item_ID

The item to lower.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_image_raise_item_to_top ()

+
gboolean
+gimp_image_raise_item_to_top (gint32 image_ID,
+                              gint32 item_ID);
+

Raise the specified item to the top of its level in its item tree

+

This procedure raises the specified item to top of its level in the +item tree. It will not move the item if there is no item above it.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

item_ID

The item to raise to top.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_image_lower_item_to_bottom ()

+
gboolean
+gimp_image_lower_item_to_bottom (gint32 image_ID,
+                                 gint32 item_ID);
+

Lower the specified item to the bottom of its level in its item tree

+

This procedure lowers the specified item to bottom of its level in +the item tree. It will not move the layer if there is no layer below +it.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

item_ID

The item to lower to bottom.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_image_add_layer ()

+
gboolean
+gimp_image_add_layer (gint32 image_ID,
+                      gint32 layer_ID,
+                      gint position);
+
+

gimp_image_add_layer is deprecated and should not be used in newly-written code.

+

Use gimp_image_insert_layer() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

layer_ID

The layer.

 

position

The layer position.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_insert_layer ()

+
gboolean
+gimp_image_insert_layer (gint32 image_ID,
+                         gint32 layer_ID,
+                         gint32 parent_ID,
+                         gint position);
+

Add the specified layer to the image.

+

This procedure adds the specified layer to the image at the given +position. If the specified parent is a valid layer group (See +gimp_item_is_group() and gimp_layer_group_new()) then the layer is +added inside the group. If the parent is 0, the layer is added +inside the main stack, outside of any group. The position argument +specifies the location of the layer inside the stack (or the group, +if a valid parent was supplied), starting from the top (0) and +increasing. If the position is specified as -1 and the parent is +specified as 0, then the layer is inserted above the active layer, +or inside the group if the active layer is a layer group. The layer +type must be compatible with the image base type.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

layer_ID

The layer.

 

parent_ID

The parent layer.

 

position

The layer position.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_remove_layer ()

+
gboolean
+gimp_image_remove_layer (gint32 image_ID,
+                         gint32 layer_ID);
+

Remove the specified layer from the image.

+

This procedure removes the specified layer from the image. If the +layer doesn't exist, an error is returned. If there are no layers +left in the image, this call will fail. If this layer is the last +layer remaining, the image will become empty and have no active +layer.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

layer_ID

The layer.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_freeze_layers ()

+
gboolean
+gimp_image_freeze_layers (gint32 image_ID);
+

Freeze the image's layer list.

+

This procedure freezes the layer list of the image, suppressing any +updates to the Layers dialog in response to changes to the image's +layers. This can significantly improve performance while applying +changes affecting the layer list.

+

Each call to gimp_image_freeze_layers() should be matched by a +corresponding call to gimp_image_thaw_layers(), undoing its effects.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10.2

+
+
+
+

gimp_image_thaw_layers ()

+
gboolean
+gimp_image_thaw_layers (gint32 image_ID);
+

Thaw the image's layer list.

+

This procedure thaws the layer list of the image, re-enabling +updates to the Layers dialog.

+

This procedure should match a corresponding call to +gimp_image_freeze_layers().

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10.2

+
+
+
+

gimp_image_raise_layer ()

+
gboolean
+gimp_image_raise_layer (gint32 image_ID,
+                        gint32 layer_ID);
+
+

gimp_image_raise_layer is deprecated and should not be used in newly-written code.

+

Use gimp_image_raise_item() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

layer_ID

The layer to raise.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_lower_layer ()

+
gboolean
+gimp_image_lower_layer (gint32 image_ID,
+                        gint32 layer_ID);
+
+

gimp_image_lower_layer is deprecated and should not be used in newly-written code.

+

Use gimp_image_lower_item() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

layer_ID

The layer to lower.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_raise_layer_to_top ()

+
gboolean
+gimp_image_raise_layer_to_top (gint32 image_ID,
+                               gint32 layer_ID);
+
+

gimp_image_raise_layer_to_top is deprecated and should not be used in newly-written code.

+

Use gimp_image_raise_item_to_top() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

layer_ID

The layer to raise to top.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_lower_layer_to_bottom ()

+
gboolean
+gimp_image_lower_layer_to_bottom (gint32 image_ID,
+                                  gint32 layer_ID);
+
+

gimp_image_lower_layer_to_bottom is deprecated and should not be used in newly-written code.

+

Use gimp_image_lower_item_to_bottom() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

layer_ID

The layer to lower to bottom.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_get_layer_position ()

+
gint
+gimp_image_get_layer_position (gint32 image_ID,
+                               gint32 layer_ID);
+
+

gimp_image_get_layer_position is deprecated and should not be used in newly-written code.

+

Use gimp_image_get_item_position() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

layer_ID

The layer.

 
+
+
+

Returns

+

The position of the layer in the layer stack.

+
+

Since: 2.4

+
+
+
+

gimp_image_add_channel ()

+
gboolean
+gimp_image_add_channel (gint32 image_ID,
+                        gint32 channel_ID,
+                        gint position);
+
+

gimp_image_add_channel is deprecated and should not be used in newly-written code.

+

Use gimp_image_insert_channel() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

channel_ID

The channel.

 

position

The channel position.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_insert_channel ()

+
gboolean
+gimp_image_insert_channel (gint32 image_ID,
+                           gint32 channel_ID,
+                           gint32 parent_ID,
+                           gint position);
+

Add the specified channel to the image.

+

This procedure adds the specified channel to the image at the given +position. Since channel groups are not currently supported, the +parent argument must always be 0. The position argument specifies +the location of the channel inside the stack, starting from the top +(0) and increasing. If the position is specified as -1, then the +channel is inserted above the active channel.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

channel_ID

The channel.

 

parent_ID

The parent channel.

 

position

The channel position.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_remove_channel ()

+
gboolean
+gimp_image_remove_channel (gint32 image_ID,
+                           gint32 channel_ID);
+

Remove the specified channel from the image.

+

This procedure removes the specified channel from the image. If the +channel doesn't exist, an error is returned.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

channel_ID

The channel.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_freeze_channels ()

+
gboolean
+gimp_image_freeze_channels (gint32 image_ID);
+

Freeze the image's channel list.

+

This procedure freezes the channel list of the image, suppressing +any updates to the Channels dialog in response to changes to the +image's channels. This can significantly improve performance while +applying changes affecting the channel list.

+

Each call to gimp_image_freeze_channels() should be matched by a +corresponding call to gimp_image_thaw_channels(), undoing its +effects.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10.2

+
+
+
+

gimp_image_thaw_channels ()

+
gboolean
+gimp_image_thaw_channels (gint32 image_ID);
+

Thaw the image's channel list.

+

This procedure thaws the channel list of the image, re-enabling +updates to the Channels dialog.

+

This procedure should match a corresponding call to +gimp_image_freeze_channels().

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10.2

+
+
+
+

gimp_image_raise_channel ()

+
gboolean
+gimp_image_raise_channel (gint32 image_ID,
+                          gint32 channel_ID);
+
+

gimp_image_raise_channel is deprecated and should not be used in newly-written code.

+

Use gimp_image_raise_item() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

channel_ID

The channel to raise.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_lower_channel ()

+
gboolean
+gimp_image_lower_channel (gint32 image_ID,
+                          gint32 channel_ID);
+
+

gimp_image_lower_channel is deprecated and should not be used in newly-written code.

+

Use gimp_image_lower_item() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

channel_ID

The channel to lower.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_get_channel_position ()

+
gint
+gimp_image_get_channel_position (gint32 image_ID,
+                                 gint32 channel_ID);
+
+

gimp_image_get_channel_position is deprecated and should not be used in newly-written code.

+

Use gimp_image_get_item_position() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

channel_ID

The channel.

 
+
+
+

Returns

+

The position of the channel in the channel stack.

+
+

Since: 2.4

+
+
+
+

gimp_image_flatten ()

+
gint32
+gimp_image_flatten (gint32 image_ID);
+

Flatten all visible layers into a single layer. Discard all +invisible layers.

+

This procedure combines the visible layers in a manner analogous to +merging with the CLIP_TO_IMAGE merge type. Non-visible layers are +discarded, and the resulting image is stripped of its alpha channel.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

The resulting layer.

+
+
+
+
+

gimp_image_merge_visible_layers ()

+
gint32
+gimp_image_merge_visible_layers (gint32 image_ID,
+                                 GimpMergeType merge_type);
+

Merge the visible image layers into one.

+

This procedure combines the visible layers into a single layer using +the specified merge type. A merge type of EXPAND_AS_NECESSARY +expands the final layer to encompass the areas of the visible +layers. A merge type of CLIP_TO_IMAGE clips the final layer to the +extents of the image. A merge type of CLIP_TO_BOTTOM_LAYER clips the +final layer to the size of the bottommost layer.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

merge_type

The type of merge.

 
+
+
+

Returns

+

The resulting layer.

+
+
+
+
+

gimp_image_merge_down ()

+
gint32
+gimp_image_merge_down (gint32 image_ID,
+                       gint32 merge_layer_ID,
+                       GimpMergeType merge_type);
+

Merge the layer passed and the first visible layer below.

+

This procedure combines the passed layer and the first visible layer +below it using the specified merge type. A merge type of +EXPAND_AS_NECESSARY expands the final layer to encompass the areas +of the visible layers. A merge type of CLIP_TO_IMAGE clips the final +layer to the extents of the image. A merge type of +CLIP_TO_BOTTOM_LAYER clips the final layer to the size of the +bottommost layer.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

merge_layer_ID

The layer to merge down from.

 

merge_type

The type of merge.

 
+
+
+

Returns

+

The resulting layer.

+
+
+
+
+

gimp_image_merge_layer_group ()

+
gint32
+gimp_image_merge_layer_group (gint32 image_ID,
+                              gint32 layer_group_ID);
+

Merge the passed layer group's layers into one normal layer.

+

This procedure combines the layers of the passed layer group into a +single normal layer, replacing the group.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

layer_group_ID

The layer group to merge.

 
+
+
+

Returns

+

The resulting layer.

+
+

Since: 2.10.14

+
+
+
+

gimp_image_clean_all ()

+
gboolean
+gimp_image_clean_all (gint32 image_ID);
+

Set the image dirty count to 0.

+

This procedure sets the specified image's dirty count to 0, allowing +operations to occur without having a 'dirtied' image. This is +especially useful for creating and loading images which should not +initially be considered dirty, even though layers must be created, +filled, and installed in the image. Note that save plug-ins must NOT +call this function themselves after saving the image.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_is_dirty ()

+
gboolean
+gimp_image_is_dirty (gint32 image_ID);
+

Checks if the image has unsaved changes.

+

This procedure checks the specified image's dirty count to see if it +needs to be saved. Note that saving the image does not automatically +set the dirty count to 0, you need to call gimp_image_clean_all() +after calling a save procedure to make the image clean.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

TRUE if the image has unsaved changes.

+
+
+
+
+

gimp_image_get_active_layer ()

+
gint32
+gimp_image_get_active_layer (gint32 image_ID);
+

Returns the specified image's active layer.

+

If there is an active layer, its ID will be returned, otherwise, -1. +If a channel is currently active, then no layer will be. If a layer +mask is active, then this will return the associated layer.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

The active layer.

+
+
+
+
+

gimp_image_set_active_layer ()

+
gboolean
+gimp_image_set_active_layer (gint32 image_ID,
+                             gint32 active_layer_ID);
+

Sets the specified image's active layer.

+

If the layer exists, it is set as the active layer in the image. Any +previous active layer or channel is set to inactive. An exception is +a previously existing floating selection, in which case this +procedure will return an execution error.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

active_layer_ID

The new image active layer.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_get_active_channel ()

+
gint32
+gimp_image_get_active_channel (gint32 image_ID);
+

Returns the specified image's active channel.

+

If there is an active channel, this will return the channel ID, +otherwise, -1.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

The active channel.

+
+
+
+
+

gimp_image_set_active_channel ()

+
gboolean
+gimp_image_set_active_channel (gint32 image_ID,
+                               gint32 active_channel_ID);
+

Sets the specified image's active channel.

+

If the channel exists, it is set as the active channel in the image. +Any previous active channel or layer is set to inactive. An +exception is a previously existing floating selection, in which case +this procedure will return an execution error.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

active_channel_ID

The new image active channel.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_unset_active_channel ()

+
gboolean
+gimp_image_unset_active_channel (gint32 image_ID);
+

Unsets the active channel in the specified image.

+

If an active channel exists, it is unset. There then exists no +active channel, and if desired, one can be set through a call to +'Set Active Channel'. No error is returned in the case of no +existing active channel.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_get_selection ()

+
gint32
+gimp_image_get_selection (gint32 image_ID);
+

Returns the specified image's selection.

+

This will always return a valid ID for a selection -- which is +represented as a channel internally.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

The selection channel.

+
+
+
+
+

gimp_image_get_component_active ()

+
gboolean
+gimp_image_get_component_active (gint32 image_ID,
+                                 GimpChannelType component);
+

Returns if the specified image's image component is active.

+

This procedure returns if the specified image's image component +(i.e. Red, Green, Blue intensity channels in an RGB image) is active +or inactive -- whether or not it can be modified. If the specified +component is not valid for the image type, an error is returned.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

component

The image component.

 
+
+
+

Returns

+

Component is active.

+
+
+
+
+

gimp_image_set_component_active ()

+
gboolean
+gimp_image_set_component_active (gint32 image_ID,
+                                 GimpChannelType component,
+                                 gboolean active);
+

Sets if the specified image's image component is active.

+

This procedure sets if the specified image's image component (i.e. +Red, Green, Blue intensity channels in an RGB image) is active or +inactive -- whether or not it can be modified. If the specified +component is not valid for the image type, an error is returned.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

component

The image component.

 

active

Component is active.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_get_component_visible ()

+
gboolean
+gimp_image_get_component_visible (gint32 image_ID,
+                                  GimpChannelType component);
+

Returns if the specified image's image component is visible.

+

This procedure returns if the specified image's image component +(i.e. Red, Green, Blue intensity channels in an RGB image) is +visible or invisible -- whether or not it can be seen. If the +specified component is not valid for the image type, an error is +returned.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

component

The image component.

 
+
+
+

Returns

+

Component is visible.

+
+
+
+
+

gimp_image_set_component_visible ()

+
gboolean
+gimp_image_set_component_visible (gint32 image_ID,
+                                  GimpChannelType component,
+                                  gboolean visible);
+

Sets if the specified image's image component is visible.

+

This procedure sets if the specified image's image component (i.e. +Red, Green, Blue intensity channels in an RGB image) is visible or +invisible -- whether or not it can be seen. If the specified +component is not valid for the image type, an error is returned.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

component

The image component.

 

visible

Component is visible.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_get_filename ()

+
gchar *
+gimp_image_get_filename (gint32 image_ID);
+

Returns the specified image's filename.

+

This procedure returns the specified image's filename in the +filesystem encoding. The image has a filename only if it was loaded +or imported from a file or has since been saved or exported. +Otherwise, this function returns NULL. See also +gimp_image_get_uri().

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

The filename. The returned value must be freed with +g_free().

+
+
+
+
+

gimp_image_set_filename ()

+
gboolean
+gimp_image_set_filename (gint32 image_ID,
+                         const gchar *filename);
+

Sets the specified image's filename.

+

This procedure sets the specified image's filename. The filename +should be in the filesystem encoding.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

filename

The new image filename.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_get_name ()

+
gchar *
+gimp_image_get_name (gint32 image_ID);
+

Returns the specified image's name.

+

This procedure returns the image's name. If the image has a filename +or an URI, then the returned name contains the filename's or URI's +base name (the last component of the path). Otherwise it is the +translated string \"Untitled\". The returned name is formatted like +the image name in the image window title, it may contain '[]', +'(imported)' etc. and should only be used to label user interface +elements. Never use it to construct filenames.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

The name. The returned value must be freed with g_free().

+
+
+
+
+

gimp_image_get_resolution ()

+
gboolean
+gimp_image_get_resolution (gint32 image_ID,
+                           gdouble *xresolution,
+                           gdouble *yresolution);
+

Returns the specified image's resolution.

+

This procedure returns the specified image's resolution in dots per +inch. This value is independent of any of the layers in this image.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

xresolution

The resolution in the x-axis, in dots per inch.

 

yresolution

The resolution in the y-axis, in dots per inch.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_set_resolution ()

+
gboolean
+gimp_image_set_resolution (gint32 image_ID,
+                           gdouble xresolution,
+                           gdouble yresolution);
+

Sets the specified image's resolution.

+

This procedure sets the specified image's resolution in dots per +inch. This value is independent of any of the layers in this image. +No scaling or resizing is performed.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

xresolution

The new image resolution in the x-axis, in dots per inch.

 

yresolution

The new image resolution in the y-axis, in dots per inch.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_get_unit ()

+
GimpUnit
+gimp_image_get_unit (gint32 image_ID);
+

Returns the specified image's unit.

+

This procedure returns the specified image's unit. This value is +independent of any of the layers in this image. See the +gimp_unit_*() procedure definitions for the valid range of unit IDs +and a description of the unit system.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

The unit.

+
+
+
+
+

gimp_image_set_unit ()

+
gboolean
+gimp_image_set_unit (gint32 image_ID,
+                     GimpUnit unit);
+

Sets the specified image's unit.

+

This procedure sets the specified image's unit. No scaling or +resizing is performed. This value is independent of any of the +layers in this image. See the gimp_unit_*() procedure definitions +for the valid range of unit IDs and a description of the unit +system.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

unit

The new image unit.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_set_tattoo_state ()

+
gboolean
+gimp_image_set_tattoo_state (gint32 image_ID,
+                             gint tattoo_state);
+

Set the tattoo state associated with the image.

+

This procedure sets the tattoo state of the image. Use only by +save/load plug-ins that wish to preserve an images tattoo state. +Using this function at other times will produce unexpected results. +A full check of uniqueness of states in layers, channels and paths +will be performed by this procedure and a execution failure will be +returned if this fails. A failure will also be returned if the new +tattoo state value is less than the maximum tattoo value from all of +the tattoos from the paths, layers and channels. After the image +data has been loaded and all the tattoos have been set then this is +the last procedure that should be called. If effectively does a +status check on the tattoo values that have been set to make sure +that all is OK.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

tattoo_state

The new image tattoo state.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_get_tattoo_state ()

+
gint
+gimp_image_get_tattoo_state (gint32 image_ID);
+

Returns the tattoo state associated with the image.

+

This procedure returns the tattoo state of the image. Use only by +save/load plug-ins that wish to preserve an images tattoo state. +Using this function at other times will produce unexpected results.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

The tattoo state.

+
+
+
+
+

gimp_image_get_layer_by_tattoo ()

+
gint32
+gimp_image_get_layer_by_tattoo (gint32 image_ID,
+                                gint tattoo);
+

Find a layer with a given tattoo in an image.

+

This procedure returns the layer with the given tattoo in the +specified image.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

tattoo

The tattoo of the layer to find.

 
+
+
+

Returns

+

The layer with the specified tattoo.

+
+
+
+
+

gimp_image_get_channel_by_tattoo ()

+
gint32
+gimp_image_get_channel_by_tattoo (gint32 image_ID,
+                                  gint tattoo);
+

Find a channel with a given tattoo in an image.

+

This procedure returns the channel with the given tattoo in the +specified image.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

tattoo

The tattoo of the channel to find.

 
+
+
+

Returns

+

The channel with the specified tattoo.

+
+
+
+
+

gimp_image_get_vectors_by_tattoo ()

+
gint32
+gimp_image_get_vectors_by_tattoo (gint32 image_ID,
+                                  gint tattoo);
+

Find a vectors with a given tattoo in an image.

+

This procedure returns the vectors with the given tattoo in the +specified image.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

tattoo

The tattoo of the vectors to find.

 
+
+
+

Returns

+

The vectors with the specified tattoo.

+
+

Since: 2.6

+
+
+
+

gimp_image_get_layer_by_name ()

+
gint32
+gimp_image_get_layer_by_name (gint32 image_ID,
+                              const gchar *name);
+

Find a layer with a given name in an image.

+

This procedure returns the layer with the given name in the +specified image.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

name

The name of the layer to find.

 
+
+
+

Returns

+

The layer with the specified name.

+
+

Since: 2.8

+
+
+
+

gimp_image_get_channel_by_name ()

+
gint32
+gimp_image_get_channel_by_name (gint32 image_ID,
+                                const gchar *name);
+

Find a channel with a given name in an image.

+

This procedure returns the channel with the given name in the +specified image.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

name

The name of the channel to find.

 
+
+
+

Returns

+

The channel with the specified name.

+
+

Since: 2.8

+
+
+
+

gimp_image_get_vectors_by_name ()

+
gint32
+gimp_image_get_vectors_by_name (gint32 image_ID,
+                                const gchar *name);
+

Find a vectors with a given name in an image.

+

This procedure returns the vectors with the given name in the +specified image.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

name

The name of the vectors to find.

 
+
+
+

Returns

+

The vectors with the specified name.

+
+

Since: 2.8

+
+
+
+

gimp_image_get_cmap ()

+
guchar *
+gimp_image_get_cmap (gint32 image_ID,
+                     gint *num_colors);
+
+

gimp_image_get_cmap is deprecated and should not be used in newly-written code.

+

Use gimp_image_get_colormap() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

num_colors

Number of colors in the colormap array.

 
+
+
+

Returns

+

The image's colormap.

+
+
+
+
+

gimp_image_set_cmap ()

+
gboolean
+gimp_image_set_cmap (gint32 image_ID,
+                     const guchar *cmap,
+                     gint num_colors);
+
+

gimp_image_set_cmap is deprecated and should not be used in newly-written code.

+

Use gimp_image_set_colormap() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

cmap

The new colormap values.

 

num_colors

Number of colors in the colormap array.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_get_colormap ()

+
guchar *
+gimp_image_get_colormap (gint32 image_ID,
+                         gint *num_colors);
+

Returns the image's colormap

+

This procedure returns an actual pointer to the image's colormap, as +well as the number of colors contained in the colormap. If the image +is not of base type INDEXED, this pointer will be NULL.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

num_colors

Returns the number of colors in the colormap array.

 
+
+
+

Returns

+

The image's colormap.

+
+
+
+
+

gimp_image_set_colormap ()

+
gboolean
+gimp_image_set_colormap (gint32 image_ID,
+                         const guchar *colormap,
+                         gint num_colors);
+

Sets the entries in the image's colormap.

+

This procedure sets the entries in the specified image's colormap. +The number of colors is specified by the \"num_colors\" parameter +and corresponds to the number of INT8 triples that must be contained +in the \"cmap\" array.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

colormap

The new colormap values.

 

num_colors

Number of colors in the colormap array.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_get_vectors ()

+
gint *
+gimp_image_get_vectors (gint32 image_ID,
+                        gint *num_vectors);
+

Returns the list of vectors contained in the specified image.

+

This procedure returns the list of vectors contained in the +specified image.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

num_vectors

The number of vectors contained in the image.

 
+
+
+

Returns

+

The list of vectors contained in the image. The returned +value must be freed with g_free().

+
+

Since: 2.4

+
+
+
+

gimp_image_get_thumbnail_data ()

+
guchar *
+gimp_image_get_thumbnail_data (gint32 image_ID,
+                               gint *width,
+                               gint *height,
+                               gint *bpp);
+
+
+
+

gimp_image_get_metadata ()

+
GimpMetadata *
+gimp_image_get_metadata (gint32 image_ID);
+

Returns the image's metadata.

+

Returns exif/iptc/xmp metadata from the image.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

The exif/ptc/xmp metadata, or NULL if there is none.

+
+

Since: 2.10

+
+
+
+

gimp_image_set_metadata ()

+
gboolean
+gimp_image_set_metadata (gint32 image_ID,
+                         GimpMetadata *metadata);
+

Set the image's metadata.

+

Sets exif/iptc/xmp metadata on the image, or deletes it if +metadata + is NULL.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

metadata

The exif/ptc/xmp metadata.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_image_attach_parasite ()

+
gboolean
+gimp_image_attach_parasite (gint32 image_ID,
+                            const GimpParasite *parasite);
+

Add a parasite to an image.

+

This procedure attaches a parasite to an image. It has no return +values.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

parasite

The parasite to attach to an image.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_image_detach_parasite ()

+
gboolean
+gimp_image_detach_parasite (gint32 image_ID,
+                            const gchar *name);
+

Removes a parasite from an image.

+

This procedure detaches a parasite from an image. It has no return +values.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

name

The name of the parasite to detach from an image.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_image_get_parasite ()

+
GimpParasite *
+gimp_image_get_parasite (gint32 image_ID,
+                         const gchar *name);
+

Look up a parasite in an image

+

Finds and returns the parasite that was previously attached to an +image.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

name

The name of the parasite to find.

 
+
+
+

Returns

+

The found parasite.

+
+

Since: 2.8

+
+
+
+

gimp_image_get_parasite_list ()

+
gchar **
+gimp_image_get_parasite_list (gint32 image_ID,
+                              gint *num_parasites);
+

List all parasites.

+

Returns a list of all currently attached parasites.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

num_parasites

The number of attached parasites.

 
+
+
+

Returns

+

The names of currently attached parasites. The returned +value must be freed with g_strfreev().

+
+

Since: 2.8

+
+
+
+

gimp_image_parasite_find ()

+
GimpParasite *
+gimp_image_parasite_find (gint32 image_ID,
+                          const gchar *name);
+
+

gimp_image_parasite_find is deprecated and should not be used in newly-written code.

+

Use gimp_image_get_parasite() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

name

The name of the parasite to find.

 
+
+
+

Returns

+

The found parasite.

+
+
+
+
+

gimp_image_parasite_list ()

+
gboolean
+gimp_image_parasite_list (gint32 image_ID,
+                          gint *num_parasites,
+                          gchar ***parasites);
+
+

gimp_image_parasite_list is deprecated and should not be used in newly-written code.

+

Use gimp_image_get_parasite_list() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

num_parasites

The number of attached parasites.

 

parasites

The names of currently attached parasites.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_parasite_attach ()

+
gboolean
+gimp_image_parasite_attach (gint32 image_ID,
+                            const GimpParasite *parasite);
+
+

gimp_image_parasite_attach is deprecated and should not be used in newly-written code.

+

Use gimp_image_attach_parasite() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

parasite

The parasite to attach to an image.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_parasite_detach ()

+
gboolean
+gimp_image_parasite_detach (gint32 image_ID,
+                            const gchar *name);
+
+

gimp_image_parasite_detach is deprecated and should not be used in newly-written code.

+

Use gimp_image_detach_parasite() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

name

The name of the parasite to detach from an image.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_attach_new_parasite ()

+
gboolean
+gimp_image_attach_new_parasite (gint32 image_ID,
+                                const gchar *name,
+                                gint flags,
+                                gint size,
+                                gconstpointer data);
+
+

gimp_image_attach_new_parasite is deprecated and should not be used in newly-written code.

+

Use gimp_image_attach_parasite() instead.

+
+

Convenience function that creates a parasite and attaches it +to GIMP.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

image_ID

the ID of the image to attach the GimpParasite to.

 

name

the name of the GimpParasite to create and attach.

 

flags

the flags set on the GimpParasite.

 

size

the size of the parasite data in bytes.

 

data

a pointer to the data attached with the GimpParasite.

 
+
+
+

Returns

+

TRUE on successful creation and attachment of +the new parasite.

+

See Also: gimp_image_parasite_attach()

+
+
+
+
+

gimp_image_add_vectors ()

+
gboolean
+gimp_image_add_vectors (gint32 image_ID,
+                        gint32 vectors_ID,
+                        gint position);
+
+

gimp_image_add_vectors is deprecated and should not be used in newly-written code.

+

Use gimp_image_insert_vectors() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

vectors_ID

The vectors object.

 

position

The vectors objects position.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_insert_vectors ()

+
gboolean
+gimp_image_insert_vectors (gint32 image_ID,
+                           gint32 vectors_ID,
+                           gint32 parent_ID,
+                           gint position);
+

Add the specified vectors to the image.

+

This procedure adds the specified vectors to the image at the given +position. Since vectors groups are not currently supported, the +parent argument must always be 0. The position argument specifies +the location of the vectors inside the stack, starting from the top +(0) and increasing. If the position is specified as -1, then the +vectors is inserted above the active vectors.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

vectors_ID

The vectors.

 

parent_ID

The parent vectors.

 

position

The vectors position.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_remove_vectors ()

+
gboolean
+gimp_image_remove_vectors (gint32 image_ID,
+                           gint32 vectors_ID);
+

Remove the specified path from the image.

+

This procedure removes the specified path from the image. If the +path doesn't exist, an error is returned.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

vectors_ID

The vectors object.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_image_freeze_vectors ()

+
gboolean
+gimp_image_freeze_vectors (gint32 image_ID);
+

Freeze the image's vectors list.

+

This procedure freezes the vectors list of the image, suppressing +any updates to the Paths dialog in response to changes to the +image's vectors. This can significantly improve performance while +applying changes affecting the vectors list.

+

Each call to gimp_image_freeze_vectors() should be matched by a +corresponding call to gimp_image_thaw_vectors(), undoing its +effects.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10.2

+
+
+
+

gimp_image_thaw_vectors ()

+
gboolean
+gimp_image_thaw_vectors (gint32 image_ID);
+

Thaw the image's vectors list.

+

This procedure thaws the vectors list of the image, re-enabling +updates to the Paths dialog.

+

This procedure should match a corresponding call to +gimp_image_freeze_vectors().

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10.2

+
+
+
+

gimp_image_get_active_vectors ()

+
gint32
+gimp_image_get_active_vectors (gint32 image_ID);
+

Returns the specified image's active vectors.

+

If there is an active path, its ID will be returned, otherwise, -1.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

The active vectors.

+
+
+
+
+

gimp_image_set_active_vectors ()

+
gboolean
+gimp_image_set_active_vectors (gint32 image_ID,
+                               gint32 active_vectors_ID);
+

Sets the specified image's active vectors.

+

If the path exists, it is set as the active path in the image.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

active_vectors_ID

The new image active vectors.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_lower_vectors ()

+
gboolean
+gimp_image_lower_vectors (gint32 image_ID,
+                          gint32 vectors_ID);
+
+

gimp_image_lower_vectors is deprecated and should not be used in newly-written code.

+

Use gimp_image_lower_item() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

vectors_ID

The vectors object to lower.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_image_raise_vectors ()

+
gboolean
+gimp_image_raise_vectors (gint32 image_ID,
+                          gint32 vectors_ID);
+
+

gimp_image_raise_vectors is deprecated and should not be used in newly-written code.

+

Use gimp_image_raise_item() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

vectors_ID

The vectors object to raise.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_image_lower_vectors_to_bottom ()

+
gboolean
+gimp_image_lower_vectors_to_bottom (gint32 image_ID,
+                                    gint32 vectors_ID);
+
+

gimp_image_lower_vectors_to_bottom is deprecated and should not be used in newly-written code.

+

Use gimp_image_lower_item_to_bottom() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

vectors_ID

The vectors object to lower to bottom.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_image_raise_vectors_to_top ()

+
gboolean
+gimp_image_raise_vectors_to_top (gint32 image_ID,
+                                 gint32 vectors_ID);
+
+

gimp_image_raise_vectors_to_top is deprecated and should not be used in newly-written code.

+

Use gimp_image_raise_item_to_top() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

vectors_ID

The vectors object to raise to top.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_image_get_vectors_position ()

+
gint
+gimp_image_get_vectors_position (gint32 image_ID,
+                                 gint32 vectors_ID);
+
+

gimp_image_get_vectors_position is deprecated and should not be used in newly-written code.

+

Use gimp_image_get_item_position() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

vectors_ID

The vectors object.

 
+
+
+

Returns

+

The position of the vectors object in the vectors stack.

+
+

Since: 2.4

+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpimagecolorprofile.html b/devel-docs/libgimp/html/libgimp-gimpimagecolorprofile.html new file mode 100644 index 0000000..708e992 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpimagecolorprofile.html @@ -0,0 +1,345 @@ + + + + +gimpimagecolorprofile: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpimagecolorprofile

+

gimpimagecolorprofile — Operations on an image's color profile.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+GimpColorProfile * + +gimp_image_get_color_profile () +
+gboolean + +gimp_image_set_color_profile () +
+gboolean + +gimp_image_set_color_profile_from_file () +
+GimpColorProfile * + +gimp_image_get_effective_color_profile () +
+gboolean + +gimp_image_convert_color_profile () +
+gboolean + +gimp_image_convert_color_profile_from_file () +
+
+
+

Description

+

Operations on an image's color profile.

+
+
+

Functions

+
+

gimp_image_get_color_profile ()

+
GimpColorProfile *
+gimp_image_get_color_profile (gint32 image_ID);
+

Returns the image's color profile

+

This procedure returns the image's color profile, or NULL if the +image has no color profile assigned.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

The image's color profile. The returned value +must be freed with g_object_unref().

+
+

Since: 2.10

+
+
+
+

gimp_image_set_color_profile ()

+
gboolean
+gimp_image_set_color_profile (gint32 image_ID,
+                              GimpColorProfile *profile);
+

Sets the image's color profile

+

This procedure sets the image's color profile.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

profile

A GimpColorProfile, or NULL.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_image_set_color_profile_from_file ()

+
gboolean
+gimp_image_set_color_profile_from_file
+                               (gint32 image_ID,
+                                const gchar *uri);
+

Sets the image's color profile from an ICC file

+

This procedure sets the image's color profile from a file containing +an ICC profile, or unsets it if NULL is passed as 'uri'. This +procedure does no color conversion.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

uri

The URI of the file containing the new color profile.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_image_get_effective_color_profile ()

+
GimpColorProfile *
+gimp_image_get_effective_color_profile
+                               (gint32 image_ID);
+

Returns the color profile that is used for the image.

+

This procedure returns the color profile that is actually used for +this image, which is the profile returned by +gimp_image_get_color_profile() if the image has a profile assigned, +or the default RGB profile from preferences if no profile is +assigned to the image. If there is no default RGB profile configured +in preferences either, a generated default RGB profile is returned.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

The color profile. The returned value +must be freed with g_object_unref().

+
+

Since: 2.10

+
+
+
+

gimp_image_convert_color_profile ()

+
gboolean
+gimp_image_convert_color_profile (gint32 image_ID,
+                                  GimpColorProfile *profile,
+                                  GimpColorRenderingIntent intent,
+                                  gboolean bpc);
+

Convert the image's layers to a color profile

+

This procedure converts from the image's color profile (or the +default RGB profile if none is set) to the given color profile. Only +RGB color profiles are accepted.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

profile

The color profile to convert to.

 

intent

Rendering intent.

 

bpc

Black point compensation.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_image_convert_color_profile_from_file ()

+
gboolean
+gimp_image_convert_color_profile_from_file
+                               (gint32 image_ID,
+                                const gchar *uri,
+                                GimpColorRenderingIntent intent,
+                                gboolean bpc);
+

Convert the image's layers to a color profile

+

This procedure converts from the image's color profile (or the +default RGB or grayscale profile if none is set) to an ICC profile +specified by 'uri'. Only RGB and grayscale color profiles are +accepted, according to the image's type.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

uri

The URI of the file containing the new color profile.

 

intent

Rendering intent.

 

bpc

Black point compensation.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpimageconvert.html b/devel-docs/libgimp/html/libgimp-gimpimageconvert.html new file mode 100644 index 0000000..27e73e9 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpimageconvert.html @@ -0,0 +1,317 @@ + + + + +gimpimageconvert: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpimageconvert

+

gimpimageconvert — Conversions between RGB, indexed, and grayscale modes.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+gboolean + +gimp_image_convert_rgb () +
+gboolean + +gimp_image_convert_grayscale () +
+gboolean + +gimp_image_convert_indexed () +
+gboolean + +gimp_image_convert_set_dither_matrix () +
+gboolean + +gimp_image_convert_precision () +
+
+
+

Description

+

Conversions between RGB, indexed, and grayscale modes.

+
+
+

Functions

+
+

gimp_image_convert_rgb ()

+
gboolean
+gimp_image_convert_rgb (gint32 image_ID);
+

Convert specified image to RGB color

+

This procedure converts the specified image to RGB color. This +process requires an image in Grayscale or Indexed color mode. No +image content is lost in this process aside from the colormap for an +indexed image.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_convert_grayscale ()

+
gboolean
+gimp_image_convert_grayscale (gint32 image_ID);
+

Convert specified image to grayscale

+

This procedure converts the specified image to grayscale. This +process requires an image in RGB or Indexed color mode.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_convert_indexed ()

+
gboolean
+gimp_image_convert_indexed (gint32 image_ID,
+                            GimpConvertDitherType dither_type,
+                            GimpConvertPaletteType palette_type,
+                            gint num_cols,
+                            gboolean alpha_dither,
+                            gboolean remove_unused,
+                            const gchar *palette);
+

Convert specified image to and Indexed image

+

This procedure converts the specified image to 'indexed' color. This +process requires an image in RGB or Grayscale mode. The +'palette_type' specifies what kind of palette to use, A type of '0' +means to use an optimal palette of 'num_cols' generated from the +colors in the image. A type of '1' means to re-use the previous +palette (not currently implemented). A type of '2' means to use the +so-called WWW-optimized palette. Type '3' means to use only black +and white colors. A type of '4' means to use a palette from the gimp +palettes directories. The 'dither type' specifies what kind of +dithering to use. '0' means no dithering, '1' means standard +Floyd-Steinberg error diffusion, '2' means Floyd-Steinberg error +diffusion with reduced bleeding, '3' means dithering based on pixel +location ('Fixed' dithering).

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

dither_type

The dither type to use.

 

palette_type

The type of palette to use.

 

num_cols

The number of colors to quantize to, ignored unless (palette_type == GIMP_CONVERT_PALETTE_GENERATE).

 

alpha_dither

Dither transparency to fake partial opacity.

 

remove_unused

Remove unused or duplicate color entries from final palette, ignored if (palette_type == GIMP_CONVERT_PALETTE_GENERATE).

 

palette

The name of the custom palette to use, ignored unless (palette_type == GIMP_CONVERT_PALETTE_CUSTOM).

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_convert_set_dither_matrix ()

+
gboolean
+gimp_image_convert_set_dither_matrix (gint width,
+                                      gint height,
+                                      gint matrix_length,
+                                      const guint8 *matrix);
+

Set dither matrix for conversion to indexed

+

This procedure sets the dither matrix used when converting images to +INDEXED mode with positional dithering.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

width

Width of the matrix (0 to reset to default matrix).

 

height

Height of the matrix (0 to reset to default matrix).

 

matrix_length

The length of 'matrix'.

 

matrix

The matrix -- all values must be >= 1.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_image_convert_precision ()

+
gboolean
+gimp_image_convert_precision (gint32 image_ID,
+                              GimpPrecision precision);
+

Convert the image to the specified precision

+

This procedure converts the image to the specified precision. Note +that indexed images cannot be converted and are always in +GIMP_PRECISION_U8.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

precision

The new precision.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpimagegrid.html b/devel-docs/libgimp/html/libgimp-gimpimagegrid.html new file mode 100644 index 0000000..8cc0c93 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpimagegrid.html @@ -0,0 +1,516 @@ + + + + +gimpimagegrid: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpimagegrid

+

gimpimagegrid — Functions manuipulating an image's grid.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+gboolean + +gimp_image_grid_get_spacing () +
+gboolean + +gimp_image_grid_set_spacing () +
+gboolean + +gimp_image_grid_get_offset () +
+gboolean + +gimp_image_grid_set_offset () +
+gboolean + +gimp_image_grid_get_foreground_color () +
+gboolean + +gimp_image_grid_set_foreground_color () +
+gboolean + +gimp_image_grid_get_background_color () +
+gboolean + +gimp_image_grid_set_background_color () +
+GimpGridStyle + +gimp_image_grid_get_style () +
+gboolean + +gimp_image_grid_set_style () +
+
+
+

Description

+

Functions manuipulating an image's grid.

+
+
+

Functions

+
+

gimp_image_grid_get_spacing ()

+
gboolean
+gimp_image_grid_get_spacing (gint32 image_ID,
+                             gdouble *xspacing,
+                             gdouble *yspacing);
+

Gets the spacing of an image's grid.

+

This procedure retrieves the horizontal and vertical spacing of an +image's grid. It takes the image as parameter.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

xspacing

The image's grid horizontal spacing.

 

yspacing

The image's grid vertical spacing.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_image_grid_set_spacing ()

+
gboolean
+gimp_image_grid_set_spacing (gint32 image_ID,
+                             gdouble xspacing,
+                             gdouble yspacing);
+

Sets the spacing of an image's grid.

+

This procedure sets the horizontal and vertical spacing of an +image's grid.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

xspacing

The image's grid horizontal spacing.

 

yspacing

The image's grid vertical spacing.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_image_grid_get_offset ()

+
gboolean
+gimp_image_grid_get_offset (gint32 image_ID,
+                            gdouble *xoffset,
+                            gdouble *yoffset);
+

Gets the offset of an image's grid.

+

This procedure retrieves the horizontal and vertical offset of an +image's grid. It takes the image as parameter.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

xoffset

The image's grid horizontal offset.

 

yoffset

The image's grid vertical offset.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_image_grid_set_offset ()

+
gboolean
+gimp_image_grid_set_offset (gint32 image_ID,
+                            gdouble xoffset,
+                            gdouble yoffset);
+

Sets the offset of an image's grid.

+

This procedure sets the horizontal and vertical offset of an image's +grid.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

xoffset

The image's grid horizontal offset.

 

yoffset

The image's grid vertical offset.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_image_grid_get_foreground_color ()

+
gboolean
+gimp_image_grid_get_foreground_color (gint32 image_ID,
+                                      GimpRGB *fgcolor);
+

Sets the foreground color of an image's grid.

+

This procedure gets the foreground color of an image's grid.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

fgcolor

The image's grid foreground color.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_image_grid_set_foreground_color ()

+
gboolean
+gimp_image_grid_set_foreground_color (gint32 image_ID,
+                                      const GimpRGB *fgcolor);
+

Gets the foreground color of an image's grid.

+

This procedure sets the foreground color of an image's grid.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

fgcolor

The new foreground color.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_image_grid_get_background_color ()

+
gboolean
+gimp_image_grid_get_background_color (gint32 image_ID,
+                                      GimpRGB *bgcolor);
+

Sets the background color of an image's grid.

+

This procedure gets the background color of an image's grid.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

bgcolor

The image's grid background color.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_image_grid_set_background_color ()

+
gboolean
+gimp_image_grid_set_background_color (gint32 image_ID,
+                                      const GimpRGB *bgcolor);
+

Gets the background color of an image's grid.

+

This procedure sets the background color of an image's grid.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

bgcolor

The new background color.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_image_grid_get_style ()

+
GimpGridStyle
+gimp_image_grid_get_style (gint32 image_ID);
+

Gets the style of an image's grid.

+

This procedure retrieves the style of an image's grid.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

The image's grid style.

+
+

Since: 2.4

+
+
+
+

gimp_image_grid_set_style ()

+
gboolean
+gimp_image_grid_set_style (gint32 image_ID,
+                           GimpGridStyle style);
+

Sets the style unit of an image's grid.

+

This procedure sets the style of an image's grid. It takes the image +and the new style as parameters.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

style

The image's grid style.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpimageguides.html b/devel-docs/libgimp/html/libgimp-gimpimageguides.html new file mode 100644 index 0000000..5702b4b --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpimageguides.html @@ -0,0 +1,324 @@ + + + + +gimpimageguides: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpimageguides

+

gimpimageguides — Functions for manipulating an image's guides.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+gint32 + +gimp_image_add_hguide () +
+gint32 + +gimp_image_add_vguide () +
+gboolean + +gimp_image_delete_guide () +
+gint32 + +gimp_image_find_next_guide () +
+GimpOrientationType + +gimp_image_get_guide_orientation () +
+gint + +gimp_image_get_guide_position () +
+
+
+

Description

+

Functions for manipulating an image's guides.

+
+
+

Functions

+
+

gimp_image_add_hguide ()

+
gint32
+gimp_image_add_hguide (gint32 image_ID,
+                       gint yposition);
+

Add a horizontal guide to an image.

+

This procedure adds a horizontal guide to an image. It takes the +input image and the y-position of the new guide as parameters. It +returns the guide ID of the new guide.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

yposition

The guide's y-offset from top of image.

 
+
+
+

Returns

+

The new guide.

+
+
+
+
+

gimp_image_add_vguide ()

+
gint32
+gimp_image_add_vguide (gint32 image_ID,
+                       gint xposition);
+

Add a vertical guide to an image.

+

This procedure adds a vertical guide to an image. It takes the input +image and the x-position of the new guide as parameters. It returns +the guide ID of the new guide.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

xposition

The guide's x-offset from left of image.

 
+
+
+

Returns

+

The new guide.

+
+
+
+
+

gimp_image_delete_guide ()

+
gboolean
+gimp_image_delete_guide (gint32 image_ID,
+                         gint32 guide_ID);
+

Deletes a guide from an image.

+

This procedure takes an image and a guide ID as input and removes +the specified guide from the specified image.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

guide_ID

The ID of the guide to be removed.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_find_next_guide ()

+
gint32
+gimp_image_find_next_guide (gint32 image_ID,
+                            gint32 guide_ID);
+

Find next guide on an image.

+

This procedure takes an image and a guide ID as input and finds the +guide ID of the successor of the given guide ID in the image's guide +list. If the supplied guide ID is 0, the procedure will return the +first Guide. The procedure will return 0 if given the final guide ID +as an argument or the image has no guides.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

guide_ID

The ID of the current guide (0 if first invocation).

 
+
+
+

Returns

+

The next guide's ID.

+
+
+
+
+

gimp_image_get_guide_orientation ()

+
GimpOrientationType
+gimp_image_get_guide_orientation (gint32 image_ID,
+                                  gint32 guide_ID);
+

Get orientation of a guide on an image.

+

This procedure takes an image and a guide ID as input and returns +the orientations of the guide.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

guide_ID

The guide.

 
+
+
+

Returns

+

The guide's orientation.

+
+
+
+
+

gimp_image_get_guide_position ()

+
gint
+gimp_image_get_guide_position (gint32 image_ID,
+                               gint32 guide_ID);
+

Get position of a guide on an image.

+

This procedure takes an image and a guide ID as input and returns +the position of the guide relative to the top or left of the image.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

guide_ID

The guide.

 
+
+
+

Returns

+

The guide's position relative to top or left of image.

+
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpimagesamplepoints.html b/devel-docs/libgimp/html/libgimp-gimpimagesamplepoints.html new file mode 100644 index 0000000..9728fc2 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpimagesamplepoints.html @@ -0,0 +1,253 @@ + + + + +gimpimagesamplepoints: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpimagesamplepoints

+

gimpimagesamplepoints — Functions for manipulating an image's sample points.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + +
+gint32 + +gimp_image_add_sample_point () +
+gboolean + +gimp_image_delete_sample_point () +
+gint32 + +gimp_image_find_next_sample_point () +
+gint + +gimp_image_get_sample_point_position () +
+
+
+

Description

+

Functions for manipulating an image's sample points.

+
+
+

Functions

+
+

gimp_image_add_sample_point ()

+
gint32
+gimp_image_add_sample_point (gint32 image_ID,
+                             gint position_x,
+                             gint position_y);
+

Add a sample point to an image.

+

This procedure adds a sample point to an image. It takes the input +image and the position of the new sample points as parameters. It +returns the sample point ID of the new sample point.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

position_x

The guide'sample points x-offset from left of image.

 

position_y

The guide'sample points y-offset from top of image.

 
+
+
+

Returns

+

The new sample point.

+
+

Since: 2.10

+
+
+
+

gimp_image_delete_sample_point ()

+
gboolean
+gimp_image_delete_sample_point (gint32 image_ID,
+                                gint32 sample_point_ID);
+

Deletes a sample point from an image.

+

This procedure takes an image and a sample point ID as input and +removes the specified sample point from the specified image.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

sample_point_ID

The ID of the sample point to be removed.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_image_find_next_sample_point ()

+
gint32
+gimp_image_find_next_sample_point (gint32 image_ID,
+                                   gint32 sample_point_ID);
+

Find next sample point on an image.

+

This procedure takes an image and a sample point ID as input and +finds the sample point ID of the successor of the given sample point +ID in the image's sample point list. If the supplied sample point ID +is 0, the procedure will return the first sample point. The +procedure will return 0 if given the final sample point ID as an +argument or the image has no sample points.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

sample_point_ID

The ID of the current sample point (0 if first invocation).

 
+
+
+

Returns

+

The next sample point's ID.

+
+

Since: 2.10

+
+
+
+

gimp_image_get_sample_point_position ()

+
gint
+gimp_image_get_sample_point_position (gint32 image_ID,
+                                      gint32 sample_point_ID,
+                                      gint *position_y);
+

Get position of a sample point on an image.

+

This procedure takes an image and a sample point ID as input and +returns the position of the sample point relative to the top and +left of the image.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

sample_point_ID

The guide.

 

position_y

The sample points's position relative to top of image.

 
+
+
+

Returns

+

The sample points's position relative to top of image.

+
+

Since: 2.10

+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpimageselect.html b/devel-docs/libgimp/html/libgimp-gimpimageselect.html new file mode 100644 index 0000000..7cd9d57 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpimageselect.html @@ -0,0 +1,564 @@ + + + + +gimpimageselect: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpimageselect

+

gimpimageselect — Modify the image's selection.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+gboolean + +gimp_image_select_color () +
+gboolean + +gimp_image_select_contiguous_color () +
+gboolean + +gimp_image_select_rectangle () +
+gboolean + +gimp_image_select_round_rectangle () +
+gboolean + +gimp_image_select_ellipse () +
+gboolean + +gimp_image_select_polygon () +
+gboolean + +gimp_image_select_item () +
+
+
+

Description

+

Functions to modify the image's selection.

+
+
+

Functions

+
+

gimp_image_select_color ()

+
gboolean
+gimp_image_select_color (gint32 image_ID,
+                         GimpChannelOps operation,
+                         gint32 drawable_ID,
+                         const GimpRGB *color);
+

Create a selection by selecting all pixels (in the specified +drawable) with the same (or similar) color to that specified.

+

This tool creates a selection over the specified image. A by-color +selection is determined by the supplied color under the constraints +of the current context settings. Essentially, all pixels (in the +drawable) that have color sufficiently close to the specified color +(as determined by the threshold and criterion context values) are +included in the selection. To select transparent regions, the color +specified must also have minimum alpha.

+

This procedure is affected by the following context setters: +gimp_context_set_antialias(), gimp_context_set_feather(), +gimp_context_set_feather_radius(), gimp_context_set_sample_merged(), +gimp_context_set_sample_criterion(), +gimp_context_set_sample_threshold(), +gimp_context_set_sample_transparent().

+

In the case of a merged sampling, the supplied drawable is ignored.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

image_ID

The affected image.

 

operation

The selection operation.

 

drawable_ID

The affected drawable.

 

color

The color to select.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_image_select_contiguous_color ()

+
gboolean
+gimp_image_select_contiguous_color (gint32 image_ID,
+                                    GimpChannelOps operation,
+                                    gint32 drawable_ID,
+                                    gdouble x,
+                                    gdouble y);
+

Create a selection by selecting all pixels around specified +coordinates with the same (or similar) color to that at the +coordinates.

+

This tool creates a contiguous selection over the specified image. A +contiguous color selection is determined by a seed fill under the +constraints of the current context settings. Essentially, the color +at the specified coordinates (in the drawable) is measured and the +selection expands outwards from that point to any adjacent pixels +which are not significantly different (as determined by the +threshold and criterion context settings). This process continues +until no more expansion is possible. If antialiasing is turned on, +the final selection mask will contain intermediate values based on +close misses to the threshold bar at pixels along the seed fill +boundary.

+

This procedure is affected by the following context setters: +gimp_context_set_antialias(), gimp_context_set_feather(), +gimp_context_set_feather_radius(), gimp_context_set_sample_merged(), +gimp_context_set_sample_criterion(), +gimp_context_set_sample_threshold(), +gimp_context_set_sample_transparent(), +gimp_context_set_diagonal_neighbors().

+

In the case of a merged sampling, the supplied drawable is ignored. +If the sample is merged, the specified coordinates are relative to +the image origin; otherwise, they are relative to the drawable's +origin.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

image_ID

The affected image.

 

operation

The selection operation.

 

drawable_ID

The affected drawable.

 

x

x coordinate of initial seed fill point: (image coordinates).

 

y

y coordinate of initial seed fill point: (image coordinates).

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_image_select_rectangle ()

+
gboolean
+gimp_image_select_rectangle (gint32 image_ID,
+                             GimpChannelOps operation,
+                             gdouble x,
+                             gdouble y,
+                             gdouble width,
+                             gdouble height);
+

Create a rectangular selection over the specified image;

+

This tool creates a rectangular selection over the specified image. +The rectangular region can be either added to, subtracted from, or +replace the contents of the previous selection mask.

+

This procedure is affected by the following context setters: +gimp_context_set_feather(), gimp_context_set_feather_radius().

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

operation

The selection operation.

 

x

x coordinate of upper-left corner of rectangle.

 

y

y coordinate of upper-left corner of rectangle.

 

width

The width of the rectangle.

 

height

The height of the rectangle.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_image_select_round_rectangle ()

+
gboolean
+gimp_image_select_round_rectangle (gint32 image_ID,
+                                   GimpChannelOps operation,
+                                   gdouble x,
+                                   gdouble y,
+                                   gdouble width,
+                                   gdouble height,
+                                   gdouble corner_radius_x,
+                                   gdouble corner_radius_y);
+

Create a rectangular selection with round corners over the specified +image;

+

This tool creates a rectangular selection with round corners over +the specified image. The rectangular region can be either added to, +subtracted from, or replace the contents of the previous selection +mask.

+

This procedure is affected by the following context setters: +gimp_context_set_antialias(), gimp_context_set_feather(), +gimp_context_set_feather_radius().

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

operation

The selection operation.

 

x

x coordinate of upper-left corner of rectangle.

 

y

y coordinate of upper-left corner of rectangle.

 

width

The width of the rectangle.

 

height

The height of the rectangle.

 

corner_radius_x

The corner radius in X direction.

 

corner_radius_y

The corner radius in Y direction.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_image_select_ellipse ()

+
gboolean
+gimp_image_select_ellipse (gint32 image_ID,
+                           GimpChannelOps operation,
+                           gdouble x,
+                           gdouble y,
+                           gdouble width,
+                           gdouble height);
+

Create an elliptical selection over the specified image.

+

This tool creates an elliptical selection over the specified image. +The elliptical region can be either added to, subtracted from, or +replace the contents of the previous selection mask.

+

This procedure is affected by the following context setters: +gimp_context_set_antialias(), gimp_context_set_feather(), +gimp_context_set_feather_radius().

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

operation

The selection operation.

 

x

x coordinate of upper-left corner of ellipse bounding box.

 

y

y coordinate of upper-left corner of ellipse bounding box.

 

width

The width of the ellipse.

 

height

The height of the ellipse.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_image_select_polygon ()

+
gboolean
+gimp_image_select_polygon (gint32 image_ID,
+                           GimpChannelOps operation,
+                           gint num_segs,
+                           const gdouble *segs);
+

Create a polygonal selection over the specified image.

+

This tool creates a polygonal selection over the specified image. +The polygonal region can be either added to, subtracted from, or +replace the contents of the previous selection mask. The polygon is +specified through an array of floating point numbers and its length. +The length of array must be 2n, where n is the number of points. +Each point is defined by 2 floating point values which correspond to +the x and y coordinates. If the final point does not connect to the +starting point, a connecting segment is automatically added.

+

This procedure is affected by the following context setters: +gimp_context_set_antialias(), gimp_context_set_feather(), +gimp_context_set_feather_radius().

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

operation

The selection operation.

 

num_segs

Number of points (count 1 coordinate as two points).

 

segs

Array of points: { p1.x, p1.y, p2.x, p2.y, ..., pn.x, pn.y}.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_image_select_item ()

+
gboolean
+gimp_image_select_item (gint32 image_ID,
+                        GimpChannelOps operation,
+                        gint32 item_ID);
+

Transforms the specified item into a selection

+

This procedure renders the item's outline into the current selection +of the image the item belongs to. What exactly the item's outline is +depends on the item type: for layers, it's the layer's alpha +channel, for vectors the vector's shape.

+

This procedure is affected by the following context setters: +gimp_context_set_antialias(), gimp_context_set_feather(), +gimp_context_set_feather_radius().

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

operation

The desired operation with current selection.

 

item_ID

The item to render to the selection.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpimagetransform.html b/devel-docs/libgimp/html/libgimp-gimpimagetransform.html new file mode 100644 index 0000000..0d662ce --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpimagetransform.html @@ -0,0 +1,424 @@ + + + + +gimpimagetransform: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpimagetransform

+

gimpimagetransform — Transformations on images.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+gboolean + +gimp_image_resize () +
+gboolean + +gimp_image_resize_to_layers () +
+gboolean + +gimp_image_scale () +
+gboolean + +gimp_image_scale_full () +
+gboolean + +gimp_image_crop () +
+gboolean + +gimp_image_flip () +
+gboolean + +gimp_image_rotate () +
+
+
+

Description

+

Operations to scale, resize, crop, flip and rotate images.

+
+
+

Functions

+
+

gimp_image_resize ()

+
gboolean
+gimp_image_resize (gint32 image_ID,
+                   gint new_width,
+                   gint new_height,
+                   gint offx,
+                   gint offy);
+

Resize the image to the specified extents.

+

This procedure resizes the image so that it's new width and height +are equal to the supplied parameters. Offsets are also provided +which describe the position of the previous image's content. All +channels within the image are resized according to the specified +parameters; this includes the image selection mask. All layers +within the image are repositioned according to the specified +offsets.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

new_width

New image width.

 

new_height

New image height.

 

offx

x offset between upper left corner of old and new images: (new - old).

 

offy

y offset between upper left corner of old and new images: (new - old).

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_resize_to_layers ()

+
gboolean
+gimp_image_resize_to_layers (gint32 image_ID);
+

Resize the image to fit all layers.

+

This procedure resizes the image to the bounding box of all layers +of the image. All channels within the image are resized to the new +size; this includes the image selection mask. All layers within the +image are repositioned to the new image area.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_image_scale ()

+
gboolean
+gimp_image_scale (gint32 image_ID,
+                  gint new_width,
+                  gint new_height);
+

Scale the image using the default interpolation method.

+

This procedure scales the image so that its new width and height are +equal to the supplied parameters. All layers and channels within the +image are scaled according to the specified parameters; this +includes the image selection mask. The interpolation method used can +be set with gimp_context_set_interpolation().

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

new_width

New image width.

 

new_height

New image height.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_scale_full ()

+
gboolean
+gimp_image_scale_full (gint32 image_ID,
+                       gint new_width,
+                       gint new_height,
+                       GimpInterpolationType interpolation);
+
+

gimp_image_scale_full is deprecated and should not be used in newly-written code.

+

Use gimp_image_scale() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

new_width

New image width.

 

new_height

New image height.

 

interpolation

Type of interpolation.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.6

+
+
+
+

gimp_image_crop ()

+
gboolean
+gimp_image_crop (gint32 image_ID,
+                 gint new_width,
+                 gint new_height,
+                 gint offx,
+                 gint offy);
+

Crop the image to the specified extents.

+

This procedure crops the image so that it's new width and height are +equal to the supplied parameters. Offsets are also provided which +describe the position of the previous image's content. All channels +and layers within the image are cropped to the new image extents; +this includes the image selection mask. If any parameters are out of +range, an error is returned.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

new_width

New image width: (0 < new_width <= width).

 

new_height

New image height: (0 < new_height <= height).

 

offx

X offset: (0 <= offx <= (width - new_width)).

 

offy

Y offset: (0 <= offy <= (height - new_height)).

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_flip ()

+
gboolean
+gimp_image_flip (gint32 image_ID,
+                 GimpOrientationType flip_type);
+

Flips the image horizontally or vertically.

+

This procedure flips (mirrors) the image.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

flip_type

Type of flip.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_rotate ()

+
gboolean
+gimp_image_rotate (gint32 image_ID,
+                   GimpRotationType rotate_type);
+

Rotates the image by the specified degrees.

+

This procedure rotates the image.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

rotate_type

Angle of rotation.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpimageundo.html b/devel-docs/libgimp/html/libgimp-gimpimageundo.html new file mode 100644 index 0000000..a00d0b7 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpimageundo.html @@ -0,0 +1,333 @@ + + + + +gimpimageundo: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpimageundo

+

gimpimageundo — Control of image undo/redo.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+gboolean + +gimp_image_undo_group_start () +
+gboolean + +gimp_image_undo_group_end () +
+gboolean + +gimp_image_undo_is_enabled () +
+gboolean + +gimp_image_undo_disable () +
+gboolean + +gimp_image_undo_enable () +
+gboolean + +gimp_image_undo_freeze () +
+gboolean + +gimp_image_undo_thaw () +
+
+
+

Description

+

Control of image undo/redo.

+
+
+

Functions

+
+

gimp_image_undo_group_start ()

+
gboolean
+gimp_image_undo_group_start (gint32 image_ID);
+

Starts a group undo.

+

This function is used to start a group undo--necessary for logically +combining two or more undo operations into a single operation. This +call must be used in conjunction with a gimp_image_undo_group_end() +call.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The ID of the image in which to open an undo group.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_undo_group_end ()

+
gboolean
+gimp_image_undo_group_end (gint32 image_ID);
+

Finish a group undo.

+

This function must be called once for each +gimp_image_undo_group_start() call that is made.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The ID of the image in which to close an undo group.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_image_undo_is_enabled ()

+
gboolean
+gimp_image_undo_is_enabled (gint32 image_ID);
+

Check if the image's undo stack is enabled.

+

This procedure checks if the image's undo stack is currently enabled +or disabled. This is useful when several plug-ins or scripts call +each other and want to check if their caller has already used +gimp_image_undo_disable() or gimp_image_undo_freeze().

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

TRUE if undo is enabled for this image.

+
+
+
+
+

gimp_image_undo_disable ()

+
gboolean
+gimp_image_undo_disable (gint32 image_ID);
+

Disable the image's undo stack.

+

This procedure disables the image's undo stack, allowing subsequent +operations to ignore their undo steps. This is generally called in +conjunction with gimp_image_undo_enable() to temporarily disable an +image undo stack. This is advantageous because saving undo steps can +be time and memory intensive.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

TRUE if the image undo has been disabled.

+
+
+
+
+

gimp_image_undo_enable ()

+
gboolean
+gimp_image_undo_enable (gint32 image_ID);
+

Enable the image's undo stack.

+

This procedure enables the image's undo stack, allowing subsequent +operations to store their undo steps. This is generally called in +conjunction with gimp_image_undo_disable() to temporarily disable an +image undo stack.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

TRUE if the image undo has been enabled.

+
+
+
+
+

gimp_image_undo_freeze ()

+
gboolean
+gimp_image_undo_freeze (gint32 image_ID);
+

Freeze the image's undo stack.

+

This procedure freezes the image's undo stack, allowing subsequent +operations to ignore their undo steps. This is generally called in +conjunction with gimp_image_undo_thaw() to temporarily disable an +image undo stack. This is advantageous because saving undo steps can +be time and memory intensive. gimp_image_undo_freeze() / +gimp_image_undo_thaw() and gimp_image_undo_disable() / +gimp_image_undo_enable() differ in that the former does not free up +all undo steps when undo is thawed, so is more suited to interactive +in-situ previews. It is important in this case that the image is +back to the same state it was frozen in before thawing, else 'undo' +behaviour is undefined.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

TRUE if the image undo has been frozen.

+
+
+
+
+

gimp_image_undo_thaw ()

+
gboolean
+gimp_image_undo_thaw (gint32 image_ID);
+

Thaw the image's undo stack.

+

This procedure thaws the image's undo stack, allowing subsequent +operations to store their undo steps. This is generally called in +conjunction with gimp_image_undo_freeze() to temporarily freeze an +image undo stack. gimp_image_undo_thaw() does NOT free the undo +stack as gimp_image_undo_enable() does, so is suited for situations +where one wishes to leave the undo stack in the same state in which +one found it despite non-destructively playing with the image in the +meantime. An example would be in-situ plug-in previews. Balancing +freezes and thaws and ensuring image consistency is the +responsibility of the caller.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

TRUE if the image undo has been thawed.

+
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpitem.html b/devel-docs/libgimp/html/libgimp-gimpitem.html new file mode 100644 index 0000000..892b323 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpitem.html @@ -0,0 +1,1361 @@ + + + + +gimpitem: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpitem

+

gimpitem — Functions to manipulate items.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+gboolean + +gimp_item_is_valid () +
+gint32 + +gimp_item_get_image () +
+gboolean + +gimp_item_delete () +
+gboolean + +gimp_item_is_drawable () +
+gboolean + +gimp_item_is_layer () +
+gboolean + +gimp_item_is_text_layer () +
+gboolean + +gimp_item_is_channel () +
+gboolean + +gimp_item_is_layer_mask () +
+gboolean + +gimp_item_is_selection () +
+gboolean + +gimp_item_is_vectors () +
+gboolean + +gimp_item_is_group () +
+gint32 + +gimp_item_get_parent () +
+gint * + +gimp_item_get_children () +
+gboolean + +gimp_item_get_expanded () +
+gboolean + +gimp_item_set_expanded () +
+gchar * + +gimp_item_get_name () +
+gboolean + +gimp_item_set_name () +
+gboolean + +gimp_item_get_visible () +
+gboolean + +gimp_item_set_visible () +
+gboolean + +gimp_item_get_linked () +
+gboolean + +gimp_item_set_linked () +
+gboolean + +gimp_item_get_lock_content () +
+gboolean + +gimp_item_set_lock_content () +
+gboolean + +gimp_item_get_lock_position () +
+gboolean + +gimp_item_set_lock_position () +
+GimpColorTag + +gimp_item_get_color_tag () +
+gboolean + +gimp_item_set_color_tag () +
+gint + +gimp_item_get_tattoo () +
+gboolean + +gimp_item_set_tattoo () +
+gboolean + +gimp_item_attach_parasite () +
+gboolean + +gimp_item_detach_parasite () +
+GimpParasite * + +gimp_item_get_parasite () +
+gchar ** + +gimp_item_get_parasite_list () +
+
+
+

Description

+

Functions to manipulate items.

+
+
+

Functions

+
+

gimp_item_is_valid ()

+
gboolean
+gimp_item_is_valid (gint32 item_ID);
+

Returns TRUE if the item is valid.

+

This procedure checks if the given item ID is valid and refers to an +existing item.

+
+

Parameters

+
+++++ + + + + + +

item_ID

The item to check.

 
+
+
+

Returns

+

Whether the item ID is valid.

+
+

Since: 2.8

+
+
+
+

gimp_item_get_image ()

+
gint32
+gimp_item_get_image (gint32 item_ID);
+

Returns the item's image.

+

This procedure returns the item's image.

+
+

Parameters

+
+++++ + + + + + +

item_ID

The item.

 
+
+
+

Returns

+

The item's image.

+
+

Since: 2.8

+
+
+
+

gimp_item_delete ()

+
gboolean
+gimp_item_delete (gint32 item_ID);
+

Delete a item.

+

This procedure deletes the specified item. This must not be done if +the image containing this item was already deleted or if the item +was already removed from the image. The only case in which this +procedure is useful is if you want to get rid of a item which has +not yet been added to an image.

+
+

Parameters

+
+++++ + + + + + +

item_ID

The item to delete.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_item_is_drawable ()

+
gboolean
+gimp_item_is_drawable (gint32 item_ID);
+

Returns whether the item is a drawable.

+

This procedure returns TRUE if the specified item is a drawable.

+
+

Parameters

+
+++++ + + + + + +

item_ID

The item.

 
+
+
+

Returns

+

TRUE if the item is a drawable, FALSE otherwise.

+
+

Since: 2.8

+
+
+
+

gimp_item_is_layer ()

+
gboolean
+gimp_item_is_layer (gint32 item_ID);
+

Returns whether the item is a layer.

+

This procedure returns TRUE if the specified item is a layer.

+
+

Parameters

+
+++++ + + + + + +

item_ID

The item.

 
+
+
+

Returns

+

TRUE if the item is a layer, FALSE otherwise.

+
+

Since: 2.8

+
+
+
+

gimp_item_is_text_layer ()

+
gboolean
+gimp_item_is_text_layer (gint32 item_ID);
+

Returns whether the item is a text layer.

+

This procedure returns TRUE if the specified item is a text layer.

+
+

Parameters

+
+++++ + + + + + +

item_ID

The item.

 
+
+
+

Returns

+

TRUE if the item is a text layer, FALSE otherwise.

+
+

Since: 2.8

+
+
+
+

gimp_item_is_channel ()

+
gboolean
+gimp_item_is_channel (gint32 item_ID);
+

Returns whether the item is a channel.

+

This procedure returns TRUE if the specified item is a channel.

+
+

Parameters

+
+++++ + + + + + +

item_ID

The item.

 
+
+
+

Returns

+

TRUE if the item is a channel, FALSE otherwise.

+
+

Since: 2.8

+
+
+
+

gimp_item_is_layer_mask ()

+
gboolean
+gimp_item_is_layer_mask (gint32 item_ID);
+

Returns whether the item is a layer mask.

+

This procedure returns TRUE if the specified item is a layer mask.

+
+

Parameters

+
+++++ + + + + + +

item_ID

The item.

 
+
+
+

Returns

+

TRUE if the item is a layer mask, FALSE otherwise.

+
+

Since: 2.8

+
+
+
+

gimp_item_is_selection ()

+
gboolean
+gimp_item_is_selection (gint32 item_ID);
+

Returns whether the item is a selection.

+

This procedure returns TRUE if the specified item is a selection.

+
+

Parameters

+
+++++ + + + + + +

item_ID

The item.

 
+
+
+

Returns

+

TRUE if the item is a selection, FALSE otherwise.

+
+

Since: 2.8

+
+
+
+

gimp_item_is_vectors ()

+
gboolean
+gimp_item_is_vectors (gint32 item_ID);
+

Returns whether the item is a vectors.

+

This procedure returns TRUE if the specified item is a vectors.

+
+

Parameters

+
+++++ + + + + + +

item_ID

The item.

 
+
+
+

Returns

+

TRUE if the item is a vectors, FALSE otherwise.

+
+

Since: 2.8

+
+
+
+

gimp_item_is_group ()

+
gboolean
+gimp_item_is_group (gint32 item_ID);
+

Returns whether the item is a group item.

+

This procedure returns TRUE if the specified item is a group item +which can have children.

+
+

Parameters

+
+++++ + + + + + +

item_ID

The item.

 
+
+
+

Returns

+

TRUE if the item is a group, FALSE otherwise.

+
+

Since: 2.8

+
+
+
+

gimp_item_get_parent ()

+
gint32
+gimp_item_get_parent (gint32 item_ID);
+

Returns the item's parent item.

+

This procedure returns the item's parent item, if any.

+
+

Parameters

+
+++++ + + + + + +

item_ID

The item.

 
+
+
+

Returns

+

The item's parent item.

+
+

Since: 2.8

+
+
+
+

gimp_item_get_children ()

+
gint *
+gimp_item_get_children (gint32 item_ID,
+                        gint *num_children);
+

Returns the item's list of children.

+

This procedure returns the list of items which are children of the +specified item. The order is topmost to bottommost.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

item_ID

The item.

 

num_children

The item's number of children.

 
+
+
+

Returns

+

The item's list of children.

+
+

Since: 2.8

+
+
+
+

gimp_item_get_expanded ()

+
gboolean
+gimp_item_get_expanded (gint32 item_ID);
+

Returns whether the item is expanded.

+

This procedure returns TRUE if the specified item is expanded.

+
+

Parameters

+
+++++ + + + + + +

item_ID

The item.

 
+
+
+

Returns

+

TRUE if the item is expanded, FALSE otherwise.

+
+

Since: 2.10

+
+
+
+

gimp_item_set_expanded ()

+
gboolean
+gimp_item_set_expanded (gint32 item_ID,
+                        gboolean expanded);
+

Sets the expanded state of the item.

+

This procedure expands or collapses the item.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

item_ID

The item.

 

expanded

TRUE to expand the item, FALSE to collapse the item.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_item_get_name ()

+
gchar *
+gimp_item_get_name (gint32 item_ID);
+

Get the name of the specified item.

+

This procedure returns the specified item's name.

+
+

Parameters

+
+++++ + + + + + +

item_ID

The item.

 
+
+
+

Returns

+

The item name.

+
+

Since: 2.8

+
+
+
+

gimp_item_set_name ()

+
gboolean
+gimp_item_set_name (gint32 item_ID,
+                    const gchar *name);
+

Set the name of the specified item.

+

This procedure sets the specified item's name.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

item_ID

The item.

 

name

The new item name.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_item_get_visible ()

+
gboolean
+gimp_item_get_visible (gint32 item_ID);
+

Get the visibility of the specified item.

+

This procedure returns the specified item's visibility.

+
+

Parameters

+
+++++ + + + + + +

item_ID

The item.

 
+
+
+

Returns

+

The item visibility.

+
+

Since: 2.8

+
+
+
+

gimp_item_set_visible ()

+
gboolean
+gimp_item_set_visible (gint32 item_ID,
+                       gboolean visible);
+

Set the visibility of the specified item.

+

This procedure sets the specified item's visibility.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

item_ID

The item.

 

visible

The new item visibility.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_item_get_linked ()

+
gboolean
+gimp_item_get_linked (gint32 item_ID);
+

Get the linked state of the specified item.

+

This procedure returns the specified item's linked state.

+
+

Parameters

+
+++++ + + + + + +

item_ID

The item.

 
+
+
+

Returns

+

The item linked state (for moves).

+
+

Since: 2.8

+
+
+
+

gimp_item_set_linked ()

+
gboolean
+gimp_item_set_linked (gint32 item_ID,
+                      gboolean linked);
+

Set the linked state of the specified item.

+

This procedure sets the specified item's linked state.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

item_ID

The item.

 

linked

The new item linked state.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_item_get_lock_content ()

+
gboolean
+gimp_item_get_lock_content (gint32 item_ID);
+

Get the 'lock content' state of the specified item.

+

This procedure returns the specified item's lock content state.

+
+

Parameters

+
+++++ + + + + + +

item_ID

The item.

 
+
+
+

Returns

+

Whether the item's contents are locked.

+
+

Since: 2.8

+
+
+
+

gimp_item_set_lock_content ()

+
gboolean
+gimp_item_set_lock_content (gint32 item_ID,
+                            gboolean lock_content);
+

Set the 'lock content' state of the specified item.

+

This procedure sets the specified item's lock content state.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

item_ID

The item.

 

lock_content

The new item 'lock content' state.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_item_get_lock_position ()

+
gboolean
+gimp_item_get_lock_position (gint32 item_ID);
+

Get the 'lock position' state of the specified item.

+

This procedure returns the specified item's lock position state.

+
+

Parameters

+
+++++ + + + + + +

item_ID

The item.

 
+
+
+

Returns

+

Whether the item's position is locked.

+
+

Since: 2.10

+
+
+
+

gimp_item_set_lock_position ()

+
gboolean
+gimp_item_set_lock_position (gint32 item_ID,
+                             gboolean lock_position);
+

Set the 'lock position' state of the specified item.

+

This procedure sets the specified item's lock position state.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

item_ID

The item.

 

lock_position

The new item 'lock position' state.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_item_get_color_tag ()

+
GimpColorTag
+gimp_item_get_color_tag (gint32 item_ID);
+

Get the color tag of the specified item.

+

This procedure returns the specified item's color tag.

+
+

Parameters

+
+++++ + + + + + +

item_ID

The item.

 
+
+
+

Returns

+

The item's color tag.

+
+

Since: 2.10

+
+
+
+

gimp_item_set_color_tag ()

+
gboolean
+gimp_item_set_color_tag (gint32 item_ID,
+                         GimpColorTag color_tag);
+

Set the color tag of the specified item.

+

This procedure sets the specified item's color tag.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

item_ID

The item.

 

color_tag

The new item color tag.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_item_get_tattoo ()

+
gint
+gimp_item_get_tattoo (gint32 item_ID);
+

Get the tattoo of the specified item.

+

This procedure returns the specified item's tattoo. A tattoo is a +unique and permanent identifier attached to a item that can be used +to uniquely identify a item within an image even between sessions.

+
+

Parameters

+
+++++ + + + + + +

item_ID

The item.

 
+
+
+

Returns

+

The item tattoo.

+
+

Since: 2.8

+
+
+
+

gimp_item_set_tattoo ()

+
gboolean
+gimp_item_set_tattoo (gint32 item_ID,
+                      gint tattoo);
+

Set the tattoo of the specified item.

+

This procedure sets the specified item's tattoo. A tattoo is a +unique and permanent identifier attached to a item that can be used +to uniquely identify a item within an image even between sessions.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

item_ID

The item.

 

tattoo

The new item tattoo.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_item_attach_parasite ()

+
gboolean
+gimp_item_attach_parasite (gint32 item_ID,
+                           const GimpParasite *parasite);
+

Add a parasite to an item.

+

This procedure attaches a parasite to an item. It has no return +values.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

item_ID

The item.

 

parasite

The parasite to attach to the item.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_item_detach_parasite ()

+
gboolean
+gimp_item_detach_parasite (gint32 item_ID,
+                           const gchar *name);
+

Removes a parasite from an item.

+

This procedure detaches a parasite from an item. It has no return +values.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

item_ID

The item.

 

name

The name of the parasite to detach from the item.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_item_get_parasite ()

+
GimpParasite *
+gimp_item_get_parasite (gint32 item_ID,
+                        const gchar *name);
+

Look up a parasite in an item

+

Finds and returns the parasite that is attached to an item.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

item_ID

The item.

 

name

The name of the parasite to find.

 
+
+
+

Returns

+

The found parasite.

+
+

Since: 2.8

+
+
+
+

gimp_item_get_parasite_list ()

+
gchar **
+gimp_item_get_parasite_list (gint32 item_ID,
+                             gint *num_parasites);
+

List all parasites.

+

Returns a list of all parasites currently attached the an item.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

item_ID

The item.

 

num_parasites

The number of attached parasites.

 
+
+
+

Returns

+

The names of currently attached parasites. The returned +value must be freed with g_strfreev().

+
+

Since: 2.8

+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpitemtransform.html b/devel-docs/libgimp/html/libgimp-gimpitemtransform.html new file mode 100644 index 0000000..501e07b --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpitemtransform.html @@ -0,0 +1,885 @@ + + + + +gimpitemtransform: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpitemtransform

+

gimpitemtransform — Functions to perform transformations on items.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+gint32 + +gimp_item_transform_translate () +
+gint32 + +gimp_item_transform_flip_simple () +
+gint32 + +gimp_item_transform_flip () +
+gint32 + +gimp_item_transform_perspective () +
+gint32 + +gimp_item_transform_rotate_simple () +
+gint32 + +gimp_item_transform_rotate () +
+gint32 + +gimp_item_transform_scale () +
+gint32 + +gimp_item_transform_shear () +
+gint32 + +gimp_item_transform_2d () +
+gint32 + +gimp_item_transform_matrix () +
+
+
+

Description

+

Functions to perform transformations on items.

+
+
+

Functions

+
+

gimp_item_transform_translate ()

+
gint32
+gimp_item_transform_translate (gint32 item_ID,
+                               gdouble off_x,
+                               gdouble off_y);
+

Translate the item by the specified offsets.

+

This procedure translates the item by the amounts specified in the +off_x and off_y arguments. These can be negative, and are considered +offsets from the current position. The offsets will be rounded to +the nearest pixel unless the item is a path.

+

If the item is attached to an image and has its linked flag set to +TRUE, all additional items contained in the image which have the +linked flag set to TRUE will also be translated by the specified +offsets.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

item_ID

The item.

 

off_x

Offset in x direction.

 

off_y

Offset in y direction.

 
+
+
+

Returns

+

The translated item.

+
+

Since: 2.10

+
+
+
+

gimp_item_transform_flip_simple ()

+
gint32
+gimp_item_transform_flip_simple (gint32 item_ID,
+                                 GimpOrientationType flip_type,
+                                 gboolean auto_center,
+                                 gdouble axis);
+

Flip the specified item either vertically or horizontally.

+

This procedure flips the specified item.

+

If a selection exists and the item is a drawable, the portion of the +drawable which lies under the selection is cut from the drawable and +made into a floating selection which is then flipped. If auto_center +is set to TRUE, the flip is around the selection's center. +Otherwise, the coordinate of the axis needs to be specified. The +return value is the ID of the flipped floating selection.

+

If there is no selection or the item is not a drawable, the entire +item will be flipped around its center if auto_center is set to +TRUE, otherwise the coordinate of the axis needs to be specified. +Additionally, if the item has its linked flag set to TRUE, all +additional items contained in the image which have the linked flag +set to TRUE will also be flipped around the same axis. The return +value will be equal to the item ID supplied as input.

+

This procedure is affected by the following context setters: +gimp_context_set_transform_resize().

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

item_ID

The affected item.

 

flip_type

Type of flip.

 

auto_center

Whether to automatically position the axis in the selection center.

 

axis

coord. of flip axis.

 
+
+
+

Returns

+

The flipped item.

+
+

Since: 2.2

+
+
+
+

gimp_item_transform_flip ()

+
gint32
+gimp_item_transform_flip (gint32 item_ID,
+                          gdouble x0,
+                          gdouble y0,
+                          gdouble x1,
+                          gdouble y1);
+

Flip the specified item around a given line.

+

This procedure flips the specified item.

+

If a selection exists and the item is a drawable, the portion of the +drawable which lies under the selection is cut from the drawable and +made into a floating selection which is then flipped. The axis to +flip around is specified by specifying two points from that line. +The return value is the ID of the flipped floating selection.

+

If there is no selection or the item is not a drawable, the entire +item will be flipped around the specified axis. Additionally, if the +item has its linked flag set to TRUE, all additional items contained +in the image which have the linked flag set to TRUE will also be +flipped around the same axis. The return value will be equal to the +item ID supplied as input.

+

This procedure is affected by the following context setters: +gimp_context_set_interpolation(), +gimp_context_set_transform_direction(), +gimp_context_set_transform_resize().

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

item_ID

The affected item.

 

x0

horz. coord. of one end of axis.

 

y0

vert. coord. of one end of axis.

 

x1

horz. coord. of other end of axis.

 

y1

vert. coord. of other end of axis.

 
+
+
+

Returns

+

The flipped item.

+
+

Since: 2.8

+
+
+
+

gimp_item_transform_perspective ()

+
gint32
+gimp_item_transform_perspective (gint32 item_ID,
+                                 gdouble x0,
+                                 gdouble y0,
+                                 gdouble x1,
+                                 gdouble y1,
+                                 gdouble x2,
+                                 gdouble y2,
+                                 gdouble x3,
+                                 gdouble y3);
+

Perform a possibly non-affine transformation on the specified item.

+

This procedure performs a possibly non-affine transformation on the +specified item by allowing the corners of the original bounding box +to be arbitrarily remapped to any values.

+

The 4 coordinates specify the new locations of each corner of the +original bounding box. By specifying these values, any affine +transformation (rotation, scaling, translation) can be affected. +Additionally, these values can be specified such that the resulting +transformed item will appear to have been projected via a +perspective transform.

+

If a selection exists and the item is a drawable, the portion of the +drawable which lies under the selection is cut from the drawable and +made into a floating selection which is then transformed as +specified. The return value is the ID of the transformed floating +selection.

+

If there is no selection or the item is not a drawable, the entire +item will be transformed according to the specified mapping. +Additionally, if the item has its linked flag set to TRUE, all +additional items contained in the image which have the linked flag +set to TRUE will also be transformed the same way. The return value +will be equal to the item ID supplied as input.

+

This procedure is affected by the following context setters: +gimp_context_set_interpolation(), +gimp_context_set_transform_direction(), +gimp_context_set_transform_resize().

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

item_ID

The affected item.

 

x0

The new x coordinate of upper-left corner of original bounding box.

 

y0

The new y coordinate of upper-left corner of original bounding box.

 

x1

The new x coordinate of upper-right corner of original bounding box.

 

y1

The new y coordinate of upper-right corner of original bounding box.

 

x2

The new x coordinate of lower-left corner of original bounding box.

 

y2

The new y coordinate of lower-left corner of original bounding box.

 

x3

The new x coordinate of lower-right corner of original bounding box.

 

y3

The new y coordinate of lower-right corner of original bounding box.

 
+
+
+

Returns

+

The transformed item.

+
+

Since: 2.8

+
+
+
+

gimp_item_transform_rotate_simple ()

+
gint32
+gimp_item_transform_rotate_simple (gint32 item_ID,
+                                   GimpRotationType rotate_type,
+                                   gboolean auto_center,
+                                   gdouble center_x,
+                                   gdouble center_y);
+

Rotate the specified item about given coordinates through the +specified angle.

+

This function rotates the specified item.

+

If a selection exists and the item is a drawable, the portion of the +drawable which lies under the selection is cut from the drawable and +made into a floating selection which is then rotated by the +specified amount. If auto_center is set to TRUE, the rotation is +around the selection's center. Otherwise, the coordinate of the +center point needs to be specified. The return value is the ID of +the rotated floating selection.

+

If there is no selection or the item is not a drawable, the entire +item will be rotated around its center if auto_center is set to +TRUE, otherwise the coordinate of the center point needs to be +specified. Additionally, if the item has its linked flag set to +TRUE, all additional items contained in the image which have the +linked flag set to TRUE will also be rotated around the same center +point. The return value will be equal to the item ID supplied as +input.

+

This procedure is affected by the following context setters: +gimp_context_set_transform_resize().

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

item_ID

The affected item.

 

rotate_type

Type of rotation.

 

auto_center

Whether to automatically rotate around the selection center.

 

center_x

The hor. coordinate of the center of rotation.

 

center_y

The vert. coordinate of the center of rotation.

 
+
+
+

Returns

+

The rotated item.

+
+

Since: 2.8

+
+
+
+

gimp_item_transform_rotate ()

+
gint32
+gimp_item_transform_rotate (gint32 item_ID,
+                            gdouble angle,
+                            gboolean auto_center,
+                            gdouble center_x,
+                            gdouble center_y);
+

Rotate the specified item about given coordinates through the +specified angle.

+

This function rotates the specified item.

+

If a selection exists and the item is a drawable, the portion of the +drawable which lies under the selection is cut from the drawable and +made into a floating selection which is then rotated by the +specified amount. If auto_center is set to TRUE, the rotation is +around the selection's center. Otherwise, the coordinate of the +center point needs to be specified. The return value is the ID of +the rotated floating selection.

+

If there is no selection or the item is not a drawable, the entire +item will be rotated around its center if auto_center is set to +TRUE, otherwise the coordinate of the center point needs to be +specified. Additionally, if the item has its linked flag set to +TRUE, all additional items contained in the image which have the +linked flag set to TRUE will also be rotated around the same center +point. The return value will be equal to the item ID supplied as +input.

+

This procedure is affected by the following context setters: +gimp_context_set_interpolation(), +gimp_context_set_transform_direction(), +gimp_context_set_transform_resize().

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

item_ID

The affected item.

 

angle

The angle of rotation (radians).

 

auto_center

Whether to automatically rotate around the selection center.

 

center_x

The hor. coordinate of the center of rotation.

 

center_y

The vert. coordinate of the center of rotation.

 
+
+
+

Returns

+

The rotated item.

+
+

Since: 2.8

+
+
+
+

gimp_item_transform_scale ()

+
gint32
+gimp_item_transform_scale (gint32 item_ID,
+                           gdouble x0,
+                           gdouble y0,
+                           gdouble x1,
+                           gdouble y1);
+

Scale the specified item.

+

This procedure scales the specified item.

+

The 2 coordinates specify the new locations of the top-left and +bottom-roght corners of the original bounding box.

+

If a selection exists and the item is a drawable, the portion of the +drawable which lies under the selection is cut from the drawable and +made into a floating selection which is then scaled as specified. +The return value is the ID of the scaled floating selection.

+

If there is no selection or the item is not a drawable, the entire +item will be scaled according to the specified coordinates. +Additionally, if the item has its linked flag set to TRUE, all +additional items contained in the image which have the linked flag +set to TRUE will also be scaled the same way. The return value will +be equal to the item ID supplied as input.

+

This procedure is affected by the following context setters: +gimp_context_set_interpolation(), +gimp_context_set_transform_direction(), +gimp_context_set_transform_resize().

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

item_ID

The affected item.

 

x0

The new x coordinate of the upper-left corner of the scaled region.

 

y0

The new y coordinate of the upper-left corner of the scaled region.

 

x1

The new x coordinate of the lower-right corner of the scaled region.

 

y1

The new y coordinate of the lower-right corner of the scaled region.

 
+
+
+

Returns

+

The scaled item.

+
+

Since: 2.8

+
+
+
+

gimp_item_transform_shear ()

+
gint32
+gimp_item_transform_shear (gint32 item_ID,
+                           GimpOrientationType shear_type,
+                           gdouble magnitude);
+

Shear the specified item about its center by the specified +magnitude.

+

This procedure shears the specified item.

+

The shear type parameter indicates whether the shear will be applied +horizontally or vertically. The magnitude can be either positive or +negative and indicates the extent (in pixels) to shear by.

+

If a selection exists and the item is a drawable, the portion of the +drawable which lies under the selection is cut from the drawable and +made into a floating selection which is then sheared as specified. +The return value is the ID of the sheared floating selection.

+

If there is no selection or the item is not a drawable, the entire +item will be sheared according to the specified parameters. +Additionally, if the item has its linked flag set to TRUE, all +additional items contained in the image which have the linked flag +set to TRUE will also be sheared the same way. The return value will +be equal to the item ID supplied as input.

+

This procedure is affected by the following context setters: +gimp_context_set_interpolation(), +gimp_context_set_transform_direction(), +gimp_context_set_transform_resize().

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

item_ID

The affected item.

 

shear_type

Type of shear.

 

magnitude

The magnitude of the shear.

 
+
+
+

Returns

+

The sheared item.

+
+

Since: 2.8

+
+
+
+

gimp_item_transform_2d ()

+
gint32
+gimp_item_transform_2d (gint32 item_ID,
+                        gdouble source_x,
+                        gdouble source_y,
+                        gdouble scale_x,
+                        gdouble scale_y,
+                        gdouble angle,
+                        gdouble dest_x,
+                        gdouble dest_y);
+

Transform the specified item in 2d.

+

This procedure transforms the specified item.

+

The transformation is done by scaling by the x and y scale factors +about the point (source_x, source_y), then rotating around the same +point, then translating that point to the new position (dest_x, +dest_y).

+

If a selection exists and the item is a drawable, the portion of the +drawable which lies under the selection is cut from the drawable and +made into a floating selection which is then transformed as +specified. The return value is the ID of the transformed floating +selection.

+

If there is no selection or the item is not a drawable, the entire +item will be transformed according to the specified parameters. +Additionally, if the item has its linked flag set to TRUE, all +additional items contained in the image which have the linked flag +set to TRUE will also be transformed the same way. The return value +will be equal to the item ID supplied as input.

+

This procedure is affected by the following context setters: +gimp_context_set_interpolation(), +gimp_context_set_transform_direction(), +gimp_context_set_transform_resize().

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

item_ID

The affected item.

 

source_x

X coordinate of the transformation center.

 

source_y

Y coordinate of the transformation center.

 

scale_x

Amount to scale in x direction.

 

scale_y

Amount to scale in y direction.

 

angle

The angle of rotation (radians).

 

dest_x

X coordinate of where the center goes.

 

dest_y

Y coordinate of where the center goes.

 
+
+
+

Returns

+

The transformed item.

+
+

Since: 2.8

+
+
+
+

gimp_item_transform_matrix ()

+
gint32
+gimp_item_transform_matrix (gint32 item_ID,
+                            gdouble coeff_0_0,
+                            gdouble coeff_0_1,
+                            gdouble coeff_0_2,
+                            gdouble coeff_1_0,
+                            gdouble coeff_1_1,
+                            gdouble coeff_1_2,
+                            gdouble coeff_2_0,
+                            gdouble coeff_2_1,
+                            gdouble coeff_2_2);
+

Transform the specified item in 2d.

+

This procedure transforms the specified item.

+

The transformation is done by assembling a 3x3 matrix from the +coefficients passed.

+

If a selection exists and the item is a drawable, the portion of the +drawable which lies under the selection is cut from the drawable and +made into a floating selection which is then transformed as +specified. The return value is the ID of the transformed floating +selection.

+

If there is no selection or the item is not a drawable, the entire +item will be transformed according to the specified matrix. +Additionally, if the item has its linked flag set to TRUE, all +additional items contained in the image which have the linked flag +set to TRUE will also be transformed the same way. The return value +will be equal to the item ID supplied as input.

+

This procedure is affected by the following context setters: +gimp_context_set_interpolation(), +gimp_context_set_transform_direction(), +gimp_context_set_transform_resize().

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

item_ID

The affected item.

 

coeff_0_0

coefficient (0,0) of the transformation matrix.

 

coeff_0_1

coefficient (0,1) of the transformation matrix.

 

coeff_0_2

coefficient (0,2) of the transformation matrix.

 

coeff_1_0

coefficient (1,0) of the transformation matrix.

 

coeff_1_1

coefficient (1,1) of the transformation matrix.

 

coeff_1_2

coefficient (1,2) of the transformation matrix.

 

coeff_2_0

coefficient (2,0) of the transformation matrix.

 

coeff_2_1

coefficient (2,1) of the transformation matrix.

 

coeff_2_2

coefficient (2,2) of the transformation matrix.

 
+
+
+

Returns

+

The transformed item.

+
+

Since: 2.8

+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimplayer.html b/devel-docs/libgimp/html/libgimp-gimplayer.html new file mode 100644 index 0000000..a273b48 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimplayer.html @@ -0,0 +1,1943 @@ + + + + +gimplayer: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimplayer

+

gimplayer — Operations on a single layer.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+gint32 + +gimp_layer_new () +
+gint32 + +gimp_layer_new_from_drawable () +
+gint32 + +gimp_layer_new_from_visible () +
+gint32 + +gimp_layer_new_from_pixbuf () +
+gint32 + +gimp_layer_new_from_surface () +
+gint32 + +gimp_layer_group_new () +
+gint32 + +gimp_layer_copy () +
+gboolean + +gimp_layer_scale () +
+gboolean + +gimp_layer_scale_full () +
+gboolean + +gimp_layer_resize () +
+gboolean + +gimp_layer_resize_to_image_size () +
+gboolean + +gimp_layer_translate () +
+gboolean + +gimp_layer_add_alpha () +
+gboolean + +gimp_layer_flatten () +
+gboolean + +gimp_layer_set_offsets () +
+gint32 + +gimp_layer_create_mask () +
+gint32 + +gimp_layer_from_mask () +
+gint32 + +gimp_layer_get_mask () +
+gboolean + +gimp_layer_add_mask () +
+gboolean + +gimp_layer_remove_mask () +
+gboolean + +gimp_layer_is_floating_sel () +
+gboolean + +gimp_layer_get_lock_alpha () +
+gboolean + +gimp_layer_set_lock_alpha () +
+gboolean + +gimp_layer_get_preserve_trans () +
+gboolean + +gimp_layer_set_preserve_trans () +
+gboolean + +gimp_layer_get_apply_mask () +
+gboolean + +gimp_layer_set_apply_mask () +
+gboolean + +gimp_layer_get_show_mask () +
+gboolean + +gimp_layer_set_show_mask () +
+gboolean + +gimp_layer_get_edit_mask () +
+gboolean + +gimp_layer_set_edit_mask () +
+gdouble + +gimp_layer_get_opacity () +
+gboolean + +gimp_layer_set_opacity () +
+GimpLayerMode + +gimp_layer_get_mode () +
+gboolean + +gimp_layer_set_mode () +
+GimpLayerColorSpace + +gimp_layer_get_blend_space () +
+gboolean + +gimp_layer_set_blend_space () +
+GimpLayerColorSpace + +gimp_layer_get_composite_space () +
+gboolean + +gimp_layer_set_composite_space () +
+GimpLayerCompositeMode + +gimp_layer_get_composite_mode () +
+gboolean + +gimp_layer_set_composite_mode () +
+
+
+

Description

+

Operations on a single layer.

+
+
+

Functions

+
+

gimp_layer_new ()

+
gint32
+gimp_layer_new (gint32 image_ID,
+                const gchar *name,
+                gint width,
+                gint height,
+                GimpImageType type,
+                gdouble opacity,
+                GimpLayerMode mode);
+

Create a new layer.

+

This procedure creates a new layer with the specified width, height, +and type. Name, opacity, and mode are also supplied parameters. The +new layer still needs to be added to the image, as this is not +automatic. Add the new layer with the gimp_image_insert_layer() +command. Other attributes such as layer mask modes, and offsets +should be set with explicit procedure calls.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

image_ID

The image to which to add the layer.

 

name

The layer name.

 

width

The layer width.

 

height

The layer height.

 

type

The layer type.

 

opacity

The layer opacity.

 

mode

The layer combination mode.

 
+
+
+

Returns

+

The newly created layer.

+
+
+
+
+

gimp_layer_new_from_drawable ()

+
gint32
+gimp_layer_new_from_drawable (gint32 drawable_ID,
+                              gint32 dest_image_ID);
+

Create a new layer by copying an existing drawable.

+

This procedure creates a new layer as a copy of the specified +drawable. The new layer still needs to be added to the image, as +this is not automatic. Add the new layer with the +gimp_image_insert_layer() command. Other attributes such as layer +mask modes, and offsets should be set with explicit procedure calls.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

drawable_ID

The source drawable from where the new layer is copied.

 

dest_image_ID

The destination image to which to add the layer.

 
+
+
+

Returns

+

The newly copied layer.

+
+
+
+
+

gimp_layer_new_from_visible ()

+
gint32
+gimp_layer_new_from_visible (gint32 image_ID,
+                             gint32 dest_image_ID,
+                             const gchar *name);
+

Create a new layer from what is visible in an image.

+

This procedure creates a new layer from what is visible in the given +image. The new layer still needs to be added to the destination +image, as this is not automatic. Add the new layer with the +gimp_image_insert_layer() command. Other attributes such as layer +mask modes, and offsets should be set with explicit procedure calls.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

image_ID

The source image from where the content is copied.

 

dest_image_ID

The destination image to which to add the layer.

 

name

The layer name.

 
+
+
+

Returns

+

The newly created layer.

+
+

Since: 2.6

+
+
+
+

gimp_layer_new_from_pixbuf ()

+
gint32
+gimp_layer_new_from_pixbuf (gint32 image_ID,
+                            const gchar *name,
+                            GdkPixbuf *pixbuf,
+                            gdouble opacity,
+                            GimpLayerMode mode,
+                            gdouble progress_start,
+                            gdouble progress_end);
+

Create a new layer from a GdkPixbuf.

+

This procedure creates a new layer from the given GdkPixbuf. The +image has to be an RGB image and just like with gimp_layer_new() +you will still need to add the layer to it.

+

If you pass progress_end + > progress_start + to this function, +gimp_progress_update() will be called for. You have to call +gimp_progress_init() beforehand then.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

image_ID

The RGB image to which to add the layer.

 

name

The layer name.

 

pixbuf

A GdkPixbuf.

 

opacity

The layer opacity.

 

mode

The layer combination mode.

 

progress_start

start of progress

 

progress_end

end of progress

 
+
+
+

Returns

+

The newly created layer.

+
+

Since: 2.4

+
+
+
+

gimp_layer_new_from_surface ()

+
gint32
+gimp_layer_new_from_surface (gint32 image_ID,
+                             const gchar *name,
+                             cairo_surface_t *surface,
+                             gdouble progress_start,
+                             gdouble progress_end);
+

Create a new layer from a cairo_surface_t.

+

This procedure creates a new layer from the given +cairo_surface_t. The image has to be an RGB image and just like +with gimp_layer_new() you will still need to add the layer to it.

+

If you pass progress_end + > progress_start + to this function, +gimp_progress_update() will be called for. You have to call +gimp_progress_init() beforehand then.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

image_ID

The RGB image to which to add the layer.

 

name

The layer name.

 

surface

A Cairo image surface.

 

progress_start

start of progress

 

progress_end

end of progress

 
+
+
+

Returns

+

The newly created layer.

+
+

Since: 2.8

+
+
+
+

gimp_layer_group_new ()

+
gint32
+gimp_layer_group_new (gint32 image_ID);
+

Create a new layer group.

+

This procedure creates a new layer group. Attributes such as layer +mode and opacity should be set with explicit procedure calls. Add +the new layer group (which is a kind of layer) with the +gimp_image_insert_layer() command. +Other procedures useful with layer groups: +gimp_image_reorder_item(), gimp_item_get_parent(), +gimp_item_get_children(), gimp_item_is_group().

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image to which to add the layer group.

 
+
+
+

Returns

+

The newly created layer group.

+
+

Since: 2.8

+
+
+
+

gimp_layer_copy ()

+
gint32
+gimp_layer_copy (gint32 layer_ID);
+

Copy a layer.

+

This procedure copies the specified layer and returns the copy. The +newly copied layer is for use within the original layer's image. It +should not be subsequently added to any other image.

+
+

Parameters

+
+++++ + + + + + +

layer_ID

The layer to copy.

 
+
+
+

Returns

+

The newly copied layer.

+
+
+
+
+

gimp_layer_scale ()

+
gboolean
+gimp_layer_scale (gint32 layer_ID,
+                  gint new_width,
+                  gint new_height,
+                  gboolean local_origin);
+

Scale the layer using the default interpolation method.

+

This procedure scales the layer so that its new width and height are +equal to the supplied parameters. The 'local-origin' parameter +specifies whether to scale from the center of the layer, or from the +image origin. This operation only works if the layer has been added +to an image. The interpolation method used can be set with +gimp_context_set_interpolation().

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

layer_ID

The layer.

 

new_width

New layer width.

 

new_height

New layer height.

 

local_origin

Use a local origin (as opposed to the image origin).

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_layer_scale_full ()

+
gboolean
+gimp_layer_scale_full (gint32 layer_ID,
+                       gint new_width,
+                       gint new_height,
+                       gboolean local_origin,
+                       GimpInterpolationType interpolation);
+
+

gimp_layer_scale_full is deprecated and should not be used in newly-written code.

+

Use gimp_layer_scale() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

layer_ID

The layer.

 

new_width

New layer width.

 

new_height

New layer height.

 

local_origin

Use a local origin (as opposed to the image origin).

 

interpolation

Type of interpolation.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.6

+
+
+
+

gimp_layer_resize ()

+
gboolean
+gimp_layer_resize (gint32 layer_ID,
+                   gint new_width,
+                   gint new_height,
+                   gint offx,
+                   gint offy);
+

Resize the layer to the specified extents.

+

This procedure resizes the layer so that its new width and height +are equal to the supplied parameters. Offsets are also provided +which describe the position of the previous layer's content. This +operation only works if the layer has been added to an image.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

layer_ID

The layer.

 

new_width

New layer width.

 

new_height

New layer height.

 

offx

x offset between upper left corner of old and new layers: (old - new).

 

offy

y offset between upper left corner of old and new layers: (old - new).

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_layer_resize_to_image_size ()

+
gboolean
+gimp_layer_resize_to_image_size (gint32 layer_ID);
+

Resize a layer to the image size.

+

This procedure resizes the layer so that it's new width and height +are equal to the width and height of its image container.

+
+

Parameters

+
+++++ + + + + + +

layer_ID

The layer to resize.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_layer_translate ()

+
gboolean
+gimp_layer_translate (gint32 layer_ID,
+                      gint offx,
+                      gint offy);
+
+

gimp_layer_translate is deprecated and should not be used in newly-written code.

+

Use gimp_item_transform_translate() instead.

+
+

Translate the layer by the specified offsets.

+

This procedure translates the layer by the amounts specified in the +x and y arguments. These can be negative, and are considered offsets +from the current position. This command only works if the layer has +been added to an image. All additional layers contained in the image +which have the linked flag set to TRUE w ill also be translated by +the specified offsets.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

layer_ID

The layer.

 

offx

Offset in x direction.

 

offy

Offset in y direction.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_layer_add_alpha ()

+
gboolean
+gimp_layer_add_alpha (gint32 layer_ID);
+

Add an alpha channel to the layer if it doesn't already have one.

+

This procedure adds an additional component to the specified layer +if it does not already possess an alpha channel. An alpha channel +makes it possible to clear and erase to transparency, instead of the +background color. This transforms layers of type RGB to RGBA, GRAY +to GRAYA, and INDEXED to INDEXEDA.

+
+

Parameters

+
+++++ + + + + + +

layer_ID

The layer.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_layer_flatten ()

+
gboolean
+gimp_layer_flatten (gint32 layer_ID);
+

Remove the alpha channel from the layer if it has one.

+

This procedure removes the alpha channel from a layer, blending all +(partially) transparent pixels in the layer against the background +color. This transforms layers of type RGBA to RGB, GRAYA to GRAY, +and INDEXEDA to INDEXED.

+
+

Parameters

+
+++++ + + + + + +

layer_ID

The layer.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_layer_set_offsets ()

+
gboolean
+gimp_layer_set_offsets (gint32 layer_ID,
+                        gint offx,
+                        gint offy);
+

Set the layer offsets.

+

This procedure sets the offsets for the specified layer. The offsets +are relative to the image origin and can be any values. This +operation is valid only on layers which have been added to an image.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

layer_ID

The layer.

 

offx

Offset in x direction.

 

offy

Offset in y direction.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_layer_create_mask ()

+
gint32
+gimp_layer_create_mask (gint32 layer_ID,
+                        GimpAddMaskType mask_type);
+

Create a layer mask for the specified layer.

+

This procedure creates a layer mask for the specified layer. +Layer masks serve as an additional alpha channel for a layer. +Different types of masks are allowed for initialisation:

+
    +

  • white mask (leaves the layer fully visible);

    • +

  • black mask (gives the layer complete transparency);

    • +

  • the layer's alpha channel (either a copy, or a transfer, which +leaves the layer fully visible, but which may be more useful than a +white mask);

    • +

  • the current selection;

    • +

  • a grayscale copy of the layer;

    • +

  • or a copy of the active channel.

    • +
+

The layer mask still needs to be added to the layer. This can be +done with a call to gimp_layer_add_mask().

+

gimp_layer_create_mask() will fail if there are no active channels +on the image, when called with 'ADD-CHANNEL-MASK'. It will return a +black mask when called with 'ADD-ALPHA-MASK' or +'ADD-ALPHA-TRANSFER-MASK' on a layer with no alpha channels, or with +'ADD-SELECTION-MASK' when there is no selection on the image.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

layer_ID

The layer to which to add the mask.

 

mask_type

The type of mask.

 
+
+
+

Returns

+

The newly created mask.

+
+
+
+
+

gimp_layer_from_mask ()

+
gint32
+gimp_layer_from_mask (gint32 mask_ID);
+

Get the specified mask's layer.

+

This procedure returns the specified mask's layer , or -1 if none +exists.

+
+

Parameters

+
+++++ + + + + + +

mask_ID

Mask for which to return the layer.

 
+
+
+

Returns

+

The mask's layer.

+
+

Since: 2.2

+
+
+
+

gimp_layer_get_mask ()

+
gint32
+gimp_layer_get_mask (gint32 layer_ID);
+

Get the specified layer's mask if it exists.

+

This procedure returns the specified layer's mask, or -1 if none +exists.

+
+

Parameters

+
+++++ + + + + + +

layer_ID

The layer.

 
+
+
+

Returns

+

The layer mask.

+
+
+
+
+

gimp_layer_add_mask ()

+
gboolean
+gimp_layer_add_mask (gint32 layer_ID,
+                     gint32 mask_ID);
+

Add a layer mask to the specified layer.

+

This procedure adds a layer mask to the specified layer. Layer masks +serve as an additional alpha channel for a layer. This procedure +will fail if a number of prerequisites aren't met. The layer cannot +already have a layer mask. The specified mask must exist and have +the same dimensions as the layer. The layer must have been created +for use with the specified image and the mask must have been created +with the procedure 'gimp-layer-create-mask'.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

layer_ID

The layer to receive the mask.

 

mask_ID

The mask to add to the layer.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_layer_remove_mask ()

+
gboolean
+gimp_layer_remove_mask (gint32 layer_ID,
+                        GimpMaskApplyMode mode);
+

Remove the specified layer mask from the layer.

+

This procedure removes the specified layer mask from the layer. If +the mask doesn't exist, an error is returned.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

layer_ID

The layer from which to remove mask.

 

mode

Removal mode.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_layer_is_floating_sel ()

+
gboolean
+gimp_layer_is_floating_sel (gint32 layer_ID);
+

Is the specified layer a floating selection?

+

This procedure returns whether the layer is a floating selection. +Floating selections are special cases of layers which are attached +to a specific drawable.

+
+

Parameters

+
+++++ + + + + + +

layer_ID

The layer.

 
+
+
+

Returns

+

TRUE if the layer is a floating selection.

+
+
+
+
+

gimp_layer_get_lock_alpha ()

+
gboolean
+gimp_layer_get_lock_alpha (gint32 layer_ID);
+

Get the lock alpha channel setting of the specified layer.

+

This procedure returns the specified layer's lock alpha channel +setting.

+
+

Parameters

+
+++++ + + + + + +

layer_ID

The layer.

 
+
+
+

Returns

+

The layer's lock alpha channel setting.

+
+
+
+
+

gimp_layer_set_lock_alpha ()

+
gboolean
+gimp_layer_set_lock_alpha (gint32 layer_ID,
+                           gboolean lock_alpha);
+

Set the lock alpha channel setting of the specified layer.

+

This procedure sets the specified layer's lock alpha channel +setting.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

layer_ID

The layer.

 

lock_alpha

The new layer's lock alpha channel setting.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_layer_get_preserve_trans ()

+
gboolean
+gimp_layer_get_preserve_trans (gint32 layer_ID);
+

gimp_layer_get_preserve_trans is deprecated and should not be used in newly-written code.

+

This procedure is deprecated! Use gimp_layer_get_lock_alpha() instead.

+
+

Parameters

+
+++++ + + + + + +

layer_ID

The layer.

 
+
+
+

Returns

+

The layer's preserve transperancy setting.

+
+
+
+
+

gimp_layer_set_preserve_trans ()

+
gboolean
+gimp_layer_set_preserve_trans (gint32 layer_ID,
+                               gboolean preserve_trans);
+

gimp_layer_set_preserve_trans is deprecated and should not be used in newly-written code.

+

This procedure is deprecated! Use gimp_layer_set_lock_alpha() instead.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

layer_ID

The layer.

 

preserve_trans

The new layer's preserve transperancy setting.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_layer_get_apply_mask ()

+
gboolean
+gimp_layer_get_apply_mask (gint32 layer_ID);
+

Get the apply mask setting of the specified layer.

+

This procedure returns the specified layer's apply mask setting. If +the value is TRUE, then the layer mask for this layer is currently +being composited with the layer's alpha channel.

+
+

Parameters

+
+++++ + + + + + +

layer_ID

The layer.

 
+
+
+

Returns

+

The layer's apply mask setting.

+
+
+
+
+

gimp_layer_set_apply_mask ()

+
gboolean
+gimp_layer_set_apply_mask (gint32 layer_ID,
+                           gboolean apply_mask);
+

Set the apply mask setting of the specified layer.

+

This procedure sets the specified layer's apply mask setting. This +controls whether the layer's mask is currently affecting the alpha +channel. If there is no layer mask, this function will return an +error.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

layer_ID

The layer.

 

apply_mask

The new layer's apply mask setting.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_layer_get_show_mask ()

+
gboolean
+gimp_layer_get_show_mask (gint32 layer_ID);
+

Get the show mask setting of the specified layer.

+

This procedure returns the specified layer's show mask setting. This +controls whether the layer or its mask is visible. TRUE indicates +that the mask should be visible. If the layer has no mask, then this +function returns an error.

+
+

Parameters

+
+++++ + + + + + +

layer_ID

The layer.

 
+
+
+

Returns

+

The layer's show mask setting.

+
+
+
+
+

gimp_layer_set_show_mask ()

+
gboolean
+gimp_layer_set_show_mask (gint32 layer_ID,
+                          gboolean show_mask);
+

Set the show mask setting of the specified layer.

+

This procedure sets the specified layer's show mask setting. This +controls whether the layer or its mask is visible. TRUE indicates +that the mask should be visible. If there is no layer mask, this +function will return an error.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

layer_ID

The layer.

 

show_mask

The new layer's show mask setting.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_layer_get_edit_mask ()

+
gboolean
+gimp_layer_get_edit_mask (gint32 layer_ID);
+

Get the edit mask setting of the specified layer.

+

This procedure returns the specified layer's edit mask setting. If +the value is TRUE, then the layer mask for this layer is currently +active, and not the layer.

+
+

Parameters

+
+++++ + + + + + +

layer_ID

The layer.

 
+
+
+

Returns

+

The layer's edit mask setting.

+
+
+
+
+

gimp_layer_set_edit_mask ()

+
gboolean
+gimp_layer_set_edit_mask (gint32 layer_ID,
+                          gboolean edit_mask);
+

Set the edit mask setting of the specified layer.

+

This procedure sets the specified layer's edit mask setting. This +controls whether the layer or it's mask is currently active for +editing. If the specified layer has no layer mask, then this +procedure will return an error.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

layer_ID

The layer.

 

edit_mask

The new layer's edit mask setting.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_layer_get_opacity ()

+
gdouble
+gimp_layer_get_opacity (gint32 layer_ID);
+

Get the opacity of the specified layer.

+

This procedure returns the specified layer's opacity.

+
+

Parameters

+
+++++ + + + + + +

layer_ID

The layer.

 
+
+
+

Returns

+

The layer opacity.

+
+
+
+
+

gimp_layer_set_opacity ()

+
gboolean
+gimp_layer_set_opacity (gint32 layer_ID,
+                        gdouble opacity);
+

Set the opacity of the specified layer.

+

This procedure sets the specified layer's opacity.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

layer_ID

The layer.

 

opacity

The new layer opacity.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_layer_get_mode ()

+
GimpLayerMode
+gimp_layer_get_mode (gint32 layer_ID);
+

Get the combination mode of the specified layer.

+

This procedure returns the specified layer's combination mode.

+
+

Parameters

+
+++++ + + + + + +

layer_ID

The layer.

 
+
+
+

Returns

+

The layer combination mode.

+
+
+
+
+

gimp_layer_set_mode ()

+
gboolean
+gimp_layer_set_mode (gint32 layer_ID,
+                     GimpLayerMode mode);
+

Set the combination mode of the specified layer.

+

This procedure sets the specified layer's combination mode.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

layer_ID

The layer.

 

mode

The new layer combination mode.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_layer_get_blend_space ()

+
GimpLayerColorSpace
+gimp_layer_get_blend_space (gint32 layer_ID);
+

Get the blend space of the specified layer.

+

This procedure returns the specified layer's blend space.

+
+

Parameters

+
+++++ + + + + + +

layer_ID

The layer.

 
+
+
+

Returns

+

The layer blend space.

+
+

Since: 2.10

+
+
+
+

gimp_layer_set_blend_space ()

+
gboolean
+gimp_layer_set_blend_space (gint32 layer_ID,
+                            GimpLayerColorSpace blend_space);
+

Set the blend space of the specified layer.

+

This procedure sets the specified layer's blend space.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

layer_ID

The layer.

 

blend_space

The new layer blend space.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_layer_get_composite_space ()

+
GimpLayerColorSpace
+gimp_layer_get_composite_space (gint32 layer_ID);
+

Get the composite space of the specified layer.

+

This procedure returns the specified layer's composite space.

+
+

Parameters

+
+++++ + + + + + +

layer_ID

The layer.

 
+
+
+

Returns

+

The layer composite space.

+
+

Since: 2.10

+
+
+
+

gimp_layer_set_composite_space ()

+
gboolean
+gimp_layer_set_composite_space (gint32 layer_ID,
+                                GimpLayerColorSpace composite_space);
+

Set the composite space of the specified layer.

+

This procedure sets the specified layer's composite space.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

layer_ID

The layer.

 

composite_space

The new layer composite space.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_layer_get_composite_mode ()

+
GimpLayerCompositeMode
+gimp_layer_get_composite_mode (gint32 layer_ID);
+

Get the composite mode of the specified layer.

+

This procedure returns the specified layer's composite mode.

+
+

Parameters

+
+++++ + + + + + +

layer_ID

The layer.

 
+
+
+

Returns

+

The layer composite mode.

+
+

Since: 2.10

+
+
+
+

gimp_layer_set_composite_mode ()

+
gboolean
+gimp_layer_set_composite_mode (gint32 layer_ID,
+                               GimpLayerCompositeMode composite_mode);
+

Set the composite mode of the specified layer.

+

This procedure sets the specified layer's composite mode.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

layer_ID

The layer.

 

composite_mode

The new layer composite mode.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpmenu.html b/devel-docs/libgimp/html/libgimp-gimpmenu.html new file mode 100644 index 0000000..2cf17d7 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpmenu.html @@ -0,0 +1,317 @@ + + + + +gimpmenu: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpmenu

+

gimpmenu — Menus for selecting images, layers, channels +and drawables.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+gboolean + +(*GimpConstraintFunc) () +
+void + +(*GimpMenuCallback) () +
+GtkWidget * + +gimp_image_menu_new () +
+GtkWidget * + +gimp_layer_menu_new () +
+GtkWidget * + +gimp_channel_menu_new () +
+GtkWidget * + +gimp_drawable_menu_new () +
+
+
+

Description

+

Menus for selecting images, layers, channels and drawables.

+
+
+

Functions

+
+

GimpConstraintFunc ()

+
gboolean
+(*GimpConstraintFunc) (gint32 image_id,
+                       gint32 drawable_id,
+                       gpointer data);
+

GimpConstraintFunc is deprecated and should not be used in newly-written code.

+
+
+
+

GimpMenuCallback ()

+
void
+(*GimpMenuCallback) (gint32 any_id,
+                     gpointer data);
+

GimpMenuCallback is deprecated and should not be used in newly-written code.

+
+
+
+

gimp_image_menu_new ()

+
GtkWidget *
+gimp_image_menu_new (GimpConstraintFunc constraint,
+                     GimpMenuCallback callback,
+                     gpointer data,
+                     gint32 active_image);
+
+

gimp_image_menu_new is deprecated and should not be used in newly-written code.

+

Use gimp_image_combo_box_new() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

constraint

a function to filter the menu contents

 

callback

the callback to call when an image is selected

 

data

the callback's user_data

 

active_image

an image to preselect

 
+
+
+

Returns

+

the image menu.

+
+
+
+
+

gimp_layer_menu_new ()

+
GtkWidget *
+gimp_layer_menu_new (GimpConstraintFunc constraint,
+                     GimpMenuCallback callback,
+                     gpointer data,
+                     gint32 active_layer);
+
+

gimp_layer_menu_new is deprecated and should not be used in newly-written code.

+

Use gimp_layer_combo_box_new() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

constraint

a function to filter the menu contents

 

callback

the callback to call when a channel is selected

 

data

the callback's user_data

 

active_layer

a layer to preselect

 
+
+
+

Returns

+

the layer menu.

+
+
+
+
+

gimp_channel_menu_new ()

+
GtkWidget *
+gimp_channel_menu_new (GimpConstraintFunc constraint,
+                       GimpMenuCallback callback,
+                       gpointer data,
+                       gint32 active_channel);
+
+

gimp_channel_menu_new is deprecated and should not be used in newly-written code.

+

Use gimp_channel_combo_box_new() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

constraint

a function to filter the menu contents

 

callback

the callback to call when a channel is selected

 

data

the callback's user_data

 

active_channel

a channel to preselect

 
+
+
+

Returns

+

the channel menu.

+
+
+
+
+

gimp_drawable_menu_new ()

+
GtkWidget *
+gimp_drawable_menu_new (GimpConstraintFunc constraint,
+                        GimpMenuCallback callback,
+                        gpointer data,
+                        gint32 active_drawable);
+
+

gimp_drawable_menu_new is deprecated and should not be used in newly-written code.

+

Use gimp_drawable_combo_box_new() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

constraint

a function to filter the menu contents

 

callback

the callback to call when a channel is selected

 

data

the callback's user_data

 

active_drawable

a drawable to preselect

 
+
+
+

Returns

+

the drawable menu.

+
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpmessage.html b/devel-docs/libgimp/html/libgimp-gimpmessage.html new file mode 100644 index 0000000..bb8e37c --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpmessage.html @@ -0,0 +1,150 @@ + + + + +gimpmessage: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpmessage

+

gimpmessage — Display a dialog box with a message.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + +
+gboolean + +gimp_message () +
+GimpMessageHandlerType + +gimp_message_get_handler () +
+gboolean + +gimp_message_set_handler () +
+
+
+

Description

+

Display a dialog box with a message.

+
+
+

Functions

+
+

gimp_message ()

+
gboolean
+gimp_message (const gchar *message);
+

Displays a dialog box with a message.

+

Displays a dialog box with a message. Useful for status or error +reporting. The message must be in UTF-8 encoding.

+
+

Parameters

+
+++++ + + + + + +

message

Message to display in the dialog.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_message_get_handler ()

+
GimpMessageHandlerType
+gimp_message_get_handler (void);
+

Returns the current state of where warning messages are displayed.

+

This procedure returns the way g_message warnings are displayed. +They can be shown in a dialog box or printed on the console where +gimp was started.

+
+

Returns

+

The current handler type.

+
+
+
+
+

gimp_message_set_handler ()

+
gboolean
+gimp_message_set_handler (GimpMessageHandlerType handler);
+

Controls where warning messages are displayed.

+

This procedure controls how g_message warnings are displayed. They +can be shown in a dialog box or printed on the console where gimp +was started.

+
+

Parameters

+
+++++ + + + + + +

handler

The new handler type.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpmetadata.html b/devel-docs/libgimp/html/libgimp-gimpmetadata.html new file mode 100644 index 0000000..adf034f --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpmetadata.html @@ -0,0 +1,323 @@ + + + + +gimpmetadata: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpmetadata

+

gimpmetadata

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+GimpMetadata * + +gimp_image_metadata_load_prepare () +
+void + +gimp_image_metadata_load_finish () +
+GimpMetadata * + +gimp_image_metadata_save_prepare () +
+gboolean + +gimp_image_metadata_save_finish () +
+gint32 + +gimp_image_metadata_load_thumbnail () +
+
+
+

Description

+
+
+

Functions

+
+

gimp_image_metadata_load_prepare ()

+
GimpMetadata *
+gimp_image_metadata_load_prepare (gint32 image_ID,
+                                  const gchar *mime_type,
+                                  GFile *file,
+                                  GError **error);
+

Loads and returns metadata from file + to be passed into +gimp_image_metadata_load_finish().

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

image_ID

The image

 

mime_type

The loaded file's mime-type

 

file

The file to load the metadata from

 

error

Return location for error

 
+
+
+

Returns

+

The file's metadata.

+
+

Since: 2.10

+
+
+
+

gimp_image_metadata_load_finish ()

+
void
+gimp_image_metadata_load_finish (gint32 image_ID,
+                                 const gchar *mime_type,
+                                 GimpMetadata *metadata,
+                                 GimpMetadataLoadFlags flags,
+                                 gboolean interactive);
+

Applies the metadata + previously loaded with +gimp_image_metadata_load_prepare() to the image, taking into account +the passed flags +.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

image_ID

The image

 

mime_type

The loaded file's mime-type

 

metadata

The metadata to set on the image

 

flags

Flags to specify what of the metadata to apply to the image

 

interactive

Whether this function is allowed to query info with dialogs

 
+
+

Since: 2.10

+
+
+
+

gimp_image_metadata_save_prepare ()

+
GimpMetadata *
+gimp_image_metadata_save_prepare (gint32 image_ID,
+                                  const gchar *mime_type,
+                                  GimpMetadataSaveFlags *suggested_flags);
+

Gets the image metadata for saving it using +gimp_image_metadata_save_finish().

+

The suggested_flags + are determined from what kind of metadata +(Exif, XMP, ...) is actually present in the image and the preferences +for metadata exporting. +The calling application may still update available_flags +, for +instance to follow the settings from a previous export in the same +session, or a previous export of the same image. But it should not +override the preferences without a good reason since it is a data +leak.

+

The suggested value for GIMP_METADATA_SAVE_THUMBNAIL is determined by +whether there was a thumbnail in the previously imported image.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

image_ID

The image

 

mime_type

The saved file's mime-type

 

suggested_flags

Suggested default values for the flags +passed to +gimp_image_metadata_save_finish()

 
+
+
+

Returns

+

The image's metadata, prepared for saving.

+
+

Since: 2.10

+
+
+
+

gimp_image_metadata_save_finish ()

+
gboolean
+gimp_image_metadata_save_finish (gint32 image_ID,
+                                 const gchar *mime_type,
+                                 GimpMetadata *metadata,
+                                 GimpMetadataSaveFlags flags,
+                                 GFile *file,
+                                 GError **error);
+

Saves the metadata + retrieved from the image with +gimp_image_metadata_save_prepare() to file +, taking into account +the passed flags +.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

image_ID

The image

 

mime_type

The saved file's mime-type

 

metadata

The metadata to set on the image

 

flags

Flags to specify what of the metadata to save

 

file

The file to load the metadata from

 

error

Return location for error message

 
+
+
+

Returns

+

Whether the save was successful.

+
+

Since: 2.10

+
+
+
+

gimp_image_metadata_load_thumbnail ()

+
gint32
+gimp_image_metadata_load_thumbnail (GFile *file,
+                                    GError **error);
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimppainttools.html b/devel-docs/libgimp/html/libgimp-gimppainttools.html new file mode 100644 index 0000000..604c720 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimppainttools.html @@ -0,0 +1,1196 @@ + + + + +gimppainttools: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimppainttools

+

gimppainttools — Access to toolbox paint tools.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+gboolean + +gimp_airbrush () +
+gboolean + +gimp_airbrush_default () +
+gboolean + +gimp_clone () +
+gboolean + +gimp_clone_default () +
+gboolean + +gimp_convolve () +
+gboolean + +gimp_convolve_default () +
+gboolean + +gimp_dodgeburn () +
+gboolean + +gimp_dodgeburn_default () +
+gboolean + +gimp_edit_bucket_fill_full () +
+gboolean + +gimp_eraser () +
+gboolean + +gimp_eraser_default () +
+gboolean + +gimp_heal () +
+gboolean + +gimp_heal_default () +
+gboolean + +gimp_paintbrush () +
+gboolean + +gimp_paintbrush_default () +
+gboolean + +gimp_pencil () +
+gboolean + +gimp_smudge () +
+gboolean + +gimp_smudge_default () +
+
+
+

Description

+

Functions giving access to toolbox paint tools.

+
+
+

Functions

+
+

gimp_airbrush ()

+
gboolean
+gimp_airbrush (gint32 drawable_ID,
+               gdouble pressure,
+               gint num_strokes,
+               const gdouble *strokes);
+

Paint in the current brush with varying pressure. Paint application +is time-dependent.

+

This tool simulates the use of an airbrush. Paint pressure +represents the relative intensity of the paint application. High +pressure results in a thicker layer of paint while low pressure +results in a thinner layer.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

pressure

The pressure of the airbrush strokes.

 

num_strokes

Number of stroke control points (count each coordinate as 2 points).

 

strokes

Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_airbrush_default ()

+
gboolean
+gimp_airbrush_default (gint32 drawable_ID,
+                       gint num_strokes,
+                       const gdouble *strokes);
+

Paint in the current brush with varying pressure. Paint application +is time-dependent.

+

This tool simulates the use of an airbrush. It is similar to +gimp_airbrush() except that the pressure is derived from the +airbrush tools options box. It the option has not been set the +default for the option will be used.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

num_strokes

Number of stroke control points (count each coordinate as 2 points).

 

strokes

Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_clone ()

+
gboolean
+gimp_clone (gint32 drawable_ID,
+            gint32 src_drawable_ID,
+            GimpCloneType clone_type,
+            gdouble src_x,
+            gdouble src_y,
+            gint num_strokes,
+            const gdouble *strokes);
+

Clone from the source to the dest drawable using the current brush

+

This tool clones (copies) from the source drawable starting at the +specified source coordinates to the dest drawable. If the +\"clone_type\" argument is set to PATTERN-CLONE, then the current +pattern is used as the source and the \"src_drawable\" argument is +ignored. Pattern cloning assumes a tileable pattern and mods the sum +of the src coordinates and subsequent stroke offsets with the width +and height of the pattern. For image cloning, if the sum of the src +coordinates and subsequent stroke offsets exceeds the extents of the +src drawable, then no paint is transferred. The clone tool is +capable of transforming between any image types including +RGB->Indexed--although converting from any type to indexed is +significantly slower.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

src_drawable_ID

The source drawable.

 

clone_type

The type of clone.

 

src_x

The x coordinate in the source image.

 

src_y

The y coordinate in the source image.

 

num_strokes

Number of stroke control points (count each coordinate as 2 points).

 

strokes

Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_clone_default ()

+
gboolean
+gimp_clone_default (gint32 drawable_ID,
+                    gint num_strokes,
+                    const gdouble *strokes);
+

Clone from the source to the dest drawable using the current brush

+

This tool clones (copies) from the source drawable starting at the +specified source coordinates to the dest drawable. This function +performs exactly the same as the gimp_clone() function except that +the tools arguments are obtained from the clones option dialog. It +this dialog has not been activated then the dialogs default values +will be used.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

num_strokes

Number of stroke control points (count each coordinate as 2 points).

 

strokes

Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_convolve ()

+
gboolean
+gimp_convolve (gint32 drawable_ID,
+               gdouble pressure,
+               GimpConvolveType convolve_type,
+               gint num_strokes,
+               const gdouble *strokes);
+

Convolve (Blur, Sharpen) using the current brush.

+

This tool convolves the specified drawable with either a sharpening +or blurring kernel. The pressure parameter controls the magnitude of +the operation. Like the paintbrush, this tool linearly interpolates +between the specified stroke coordinates.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

pressure

The pressure.

 

convolve_type

Convolve type.

 

num_strokes

Number of stroke control points (count each coordinate as 2 points).

 

strokes

Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_convolve_default ()

+
gboolean
+gimp_convolve_default (gint32 drawable_ID,
+                       gint num_strokes,
+                       const gdouble *strokes);
+

Convolve (Blur, Sharpen) using the current brush.

+

This tool convolves the specified drawable with either a sharpening +or blurring kernel. This function performs exactly the same as the +gimp_convolve() function except that the tools arguments are +obtained from the convolve option dialog. It this dialog has not +been activated then the dialogs default values will be used.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

num_strokes

Number of stroke control points (count each coordinate as 2 points).

 

strokes

Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_dodgeburn ()

+
gboolean
+gimp_dodgeburn (gint32 drawable_ID,
+                gdouble exposure,
+                GimpDodgeBurnType dodgeburn_type,
+                GimpTransferMode dodgeburn_mode,
+                gint num_strokes,
+                const gdouble *strokes);
+

Dodgeburn image with varying exposure.

+

Dodgeburn. More details here later.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

exposure

The exposure of the strokes.

 

dodgeburn_type

The type either dodge or burn.

 

dodgeburn_mode

The mode.

 

num_strokes

Number of stroke control points (count each coordinate as 2 points).

 

strokes

Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_dodgeburn_default ()

+
gboolean
+gimp_dodgeburn_default (gint32 drawable_ID,
+                        gint num_strokes,
+                        const gdouble *strokes);
+

Dodgeburn image with varying exposure. This is the same as the +gimp_dodgeburn() function except that the exposure, type and mode +are taken from the tools option dialog. If the dialog has not been +activated then the defaults as used by the dialog will be used.

+

Dodgeburn. More details here later.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

num_strokes

Number of stroke control points (count each coordinate as 2 points).

 

strokes

Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_edit_bucket_fill_full ()

+
gboolean
+gimp_edit_bucket_fill_full (gint32 drawable_ID,
+                            GimpBucketFillMode fill_mode,
+                            GimpLayerMode paint_mode,
+                            gdouble opacity,
+                            gdouble threshold,
+                            gboolean sample_merged,
+                            gboolean fill_transparent,
+                            GimpSelectCriterion select_criterion,
+                            gdouble x,
+                            gdouble y);
+
+

gimp_edit_bucket_fill_full is deprecated and should not be used in newly-written code.

+

Use gimp_drawable_edit_bucket_fill() instead.

+
+

Fill the area specified either by the current selection if there is +one, or by a seed fill starting at the specified coordinates.

+

This tool requires information on the paint application mode, and +the fill mode, which can either be in the foreground color, or in +the currently active pattern. If there is no selection, a seed fill +is executed at the specified coordinates and extends outward in +keeping with the threshold parameter. If there is a selection in the +target image, the threshold, sample merged, x, and y arguments are +unused. If the sample_merged parameter is TRUE, the data of the +composite image will be used instead of that for the specified +drawable. This is equivalent to sampling for colors after merging +all visible layers. 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.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

fill_mode

The type of fill.

 

paint_mode

The paint application mode.

 

opacity

The opacity of the final bucket fill.

 

threshold

The threshold determines how extensive the seed fill will be. It's value is specified in terms of intensity levels. This parameter is only valid when there is no selection in the specified image.

 

sample_merged

Use the composite image, not the drawable.

 

fill_transparent

Whether to consider transparent pixels for filling. If TRUE, transparency is considered as a unique fillable color.

 

select_criterion

The criterion used to determine color similarity. SELECT_CRITERION_COMPOSITE is the standard choice.

 

x

The x coordinate of this bucket fill's application. This parameter is only valid when there is no selection in the specified image.

 

y

The y coordinate of this bucket fill's application. This parameter is only valid when there is no selection in the specified image.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_eraser ()

+
gboolean
+gimp_eraser (gint32 drawable_ID,
+             gint num_strokes,
+             const gdouble *strokes,
+             GimpBrushApplicationMode hardness,
+             GimpPaintApplicationMode method);
+

Erase using the current brush.

+

This tool erases using the current brush mask. If the specified +drawable contains an alpha channel, then the erased pixels will +become transparent. Otherwise, the eraser tool replaces the contents +of the drawable with the background color. Like paintbrush, this +tool linearly interpolates between the specified stroke coordinates.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

num_strokes

Number of stroke control points (count each coordinate as 2 points).

 

strokes

Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.

 

hardness

How to apply the brush.

 

method

The paint method to use.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_eraser_default ()

+
gboolean
+gimp_eraser_default (gint32 drawable_ID,
+                     gint num_strokes,
+                     const gdouble *strokes);
+

Erase using the current brush.

+

This tool erases using the current brush mask. This function +performs exactly the same as the gimp_eraser() function except that +the tools arguments are obtained from the eraser option dialog. It +this dialog has not been activated then the dialogs default values +will be used.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

num_strokes

Number of stroke control points (count each coordinate as 2 points).

 

strokes

Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_heal ()

+
gboolean
+gimp_heal (gint32 drawable_ID,
+           gint32 src_drawable_ID,
+           gdouble src_x,
+           gdouble src_y,
+           gint num_strokes,
+           const gdouble *strokes);
+

Heal from the source to the dest drawable using the current brush

+

This tool heals the source drawable starting at the specified source +coordinates to the dest drawable. For image healing, if the sum of +the src coordinates and subsequent stroke offsets exceeds the +extents of the src drawable, then no paint is transferred. The +healing tool is capable of transforming between any image types +except RGB->Indexed.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

src_drawable_ID

The source drawable.

 

src_x

The x coordinate in the source image.

 

src_y

The y coordinate in the source image.

 

num_strokes

Number of stroke control points (count each coordinate as 2 points).

 

strokes

Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_heal_default ()

+
gboolean
+gimp_heal_default (gint32 drawable_ID,
+                   gint num_strokes,
+                   const gdouble *strokes);
+

Heal from the source to the dest drawable using the current brush

+

This tool heals from the source drawable starting at the specified +source coordinates to the dest drawable. This function performs +exactly the same as the gimp_heal() function except that the tools +arguments are obtained from the healing option dialog. It this +dialog has not been activated then the dialogs default values will +be used.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

num_strokes

Number of stroke control points (count each coordinate as 2 points).

 

strokes

Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_paintbrush ()

+
gboolean
+gimp_paintbrush (gint32 drawable_ID,
+                 gdouble fade_out,
+                 gint num_strokes,
+                 const gdouble *strokes,
+                 GimpPaintApplicationMode method,
+                 gdouble gradient_length);
+

Paint in the current brush with optional fade out parameter and pull +colors from a gradient.

+

This tool is the standard paintbrush. It draws linearly interpolated +lines through the specified stroke coordinates. It operates on the +specified drawable in the foreground color with the active brush. +The 'fade-out' parameter is measured in pixels and allows the brush +stroke to linearly fall off. The pressure is set to the maximum at +the beginning of the stroke. As the distance of the stroke nears the +fade-out value, the pressure will approach zero. The gradient-length +is the distance to spread the gradient over. It is measured in +pixels. If the gradient-length is 0, no gradient is used.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

fade_out

Fade out parameter.

 

num_strokes

Number of stroke control points (count each coordinate as 2 points).

 

strokes

Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.

 

method

The paint method to use.

 

gradient_length

Length of gradient to draw.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_paintbrush_default ()

+
gboolean
+gimp_paintbrush_default (gint32 drawable_ID,
+                         gint num_strokes,
+                         const gdouble *strokes);
+

Paint in the current brush. The fade out parameter and pull colors +from a gradient parameter are set from the paintbrush options +dialog. If this dialog has not been activated then the dialog +defaults will be used.

+

This tool is similar to the standard paintbrush. It draws linearly +interpolated lines through the specified stroke coordinates. It +operates on the specified drawable in the foreground color with the +active brush. The 'fade-out' parameter is measured in pixels and +allows the brush stroke to linearly fall off (value obtained from +the option dialog). The pressure is set to the maximum at the +beginning of the stroke. As the distance of the stroke nears the +fade-out value, the pressure will approach zero. The gradient-length +(value obtained from the option dialog) is the distance to spread +the gradient over. It is measured in pixels. If the gradient-length +is 0, no gradient is used.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

num_strokes

Number of stroke control points (count each coordinate as 2 points).

 

strokes

Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_pencil ()

+
gboolean
+gimp_pencil (gint32 drawable_ID,
+             gint num_strokes,
+             const gdouble *strokes);
+

Paint in the current brush without sub-pixel sampling.

+

This tool is the standard pencil. It draws linearly interpolated +lines through the specified stroke coordinates. It operates on the +specified drawable in the foreground color with the active brush. +The brush mask is treated as though it contains only black and white +values. Any value below half is treated as black; any above half, as +white.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

num_strokes

Number of stroke control points (count each coordinate as 2 points).

 

strokes

Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_smudge ()

+
gboolean
+gimp_smudge (gint32 drawable_ID,
+             gdouble pressure,
+             gint num_strokes,
+             const gdouble *strokes);
+

Smudge image with varying pressure.

+

This tool simulates a smudge using the current brush. High pressure +results in a greater smudge of paint while low pressure results in a +lesser smudge.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

pressure

The pressure of the smudge strokes.

 

num_strokes

Number of stroke control points (count each coordinate as 2 points).

 

strokes

Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_smudge_default ()

+
gboolean
+gimp_smudge_default (gint32 drawable_ID,
+                     gint num_strokes,
+                     const gdouble *strokes);
+

Smudge image with varying pressure.

+

This tool simulates a smudge using the current brush. It behaves +exactly the same as gimp_smudge() except that the pressure value is +taken from the smudge tool options or the options default if the +tools option dialog has not been activated.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

num_strokes

Number of stroke control points (count each coordinate as 2 points).

 

strokes

Array of stroke coordinates: { s1.x, s1.y, s2.x, s2.y, ..., sn.x, sn.y }.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimppalette.html b/devel-docs/libgimp/html/libgimp-gimppalette.html new file mode 100644 index 0000000..2d259d2 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimppalette.html @@ -0,0 +1,924 @@ + + + + +gimppalette: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimppalette

+

gimppalette — Functions operating on a single palette.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+gchar * + +gimp_palette_new () +
+gchar * + +gimp_palette_duplicate () +
+gchar * + +gimp_palette_rename () +
+gboolean + +gimp_palette_delete () +
+gboolean + +gimp_palette_get_info () +
+GimpRGB * + +gimp_palette_get_colors () +
+gint + +gimp_palette_get_columns () +
+gboolean + +gimp_palette_set_columns () +
+gboolean + +gimp_palette_add_entry () +
+gboolean + +gimp_palette_delete_entry () +
+gboolean + +gimp_palette_entry_get_color () +
+gboolean + +gimp_palette_entry_set_color () +
+gboolean + +gimp_palette_entry_get_name () +
+gboolean + +gimp_palette_entry_set_name () +
+gboolean + +gimp_palette_get_foreground () +
+gboolean + +gimp_palette_get_background () +
+gboolean + +gimp_palette_set_foreground () +
+gboolean + +gimp_palette_set_background () +
+gboolean + +gimp_palette_set_default_colors () +
+gboolean + +gimp_palette_swap_colors () +
+gboolean + +gimp_palette_is_editable () +
+
+
+

Description

+

Functions operating on a single palette.

+
+
+

Functions

+
+

gimp_palette_new ()

+
gchar *
+gimp_palette_new (const gchar *name);
+

Creates a new palette

+

This procedure creates a new, uninitialized palette

+
+

Parameters

+
+++++ + + + + + +

name

The requested name of the new palette.

 
+
+
+

Returns

+

The actual new palette name.

+
+

Since: 2.2

+
+
+
+

gimp_palette_duplicate ()

+
gchar *
+gimp_palette_duplicate (const gchar *name);
+

Duplicates a palette

+

This procedure creates an identical palette by a different name

+
+

Parameters

+
+++++ + + + + + +

name

The palette name.

 
+
+
+

Returns

+

The name of the palette's copy.

+
+

Since: 2.2

+
+
+
+

gimp_palette_rename ()

+
gchar *
+gimp_palette_rename (const gchar *name,
+                     const gchar *new_name);
+

Rename a palette

+

This procedure renames a palette

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

name

The palette name.

 

new_name

The new name of the palette.

 
+
+
+

Returns

+

The actual new name of the palette.

+
+

Since: 2.2

+
+
+
+

gimp_palette_delete ()

+
gboolean
+gimp_palette_delete (const gchar *name);
+

Deletes a palette

+

This procedure deletes a palette

+
+

Parameters

+
+++++ + + + + + +

name

The palette name.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_palette_get_info ()

+
gboolean
+gimp_palette_get_info (const gchar *name,
+                       gint *num_colors);
+

Retrieve information about the specified palette.

+

This procedure retrieves information about the specified palette. +This includes the name, and the number of colors.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

name

The palette name.

 

num_colors

The number of colors in the palette.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_palette_get_colors ()

+
GimpRGB *
+gimp_palette_get_colors (const gchar *name,
+                         gint *num_colors);
+

Gets all colors from the specified palette.

+

This procedure retrieves all color entries of the specified palette.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

name

The palette name.

 

num_colors

Length of the colors array.

 
+
+
+

Returns

+

The colors in the palette.

+
+

Since: 2.6

+
+
+
+

gimp_palette_get_columns ()

+
gint
+gimp_palette_get_columns (const gchar *name);
+

Retrieves the number of columns to use to display this palette

+

This procedures retrieves the preferred number of columns to use +when the palette is being displayed.

+
+

Parameters

+
+++++ + + + + + +

name

The palette name.

 
+
+
+

Returns

+

The number of columns used to display this palette.

+
+

Since: 2.4

+
+
+
+

gimp_palette_set_columns ()

+
gboolean
+gimp_palette_set_columns (const gchar *name,
+                          gint columns);
+

Sets the number of columns to use when displaying the palette

+

This procedures controls how many colors are shown per row when the +palette is being displayed. This value can only be changed if the +palette is writable. The maximum allowed value is 64.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

name

The palette name.

 

columns

The new number of columns.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_palette_add_entry ()

+
gboolean
+gimp_palette_add_entry (const gchar *name,
+                        const gchar *entry_name,
+                        const GimpRGB *color,
+                        gint *entry_num);
+

Adds a palette entry to the specified palette.

+

This procedure adds an entry to the specified palette. It returns an +error if the entry palette does not exist.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

name

The palette name.

 

entry_name

The name of the entry.

 

color

The new entry's color color.

 

entry_num

The index of the added entry.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_palette_delete_entry ()

+
gboolean
+gimp_palette_delete_entry (const gchar *name,
+                           gint entry_num);
+

Deletes a palette entry from the specified palette.

+

This procedure deletes an entry from the specified palette. It +returns an error if the entry palette does not exist.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

name

The palette name.

 

entry_num

The index of the added entry.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_palette_entry_get_color ()

+
gboolean
+gimp_palette_entry_get_color (const gchar *name,
+                              gint entry_num,
+                              GimpRGB *color);
+

Gets the specified palette entry from the specified palette.

+

This procedure retrieves the color of the zero-based entry specified +for the specified palette. It returns an error if the entry does not +exist.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

name

The palette name.

 

entry_num

The entry to retrieve.

 

color

The color requested.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_palette_entry_set_color ()

+
gboolean
+gimp_palette_entry_set_color (const gchar *name,
+                              gint entry_num,
+                              const GimpRGB *color);
+

Sets the specified palette entry in the specified palette.

+

This procedure sets the color of the zero-based entry specified for +the specified palette. It returns an error if the entry does not +exist.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

name

The palette name.

 

entry_num

The entry to retrieve.

 

color

The new color.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_palette_entry_get_name ()

+
gboolean
+gimp_palette_entry_get_name (const gchar *name,
+                             gint entry_num,
+                             gchar **entry_name);
+

Gets the specified palette entry from the specified palette.

+

This procedure retrieves the name of the zero-based entry specified +for the specified palette. It returns an error if the entry does not +exist.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

name

The palette name.

 

entry_num

The entry to retrieve.

 

entry_name

The name requested.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_palette_entry_set_name ()

+
gboolean
+gimp_palette_entry_set_name (const gchar *name,
+                             gint entry_num,
+                             const gchar *entry_name);
+

Sets the specified palette entry in the specified palette.

+

This procedure sets the name of the zero-based entry specified for +the specified palette. It returns an error if the entry does not +exist.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

name

The palette name.

 

entry_num

The entry to retrieve.

 

entry_name

The new name.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_palette_get_foreground ()

+
gboolean
+gimp_palette_get_foreground (GimpRGB *foreground);
+

gimp_palette_get_foreground is deprecated and should not be used in newly-written code.

+

Get the current GIMP foreground color.

+

This procedure retrieves the current GIMP foreground color. The +foreground color is used in a variety of tools such as paint tools, +blending, and bucket fill.

+
+

Parameters

+
+++++ + + + + + +

foreground

The foreground color.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_palette_get_background ()

+
gboolean
+gimp_palette_get_background (GimpRGB *background);
+

gimp_palette_get_background is deprecated and should not be used in newly-written code.

+

Get the current GIMP background color.

+

This procedure retrieves the current GIMP background color. The +background color is used in a variety of tools such as blending, +erasing (with non-alpha images), and image filling.

+
+

Parameters

+
+++++ + + + + + +

background

The background color.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_palette_set_foreground ()

+
gboolean
+gimp_palette_set_foreground (const GimpRGB *foreground);
+

gimp_palette_set_foreground is deprecated and should not be used in newly-written code.

+

Set the current GIMP foreground color.

+

This procedure sets the current GIMP foreground color. After this is +set, operations which use foreground such as paint tools, blending, +and bucket fill will use the new value.

+
+

Parameters

+
+++++ + + + + + +

foreground

The foreground color.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_palette_set_background ()

+
gboolean
+gimp_palette_set_background (const GimpRGB *background);
+

gimp_palette_set_background is deprecated and should not be used in newly-written code.

+

Set the current GIMP background color.

+

This procedure sets the current GIMP background color. After this is +set, operations which use background such as blending, filling +images, clearing, and erasing (in non-alpha images) will use the new +value.

+
+

Parameters

+
+++++ + + + + + +

background

The background color.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_palette_set_default_colors ()

+
gboolean
+gimp_palette_set_default_colors (void);
+

gimp_palette_set_default_colors is deprecated and should not be used in newly-written code.

+

Set the current GIMP foreground and background colors to black and +white.

+

This procedure sets the current GIMP foreground and background +colors to their initial default values, black and white.

+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_palette_swap_colors ()

+
gboolean
+gimp_palette_swap_colors (void);
+

gimp_palette_swap_colors is deprecated and should not be used in newly-written code.

+

Swap the current GIMP foreground and background colors.

+

This procedure swaps the current GIMP foreground and background +colors, so that the new foreground color becomes the old background +color and vice versa.

+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_palette_is_editable ()

+
gboolean
+gimp_palette_is_editable (const gchar *name);
+

Tests if palette can be edited

+

Returns TRUE if you have permission to change the palette

+
+

Parameters

+
+++++ + + + + + +

name

The palette name.

 
+
+
+

Returns

+

TRUE if the palette can be edited.

+
+

Since: 2.4

+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimppalettemenu.html b/devel-docs/libgimp/html/libgimp-gimppalettemenu.html new file mode 100644 index 0000000..2106e3e --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimppalettemenu.html @@ -0,0 +1,189 @@ + + + + +gimppalettemenu: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimppalettemenu

+

gimppalettemenu — A widget for selecting palettes.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + +
+GtkWidget * + +gimp_palette_select_widget_new () +
+void + +gimp_palette_select_widget_close () +
+void + +gimp_palette_select_widget_set () +
+
+
+

Description

+

A widget for selecting palettes.

+
+
+

Functions

+
+

gimp_palette_select_widget_new ()

+
GtkWidget *
+gimp_palette_select_widget_new (const gchar *title,
+                                const gchar *palette_name,
+                                GimpRunPaletteCallback callback,
+                                gpointer data);
+

gimp_palette_select_widget_new is deprecated and should not be used in newly-written code.

+

Creates a new GtkWidget that completely controls the selection of +a palette. This widget is suitable for placement in a table in a +plug-in dialog.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

title

Title of the dialog to use or NULL to use the default title.

 

palette_name

Initial palette name.

 

callback

A function to call when the selected palette changes.

 

data

A pointer to arbitrary data to be used in the call to callback +.

 
+
+
+

Returns

+

A GtkWidget that you can use in your UI.

+
+

Since: 2.2

+
+
+
+

gimp_palette_select_widget_close ()

+
void
+gimp_palette_select_widget_close (GtkWidget *widget);
+

gimp_palette_select_widget_close is deprecated and should not be used in newly-written code.

+

Closes the popup window associated with widget +.

+
+

Parameters

+
+++++ + + + + + +

widget

A palette select widget.

 
+
+

Since: 2.2

+
+
+
+

gimp_palette_select_widget_set ()

+
void
+gimp_palette_select_widget_set (GtkWidget *widget,
+                                const gchar *palette_name);
+

gimp_palette_select_widget_set is deprecated and should not be used in newly-written code.

+

Sets the current palette for the palette select widget. Calls the +callback function if one was supplied in the call to +gimp_palette_select_widget_new().

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

widget

A palette select widget.

 

palette_name

Palette name to set; NULL means no change.

 
+
+

Since: 2.2

+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimppalettes.html b/devel-docs/libgimp/html/libgimp-gimppalettes.html new file mode 100644 index 0000000..262c5d6 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimppalettes.html @@ -0,0 +1,251 @@ + + + + +gimppalettes: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimppalettes

+

gimppalettes — Operations related to palettes.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+gboolean + +gimp_palettes_refresh () +
+gchar ** + +gimp_palettes_get_list () +
+gchar * + +gimp_palettes_get_palette () +
+gboolean + +gimp_palettes_set_palette () +
+gchar * + +gimp_palettes_get_palette_entry () +
+
+
+

Description

+

Operations related to palettes.

+
+
+

Functions

+
+

gimp_palettes_refresh ()

+
gboolean
+gimp_palettes_refresh (void);
+

Refreshes current palettes. This function always succeeds.

+

This procedure retrieves all palettes currently in the user's +palette path and updates the palette dialogs accordingly.

+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_palettes_get_list ()

+
gchar **
+gimp_palettes_get_list (const gchar *filter,
+                        gint *num_palettes);
+

Retrieves a list of all of the available palettes

+

This procedure returns a complete listing of available palettes. +Each name returned can be used as input to the command +gimp_context_set_palette().

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

filter

An optional regular expression used to filter the list.

 

num_palettes

The number of palettes in the list.

 
+
+
+

Returns

+

The list of palette names. The returned value must be freed +with g_strfreev().

+
+
+
+
+

gimp_palettes_get_palette ()

+
gchar *
+gimp_palettes_get_palette (gint *num_colors);
+
+

gimp_palettes_get_palette is deprecated and should not be used in newly-written code.

+

Use gimp_context_get_palette() instead.

+
+
+

Parameters

+
+++++ + + + + + +

num_colors

The palette num_colors.

 
+
+
+

Returns

+

The palette name.

+
+
+
+
+

gimp_palettes_set_palette ()

+
gboolean
+gimp_palettes_set_palette (const gchar *name);
+

gimp_palettes_set_palette is deprecated and should not be used in newly-written code.

+

This procedure is deprecated! Use gimp_context_set_palette() instead.

+
+

Parameters

+
+++++ + + + + + +

name

The palette name.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_palettes_get_palette_entry ()

+
gchar *
+gimp_palettes_get_palette_entry (const gchar *name,
+                                 gint entry_num,
+                                 gint *num_colors,
+                                 GimpRGB *color);
+
+

gimp_palettes_get_palette_entry is deprecated and should not be used in newly-written code.

+

Use gimp_palette_entry_get_color() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

name

The palette name (\"\" means currently active palette).

 

entry_num

The entry to retrieve.

 

num_colors

The palette num_colors.

 

color

The color requested.

 
+
+
+

Returns

+

The palette name.

+
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimppaletteselect.html b/devel-docs/libgimp/html/libgimp-gimppaletteselect.html new file mode 100644 index 0000000..2990ae4 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimppaletteselect.html @@ -0,0 +1,228 @@ + + + + +gimppaletteselect: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimppaletteselect

+

gimppaletteselect — Functions providing a palette selection dialog.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+void + +(*GimpRunPaletteCallback) () +
const gchar * + +gimp_palette_select_new () +
+void + +gimp_palette_select_destroy () +
+gboolean + +gimp_palettes_popup () +
+gboolean + +gimp_palettes_close_popup () +
+gboolean + +gimp_palettes_set_popup () +
+
+
+

Description

+

Functions providing a palette selection dialog.

+
+
+

Functions

+
+

GimpRunPaletteCallback ()

+
void
+(*GimpRunPaletteCallback) (const gchar *palette_name,
+                           gboolean dialog_closing,
+                           gpointer user_data);
+
+
+
+

gimp_palette_select_new ()

+
const gchar *
+gimp_palette_select_new (const gchar *title,
+                         const gchar *palette_name,
+                         GimpRunPaletteCallback callback,
+                         gpointer data);
+
+
+
+

gimp_palette_select_destroy ()

+
void
+gimp_palette_select_destroy (const gchar *palette_callback);
+
+
+
+

gimp_palettes_popup ()

+
gboolean
+gimp_palettes_popup (const gchar *palette_callback,
+                     const gchar *popup_title,
+                     const gchar *initial_palette);
+

Invokes the Gimp palette selection.

+

This procedure opens the palette selection dialog.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

palette_callback

The callback PDB proc to call when palette selection is made.

 

popup_title

Title of the palette selection dialog.

 

initial_palette

The name of the palette to set as the first selected.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_palettes_close_popup ()

+
gboolean
+gimp_palettes_close_popup (const gchar *palette_callback);
+

Close the palette selection dialog.

+

This procedure closes an opened palette selection dialog.

+
+

Parameters

+
+++++ + + + + + +

palette_callback

The name of the callback registered for this pop-up.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_palettes_set_popup ()

+
gboolean
+gimp_palettes_set_popup (const gchar *palette_callback,
+                         const gchar *palette_name);
+

Sets the current palette in a palette selection dialog.

+

Sets the current palette in a palette selection dialog.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

palette_callback

The name of the callback registered for this pop-up.

 

palette_name

The name of the palette to set as selected.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimppaths.html b/devel-docs/libgimp/html/libgimp-gimppaths.html new file mode 100644 index 0000000..151f22c --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimppaths.html @@ -0,0 +1,818 @@ + + + + +gimppaths: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimppaths

+

gimppaths — Deprecated operations related to paths.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+gchar ** + +gimp_path_list () +
+gint + +gimp_path_get_points () +
+gchar * + +gimp_path_get_current () +
+gboolean + +gimp_path_set_current () +
+gboolean + +gimp_path_set_points () +
+gboolean + +gimp_path_stroke_current () +
+gint + +gimp_path_get_point_at_dist () +
+gint + +gimp_path_get_tattoo () +
+gchar * + +gimp_get_path_by_tattoo () +
+gboolean + +gimp_path_delete () +
+gboolean + +gimp_path_get_locked () +
+gboolean + +gimp_path_set_locked () +
+gboolean + +gimp_path_set_tattoo () +
+gboolean + +gimp_path_to_selection () +
+gboolean + +gimp_path_import () +
+
+
+

Description

+

Deprecated operations related to paths.

+
+
+

Functions

+
+

gimp_path_list ()

+
gchar **
+gimp_path_list (gint32 image_ID,
+                gint *num_paths);
+
+

gimp_path_list is deprecated and should not be used in newly-written code.

+

Use gimp_image_get_vectors() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image to list the paths from.

 

num_paths

The number of paths returned.

 
+
+
+

Returns

+

List of the paths belonging to this image. The returned +value must be freed with g_strfreev().

+
+
+
+
+

gimp_path_get_points ()

+
gint
+gimp_path_get_points (gint32 image_ID,
+                      const gchar *name,
+                      gint *path_closed,
+                      gint *num_path_point_details,
+                      gdouble **points_pairs);
+
+

gimp_path_get_points is deprecated and should not be used in newly-written code.

+

Use gimp_vectors_stroke_get_points() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

image_ID

The image to list the paths from.

 

name

The name of the path whose points should be listed.

 

path_closed

Return if the path is closed. (0 = path open, 1 = path closed).

 

num_path_point_details

The number of points returned. Each point is made up of (x, y, pnt_type) of floats.

 

points_pairs

The points in the path represented as 3 floats. The first is the x pos, next is the y pos, last is the type of the pnt. The type field is dependent on the path type. For beziers (type 1 paths) the type can either be (1.0 = BEZIER_ANCHOR, 2.0 = BEZIER_CONTROL, 3.0 = BEZIER_MOVE). Note all points are returned in pixel resolution.

 
+
+
+

Returns

+

The type of the path. Currently only one type (1 = Bezier) +is supported.

+
+
+
+
+

gimp_path_get_current ()

+
gchar *
+gimp_path_get_current (gint32 image_ID);
+
+

gimp_path_get_current is deprecated and should not be used in newly-written code.

+

Use gimp_image_get_active_vectors() instead.

+
+
+

Parameters

+
+++++ + + + + + +

image_ID

The image to get the current path from.

 
+
+
+

Returns

+

The name of the current path.

+
+
+
+
+

gimp_path_set_current ()

+
gboolean
+gimp_path_set_current (gint32 image_ID,
+                       const gchar *name);
+
+

gimp_path_set_current is deprecated and should not be used in newly-written code.

+

Use gimp_image_set_active_vectors() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image in which a path will become current.

 

name

The name of the path to make current.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_path_set_points ()

+
gboolean
+gimp_path_set_points (gint32 image_ID,
+                      const gchar *name,
+                      gint ptype,
+                      gint num_path_points,
+                      const gdouble *points_pairs);
+
+

gimp_path_set_points is deprecated and should not be used in newly-written code.

+

Use gimp_vectors_stroke_new_from_points() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

image_ID

The image to set the paths in.

 

name

The name of the path to create. If it exists then a unique name will be created - query the list of paths if you want to make sure that the name of the path you create is unique. This will be set as the current path.

 

ptype

The type of the path. Currently only one type (1 = Bezier) is supported.

 

num_path_points

The number of elements in the array, i.e. the number of points in the path * 3. Each point is made up of (x, y, type) of floats. Currently only the creation of bezier curves is allowed. The type parameter must be set to (1) to indicate a BEZIER type curve. Note that for BEZIER curves, points must be given in the following order: ACCACCAC... If the path is not closed the last control point is missed off. Points consist of three control points (control/anchor/control) so for a curve that is not closed there must be at least two points passed (2 x,y pairs). If (num_path_points/3) % 3 = 0 then the path is assumed to be closed and the points are ACCACCACCACC.

 

points_pairs

The points in the path represented as 3 floats. The first is the x pos, next is the y pos, last is the type of the pnt. The type field is dependent on the path type. For beziers (type 1 paths) the type can either be (1.0 = BEZIER_ANCHOR, 2.0 = BEZIER_CONTROL, 3.0= BEZIER_MOVE). Note all points are returned in pixel resolution.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_path_stroke_current ()

+
gboolean
+gimp_path_stroke_current (gint32 image_ID);
+
+

gimp_path_stroke_current is deprecated and should not be used in newly-written code.

+

Use gimp_edit_stroke_vectors() instead.

+
+
+

Parameters

+
+++++ + + + + + +

image_ID

The image which contains the path to stroke.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_path_get_point_at_dist ()

+
gint
+gimp_path_get_point_at_dist (gint32 image_ID,
+                             gdouble distance,
+                             gint *y_point,
+                             gdouble *slope);
+
+

gimp_path_get_point_at_dist is deprecated and should not be used in newly-written code.

+

Use gimp_vectors_stroke_get_point_at_dist() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

image_ID

The image the paths belongs to.

 

distance

The distance along the path.

 

y_point

The y position of the point.

 

slope

The slope (dy / dx) at the specified point.

 
+
+
+

Returns

+

The x position of the point.

+
+
+
+
+

gimp_path_get_tattoo ()

+
gint
+gimp_path_get_tattoo (gint32 image_ID,
+                      const gchar *name);
+
+

gimp_path_get_tattoo is deprecated and should not be used in newly-written code.

+

Use gimp_vectors_get_tattoo() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

name

The name of the path whose tattoo should be obtained.

 
+
+
+

Returns

+

The tattoo associated with the named path.

+
+
+
+
+

gimp_get_path_by_tattoo ()

+
gchar *
+gimp_get_path_by_tattoo (gint32 image_ID,
+                         gint tattoo);
+
+

gimp_get_path_by_tattoo is deprecated and should not be used in newly-written code.

+

Use gimp_image_get_vectors_by_tattoo() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

tattoo

The tattoo of the required path.

 
+
+
+

Returns

+

The name of the path with the specified tattoo.

+
+
+
+
+

gimp_path_delete ()

+
gboolean
+gimp_path_delete (gint32 image_ID,
+                  const gchar *name);
+
+

gimp_path_delete is deprecated and should not be used in newly-written code.

+

Use gimp_image_remove_vectors() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image to delete the path from.

 

name

The name of the path to delete.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_path_get_locked ()

+
gboolean
+gimp_path_get_locked (gint32 image_ID,
+                      const gchar *name);
+
+

gimp_path_get_locked is deprecated and should not be used in newly-written code.

+

Use gimp_vectors_get_linked() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

name

The name of the path whose locked status should be obtained.

 
+
+
+

Returns

+

TRUE if the path is locked, FALSE otherwise.

+
+
+
+
+

gimp_path_set_locked ()

+
gboolean
+gimp_path_set_locked (gint32 image_ID,
+                      const gchar *name,
+                      gboolean locked);
+
+

gimp_path_set_locked is deprecated and should not be used in newly-written code.

+

Use gimp_vectors_set_linked() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

name

the name of the path whose locked status should be set.

 

locked

Whether the path is locked.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_path_set_tattoo ()

+
gboolean
+gimp_path_set_tattoo (gint32 image_ID,
+                      const gchar *name,
+                      gint tattovalue);
+
+

gimp_path_set_tattoo is deprecated and should not be used in newly-written code.

+

Use gimp_vectors_set_tattoo() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

name

the name of the path whose tattoo should be set.

 

tattovalue

The tattoo associated with the name path. Only values returned from 'path_get_tattoo' should be used here.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_path_to_selection ()

+
gboolean
+gimp_path_to_selection (gint32 image_ID,
+                        const gchar *name,
+                        GimpChannelOps op,
+                        gboolean antialias,
+                        gboolean feather,
+                        gdouble feather_radius_x,
+                        gdouble feather_radius_y);
+
+

gimp_path_to_selection is deprecated and should not be used in newly-written code.

+

Use gimp_vectors_to_selection() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

name

The name of the path which should be made into selection.

 

op

The desired operation with current selection.

 

antialias

Antialias selection.

 

feather

Feather selection.

 

feather_radius_x

Feather radius x.

 

feather_radius_y

Feather radius y.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_path_import ()

+
gboolean
+gimp_path_import (gint32 image_ID,
+                  const gchar *filename,
+                  gboolean merge,
+                  gboolean scale);
+
+

gimp_path_import is deprecated and should not be used in newly-written code.

+

Use gimp_vectors_import_from_file() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

filename

The name of the SVG file to import.

 

merge

Merge paths into a single vectors object.

 

scale

Scale the SVG to image dimensions.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimppattern.html b/devel-docs/libgimp/html/libgimp-gimppattern.html new file mode 100644 index 0000000..a722f23 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimppattern.html @@ -0,0 +1,182 @@ + + + + +gimppattern: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimppattern

+

gimppattern — Functions operating on a single pattern.

+
+
+

Functions

+
++++ + + + + + + + + + + +
+gboolean + +gimp_pattern_get_info () +
+gboolean + +gimp_pattern_get_pixels () +
+
+
+

Description

+

Functions operating on a single pattern.

+
+
+

Functions

+
+

gimp_pattern_get_info ()

+
gboolean
+gimp_pattern_get_info (const gchar *name,
+                       gint *width,
+                       gint *height,
+                       gint *bpp);
+

Retrieve information about the specified pattern.

+

This procedure retrieves information about the specified pattern. +This includes the pattern extents (width and height).

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

name

The pattern name.

 

width

The pattern width.

 

height

The pattern height.

 

bpp

The pattern bpp.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_pattern_get_pixels ()

+
gboolean
+gimp_pattern_get_pixels (const gchar *name,
+                         gint *width,
+                         gint *height,
+                         gint *bpp,
+                         gint *num_color_bytes,
+                         guint8 **color_bytes);
+

Retrieve information about the specified pattern (including pixels).

+

This procedure retrieves information about the specified. This +includes the pattern extents (width and height), its bpp and its +pixel data.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

name

The pattern name.

 

width

The pattern width.

 

height

The pattern height.

 

bpp

The pattern bpp.

 

num_color_bytes

Number of pattern bytes.

 

color_bytes

The pattern data.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimppatternmenu.html b/devel-docs/libgimp/html/libgimp-gimppatternmenu.html new file mode 100644 index 0000000..0ab27b5 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimppatternmenu.html @@ -0,0 +1,186 @@ + + + + +gimppatternmenu: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimppatternmenu

+

gimppatternmenu — A widget for selecting patterns.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + +
+GtkWidget * + +gimp_pattern_select_widget_new () +
+void + +gimp_pattern_select_widget_close () +
+void + +gimp_pattern_select_widget_set () +
+
+
+

Description

+

A widget for selecting patterns.

+
+
+

Functions

+
+

gimp_pattern_select_widget_new ()

+
GtkWidget *
+gimp_pattern_select_widget_new (const gchar *title,
+                                const gchar *pattern_name,
+                                GimpRunPatternCallback callback,
+                                gpointer data);
+

gimp_pattern_select_widget_new is deprecated and should not be used in newly-written code.

+

Creates a new GtkWidget that completely controls the selection of +a pattern. This widget is suitable for placement in a table in a +plug-in dialog.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

title

Title of the dialog to use or NULL to use the default title.

 

pattern_name

Initial pattern name or NULL to use current selection.

 

callback

A function to call when the selected pattern changes.

 

data

A pointer to arbitrary data to be used in the call to callback +.

 
+
+
+

Returns

+

A GtkWidget that you can use in your UI.

+
+
+
+
+

gimp_pattern_select_widget_close ()

+
void
+gimp_pattern_select_widget_close (GtkWidget *widget);
+

gimp_pattern_select_widget_close is deprecated and should not be used in newly-written code.

+

Closes the popup window associated with widget +.

+
+

Parameters

+
+++++ + + + + + +

widget

A pattern select widget.

 
+
+
+
+
+

gimp_pattern_select_widget_set ()

+
void
+gimp_pattern_select_widget_set (GtkWidget *widget,
+                                const gchar *pattern_name);
+

gimp_pattern_select_widget_set is deprecated and should not be used in newly-written code.

+

Sets the current pattern for the pattern select widget. Calls the +callback function if one was supplied in the call to +gimp_pattern_select_widget_new().

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

widget

A pattern select widget.

 

pattern_name

Pattern name to set. NULL means no change.

 
+
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimppatterns.html b/devel-docs/libgimp/html/libgimp-gimppatterns.html new file mode 100644 index 0000000..65ea36f --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimppatterns.html @@ -0,0 +1,271 @@ + + + + +gimppatterns: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimppatterns

+

gimppatterns — Functions relating to patterns.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+gboolean + +gimp_patterns_refresh () +
+gchar ** + +gimp_patterns_get_list () +
+gchar * + +gimp_patterns_get_pattern () +
+gboolean + +gimp_patterns_set_pattern () +
+gchar * + +gimp_patterns_get_pattern_data () +
+
+
+

Description

+

Functions relating to patterns.

+
+
+

Functions

+
+

gimp_patterns_refresh ()

+
gboolean
+gimp_patterns_refresh (void);
+

Refresh current patterns. This function always succeeds.

+

This procedure retrieves all patterns currently in the user's +pattern path and updates all pattern dialogs accordingly.

+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_patterns_get_list ()

+
gchar **
+gimp_patterns_get_list (const gchar *filter,
+                        gint *num_patterns);
+

Retrieve a complete listing of the available patterns.

+

This procedure returns a complete listing of available GIMP +patterns. Each name returned can be used as input to the +gimp_context_set_pattern().

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

filter

An optional regular expression used to filter the list.

 

num_patterns

The number of patterns in the pattern list.

 
+
+
+

Returns

+

The list of pattern names. The returned value must be freed +with g_strfreev().

+
+
+
+
+

gimp_patterns_get_pattern ()

+
gchar *
+gimp_patterns_get_pattern (gint *width,
+                           gint *height);
+
+

gimp_patterns_get_pattern is deprecated and should not be used in newly-written code.

+

Use gimp_context_get_pattern() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

width

The pattern width.

 

height

The pattern height.

 
+
+
+

Returns

+

The pattern name.

+
+
+
+
+

gimp_patterns_set_pattern ()

+
gboolean
+gimp_patterns_set_pattern (const gchar *name);
+

gimp_patterns_set_pattern is deprecated and should not be used in newly-written code.

+

This procedure is deprecated! Use gimp_context_set_pattern() instead.

+
+

Parameters

+
+++++ + + + + + +

name

The pattern name.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_patterns_get_pattern_data ()

+
gchar *
+gimp_patterns_get_pattern_data (const gchar *name,
+                                gint *width,
+                                gint *height,
+                                gint *mask_bpp,
+                                gint *length,
+                                guint8 **mask_data);
+
+

gimp_patterns_get_pattern_data is deprecated and should not be used in newly-written code.

+

Use gimp_pattern_get_pixels() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

name

The pattern name (\"\" means currently active pattern).

 

width

The pattern width.

 

height

The pattern height.

 

mask_bpp

Pattern bytes per pixel.

 

length

Length of pattern mask data.

 

mask_data

The pattern mask data.

 
+
+
+

Returns

+

The pattern name.

+
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimppatternselect.html b/devel-docs/libgimp/html/libgimp-gimppatternselect.html new file mode 100644 index 0000000..cbdbc3b --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimppatternselect.html @@ -0,0 +1,232 @@ + + + + +gimppatternselect: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimppatternselect

+

gimppatternselect — Functions providing a pattern selection dialog.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+void + +(*GimpRunPatternCallback) () +
const gchar * + +gimp_pattern_select_new () +
+void + +gimp_pattern_select_destroy () +
+gboolean + +gimp_patterns_popup () +
+gboolean + +gimp_patterns_close_popup () +
+gboolean + +gimp_patterns_set_popup () +
+
+
+

Description

+

Functions providing a pattern selection dialog.

+
+
+

Functions

+
+

GimpRunPatternCallback ()

+
void
+(*GimpRunPatternCallback) (const gchar *pattern_name,
+                           gint width,
+                           gint height,
+                           gint bpp,
+                           const guchar *mask_data,
+                           gboolean dialog_closing,
+                           gpointer user_data);
+
+
+
+

gimp_pattern_select_new ()

+
const gchar *
+gimp_pattern_select_new (const gchar *title,
+                         const gchar *pattern_name,
+                         GimpRunPatternCallback callback,
+                         gpointer data);
+
+
+
+

gimp_pattern_select_destroy ()

+
void
+gimp_pattern_select_destroy (const gchar *pattern_callback);
+
+
+
+

gimp_patterns_popup ()

+
gboolean
+gimp_patterns_popup (const gchar *pattern_callback,
+                     const gchar *popup_title,
+                     const gchar *initial_pattern);
+

Invokes the Gimp pattern selection.

+

This procedure opens the pattern selection dialog.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

pattern_callback

The callback PDB proc to call when pattern selection is made.

 

popup_title

Title of the pattern selection dialog.

 

initial_pattern

The name of the pattern to set as the first selected.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_patterns_close_popup ()

+
gboolean
+gimp_patterns_close_popup (const gchar *pattern_callback);
+

Close the pattern selection dialog.

+

This procedure closes an opened pattern selection dialog.

+
+

Parameters

+
+++++ + + + + + +

pattern_callback

The name of the callback registered for this pop-up.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_patterns_set_popup ()

+
gboolean
+gimp_patterns_set_popup (const gchar *pattern_callback,
+                         const gchar *pattern_name);
+

Sets the current pattern in a pattern selection dialog.

+

Sets the current pattern in a pattern selection dialog.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

pattern_callback

The name of the callback registered for this pop-up.

 

pattern_name

The name of the pattern to set as selected.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimppixbuf.html b/devel-docs/libgimp/html/libgimp-gimppixbuf.html new file mode 100644 index 0000000..cd74562 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimppixbuf.html @@ -0,0 +1,306 @@ + + + + +gimppixbuf: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimppixbuf

+

gimppixbuf — Get a thumbnail pixbuf for a drawable or image.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + +
+GdkPixbuf * + +gimp_image_get_thumbnail () +
+GdkPixbuf * + +gimp_drawable_get_thumbnail () +
+GdkPixbuf * + +gimp_drawable_get_sub_thumbnail () +
+
+
+

Types and Values

+
++++ + + + + +
enumGimpPixbufTransparency
+
+
+

Description

+

Get a thumbnail pixbuf for a drawable or image.

+
+
+

Functions

+
+

gimp_image_get_thumbnail ()

+
GdkPixbuf *
+gimp_image_get_thumbnail (gint32 image_ID,
+                          gint width,
+                          gint height,
+                          GimpPixbufTransparency alpha);
+

Retrieves a thumbnail pixbuf for the image identified by image_ID +. +The thumbnail will be not larger than the requested size.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

image_ID

the image ID

 

width

the requested thumbnail width (<= 1024 pixels)

 

height

the requested thumbnail height (<= 1024 pixels)

 

alpha

how to handle an alpha channel

 
+
+
+

Returns

+

a new GdkPixbuf

+
+

Since: 2.2

+
+
+
+

gimp_drawable_get_thumbnail ()

+
GdkPixbuf *
+gimp_drawable_get_thumbnail (gint32 drawable_ID,
+                             gint width,
+                             gint height,
+                             GimpPixbufTransparency alpha);
+

Retrieves a thumbnail pixbuf for the drawable identified by +drawable_ID +. The thumbnail will be not larger than the requested +size.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

the drawable ID

 

width

the requested thumbnail width (<= 1024 pixels)

 

height

the requested thumbnail height (<= 1024 pixels)

 

alpha

how to handle an alpha channel

 
+
+
+

Returns

+

a new GdkPixbuf

+
+

Since: 2.2

+
+
+
+

gimp_drawable_get_sub_thumbnail ()

+
GdkPixbuf *
+gimp_drawable_get_sub_thumbnail (gint32 drawable_ID,
+                                 gint src_x,
+                                 gint src_y,
+                                 gint src_width,
+                                 gint src_height,
+                                 gint dest_width,
+                                 gint dest_height,
+                                 GimpPixbufTransparency alpha);
+

Retrieves a thumbnail pixbuf for the drawable identified by +drawable_ID +. The thumbnail will be not larger than the requested +size.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

the drawable ID

 

src_x

the x coordinate of the area

 

src_y

the y coordinate of the area

 

src_width

the width of the area

 

src_height

the height of the area

 

dest_width

the requested thumbnail width (<= 1024 pixels)

 

dest_height

the requested thumbnail height (<= 1024 pixels)

 

alpha

how to handle an alpha channel

 
+
+
+

Returns

+

a new GdkPixbuf

+
+

Since: 2.2

+
+
+
+

Types and Values

+
+

enum GimpPixbufTransparency

+

How to deal with transparency when creating thubnail pixbufs from +images and drawables.

+
+

Members

+
+++++ + + + + + + + + + + + + + + + + + +

GIMP_PIXBUF_KEEP_ALPHA

 +

Create a pixbuf with alpha

+		 

GIMP_PIXBUF_SMALL_CHECKS

 +

Show transparency as small checks

+		 

GIMP_PIXBUF_LARGE_CHECKS

 +

Show transparency as large checks

+		 
+
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimppixelfetcher.html b/devel-docs/libgimp/html/libgimp-gimppixelfetcher.html new file mode 100644 index 0000000..9ada2ff --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimppixelfetcher.html @@ -0,0 +1,382 @@ + + + + +gimppixelfetcher: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimppixelfetcher

+

gimppixelfetcher — Functions for operating on pixel regions.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+GimpPixelFetcher * + +gimp_pixel_fetcher_new () +
+void + +gimp_pixel_fetcher_set_edge_mode () +
+void + +gimp_pixel_fetcher_set_bg_color () +
+void + +gimp_pixel_fetcher_get_pixel () +
+void + +gimp_pixel_fetcher_put_pixel () +
+void + +gimp_pixel_fetcher_destroy () +
+
+
+

Types and Values

+
++++ + + + + + + + + + + +
enumGimpPixelFetcherEdgeMode
 GimpPixelFetcher
+
+
+

Description

+

These functions provide neighbourhood-based algorithms which get +dramatically slower on region boundaries, to the point where a +special treatment for neighbourhoods which are completely inside a +tile is called for. It hides the special treatment of tile borders, +making plug-in code more readable and shorter.

+
+
+

Functions

+
+

gimp_pixel_fetcher_new ()

+
GimpPixelFetcher *
+gimp_pixel_fetcher_new (GimpDrawable *drawable,
+                        gboolean shadow);
+

gimp_pixel_fetcher_new is deprecated and should not be used in newly-written code.

+

Initialize a pixel region from the drawable.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

drawable

the GimpDrawable the new region will be attached to.

 

shadow

a gboolean indicating whether the region is attached to +the shadow tiles or the real drawable +tiles.

 
+
+
+

Returns

+

a pointer to a GimpPixelRgn structure (or NULL).

+
+
+
+
+

gimp_pixel_fetcher_set_edge_mode ()

+
void
+gimp_pixel_fetcher_set_edge_mode (GimpPixelFetcher *pf,
+                                  GimpPixelFetcherEdgeMode mode);
+

gimp_pixel_fetcher_set_edge_mode is deprecated and should not be used in newly-written code.

+

Change the edge mode of a previously initialized pixel region.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

pf

a pointer to a previously initialized GimpPixelFetcher.

 

mode

the new edge mode from GimpPixelFetcherEdgeMode.

 
+
+
+
+
+

gimp_pixel_fetcher_set_bg_color ()

+
void
+gimp_pixel_fetcher_set_bg_color (GimpPixelFetcher *pf,
+                                 const GimpRGB *color);
+

gimp_pixel_fetcher_set_bg_color is deprecated and should not be used in newly-written code.

+

Change the background color of a previously initialized pixel region.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

pf

a pointer to a previously initialized GimpPixelFetcher.

 

color

the color to be used as bg color.

 
+
+
+
+
+

gimp_pixel_fetcher_get_pixel ()

+
void
+gimp_pixel_fetcher_get_pixel (GimpPixelFetcher *pf,
+                              gint x,
+                              gint y,
+                              guchar *pixel);
+

gimp_pixel_fetcher_get_pixel is deprecated and should not be used in newly-written code.

+

Get a pixel from the pixel region.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

pf

a pointer to a previously initialized GimpPixelFetcher.

 

x

the x coordinate of the pixel to get.

 

y

the y coordinate of the pixel to get.

 

pixel

the memory location where to return the pixel.

 
+
+
+
+
+

gimp_pixel_fetcher_put_pixel ()

+
void
+gimp_pixel_fetcher_put_pixel (GimpPixelFetcher *pf,
+                              gint x,
+                              gint y,
+                              const guchar *pixel);
+

gimp_pixel_fetcher_put_pixel is deprecated and should not be used in newly-written code.

+

Set a pixel in the pixel region.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

pf

a pointer to a previously initialized GimpPixelFetcher.

 

x

the x coordinate of the pixel to set.

 

y

the y coordinate of the pixel to set.

 

pixel

the pixel to set.

 
+
+
+
+
+

gimp_pixel_fetcher_destroy ()

+
void
+gimp_pixel_fetcher_destroy (GimpPixelFetcher *pf);
+

gimp_pixel_fetcher_destroy is deprecated and should not be used in newly-written code.

+

Close a previously initialized pixel region.

+
+

Parameters

+
+++++ + + + + + +

pf

a pointer to a previously initialized GimpPixelFetcher.

 
+
+
+
+
+

Types and Values

+
+

enum GimpPixelFetcherEdgeMode

+
+

Members

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

GIMP_PIXEL_FETCHER_EDGE_NONE

  

GIMP_PIXEL_FETCHER_EDGE_WRAP

  

GIMP_PIXEL_FETCHER_EDGE_SMEAR

  

GIMP_PIXEL_FETCHER_EDGE_BLACK

  

GIMP_PIXEL_FETCHER_EDGE_BACKGROUND

  
+
+
+
+
+

GimpPixelFetcher

+
typedef struct _GimpPixelFetcher GimpPixelFetcher;
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimppixelrgn.html b/devel-docs/libgimp/html/libgimp-gimppixelrgn.html new file mode 100644 index 0000000..ddf93b7 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimppixelrgn.html @@ -0,0 +1,940 @@ + + + + +gimppixelrgn: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimppixelrgn

+

gimppixelrgn — Functions for operating on pixel regions.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+void + +gimp_pixel_rgn_init () +
+void + +gimp_pixel_rgn_resize () +
+void + +gimp_pixel_rgn_get_pixel () +
+void + +gimp_pixel_rgn_get_row () +
+void + +gimp_pixel_rgn_get_col () +
+void + +gimp_pixel_rgn_get_rect () +
+void + +gimp_pixel_rgn_set_pixel () +
+void + +gimp_pixel_rgn_set_row () +
+void + +gimp_pixel_rgn_set_col () +
+void + +gimp_pixel_rgn_set_rect () +
+gpointer + +gimp_pixel_rgns_register () +
+gpointer + +gimp_pixel_rgns_register2 () +
+gpointer + +gimp_pixel_rgns_process () +
+
+
+

Types and Values

+
++++ + + + + +
 GimpPixelRgn
+
+
+

Description

+

Functions for operating on pixel regions. These functions provide +fast ways of accessing and modifying portions of a drawable.

+
+
+

Functions

+
+

gimp_pixel_rgn_init ()

+
void
+gimp_pixel_rgn_init (GimpPixelRgn *pr,
+                     GimpDrawable *drawable,
+                     gint x,
+                     gint y,
+                     gint width,
+                     gint height,
+                     gint dirty,
+                     gint shadow);
+

gimp_pixel_rgn_init is deprecated and should not be used in newly-written code.

+

Initialize the pixel region pointed by pr + with the specified parameters.

+

The dirty + and shadow + flags can be used as follows:

+
    +

  • dirty + = FALSE, shadow + = FALSE: the region will be used to read + the actual drawable datas. This + is useful for save plug-ins or for + filters.

    • +

  • dirty + = FALSE, shadow + = TRUE: the region will be used to read the + shadow tiles. This is used in + some filter plug-ins which operate + in two passes such as gaussian + blur. The first pass reads the + actual drawable data and writes to + the shadow tiles, and the second + one reads from and writes to the + shadow tiles.

    • +

  • dirty + = TRUE, shadow + = TRUE: the region will be used to write to + the shadow tiles. It is common + practice to write to the shadow + tiles and then use + gimp_drawable_merge_shadow() to + merge the changes from the shadow + tiles using the current selection + as a mask.

    • +

  • dirty + = TRUE, shadow + = FALSE: the region will be used to directly + change the drawable content. Don't + do this, since this could prevent + the Undo-System from working as + expected.

    • +
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

pr

a pointer to a GimpPixelRgn variable.

 

drawable

the GimpDrawable the new region will be attached to.

 

x

the x coordinate of the top-left pixel of the region in the +drawable +.

 

y

the y coordinate of the top-left pixel of the region in the +drawable +.

 

width

the width of the region.

 

height

the height of the region.

 

dirty

a gboolean indicating whether the drawable +should be marked +as "dirty".

 

shadow

a gboolean indicating whether the region is attached to the +shadow tiles or the real drawable +tiles.

 
+
+
+
+
+

gimp_pixel_rgn_resize ()

+
void
+gimp_pixel_rgn_resize (GimpPixelRgn *pr,
+                       gint x,
+                       gint y,
+                       gint width,
+                       gint height);
+

gimp_pixel_rgn_resize is deprecated and should not be used in newly-written code.

+

Change the position and size of a previously initialized pixel region.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

pr

a pointer to a previously initialized GimpPixelRgn.

 

x

the x coordinate of the new position of the region's +top-left corner.

 

y

the y coordinate of the new position of the region's +top-left corner.

 

width

the new width of the region.

 

height

the new height of the region.

 
+
+
+
+
+

gimp_pixel_rgn_get_pixel ()

+
void
+gimp_pixel_rgn_get_pixel (GimpPixelRgn *pr,
+                          guchar *buf,
+                          gint x,
+                          gint y);
+

gimp_pixel_rgn_get_pixel is deprecated and should not be used in newly-written code.

+

Fill the buffer pointed by buf + with the value of the pixel at (x +, y +) +in the region pr +. buf + should be large enough to hold the pixel value +(1 guchar for an indexed or grayscale drawable, 2 guchar for +indexed with alpha or grayscale with alpha drawable, 3 guchar for +rgb drawable and 4 guchar for rgb with alpha drawable.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

pr

a pointer to a previously initialized GimpPixelRgn.

 

buf

a pointer to an array of guchar

 

x

the x coordinate of the wanted pixel (relative to the drawable)

 

y

the y coordinate of the wanted pixel (relative to the drawable)

 
+
+
+
+
+

gimp_pixel_rgn_get_row ()

+
void
+gimp_pixel_rgn_get_row (GimpPixelRgn *pr,
+                        guchar *buf,
+                        gint x,
+                        gint y,
+                        gint width);
+

gimp_pixel_rgn_get_row is deprecated and should not be used in newly-written code.

+

Get several pixels of a region in a row. This function fills the buffer +buf + with the values of the pixels from (x +, y +) to (x ++width +-1, y +). +buf + should be large enough to hold all these values.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

pr

a pointer to a previously initialized GimpPixelRgn.

 

buf

a pointer to an array of guchar

 

x

the x coordinate of the first pixel (relative to the drawable).

 

y

the y coordinate of the first pixel (relative to the drawable).

 

width

the number of pixels to get.

 
+
+
+
+
+

gimp_pixel_rgn_get_col ()

+
void
+gimp_pixel_rgn_get_col (GimpPixelRgn *pr,
+                        guchar *buf,
+                        gint x,
+                        gint y,
+                        gint height);
+

gimp_pixel_rgn_get_col is deprecated and should not be used in newly-written code.

+

Get several pixels of a region's column. This function fills the buffer +buf + with the values of the pixels from (x +, y +) to (x +, y ++height +-1). +buf + should be large enough to hold all these values.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

pr

a pointer to a previously initialized GimpPixelRgn.

 

buf

a pointer to an array of guchar

 

x

the x coordinate of the first pixel (relative to the drawable).

 

y

the y coordinate of the first pixel (relative to the drawable).

 

height

the number of pixels to get.

 
+
+
+
+
+

gimp_pixel_rgn_get_rect ()

+
void
+gimp_pixel_rgn_get_rect (GimpPixelRgn *pr,
+                         guchar *buf,
+                         gint x,
+                         gint y,
+                         gint width,
+                         gint height);
+

gimp_pixel_rgn_get_rect is deprecated and should not be used in newly-written code.

+

Get all the pixel values from the rectangle defined by x +, y +, width + and +height +. This function fills the buffer buf + with the values of the pixels +from (x +, y +) to (x ++width +-1, y ++height +-1). +buf + should be large enough to hold all these values (width +*height +*bpp).

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

pr

a pointer to a previously initialized GimpPixelRgn.

 

buf

a pointer to an array of guchar

 

x

the x coordinate of the first pixel (relative to the drawable).

 

y

the y coordinate of the first pixel (relative to the drawable).

 

width

the width of the rectangle.

 

height

the height of the rectangle.

 
+
+
+
+
+

gimp_pixel_rgn_set_pixel ()

+
void
+gimp_pixel_rgn_set_pixel (GimpPixelRgn *pr,
+                          const guchar *buf,
+                          gint x,
+                          gint y);
+

gimp_pixel_rgn_set_pixel is deprecated and should not be used in newly-written code.

+

Set the pixel at (x +, y +) to the values from buf +.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

pr

a pointer to a previously initialized GimpPixelRgn.

 

buf

a pointer to an array of guchar.

 

x

the x coordinate of the pixel (relative to the drawable).

 

y

the y coordinate of the pixel (relative to the drawable).

 
+
+
+
+
+

gimp_pixel_rgn_set_row ()

+
void
+gimp_pixel_rgn_set_row (GimpPixelRgn *pr,
+                        const guchar *buf,
+                        gint x,
+                        gint y,
+                        gint width);
+

gimp_pixel_rgn_set_row is deprecated and should not be used in newly-written code.

+

Set several pixels of a region in a row. This function draws the pixels +from (x +, y +) to (x ++width +-1, y +) using the values of the buffer buf +. +buf + should be large enough to hold all these values.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

pr

a pointer to a previously initialized GimpPixelRgn.

 

buf

a pointer to an array of guchar

 

x

the x coordinate of the first pixel (relative to the drawable).

 

y

the y coordinate of the first pixel (relative to the drawable).

 

width

the number of pixels to set.

 
+
+
+
+
+

gimp_pixel_rgn_set_col ()

+
void
+gimp_pixel_rgn_set_col (GimpPixelRgn *pr,
+                        const guchar *buf,
+                        gint x,
+                        gint y,
+                        gint height);
+

gimp_pixel_rgn_set_col is deprecated and should not be used in newly-written code.

+

Set several pixels of a region's column. This function draws the pixels +from (x +, y +) to (x +, y ++height +-1) using the values from the buffer buf +. +buf + should be large enough to hold all these values.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

pr

a pointer to a previously initialized GimpPixelRgn.

 

buf

a pointer to an array of guchar

 

x

the x coordinate of the first pixel (relative to the drawable).

 

y

the y coordinate of the first pixel (relative to the drawable).

 

height

the number of pixels to set.

 
+
+
+
+
+

gimp_pixel_rgn_set_rect ()

+
void
+gimp_pixel_rgn_set_rect (GimpPixelRgn *pr,
+                         const guchar *buf,
+                         gint x,
+                         gint y,
+                         gint width,
+                         gint height);
+

gimp_pixel_rgn_set_rect is deprecated and should not be used in newly-written code.

+

Set all the pixel of the rectangle defined by x +, y +, width + and +height +. This function draws the rectangle from (x +, y +) to +(x ++width +-1, y ++height +-1), using the pixel values from the buffer buf +. +buf + should be large enough to hold all these values (width +*height +*bpp).

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

pr

a pointer to a previously initialized GimpPixelRgn.

 

buf

a pointer to an array of guchar

 

x

the x coordinate of the first pixel (relative to the drawable).

 

y

the y coordinate of the first pixel (relative to the drawable).

 

width

the width of the rectangle.

 

height

the height of the rectangle.

 
+
+
+
+
+

gimp_pixel_rgns_register ()

+
gpointer
+gimp_pixel_rgns_register (gint nrgns,
+                          ...);
+

gimp_pixel_rgns_register is deprecated and should not be used in newly-written code.

+

This is the varargs version of gimp_pixel_rgns_register2.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

nrgns

the number of regions to register.

 

...

nrgns +pointers to GimpPixelRgn.

 
+
+
+

Returns

+

a gpointer to a regions iterator.

+
+
+
+
+

gimp_pixel_rgns_register2 ()

+
gpointer
+gimp_pixel_rgns_register2 (gint nrgns,
+                           GimpPixelRgn **prs);
+

gimp_pixel_rgns_register2 is deprecated and should not be used in newly-written code.

+

It takes a number of initialized regions of the same size and provides a +pixel region iterator the iterator can be used to iterate over the +registered pixel regions. While iterating the registered pixel regions will +cover subsets of the original pixel regions, chosen for optimized access to +the image data.

+

Note that the given regions themselves are changed by this function, so +they are resized to the first subsets.

+

This function has to be used together with gimp_pixel_rgns_process in a loop.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

nrgns

the number of regions to register.

 

prs

an array of nrgns +pointers to initialized GimpPixelRgn.

 
+
+
+

Returns

+

a gpointer to a regions iterator.

+
+
+
+
+

gimp_pixel_rgns_process ()

+
gpointer
+gimp_pixel_rgns_process (gpointer pri_ptr);
+

gimp_pixel_rgns_process is deprecated and should not be used in newly-written code.

+

This function update the regions registered previously with one of the +gimp_pixel_rgns_register* functions to their next tile.

+
+

Parameters

+
+++++ + + + + + +

pri_ptr

a regions iterator returned by gimp_pixel_rgns_register, +gimp_pixel_rgns_register2 or gimp_pixel_rgns_process.

 
+
+
+

Returns

+

a gpointer to a new regions iterator or NULL if there isn't +any tiles left.

+
+
+
+
+

Types and Values

+
+

GimpPixelRgn

+
typedef struct {
+  guchar       *data;          /* pointer to region data */
+  GimpDrawable *drawable;      /* pointer to drawable */
+  gint          bpp;           /* bytes per pixel */
+  gint          rowstride;     /* bytes per pixel row */
+  gint          x, y;          /* origin */
+  gint          w, h;          /* width and height of region */
+  guint         dirty : 1;     /* will this region be dirtied? */
+  guint         shadow : 1;    /* will this region use the shadow or normal tiles */
+  gint          process_count; /* used internally */
+} GimpPixelRgn;
+
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpplugin.html b/devel-docs/libgimp/html/libgimp-gimpplugin.html new file mode 100644 index 0000000..091328a --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpplugin.html @@ -0,0 +1,374 @@ + + + + +gimpplugin: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpplugin

+

gimpplugin — Functions useful for plug-ins, e.g. registration and progress indicators.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+gboolean + +gimp_plugin_domain_register () +
+gboolean + +gimp_plugin_help_register () +
+gboolean + +gimp_plugin_icon_register () +
+gboolean + +gimp_plugin_menu_register () +
+gboolean + +gimp_plugin_menu_branch_register () +
+gboolean + +gimp_plugin_set_pdb_error_handler () +
+GimpPDBErrorHandler + +gimp_plugin_get_pdb_error_handler () +
+gboolean + +gimp_plugin_enable_precision () +
+gboolean + +gimp_plugin_precision_enabled () +
+
+
+

Description

+

Functions useful for plug-ins, e.g. registration and progress +indicators.

+
+
+

Functions

+
+

gimp_plugin_domain_register ()

+
gboolean
+gimp_plugin_domain_register (const gchar *domain_name,
+                             const gchar *domain_path);
+

Registers a textdomain for localisation.

+

This procedure adds a textdomain to the list of domains Gimp +searches for strings when translating its menu entries. There is no +need to call this function for plug-ins that have their strings +included in the 'gimp-std-plugins' domain as that is used by +default. If the compiled message catalog is not in the standard +location, you may specify an absolute path to another location. This +procedure can only be called in the query function of a plug-in and +it has to be called before any procedure is installed.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

domain_name

The name of the textdomain (must be unique).

 

domain_path

The absolute path to the compiled message catalog (may be NULL).

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_plugin_help_register ()

+
gboolean
+gimp_plugin_help_register (const gchar *domain_name,
+                           const gchar *domain_uri);
+

Register a help path for a plug-in.

+

This procedure registers user documentation for the calling plug-in +with the GIMP help system. The domain_uri parameter points to the +root directory where the plug-in help is installed. For each +supported language there should be a file called 'gimp-help.xml' +that maps the help IDs to the actual help files.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

domain_name

The XML namespace of the plug-in's help pages.

 

domain_uri

The root URI of the plug-in's help pages.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_plugin_icon_register ()

+
gboolean
+gimp_plugin_icon_register (const gchar *procedure_name,
+                           GimpIconType icon_type,
+                           const guint8 *icon_data);
+
+
+
+

gimp_plugin_menu_register ()

+
gboolean
+gimp_plugin_menu_register (const gchar *procedure_name,
+                           const gchar *menu_path);
+

Register an additional menu path for a plug-in procedure.

+

This procedure installs an additional menu entry for the given +procedure.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

procedure_name

The procedure for which to install the menu path.

 

menu_path

The procedure's additional menu path.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

gimp_plugin_menu_branch_register ()

+
gboolean
+gimp_plugin_menu_branch_register (const gchar *menu_path,
+                                  const gchar *menu_name);
+

Register a sub-menu.

+

This procedure installs a sub-menu which does not belong to any +procedure. The menu-name should be the untranslated menu label. GIMP +will look up the translation in the textdomain registered for the +plug-in.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

menu_path

The sub-menu's menu path.

 

menu_name

The name of the sub-menu.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_plugin_set_pdb_error_handler ()

+
gboolean
+gimp_plugin_set_pdb_error_handler (GimpPDBErrorHandler handler);
+

Sets an error handler for procedure calls.

+

This procedure changes the way that errors in procedure calls are +handled. By default GIMP will raise an error dialog if a procedure +call made by a plug-in fails. Using this procedure the plug-in can +change this behavior. If the error handler is set to +GIMP_PDB_ERROR_HANDLER_PLUGIN, then the plug-in is responsible for +calling gimp_get_pdb_error() and handling the error whenever one if +its procedure calls fails. It can do this by displaying the error +message or by forwarding it in its own return values.

+
+

Parameters

+
+++++ + + + + + +

handler

Who is responsible for handling procedure call errors.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.6

+
+
+
+

gimp_plugin_get_pdb_error_handler ()

+
GimpPDBErrorHandler
+gimp_plugin_get_pdb_error_handler (void);
+

Retrieves the active error handler for procedure calls.

+

This procedure retrieves the currently active error handler for +procedure calls made by the calling plug-in. See +gimp_plugin_set_pdb_error_handler() for details.

+
+

Returns

+

Who is responsible for handling procedure call errors.

+
+

Since: 2.6

+
+
+
+

gimp_plugin_enable_precision ()

+
gboolean
+gimp_plugin_enable_precision (void);
+

Switches this plug-in to using the real bit depth of drawables.

+

Switches this plug-in to using the real bit depth of drawables. This +setting can only be enabled, and not disabled again during the +lifetime of the plug-in. Using gimp_drawable_get_buffer(), +gimp_drawable_get_shadow_buffer() or gimp_drawable_get_format() will +automatically call this function.

+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_plugin_precision_enabled ()

+
gboolean
+gimp_plugin_precision_enabled (void);
+

Whether this plug-in is using the real bit depth of drawables.

+

Returns whether this plug-in is using the real bit depth of +drawables, which can be more than 8 bits per channel.

+
+

Returns

+

Whether precision is enabled.

+
+

Since: 2.10

+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpproceduraldb.html b/devel-docs/libgimp/html/libgimp-gimpproceduraldb.html new file mode 100644 index 0000000..09729af --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpproceduraldb.html @@ -0,0 +1,611 @@ + + + + +gimpproceduraldb: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpproceduraldb

+

gimpproceduraldb — Functions for querying and changing procedural database (PDB) entries.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+gchar * + +gimp_procedural_db_temp_name () +
+gboolean + +gimp_procedural_db_get_data () +
+gboolean + +gimp_procedural_db_set_data () +
+gboolean + +gimp_procedural_db_dump () +
+gboolean + +gimp_procedural_db_query () +
+gboolean + +gimp_procedural_db_proc_exists () +
+gboolean + +gimp_procedural_db_proc_info () +
+gboolean + +gimp_procedural_db_proc_arg () +
+gboolean + +gimp_procedural_db_proc_val () +
+gint + +gimp_procedural_db_get_data_size () +
+
+
+

Description

+

Functions for querying and changing procedural database (PDB) +entries.

+
+
+

Functions

+
+

gimp_procedural_db_temp_name ()

+
gchar *
+gimp_procedural_db_temp_name (void);
+

Generates a unique temporary PDB name.

+

This procedure generates a temporary PDB entry name that is +guaranteed to be unique.

+
+

Returns

+

A unique temporary name for a temporary PDB entry.

+
+
+
+
+

gimp_procedural_db_get_data ()

+
gboolean
+gimp_procedural_db_get_data (const gchar *identifier,
+                             gpointer data);
+

Returns data associated with the specified identifier.

+

This procedure returns any data which may have been associated with +the specified identifier. The data is copied into the given memory +location.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

identifier

The identifier associated with data.

 

data

A byte array containing data.

 
+
+
+

Returns

+

TRUE on success, FALSE if no data has been associated with +the identifier

+
+
+
+
+

gimp_procedural_db_set_data ()

+
gboolean
+gimp_procedural_db_set_data (const gchar *identifier,
+                             gconstpointer data,
+                             guint32 bytes);
+

Associates the specified identifier with the supplied data.

+

This procedure associates the supplied data with the provided +identifier. The data may be subsequently retrieved by a call to +'procedural-db-get-data'.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

identifier

The identifier associated with data.

 

data

A byte array containing data.

 

bytes

The number of bytes in the data

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_procedural_db_dump ()

+
gboolean
+gimp_procedural_db_dump (const gchar *filename);
+

Dumps the current contents of the procedural database

+

This procedure dumps the contents of the procedural database to the +specified file. The file will contain all of the information +provided for each registered procedure.

+
+

Parameters

+
+++++ + + + + + +

filename

The dump filename.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_procedural_db_query ()

+
gboolean
+gimp_procedural_db_query (const gchar *name,
+                          const gchar *blurb,
+                          const gchar *help,
+                          const gchar *author,
+                          const gchar *copyright,
+                          const gchar *date,
+                          const gchar *proc_type,
+                          gint *num_matches,
+                          gchar ***procedure_names);
+

Queries the procedural database for its contents using regular +expression matching.

+

This procedure queries the contents of the procedural database. It +is supplied with seven arguments matching procedures on { name, +blurb, help, author, copyright, date, procedure type}. This is +accomplished using regular expression matching. For instance, to +find all procedures with \"jpeg\" listed in the blurb, all seven +arguments can be supplied as \".*\", except for the second, which +can be supplied as \".*jpeg.*\". There are two return arguments for +this procedure. The first is the number of procedures matching the +query. The second is a concatenated list of procedure names +corresponding to those matching the query. If no matching entries +are found, then the returned string is NULL and the number of +entries is 0.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

name

The regex for procedure name.

 

blurb

The regex for procedure blurb.

 

help

The regex for procedure help.

 

author

The regex for procedure author.

 

copyright

The regex for procedure copyright.

 

date

The regex for procedure date.

 

proc_type

The regex for procedure type: { 'Internal GIMP procedure', 'GIMP Plug-in', 'GIMP Extension', 'Temporary Procedure' }.

 

num_matches

The number of matching procedures.

 

procedure_names

The list of procedure names.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_procedural_db_proc_exists ()

+
gboolean
+gimp_procedural_db_proc_exists (const gchar *procedure_name);
+

Checks if the specified procedure exists in the procedural database

+

This procedure checks if the specified procedure is registered in +the procedural database.

+
+

Parameters

+
+++++ + + + + + +

procedure_name

The procedure name.

 
+
+
+

Returns

+

Whether a procedure of that name is registered.

+
+

Since: 2.6

+
+
+
+

gimp_procedural_db_proc_info ()

+
gboolean
+gimp_procedural_db_proc_info (const gchar *procedure,
+                              gchar **blurb,
+                              gchar **help,
+                              gchar **author,
+                              gchar **copyright,
+                              gchar **date,
+                              GimpPDBProcType *proc_type,
+                              gint *num_args,
+                              gint *num_values,
+                              GimpParamDef **args,
+                              GimpParamDef **return_vals);
+

Queries the procedural database for information on the specified +procedure.

+

This procedure returns information on the specified procedure. A +short blurb, detailed help, author(s), copyright information, +procedure type, number of input, and number of return values are +returned. Additionally this function returns specific information +about each input argument and return value.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

procedure

The procedure name.

 

blurb

A short blurb.

 

help

Detailed procedure help.

 

author

Author(s) of the procedure.

 

copyright

The copyright.

 

date

Copyright date.

 

proc_type

The procedure type.

 

num_args

The number of input arguments.

 

num_values

The number of return values.

 

args

The input arguments.

 

return_vals

The return values.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_procedural_db_proc_arg ()

+
gboolean
+gimp_procedural_db_proc_arg (const gchar *procedure_name,
+                             gint arg_num,
+                             GimpPDBArgType *arg_type,
+                             gchar **arg_name,
+                             gchar **arg_desc);
+

Queries the procedural database for information on the specified +procedure's argument.

+

This procedure returns information on the specified procedure's +argument. The argument type, name, and a description are retrieved.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

procedure_name

The procedure name.

 

arg_num

The argument number.

 

arg_type

The type of argument.

 

arg_name

The name of the argument.

 

arg_desc

A description of the argument.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_procedural_db_proc_val ()

+
gboolean
+gimp_procedural_db_proc_val (const gchar *procedure_name,
+                             gint val_num,
+                             GimpPDBArgType *val_type,
+                             gchar **val_name,
+                             gchar **val_desc);
+

Queries the procedural database for information on the specified +procedure's return value.

+

This procedure returns information on the specified procedure's +return value. The return value type, name, and a description are +retrieved.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

procedure_name

The procedure name.

 

val_num

The return value number.

 

val_type

The type of return value.

 

val_name

The name of the return value.

 

val_desc

A description of the return value.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_procedural_db_get_data_size ()

+
gint
+gimp_procedural_db_get_data_size (const gchar *identifier);
+

Returns size of data associated with the specified identifier.

+

This procedure returns the size of any data which may have been +associated with the specified identifier. If no data has been +associated with the identifier, an error is returned.

+
+

Parameters

+
+++++ + + + + + +

identifier

The identifier associated with data.

 
+
+
+

Returns

+

The number of bytes in the data.

+
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpprogress.html b/devel-docs/libgimp/html/libgimp-gimpprogress.html new file mode 100644 index 0000000..f41cfad --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpprogress.html @@ -0,0 +1,614 @@ + + + + +gimpprogress: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpprogress

+

gimpprogress — Functions for embedding the progress bar into a plug-in's GUI.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+gboolean + +gimp_progress_init () +
+gboolean + +gimp_progress_init_printf () +
+gboolean + +gimp_progress_update () +
+gboolean + +gimp_progress_pulse () +
+gboolean + +gimp_progress_set_text () +
+gboolean + +gimp_progress_set_text_printf () +
+gboolean + +gimp_progress_end () +
+gint + +gimp_progress_get_window_handle () +
+void + +(*GimpProgressStartCallback) () +
+void + +(*GimpProgressEndCallback) () +
+void + +(*GimpProgressTextCallback) () +
+void + +(*GimpProgressValueCallback) () +
const gchar * + +gimp_progress_install_vtable () +
const gchar * + +gimp_progress_install () +
+gpointer + +gimp_progress_uninstall () +
+gboolean + +gimp_progress_cancel () +
+
+
+

Types and Values

+
++++ + + + + +
structGimpProgressVtable
+
+
+

Description

+

Functions for embedding the progress bar into a plug-in's GUI.

+
+
+

Functions

+
+

gimp_progress_init ()

+
gboolean
+gimp_progress_init (const gchar *message);
+

Initializes the progress bar for the current plug-in.

+

Initializes the progress bar for the current plug-in. It is only +valid to call this procedure from a plug-in.

+
+

Parameters

+
+++++ + + + + + +

message

Message to use in the progress dialog.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_progress_init_printf ()

+
gboolean
+gimp_progress_init_printf (const gchar *format,
+                           ...);
+

Initializes the progress bar for the current plug-in.

+

Initializes the progress bar for the current plug-in. It is only +valid to call this procedure from a plug-in.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

format

a standard printf() format string

 

...

arguments for format +

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_progress_update ()

+
gboolean
+gimp_progress_update (gdouble percentage);
+

Updates the progress bar for the current plug-in.

+
+

Parameters

+
+++++ + + + + + +

percentage

Percentage of progress completed (in the range from 0.0 to 1.0).

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_progress_pulse ()

+
gboolean
+gimp_progress_pulse (void);
+

Pulses the progress bar for the current plug-in.

+

Updates the progress bar for the current plug-in. It is only valid +to call this procedure from a plug-in. Use this function instead of +gimp_progress_update() if you cannot tell how much progress has been +made. This usually causes the the progress bar to enter \"activity +mode\", where a block bounces back and forth.

+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_progress_set_text ()

+
gboolean
+gimp_progress_set_text (const gchar *message);
+

Changes the text in the progress bar for the current plug-in.

+

This function changes the text in the progress bar for the current +plug-in. Unlike gimp_progress_init() it does not change the +displayed value.

+
+

Parameters

+
+++++ + + + + + +

message

Message to use in the progress dialog.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_progress_set_text_printf ()

+
gboolean
+gimp_progress_set_text_printf (const gchar *format,
+                               ...);
+

Changes the text in the progress bar for the current plug-in.

+

This function changes the text in the progress bar for the current +plug-in. Unlike gimp_progress_init() it does not change the +displayed value.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

format

a standard printf() format string

 

...

arguments for format +

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_progress_end ()

+
gboolean
+gimp_progress_end (void);
+

Ends the progress bar for the current plug-in.

+

Ends the progress display for the current plug-in. Most plug-ins +don't need to call this, they just exit when the work is done. It is +only valid to call this procedure from a plug-in.

+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_progress_get_window_handle ()

+
gint
+gimp_progress_get_window_handle (void);
+

Returns the native window ID of the toplevel window this plug-in's +progress is displayed in.

+

This function returns the native window ID of the toplevel window +this plug-in\'s progress is displayed in.

+
+

Returns

+

The progress bar's toplevel window.

+
+

Since: 2.2

+
+
+
+

GimpProgressStartCallback ()

+
void
+(*GimpProgressStartCallback) (const gchar *message,
+                              gboolean cancelable,
+                              gpointer user_data);
+

GimpProgressStartCallback is deprecated and should not be used in newly-written code.

+
+
+
+

GimpProgressEndCallback ()

+
void
+(*GimpProgressEndCallback) (gpointer user_data);
+

GimpProgressEndCallback is deprecated and should not be used in newly-written code.

+
+
+
+

GimpProgressTextCallback ()

+
void
+(*GimpProgressTextCallback) (const gchar *message,
+                             gpointer user_data);
+

GimpProgressTextCallback is deprecated and should not be used in newly-written code.

+
+
+
+

GimpProgressValueCallback ()

+
void
+(*GimpProgressValueCallback) (gdouble percentage,
+                              gpointer user_data);
+

GimpProgressValueCallback is deprecated and should not be used in newly-written code.

+
+
+
+

gimp_progress_install_vtable ()

+
const gchar *
+gimp_progress_install_vtable (const GimpProgressVtable *vtable,
+                              gpointer user_data);
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

vtable

a pointer to a GimpProgressVtable +.

 

user_data

a pointer that is passed as user_data to all vtable functions.

 
+
+
+

Returns

+

the name of the temporary procedure that's been installed

+
+

Since: 2.4

+
+
+
+

gimp_progress_install ()

+
const gchar *
+gimp_progress_install (GimpProgressStartCallback start_callback,
+                       GimpProgressEndCallback end_callback,
+                       GimpProgressTextCallback text_callback,
+                       GimpProgressValueCallback value_callback,
+                       gpointer user_data);
+

gimp_progress_install is deprecated and should not be used in newly-written code.

+

Note that since GIMP 2.4, value_callback + can be called with +negative values. This is triggered by calls to gimp_progress_pulse(). +The callback should then implement a progress indicating business, +e.g. by calling gtk_progress_bar_pulse().

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

start_callback

the function to call when progress starts

 

end_callback

the function to call when progress finishes

 

text_callback

the function to call to change the text

 

value_callback

the function to call to change the value

 

user_data

a pointer that is returned when uninstalling the progress

 
+
+
+

Returns

+

the name of the temporary procedure that's been installed

+
+

Since: 2.2

+
+
+
+

gimp_progress_uninstall ()

+
gpointer
+gimp_progress_uninstall (const gchar *progress_callback);
+

Uninstalls a temporary progress procedure that was installed using +gimp_progress_install().

+
+

Parameters

+
+++++ + + + + + +

progress_callback

the name of the temporary procedure to uninstall

 
+
+
+

Returns

+

the user_data +that was passed to gimp_progress_install().

+
+

Since: 2.2

+
+
+
+

gimp_progress_cancel ()

+
gboolean
+gimp_progress_cancel (const gchar *progress_callback);
+

Cancels a running progress.

+

This function cancels the currently running progress.

+
+

Parameters

+
+++++ + + + + + +

progress_callback

The name of the callback registered for this progress.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.2

+
+
+
+

Types and Values

+
+

struct GimpProgressVtable

+
struct GimpProgressVtable {
+  void    (* start)        (const gchar *message,
+                            gboolean     cancelable,
+                            gpointer     user_data);
+  void    (* end)          (gpointer     user_data);
+  void    (* set_text)     (const gchar *message,
+                            gpointer     user_data);
+  void    (* set_value)    (gdouble      percentage,
+                            gpointer     user_data);
+  void    (* pulse)        (gpointer     user_data);
+
+  guint32 (* get_window)   (gpointer     user_data);
+
+  /* Padding for future expansion. Must be initialized with NULL! */
+  void (* _gimp_reserved1) (void);
+  void (* _gimp_reserved2) (void);
+  void (* _gimp_reserved3) (void);
+  void (* _gimp_reserved4) (void);
+  void (* _gimp_reserved5) (void);
+  void (* _gimp_reserved6) (void);
+  void (* _gimp_reserved7) (void);
+  void (* _gimp_reserved8) (void);
+};
+
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpregioniterator.html b/devel-docs/libgimp/html/libgimp-gimpregioniterator.html new file mode 100644 index 0000000..ea0a308 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpregioniterator.html @@ -0,0 +1,330 @@ + + + + +gimpregioniterator: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpregioniterator

+

gimpregioniterator — Functions to traverse a pixel regions.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+void + +(*GimpRgnFunc1) () +
+void + +(*GimpRgnFunc2) () +
+void + +(*GimpRgnFuncSrc) () +
+void + +(*GimpRgnFuncDest) () +
+void + +(*GimpRgnFuncSrcDest) () +
+GimpRgnIterator * + +gimp_rgn_iterator_new () +
+void + +gimp_rgn_iterator_free () +
+void + +gimp_rgn_iterator_src () +
+void + +gimp_rgn_iterator_dest () +
+void + +gimp_rgn_iterator_src_dest () +
+void + +gimp_rgn_iterate1 () +
+void + +gimp_rgn_iterate2 () +
+
+
+

Types and Values

+
++++ + + + + +
 GimpRgnIterator
+
+
+

Description

+

The GimpRgnIterator functions provide a variety of common ways to +traverse a PixelRegion, using a pre-defined function pointer per +pixel.

+
+
+

Functions

+
+

GimpRgnFunc1 ()

+
void
+(*GimpRgnFunc1) (const guchar *src,
+                 gint bpp,
+                 gpointer data);
+
+
+
+

GimpRgnFunc2 ()

+
void
+(*GimpRgnFunc2) (const guchar *src,
+                 guchar *dest,
+                 gint bpp,
+                 gpointer data);
+
+
+
+

GimpRgnFuncSrc ()

+
void
+(*GimpRgnFuncSrc) (gint x,
+                   gint y,
+                   const guchar *src,
+                   gint bpp,
+                   gpointer data);
+
+
+
+

GimpRgnFuncDest ()

+
void
+(*GimpRgnFuncDest) (gint x,
+                    gint y,
+                    guchar *dest,
+                    gint bpp,
+                    gpointer data);
+
+
+
+

GimpRgnFuncSrcDest ()

+
void
+(*GimpRgnFuncSrcDest) (gint x,
+                       gint y,
+                       const guchar *src,
+                       guchar *dest,
+                       gint bpp,
+                       gpointer data);
+
+
+
+

gimp_rgn_iterator_new ()

+
GimpRgnIterator *
+gimp_rgn_iterator_new (GimpDrawable *drawable,
+                       GimpRunMode unused);
+

gimp_rgn_iterator_new is deprecated and should not be used in newly-written code.

+

Creates a new GimpRgnIterator for drawable +. The GimpRunMode +parameter is ignored. Use gimp_rgn_iterator_free() to free this +iterator.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

drawable

a GimpDrawable

 

unused

ignored

 
+
+
+

Returns

+

a newly allocated GimpRgnIterator.

+
+
+
+
+

gimp_rgn_iterator_free ()

+
void
+gimp_rgn_iterator_free (GimpRgnIterator *iter);
+

gimp_rgn_iterator_free is deprecated and should not be used in newly-written code.

+

Frees the resources allocated for iter +.

+
+

Parameters

+
+++++ + + + + + +

iter

a GimpRgnIterator

 
+
+
+
+
+

gimp_rgn_iterator_src ()

+
void
+gimp_rgn_iterator_src (GimpRgnIterator *iter,
+                       GimpRgnFuncSrc func,
+                       gpointer data);
+

gimp_rgn_iterator_src is deprecated and should not be used in newly-written code.

+
+
+
+

gimp_rgn_iterator_dest ()

+
void
+gimp_rgn_iterator_dest (GimpRgnIterator *iter,
+                        GimpRgnFuncDest func,
+                        gpointer data);
+

gimp_rgn_iterator_dest is deprecated and should not be used in newly-written code.

+
+
+
+

gimp_rgn_iterator_src_dest ()

+
void
+gimp_rgn_iterator_src_dest (GimpRgnIterator *iter,
+                            GimpRgnFuncSrcDest func,
+                            gpointer data);
+

gimp_rgn_iterator_src_dest is deprecated and should not be used in newly-written code.

+
+
+
+

gimp_rgn_iterate1 ()

+
void
+gimp_rgn_iterate1 (GimpDrawable *drawable,
+                   GimpRunMode unused,
+                   GimpRgnFunc1 func,
+                   gpointer data);
+

gimp_rgn_iterate1 is deprecated and should not be used in newly-written code.

+
+
+
+

gimp_rgn_iterate2 ()

+
void
+gimp_rgn_iterate2 (GimpDrawable *drawable,
+                   GimpRunMode unused,
+                   GimpRgnFunc2 func,
+                   gpointer data);
+

gimp_rgn_iterate2 is deprecated and should not be used in newly-written code.

+
+
+
+

Types and Values

+
+

GimpRgnIterator

+
typedef struct _GimpRgnIterator GimpRgnIterator;
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpselection.html b/devel-docs/libgimp/html/libgimp-gimpselection.html new file mode 100644 index 0000000..94a9c95 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpselection.html @@ -0,0 +1,882 @@ + + + + +gimpselection: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpselection

+

gimpselection — Functions for manipulating selections.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+gboolean + +gimp_selection_bounds () +
+gboolean + +gimp_selection_all () +
+gboolean + +gimp_selection_none () +
+gboolean + +gimp_selection_clear () +
+gboolean + +gimp_selection_is_empty () +
+gint32 + +gimp_selection_float () +
+gboolean + +gimp_selection_load () +
+gint32 + +gimp_selection_save () +
+gint + +gimp_selection_value () +
+gboolean + +gimp_selection_grow () +
+gboolean + +gimp_selection_shrink () +
+gboolean + +gimp_selection_invert () +
+gboolean + +gimp_selection_feather () +
+gboolean + +gimp_selection_sharpen () +
+gboolean + +gimp_selection_border () +
+gboolean + +gimp_selection_flood () +
+gboolean + +gimp_selection_translate () +
+gboolean + +gimp_selection_layer_alpha () +
+gboolean + +gimp_selection_combine () +
+
+
+

Description

+

Functions for manipulating selections.

+
+
+

Functions

+
+

gimp_selection_bounds ()

+
gboolean
+gimp_selection_bounds (gint32 image_ID,
+                       gboolean *non_empty,
+                       gint *x1,
+                       gint *y1,
+                       gint *x2,
+                       gint *y2);
+

Find the bounding box of the current selection.

+

This procedure returns whether there is a selection for the +specified image. If there is one, the upper left and lower right +corners of the bounding box are returned. These coordinates are +relative to the image. Please note that the pixel specified by the +lower right coordinate of the bounding box is not part of the +selection. The selection ends at the upper left corner of this +pixel. This means the width of the selection can be calculated as +(x2 - x1), its height as (y2 - y1).

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

non_empty

TRUE if there is a selection.

 

x1

x coordinate of upper left corner of selection bounds.

 

y1

y coordinate of upper left corner of selection bounds.

 

x2

x coordinate of lower right corner of selection bounds.

 

y2

y coordinate of lower right corner of selection bounds.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_selection_all ()

+
gboolean
+gimp_selection_all (gint32 image_ID);
+

Select all of the image.

+

This procedure sets the selection mask to completely encompass the +image. Every pixel in the selection channel is set to 255.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_selection_none ()

+
gboolean
+gimp_selection_none (gint32 image_ID);
+

Deselect the entire image.

+

This procedure deselects the entire image. Every pixel in the +selection channel is set to 0.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_selection_clear ()

+
gboolean
+gimp_selection_clear (gint32 image_ID);
+

gimp_selection_clear is deprecated and should not be used in newly-written code.

+

This procedure is deprecated! Use gimp_selection_none() instead.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_selection_is_empty ()

+
gboolean
+gimp_selection_is_empty (gint32 image_ID);
+

Determine whether the selection is empty.

+

This procedure returns TRUE if the selection for the specified image +is empty.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

Is the selection empty?

+
+
+
+
+

gimp_selection_float ()

+
gint32
+gimp_selection_float (gint32 image_ID,
+                      gint32 drawable_ID,
+                      gint offx,
+                      gint offy);
+

Float the selection from the specified drawable with initial offsets +as specified.

+

This procedure determines the region of the specified drawable that +lies beneath the current selection. The region is then cut from the +drawable and the resulting data is made into a new layer which is +instantiated as a floating selection. The offsets allow initial +positioning of the new floating selection.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

image_ID

ignored

 

drawable_ID

The drawable from which to float selection.

 

offx

x offset for translation.

 

offy

y offset for translation.

 
+
+
+

Returns

+

The floated layer.

+
+
+
+
+

gimp_selection_load ()

+
gboolean
+gimp_selection_load (gint32 channel_ID);
+
+

gimp_selection_load is deprecated and should not be used in newly-written code.

+

Use gimp_image_select_item() instead.

+
+
+

Parameters

+
+++++ + + + + + +

channel_ID

The channel.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_selection_save ()

+
gint32
+gimp_selection_save (gint32 image_ID);
+

Copy the selection mask to a new channel.

+

This procedure copies the selection mask and stores the content in a +new channel. The new channel is automatically inserted into the +image's list of channels.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

The new channel.

+
+
+
+
+

gimp_selection_value ()

+
gint
+gimp_selection_value (gint32 image_ID,
+                      gint x,
+                      gint y);
+

Find the value of the selection at the specified coordinates.

+

This procedure returns the value of the selection at the specified +coordinates. If the coordinates lie out of bounds, 0 is returned.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

x

x coordinate of value.

 

y

y coordinate of value.

 
+
+
+

Returns

+

Value of the selection.

+
+
+
+
+

gimp_selection_grow ()

+
gboolean
+gimp_selection_grow (gint32 image_ID,
+                     gint steps);
+

Grow the image's selection

+

This procedure grows the selection. Growing involves expanding the +boundary in all directions by the specified pixel amount.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

steps

Steps of grow (in pixels).

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_selection_shrink ()

+
gboolean
+gimp_selection_shrink (gint32 image_ID,
+                       gint steps);
+

Shrink the image's selection

+

This procedure shrinks the selection. Shrinking involves trimming +the existing selection boundary on all sides by the specified number +of pixels.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

steps

Steps of shrink (in pixels).

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_selection_invert ()

+
gboolean
+gimp_selection_invert (gint32 image_ID);
+

Invert the selection mask.

+

This procedure inverts the selection mask. For every pixel in the +selection channel, its new value is calculated as (255 - old-value).

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_selection_feather ()

+
gboolean
+gimp_selection_feather (gint32 image_ID,
+                        gdouble radius);
+

Feather the image's selection

+

This procedure feathers the selection. Feathering is implemented +using a gaussian blur.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

radius

Radius of feather (in pixels).

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_selection_sharpen ()

+
gboolean
+gimp_selection_sharpen (gint32 image_ID);
+

Sharpen the selection mask.

+

This procedure sharpens the selection mask. For every pixel in the +selection channel, if the value is > 127, the new pixel is +assigned a value of 255. This removes any \"anti-aliasing\" that +might exist in the selection mask's boundary.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_selection_border ()

+
gboolean
+gimp_selection_border (gint32 image_ID,
+                       gint radius);
+

Border the image's selection

+

This procedure borders the selection. Bordering creates a new +selection which is defined along the boundary of the previous +selection at every point within the specified radius.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

radius

Radius of border (in pixels).

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_selection_flood ()

+
gboolean
+gimp_selection_flood (gint32 image_ID);
+

Remove holes from the image's selection

+

This procedure removes holes from the selection, that can come from +selecting a patchy area with the Fuzzy Select Tool. In technical +terms this procedure floods the selection. See the Algorithms page +in the developer wiki for details.

+
+

Parameters

+
+++++ + + + + + +

image_ID

The image.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.10

+
+
+
+

gimp_selection_translate ()

+
gboolean
+gimp_selection_translate (gint32 image_ID,
+                          gint offx,
+                          gint offy);
+

Translate the selection by the specified offsets.

+

This procedure actually translates the selection for the specified +image by the specified offsets. Regions that are translated from +beyond the bounds of the image are set to empty. Valid regions of +the selection which are translated beyond the bounds of the image +because of this call are lost.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

offx

x offset for translation.

 

offy

y offset for translation.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_selection_layer_alpha ()

+
gboolean
+gimp_selection_layer_alpha (gint32 layer_ID);
+
+

gimp_selection_layer_alpha is deprecated and should not be used in newly-written code.

+

Use gimp_image_select_item() instead.

+
+
+

Parameters

+
+++++ + + + + + +

layer_ID

Layer with alpha.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_selection_combine ()

+
gboolean
+gimp_selection_combine (gint32 channel_ID,
+                        GimpChannelOps operation);
+
+

gimp_selection_combine is deprecated and should not be used in newly-written code.

+

Use gimp_image_select_item() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

channel_ID

The channel.

 

operation

The selection operation.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpselectiontools.html b/devel-docs/libgimp/html/libgimp-gimpselectiontools.html new file mode 100644 index 0000000..d67be4e --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpselectiontools.html @@ -0,0 +1,778 @@ + + + + +gimpselectiontools: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpselectiontools

+

gimpselectiontools — Access to toolbox selection tools.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+gboolean + +gimp_by_color_select () +
+gboolean + +gimp_by_color_select_full () +
+gboolean + +gimp_ellipse_select () +
+gboolean + +gimp_free_select () +
+gboolean + +gimp_fuzzy_select () +
+gboolean + +gimp_fuzzy_select_full () +
+gboolean + +gimp_rect_select () +
+gboolean + +gimp_round_rect_select () +
+
+
+

Description

+

Functions giving access to toolbox selection tools.

+
+
+

Functions

+
+

gimp_by_color_select ()

+
gboolean
+gimp_by_color_select (gint32 drawable_ID,
+                      const GimpRGB *color,
+                      gint threshold,
+                      GimpChannelOps operation,
+                      gboolean antialias,
+                      gboolean feather,
+                      gdouble feather_radius,
+                      gboolean sample_merged);
+
+

gimp_by_color_select is deprecated and should not be used in newly-written code.

+

Use gimp_image_select_color() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

color

The color to select.

 

threshold

Threshold in intensity levels.

 

operation

The selection operation.

 

antialias

Antialiasing.

 

feather

Feather option for selections.

 

feather_radius

Radius for feather operation.

 

sample_merged

Use the composite image, not the drawable.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_by_color_select_full ()

+
gboolean
+gimp_by_color_select_full (gint32 drawable_ID,
+                           const GimpRGB *color,
+                           gint threshold,
+                           GimpChannelOps operation,
+                           gboolean antialias,
+                           gboolean feather,
+                           gdouble feather_radius_x,
+                           gdouble feather_radius_y,
+                           gboolean sample_merged,
+                           gboolean select_transparent,
+                           GimpSelectCriterion select_criterion);
+
+

gimp_by_color_select_full is deprecated and should not be used in newly-written code.

+

Use gimp_image_select_color() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

color

The color to select.

 

threshold

Threshold in intensity levels.

 

operation

The selection operation.

 

antialias

Antialiasing.

 

feather

Feather option for selections.

 

feather_radius_x

Radius for feather operation in X direction.

 

feather_radius_y

Radius for feather operation in Y direction.

 

sample_merged

Use the composite image, not the drawable.

 

select_transparent

Whether to consider transparent pixels for selection. If TRUE, transparency is considered as a unique selectable color.

 

select_criterion

The criterion used to determine color similarity. SELECT_CRITERION_COMPOSITE is the standard choice.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_ellipse_select ()

+
gboolean
+gimp_ellipse_select (gint32 image_ID,
+                     gdouble x,
+                     gdouble y,
+                     gdouble width,
+                     gdouble height,
+                     GimpChannelOps operation,
+                     gboolean antialias,
+                     gboolean feather,
+                     gdouble feather_radius);
+
+

gimp_ellipse_select is deprecated and should not be used in newly-written code.

+

Use gimp_image_select_ellipse() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

x

x coordinate of upper-left corner of ellipse bounding box.

 

y

y coordinate of upper-left corner of ellipse bounding box.

 

width

The width of the ellipse.

 

height

The height of the ellipse.

 

operation

The selection operation.

 

antialias

Antialiasing.

 

feather

Feather option for selections.

 

feather_radius

Radius for feather operation.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_free_select ()

+
gboolean
+gimp_free_select (gint32 image_ID,
+                  gint num_segs,
+                  const gdouble *segs,
+                  GimpChannelOps operation,
+                  gboolean antialias,
+                  gboolean feather,
+                  gdouble feather_radius);
+
+

gimp_free_select is deprecated and should not be used in newly-written code.

+

Use gimp_image_select_polygon() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

num_segs

Number of points (count 1 coordinate as two points).

 

segs

Array of points: { p1.x, p1.y, p2.x, p2.y, ..., pn.x, pn.y}.

 

operation

The selection operation.

 

antialias

Antialiasing.

 

feather

Feather option for selections.

 

feather_radius

Radius for feather operation.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_fuzzy_select ()

+
gboolean
+gimp_fuzzy_select (gint32 drawable_ID,
+                   gdouble x,
+                   gdouble y,
+                   gint threshold,
+                   GimpChannelOps operation,
+                   gboolean antialias,
+                   gboolean feather,
+                   gdouble feather_radius,
+                   gboolean sample_merged);
+
+

gimp_fuzzy_select is deprecated and should not be used in newly-written code.

+

Use gimp_image_select_contiguous_color() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

x

x coordinate of initial seed fill point: (image coordinates).

 

y

y coordinate of initial seed fill point: (image coordinates).

 

threshold

Threshold in intensity levels.

 

operation

The selection operation.

 

antialias

Antialiasing.

 

feather

Feather option for selections.

 

feather_radius

Radius for feather operation.

 

sample_merged

Use the composite image, not the drawable.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_fuzzy_select_full ()

+
gboolean
+gimp_fuzzy_select_full (gint32 drawable_ID,
+                        gdouble x,
+                        gdouble y,
+                        gint threshold,
+                        GimpChannelOps operation,
+                        gboolean antialias,
+                        gboolean feather,
+                        gdouble feather_radius_x,
+                        gdouble feather_radius_y,
+                        gboolean sample_merged,
+                        gboolean select_transparent,
+                        GimpSelectCriterion select_criterion);
+
+

gimp_fuzzy_select_full is deprecated and should not be used in newly-written code.

+

Use gimp_image_select_contiguous_color() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

x

x coordinate of initial seed fill point: (image coordinates).

 

y

y coordinate of initial seed fill point: (image coordinates).

 

threshold

Threshold in intensity levels.

 

operation

The selection operation.

 

antialias

Antialiasing.

 

feather

Feather option for selections.

 

feather_radius_x

Radius for feather operation in X direction.

 

feather_radius_y

Radius for feather operation in Y direction.

 

sample_merged

Use the composite image, not the drawable.

 

select_transparent

Whether to consider transparent pixels for selection. If TRUE, transparency is considered as a unique selectable color.

 

select_criterion

The criterion used to determine color similarity. SELECT_CRITERION_COMPOSITE is the standard choice.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_rect_select ()

+
gboolean
+gimp_rect_select (gint32 image_ID,
+                  gdouble x,
+                  gdouble y,
+                  gdouble width,
+                  gdouble height,
+                  GimpChannelOps operation,
+                  gboolean feather,
+                  gdouble feather_radius);
+
+

gimp_rect_select is deprecated and should not be used in newly-written code.

+

Use gimp_image_select_rectangle() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

x

x coordinate of upper-left corner of rectangle.

 

y

y coordinate of upper-left corner of rectangle.

 

width

The width of the rectangle.

 

height

The height of the rectangle.

 

operation

The selection operation.

 

feather

Feather option for selections.

 

feather_radius

Radius for feather operation.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_round_rect_select ()

+
gboolean
+gimp_round_rect_select (gint32 image_ID,
+                        gdouble x,
+                        gdouble y,
+                        gdouble width,
+                        gdouble height,
+                        gdouble corner_radius_x,
+                        gdouble corner_radius_y,
+                        GimpChannelOps operation,
+                        gboolean antialias,
+                        gboolean feather,
+                        gdouble feather_radius_x,
+                        gdouble feather_radius_y);
+
+

gimp_round_rect_select is deprecated and should not be used in newly-written code.

+

Use gimp_image_select_round_rectangle() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

x

x coordinate of upper-left corner of rectangle.

 

y

y coordinate of upper-left corner of rectangle.

 

width

The width of the rectangle.

 

height

The height of the rectangle.

 

corner_radius_x

The corner radius in X direction.

 

corner_radius_y

The corner radius in Y direction.

 

operation

The selection operation.

 

antialias

Antialiasing.

 

feather

Feather option for selections.

 

feather_radius_x

Radius for feather operation in X direction.

 

feather_radius_y

Radius for feather operation in Y direction.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimptextlayer.html b/devel-docs/libgimp/html/libgimp-gimptextlayer.html new file mode 100644 index 0000000..4fb870b --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimptextlayer.html @@ -0,0 +1,1401 @@ + + + + +gimptextlayer: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimptextlayer

+

gimptextlayer — Functions for querying and manipulating text layers.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+gint32 + +gimp_text_layer_new () +
+gchar * + +gimp_text_layer_get_text () +
+gboolean + +gimp_text_layer_set_text () +
+gchar * + +gimp_text_layer_get_markup () +
+gchar * + +gimp_text_layer_get_font () +
+gboolean + +gimp_text_layer_set_font () +
+gdouble + +gimp_text_layer_get_font_size () +
+gboolean + +gimp_text_layer_set_font_size () +
+gboolean + +gimp_text_layer_get_hinting () +
+gboolean + +gimp_text_layer_set_hinting () +
+gboolean + +gimp_text_layer_get_antialias () +
+gboolean + +gimp_text_layer_set_antialias () +
+gboolean + +gimp_text_layer_get_kerning () +
+gboolean + +gimp_text_layer_set_kerning () +
+gchar * + +gimp_text_layer_get_language () +
+gboolean + +gimp_text_layer_set_language () +
+GimpTextDirection + +gimp_text_layer_get_base_direction () +
+gboolean + +gimp_text_layer_set_base_direction () +
+GimpTextJustification + +gimp_text_layer_get_justification () +
+gboolean + +gimp_text_layer_set_justification () +
+gboolean + +gimp_text_layer_get_color () +
+gboolean + +gimp_text_layer_set_color () +
+gdouble + +gimp_text_layer_get_indent () +
+gboolean + +gimp_text_layer_set_indent () +
+gdouble + +gimp_text_layer_get_line_spacing () +
+gboolean + +gimp_text_layer_set_line_spacing () +
+gdouble + +gimp_text_layer_get_letter_spacing () +
+gboolean + +gimp_text_layer_set_letter_spacing () +
+GimpTextHintStyle + +gimp_text_layer_get_hint_style () +
+gboolean + +gimp_text_layer_set_hint_style () +
+gboolean + +gimp_text_layer_resize () +
+
+
+

Description

+

Functions for querying and manipulating text layers.

+
+
+

Functions

+
+

gimp_text_layer_new ()

+
gint32
+gimp_text_layer_new (gint32 image_ID,
+                     const gchar *text,
+                     const gchar *fontname,
+                     gdouble size,
+                     GimpUnit unit);
+

Creates a new text layer.

+

This procedure creates a new text layer. The arguments are kept as +simple as necessary for the normal case. All text attributes, +however, can be modified with the appropriate +gimp_text_layer_set_*() procedures. The new layer still needs to be +added to the image, as this is not automatic. Add the new layer +using gimp_image_insert_layer().

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

text

The text to generate (in UTF-8 encoding).

 

fontname

The name of the font.

 

size

The size of text in either pixels or points.

 

unit

The units of specified size.

 
+
+
+

Returns

+

The new text layer.

+
+

Since: 2.6

+
+
+
+

gimp_text_layer_get_text ()

+
gchar *
+gimp_text_layer_get_text (gint32 layer_ID);
+

Get the text from a text layer as string.

+

This procedure returns the text from a text layer as a string.

+
+

Parameters

+
+++++ + + + + + +

layer_ID

The text layer.

 
+
+
+

Returns

+

The text from the specified text layer.

+
+

Since: 2.6

+
+
+
+

gimp_text_layer_set_text ()

+
gboolean
+gimp_text_layer_set_text (gint32 layer_ID,
+                          const gchar *text);
+

Set the text of a text layer.

+

This procedure changes the text of a text layer.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

layer_ID

The text layer.

 

text

The new text to set.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.6

+
+
+
+

gimp_text_layer_get_markup ()

+
gchar *
+gimp_text_layer_get_markup (gint32 layer_ID);
+

Get the markup from a text layer as string.

+

This procedure returns the markup of the styles from a text layer. +The markup will be in the form of Pango's markup - See +https://www.pango.org/ for more information about Pango and its +markup. Note: Setting the markup of a text layer using Pango's +markup is not supported for now.

+
+

Parameters

+
+++++ + + + + + +

layer_ID

The text layer.

 
+
+
+

Returns

+

The markup which represents the style of the specified text +layer.

+
+

Since: 2.8

+
+
+
+

gimp_text_layer_get_font ()

+
gchar *
+gimp_text_layer_get_font (gint32 layer_ID);
+

Get the font from a text layer as string.

+

This procedure returns the name of the font from a text layer.

+
+

Parameters

+
+++++ + + + + + +

layer_ID

The text layer.

 
+
+
+

Returns

+

The font which is used in the specified text layer.

+
+

Since: 2.6

+
+
+
+

gimp_text_layer_set_font ()

+
gboolean
+gimp_text_layer_set_font (gint32 layer_ID,
+                          const gchar *font);
+

Set the font of a text layer.

+

This procedure modifies the font used in the specified text layer.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

layer_ID

The text layer.

 

font

The new font to use.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.6

+
+
+
+

gimp_text_layer_get_font_size ()

+
gdouble
+gimp_text_layer_get_font_size (gint32 layer_ID,
+                               GimpUnit *unit);
+

Get the font size from a text layer.

+

This procedure returns the size of the font which is used in a text +layer. You will receive the size as a float 'font-size' in 'unit' +units.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

layer_ID

The text layer.

 

unit

The unit used for the font size.

 
+
+
+

Returns

+

The font size.

+
+

Since: 2.6

+
+
+
+

gimp_text_layer_set_font_size ()

+
gboolean
+gimp_text_layer_set_font_size (gint32 layer_ID,
+                               gdouble font_size,
+                               GimpUnit unit);
+

Set the font size.

+

This procedure changes the font size of a text layer. The size of +your font will be a double 'font-size' of 'unit' units.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

layer_ID

The text layer.

 

font_size

The font size.

 

unit

The unit to use for the font size.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.6

+
+
+
+

gimp_text_layer_get_hinting ()

+
gboolean
+gimp_text_layer_get_hinting (gint32 layer_ID,
+                             gboolean *autohint);
+
+

gimp_text_layer_get_hinting is deprecated and should not be used in newly-written code.

+

Use gimp_text_layer_get_hint_style() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

layer_ID

The text layer.

 

autohint

A flag which is true if the text layer is forced to use the autohinter from FreeType.

 
+
+
+

Returns

+

A flag which is true if hinting is used on the font.

+
+
+
+
+

gimp_text_layer_set_hinting ()

+
gboolean
+gimp_text_layer_set_hinting (gint32 layer_ID,
+                             gboolean hinting,
+                             gboolean autohint);
+
+

gimp_text_layer_set_hinting is deprecated and should not be used in newly-written code.

+

Use gimp_text_layer_set_hint_style() instead.

+
+

Enable/disable the use of hinting in a text layer.

+

This procedure enables or disables hinting on the text of a text +layer. If you enable 'auto-hint', FreeType\'s automatic hinter will +be used and hinting information from the font will be ignored.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

layer_ID

The text layer.

 

hinting

Enable/disable the use of hinting on the text.

 

autohint

Force the use of the autohinter provided through FreeType.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.6

+
+
+
+

gimp_text_layer_get_antialias ()

+
gboolean
+gimp_text_layer_get_antialias (gint32 layer_ID);
+

Check if antialiasing is used in the text layer.

+

This procedure checks if antialiasing is enabled in the specified +text layer.

+
+

Parameters

+
+++++ + + + + + +

layer_ID

The text layer.

 
+
+
+

Returns

+

A flag which is true if antialiasing is used for rendering +the font in the text layer.

+
+

Since: 2.6

+
+
+
+

gimp_text_layer_set_antialias ()

+
gboolean
+gimp_text_layer_set_antialias (gint32 layer_ID,
+                               gboolean antialias);
+

Enable/disable anti-aliasing in a text layer.

+

This procedure enables or disables anti-aliasing of the text in a +text layer.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

layer_ID

The text layer.

 

antialias

Enable/disable antialiasing of the text.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.6

+
+
+
+

gimp_text_layer_get_kerning ()

+
gboolean
+gimp_text_layer_get_kerning (gint32 layer_ID);
+

Check if kerning is used in the text layer.

+

This procedure checks if kerning is enabled in the specified text +layer.

+
+

Parameters

+
+++++ + + + + + +

layer_ID

The text layer.

 
+
+
+

Returns

+

A flag which is true if kerning is used in the text layer.

+
+

Since: 2.6

+
+
+
+

gimp_text_layer_set_kerning ()

+
gboolean
+gimp_text_layer_set_kerning (gint32 layer_ID,
+                             gboolean kerning);
+

Enable/disable kerning in a text layer.

+

This procedure enables or disables kerning in a text layer.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

layer_ID

The text layer.

 

kerning

Enable/disable kerning in the text.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.6

+
+
+
+

gimp_text_layer_get_language ()

+
gchar *
+gimp_text_layer_get_language (gint32 layer_ID);
+

Get the language used in the text layer.

+

This procedure returns the language string which is set for the text +in the text layer.

+
+

Parameters

+
+++++ + + + + + +

layer_ID

The text layer.

 
+
+
+

Returns

+

The language used in the text layer.

+
+

Since: 2.6

+
+
+
+

gimp_text_layer_set_language ()

+
gboolean
+gimp_text_layer_set_language (gint32 layer_ID,
+                              const gchar *language);
+

Set the language of the text layer.

+

This procedure sets the language of the text in text layer. For some +scripts the language has an influence of how the text is rendered.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

layer_ID

The text layer.

 

language

The new language to use for the text layer.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.6

+
+
+
+

gimp_text_layer_get_base_direction ()

+
GimpTextDirection
+gimp_text_layer_get_base_direction (gint32 layer_ID);
+

Get the base direction used for rendering the text layer.

+

This procedure returns the base direction used for rendering the +text in the text layer

+
+

Parameters

+
+++++ + + + + + +

layer_ID

The text layer.

 
+
+
+

Returns

+

The based direction used for the text layer.

+
+

Since: 2.6

+
+
+
+

gimp_text_layer_set_base_direction ()

+
gboolean
+gimp_text_layer_set_base_direction (gint32 layer_ID,
+                                    GimpTextDirection direction);
+

Set the base direction in the text layer.

+

This procedure sets the base direction used in applying the Unicode +bidirectional algorithm when rendering the text.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

layer_ID

The text layer.

 

direction

The base direction of the text.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.6

+
+
+
+

gimp_text_layer_get_justification ()

+
GimpTextJustification
+gimp_text_layer_get_justification (gint32 layer_ID);
+

Get the text justification information of the text layer.

+

This procedure returns the alignment of the lines in the text layer +relative to each other.

+
+

Parameters

+
+++++ + + + + + +

layer_ID

The text layer.

 
+
+
+

Returns

+

The justification used in the text layer.

+
+

Since: 2.6

+
+
+
+

gimp_text_layer_set_justification ()

+
gboolean
+gimp_text_layer_set_justification (gint32 layer_ID,
+                                   GimpTextJustification justify);
+

Set the justification of the text in a text layer.

+

This procedure sets the alignment of the lines in the text layer +relative to each other.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

layer_ID

The text layer.

 

justify

The justification for your text.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.6

+
+
+
+

gimp_text_layer_get_color ()

+
gboolean
+gimp_text_layer_get_color (gint32 layer_ID,
+                           GimpRGB *color);
+

Get the color of the text in a text layer.

+

This procedure returns the color of the text in a text layer.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

layer_ID

The text layer.

 

color

The color of the text.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.6

+
+
+
+

gimp_text_layer_set_color ()

+
gboolean
+gimp_text_layer_set_color (gint32 layer_ID,
+                           const GimpRGB *color);
+

Set the color of the text in the text layer.

+

This procedure sets the text color in the text layer 'layer'.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

layer_ID

The text layer.

 

color

The color to use for the text.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.6

+
+
+
+

gimp_text_layer_get_indent ()

+
gdouble
+gimp_text_layer_get_indent (gint32 layer_ID);
+

Get the line indentation of text layer.

+

This procedure returns the indentation of the first line in a text +layer.

+
+

Parameters

+
+++++ + + + + + +

layer_ID

The text layer.

 
+
+
+

Returns

+

The indentation value of the first line.

+
+

Since: 2.6

+
+
+
+

gimp_text_layer_set_indent ()

+
gboolean
+gimp_text_layer_set_indent (gint32 layer_ID,
+                            gdouble indent);
+

Set the indentation of the first line in a text layer.

+

This procedure sets the indentation of the first line in the text +layer.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

layer_ID

The text layer.

 

indent

The indentation for the first line.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.6

+
+
+
+

gimp_text_layer_get_line_spacing ()

+
gdouble
+gimp_text_layer_get_line_spacing (gint32 layer_ID);
+

Get the spacing between lines of text.

+

This procedure returns the line-spacing between lines of text in a +text layer.

+
+

Parameters

+
+++++ + + + + + +

layer_ID

The text layer.

 
+
+
+

Returns

+

The line-spacing value.

+
+

Since: 2.6

+
+
+
+

gimp_text_layer_set_line_spacing ()

+
gboolean
+gimp_text_layer_set_line_spacing (gint32 layer_ID,
+                                  gdouble line_spacing);
+

Adjust the line spacing in a text layer.

+

This procedure sets the additional spacing used between lines a text +layer.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

layer_ID

The text layer.

 

line_spacing

The additional line spacing to use.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.6

+
+
+
+

gimp_text_layer_get_letter_spacing ()

+
gdouble
+gimp_text_layer_get_letter_spacing (gint32 layer_ID);
+

Get the letter spacing used in a text layer.

+

This procedure returns the additional spacing between the single +glyphs in a text layer.

+
+

Parameters

+
+++++ + + + + + +

layer_ID

The text layer.

 
+
+
+

Returns

+

The letter-spacing value.

+
+

Since: 2.6

+
+
+
+

gimp_text_layer_set_letter_spacing ()

+
gboolean
+gimp_text_layer_set_letter_spacing (gint32 layer_ID,
+                                    gdouble letter_spacing);
+

Adjust the letter spacing in a text layer.

+

This procedure sets the additional spacing between the single glyphs +in a text layer.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

layer_ID

The text layer.

 

letter_spacing

The additional letter spacing to use.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.6

+
+
+
+

gimp_text_layer_get_hint_style ()

+
GimpTextHintStyle
+gimp_text_layer_get_hint_style (gint32 layer_ID);
+

Get information about hinting in the specified text layer.

+

This procedure provides information about the hinting that is being +used in a text layer. Hinting can be optimized for fidelity or +contrast or it can be turned entirely off.

+
+

Parameters

+
+++++ + + + + + +

layer_ID

The text layer.

 
+
+
+

Returns

+

The hint style used for font outlines.

+
+

Since: 2.8

+
+
+
+

gimp_text_layer_set_hint_style ()

+
gboolean
+gimp_text_layer_set_hint_style (gint32 layer_ID,
+                                GimpTextHintStyle style);
+

Control how font outlines are hinted in a text layer.

+

This procedure sets the hint style for font outlines in a text +layer. This controls whether to fit font outlines to the pixel grid, +and if so, whether to optimize for fidelity or contrast.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

layer_ID

The text layer.

 

style

The new hint style.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+

gimp_text_layer_resize ()

+
gboolean
+gimp_text_layer_resize (gint32 layer_ID,
+                        gdouble width,
+                        gdouble height);
+

Resize the box of a text layer.

+

This procedure changes the width and height of a text layer while +keeping it as a text layer and not converting it to a bitmap like +gimp_layer_resize() would do.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

layer_ID

The text layer.

 

width

The new box width in pixels.

 

height

The new box height in pixels.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.8

+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimptexttool.html b/devel-docs/libgimp/html/libgimp-gimptexttool.html new file mode 100644 index 0000000..d2d2aa8 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimptexttool.html @@ -0,0 +1,502 @@ + + + + +gimptexttool: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimptexttool

+

gimptexttool — Functions for controlling the text tool.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + +
+gint32 + +gimp_text_fontname () +
+gboolean + +gimp_text_get_extents_fontname () +
+gint32 + +gimp_text () +
+gboolean + +gimp_text_get_extents () +
+
+
+

Description

+

Functions for controlling the text tool.

+
+
+

Functions

+
+

gimp_text_fontname ()

+
gint32
+gimp_text_fontname (gint32 image_ID,
+                    gint32 drawable_ID,
+                    gdouble x,
+                    gdouble y,
+                    const gchar *text,
+                    gint border,
+                    gboolean antialias,
+                    gdouble size,
+                    GimpSizeType size_type,
+                    const gchar *fontname);
+

Add text at the specified location as a floating selection or a new +layer.

+

This tool requires a fontname matching an installed PangoFT2 font. +You can specify the fontsize in units of pixels or points, and the +appropriate metric is specified using the size_type argument. The x +and y parameters together control the placement of the new text by +specifying the upper left corner of the text bounding box. If the +specified drawable parameter is valid, the text will be created as a +floating selection attached to the drawable. If the drawable +parameter is not valid (-1), the text will appear as a new layer. +Finally, a border can be specified around the final rendered text. +The border is measured in pixels. Parameter size-type is not used +and is currently ignored. If you need to display a font in points, +divide the size in points by 72.0 and multiply it by the image's +vertical resolution.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

drawable_ID

The affected drawable: (-1 for a new text layer).

 

x

The x coordinate for the left of the text bounding box.

 

y

The y coordinate for the top of the text bounding box.

 

text

The text to generate (in UTF-8 encoding).

 

border

The size of the border.

 

antialias

Antialiasing.

 

size

The size of text in either pixels or points.

 

size_type

The units of specified size.

 

fontname

The name of the font.

 
+
+
+

Returns

+

The new text layer or -1 if no layer was created.

+
+
+
+
+

gimp_text_get_extents_fontname ()

+
gboolean
+gimp_text_get_extents_fontname (const gchar *text,
+                                gdouble size,
+                                GimpSizeType size_type,
+                                const gchar *fontname,
+                                gint *width,
+                                gint *height,
+                                gint *ascent,
+                                gint *descent);
+

Get extents of the bounding box for the specified text.

+

This tool returns the width and height of a bounding box for the +specified text string with the specified font information. Ascent +and descent for the specified font are returned as well. Parameter +size-type is not used and is currently ignored. If you need to +display a font in points, divide the size in points by 72.0 and +multiply it by the vertical resolution of the image you are taking +into account.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

text

The text to generate (in UTF-8 encoding).

 

size

The size of text in either pixels or points.

 

size_type

The units of specified size.

 

fontname

The name of the font.

 

width

The width of the specified font.

 

height

The height of the specified font.

 

ascent

The ascent of the specified font.

 

descent

The descent of the specified font.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+

gimp_text ()

+
gint32
+gimp_text (gint32 image_ID,
+           gint32 drawable_ID,
+           gdouble x,
+           gdouble y,
+           const gchar *text,
+           gint border,
+           gboolean antialias,
+           gdouble size,
+           GimpSizeType size_type,
+           const gchar *foundry,
+           const gchar *family,
+           const gchar *weight,
+           const gchar *slant,
+           const gchar *set_width,
+           const gchar *spacing,
+           const gchar *registry,
+           const gchar *encoding);
+
+

gimp_text is deprecated and should not be used in newly-written code.

+

Use gimp_text_fontname() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

drawable_ID

The affected drawable: (-1 for a new text layer).

 

x

The x coordinate for the left of the text bounding box.

 

y

The y coordinate for the top of the text bounding box.

 

text

The text to generate (in UTF-8 encoding).

 

border

The size of the border.

 

antialias

Antialiasing.

 

size

The size of text in either pixels or points.

 

size_type

The units of specified size.

 

foundry

The font foundry.

 

family

The font family.

 

weight

The font weight.

 

slant

The font slant.

 

set_width

The font set-width.

 

spacing

The font spacing.

 

registry

The font registry.

 

encoding

The font encoding.

 
+
+
+

Returns

+

The new text layer or -1 if no layer was created.

+
+
+
+
+

gimp_text_get_extents ()

+
gboolean
+gimp_text_get_extents (const gchar *text,
+                       gdouble size,
+                       GimpSizeType size_type,
+                       const gchar *foundry,
+                       const gchar *family,
+                       const gchar *weight,
+                       const gchar *slant,
+                       const gchar *set_width,
+                       const gchar *spacing,
+                       const gchar *registry,
+                       const gchar *encoding,
+                       gint *width,
+                       gint *height,
+                       gint *ascent,
+                       gint *descent);
+
+

gimp_text_get_extents is deprecated and should not be used in newly-written code.

+

Use gimp_text_get_extents_fontname() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

text

The text to generate (in UTF-8 encoding).

 

size

The size of text in either pixels or points.

 

size_type

The units of specified size.

 

foundry

The font foundry.

 

family

The font family.

 

weight

The font weight.

 

slant

The font slant.

 

set_width

The font set-width.

 

spacing

The font spacing.

 

registry

The font registry.

 

encoding

The font encoding.

 

width

The width of the specified font.

 

height

The height of the specified font.

 

ascent

The ascent of the specified font.

 

descent

The descent of the specified font.

 
+
+
+

Returns

+

TRUE on success.

+
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimptile.html b/devel-docs/libgimp/html/libgimp-gimptile.html new file mode 100644 index 0000000..18c4938 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimptile.html @@ -0,0 +1,218 @@ + + + + +gimptile: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimptile

+

gimptile — Functions for working with tiles.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+void + +gimp_tile_ref () +
+void + +gimp_tile_ref_zero () +
+void + +gimp_tile_unref () +
+void + +gimp_tile_flush () +
+void + +gimp_tile_cache_size () +
+void + +gimp_tile_cache_ntiles () +
+
+
+

Types and Values

+
++++ + + + + +
 GimpTile
+
+
+

Description

+

Functions for working with tiles.

+
+
+

Functions

+
+

gimp_tile_ref ()

+
void
+gimp_tile_ref (GimpTile *tile);
+

gimp_tile_ref is deprecated and should not be used in newly-written code.

+
+
+
+

gimp_tile_ref_zero ()

+
void
+gimp_tile_ref_zero (GimpTile *tile);
+

gimp_tile_ref_zero is deprecated and should not be used in newly-written code.

+
+
+
+

gimp_tile_unref ()

+
void
+gimp_tile_unref (GimpTile *tile,
+                 gboolean dirty);
+

gimp_tile_unref is deprecated and should not be used in newly-written code.

+
+
+
+

gimp_tile_flush ()

+
void
+gimp_tile_flush (GimpTile *tile);
+

gimp_tile_flush is deprecated and should not be used in newly-written code.

+
+
+
+

gimp_tile_cache_size ()

+
void
+gimp_tile_cache_size (gulong kilobytes);
+

gimp_tile_cache_size is deprecated and should not be used in newly-written code.

+

Sets the size of the tile cache on the plug-in side. The tile cache +is used to reduce the number of tiles exchanged between the GIMP core +and the plug-in. See also gimp_tile_cache_ntiles().

+
+

Parameters

+
+++++ + + + + + +

kilobytes

new cache size in kilobytes

 
+
+
+
+
+

gimp_tile_cache_ntiles ()

+
void
+gimp_tile_cache_ntiles (gulong ntiles);
+

gimp_tile_cache_ntiles is deprecated and should not be used in newly-written code.

+

Sets the size of the tile cache on the plug-in side. This function +is similar to gimp_tile_cache_size() but supports specifying the +number of tiles directly.

+

If your plug-in access pixels tile-by-tile, it doesn't need a tile +cache at all. If however the plug-in accesses drawable pixel data +row-by-row, it should set the tile cache large enough to hold the +number of tiles per row. Double this size if your plug-in uses +shadow tiles.

+
+

Parameters

+
+++++ + + + + + +

ntiles

number of tiles that should fit into the cache

 
+
+
+
+
+

Types and Values

+
+

GimpTile

+
typedef struct {
+  guint         ewidth;     /* the effective width of the tile */
+  guint         eheight;    /* the effective height of the tile */
+  guint         bpp;        /* the bytes per pixel (1, 2, 3 or 4 ) */
+  guint         tile_num;   /* the number of this tile within the drawable */
+  guint16       ref_count;  /* reference count for the tile */
+  guint         dirty : 1;  /* is the tile dirty? has it been modified? */
+  guint         shadow: 1;  /* is this a shadow tile */
+  guchar       *data;       /* the pixel data for the tile */
+  GimpDrawable *drawable;   /* the drawable this tile came from */
+} GimpTile;
+
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimptransformtools.html b/devel-docs/libgimp/html/libgimp-gimptransformtools.html new file mode 100644 index 0000000..db8af3d --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimptransformtools.html @@ -0,0 +1,457 @@ + + + + +gimptransformtools: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimptransformtools

+

gimptransformtools — Access to toolbox transform tools.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+gint32 + +gimp_flip () +
+gint32 + +gimp_perspective () +
+gint32 + +gimp_rotate () +
+gint32 + +gimp_scale () +
+gint32 + +gimp_shear () +
+gint32 + +gimp_transform_2d () +
+
+
+

Description

+

Functions giving access to toolbox transform tools.

+
+
+

Functions

+
+

gimp_flip ()

+
gint32
+gimp_flip (gint32 drawable_ID,
+           GimpOrientationType flip_type);
+
+

gimp_flip is deprecated and should not be used in newly-written code.

+

Use gimp_item_transform_flip_simple() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

flip_type

Type of flip.

 
+
+
+

Returns

+

The flipped drawable.

+
+
+
+
+

gimp_perspective ()

+
gint32
+gimp_perspective (gint32 drawable_ID,
+                  gboolean interpolation,
+                  gdouble x0,
+                  gdouble y0,
+                  gdouble x1,
+                  gdouble y1,
+                  gdouble x2,
+                  gdouble y2,
+                  gdouble x3,
+                  gdouble y3);
+
+

gimp_perspective is deprecated and should not be used in newly-written code.

+

Use gimp_item_transform_perspective() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

interpolation

Whether to use interpolation.

 

x0

The new x coordinate of upper-left corner of original bounding box.

 

y0

The new y coordinate of upper-left corner of original bounding box.

 

x1

The new x coordinate of upper-right corner of original bounding box.

 

y1

The new y coordinate of upper-right corner of original bounding box.

 

x2

The new x coordinate of lower-left corner of original bounding box.

 

y2

The new y coordinate of lower-left corner of original bounding box.

 

x3

The new x coordinate of lower-right corner of original bounding box.

 

y3

The new y coordinate of lower-right corner of original bounding box.

 
+
+
+

Returns

+

The newly mapped drawable.

+
+
+
+
+

gimp_rotate ()

+
gint32
+gimp_rotate (gint32 drawable_ID,
+             gboolean interpolation,
+             gdouble angle);
+
+

gimp_rotate is deprecated and should not be used in newly-written code.

+

Use gimp_item_transform_rotate() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

interpolation

Whether to use interpolation.

 

angle

The angle of rotation (radians).

 
+
+
+

Returns

+

The rotated drawable.

+
+
+
+
+

gimp_scale ()

+
gint32
+gimp_scale (gint32 drawable_ID,
+            gboolean interpolation,
+            gdouble x0,
+            gdouble y0,
+            gdouble x1,
+            gdouble y1);
+
+

gimp_scale is deprecated and should not be used in newly-written code.

+

Use gimp_item_transform_scale() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

interpolation

Whether to use interpolation.

 

x0

The new x coordinate of the upper-left corner of the scaled region.

 

y0

The new y coordinate of the upper-left corner of the scaled region.

 

x1

The new x coordinate of the lower-right corner of the scaled region.

 

y1

The new y coordinate of the lower-right corner of the scaled region.

 
+
+
+

Returns

+

The scaled drawable.

+
+
+
+
+

gimp_shear ()

+
gint32
+gimp_shear (gint32 drawable_ID,
+            gboolean interpolation,
+            GimpOrientationType shear_type,
+            gdouble magnitude);
+
+

gimp_shear is deprecated and should not be used in newly-written code.

+

Use gimp_item_transform_shear() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

interpolation

Whether to use interpolation.

 

shear_type

Type of shear.

 

magnitude

The magnitude of the shear.

 
+
+
+

Returns

+

The sheared drawable.

+
+
+
+
+

gimp_transform_2d ()

+
gint32
+gimp_transform_2d (gint32 drawable_ID,
+                   gboolean interpolation,
+                   gdouble source_x,
+                   gdouble source_y,
+                   gdouble scale_x,
+                   gdouble scale_y,
+                   gdouble angle,
+                   gdouble dest_x,
+                   gdouble dest_y);
+
+

gimp_transform_2d is deprecated and should not be used in newly-written code.

+

Use gimp_item_transform_2d() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

drawable_ID

The affected drawable.

 

interpolation

Whether to use interpolation.

 

source_x

X coordinate of the transformation center.

 

source_y

Y coordinate of the transformation center.

 

scale_x

Amount to scale in x direction.

 

scale_y

Amount to scale in y direction.

 

angle

The angle of rotation (radians).

 

dest_x

X coordinate of where the centre goes.

 

dest_y

Y coordinate of where the centre goes.

 
+
+
+

Returns

+

The transformed drawable.

+
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpui.html b/devel-docs/libgimp/html/libgimp-gimpui.html new file mode 100644 index 0000000..ce31e70 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpui.html @@ -0,0 +1,256 @@ + + + + +gimpui: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpui

+

gimpui — Common user interface functions. This header includes +all other GIMP User Interface Library headers.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + +
+void + +gimp_ui_init () +
+GdkWindow * + +gimp_ui_get_display_window () +
+GdkWindow * + +gimp_ui_get_progress_window () +
+void + +gimp_window_set_transient () +
+void + +gimp_window_set_transient_for_display () +
+
+
+

Description

+

Common user interface functions. This header includes all other +GIMP User Interface Library headers.

+
+
+

Functions

+
+

gimp_ui_init ()

+
void
+gimp_ui_init (const gchar *prog_name,
+              gboolean preview);
+

This function initializes GTK+ with gtk_init() and initializes GDK's +image rendering subsystem (GdkRGB) to follow the GIMP main program's +colormap allocation/installation policy.

+

It also sets up various other things so that the plug-in user looks +and behaves like the GIMP core. This includes selecting the GTK+ +theme and setting up the help system as chosen in the GIMP +preferences. Any plug-in that provides a user interface should call +this function.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

prog_name

The name of the plug-in which will be passed as argv[0] to +gtk_init(). It's a convention to use the name of the +executable and _not_ the PDB procedure name.

 

preview

This parameter is unused and exists for historical +reasons only.

 
+
+
+
+
+

gimp_ui_get_display_window ()

+
GdkWindow *
+gimp_ui_get_display_window (guint32 gdisp_ID);
+

Returns the GdkWindow of a display window. The purpose is to allow +to make plug-in dialogs transient to the image display as explained +with gdk_window_set_transient_for().

+

You shouldn't have to call this function directly. Use +gimp_window_set_transient_for_display() instead.

+
+

Parameters

+
+++++ + + + + + +

gdisp_ID

a GimpDisplay ID.

 
+
+
+

Returns

+

A reference to a GdkWindow or NULL. You should +unref the window using g_object_unref() as soon as +you don't need it any longer.

+
+

Since: 2.4

+
+
+
+

gimp_ui_get_progress_window ()

+
GdkWindow *
+gimp_ui_get_progress_window (void);
+

Returns the GdkWindow of the window this plug-in's progress bar is +shown in. Use it to make plug-in dialogs transient to this window +as explained with gdk_window_set_transient_for().

+

You shouldn't have to call this function directly. Use +gimp_window_set_transient() instead.

+
+

Returns

+

A reference to a GdkWindow or NULL. You should +unref the window using g_object_unref() as soon as +you don't need it any longer.

+
+

Since: 2.4

+
+
+
+

gimp_window_set_transient ()

+
void
+gimp_window_set_transient (GtkWindow *window);
+

Indicates to the window manager that window + is a transient dialog +associated with the GIMP window that the plug-in has been +started from. See also gimp_window_set_transient_for_display().

+
+

Parameters

+
+++++ + + + + + +

window

the GtkWindow that should become transient

 
+
+

Since: 2.4

+
+
+
+

gimp_window_set_transient_for_display ()

+
void
+gimp_window_set_transient_for_display (GtkWindow *window,
+                                       guint32 gdisp_ID);
+

Indicates to the window manager that window + is a transient dialog +associated with the GIMP image window that is identified by it's +display ID. See gdk_window_set_transient_for() for more information.

+

Most of the time you will want to use the convenience function +gimp_window_set_transient().

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

window

the GtkWindow that should become transient

 

gdisp_ID

display ID of the image window that should become the parent

 
+
+

Since: 2.4

+
+
+
+

See Also

+

gtk_init(), gdk_set_use_xshm(), gdk_rgb_get_visual(), +gdk_rgb_get_cmap(), gtk_widget_set_default_visual(), +gtk_widget_set_default_colormap(), gtk_preview_set_gamma().

+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-gimpvectors.html b/devel-docs/libgimp/html/libgimp-gimpvectors.html new file mode 100644 index 0000000..c24f216 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpvectors.html @@ -0,0 +1,2190 @@ + + + + +gimpvectors: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+
+
+ + +
+

gimpvectors

+

gimpvectors — Functions for querying and manipulating vectors.

+
+
+

Functions

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+gint32 + +gimp_vectors_new () +
+gint32 + +gimp_vectors_new_from_text_layer () +
+gint32 + +gimp_vectors_copy () +
+gboolean + +gimp_vectors_is_valid () +
+gint * + +gimp_vectors_get_strokes () +
+gint32 + +gimp_vectors_get_image () +
+gchar * + +gimp_vectors_get_name () +
+gboolean + +gimp_vectors_set_name () +
+gboolean + +gimp_vectors_get_visible () +
+gboolean + +gimp_vectors_set_visible () +
+gboolean + +gimp_vectors_get_linked () +
+gboolean + +gimp_vectors_set_linked () +
+gint + +gimp_vectors_get_tattoo () +
+gboolean + +gimp_vectors_set_tattoo () +
+gboolean + +gimp_vectors_remove_stroke () +
+gboolean + +gimp_vectors_to_selection () +
+gboolean + +gimp_vectors_export_to_file () +
+gchar * + +gimp_vectors_export_to_string () +
+gboolean + +gimp_vectors_import_from_file () +
+gboolean + +gimp_vectors_import_from_string () +
+gboolean + +gimp_vectors_parasite_attach () +
+gboolean + +gimp_vectors_parasite_detach () +
+GimpParasite * + +gimp_vectors_parasite_find () +
+gboolean + +gimp_vectors_parasite_list () +
+gint + +gimp_vectors_stroke_new_from_points () +
+gboolean + +gimp_vectors_stroke_close () +
+gdouble + +gimp_vectors_stroke_get_length () +
+GimpVectorsStrokeType + +gimp_vectors_stroke_get_points () +
+gboolean + +gimp_vectors_stroke_get_point_at_dist () +
+gdouble * + +gimp_vectors_stroke_interpolate () +
+gboolean + +gimp_vectors_stroke_scale () +
+gboolean + +gimp_vectors_stroke_translate () +
+gboolean + +gimp_vectors_stroke_flip () +
+gboolean + +gimp_vectors_stroke_flip_free () +
+gboolean + +gimp_vectors_stroke_rotate () +
+gboolean + +gimp_vectors_bezier_stroke_conicto () +
+gboolean + +gimp_vectors_bezier_stroke_cubicto () +
+gboolean + +gimp_vectors_bezier_stroke_lineto () +
+gint + +gimp_vectors_bezier_stroke_new_ellipse () +
+gint + +gimp_vectors_bezier_stroke_new_moveto () +
+
+
+

Description

+

Functions for querying and manipulating vectors.

+
+
+

Functions

+
+

gimp_vectors_new ()

+
gint32
+gimp_vectors_new (gint32 image_ID,
+                  const gchar *name);
+

Creates a new empty vectors object.

+

Creates a new empty vectors object. The vectors object needs to be +added to the image using gimp_image_insert_vectors().

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

name

the name of the new vector object.

 
+
+
+

Returns

+

the current vector object, 0 if no vector exists in the +image.

+
+

Since: 2.4

+
+
+
+

gimp_vectors_new_from_text_layer ()

+
gint32
+gimp_vectors_new_from_text_layer (gint32 image_ID,
+                                  gint32 layer_ID);
+

Creates a new vectors object from a text layer.

+

Creates a new vectors object from a text layer. The vectors object +needs to be added to the image using gimp_image_insert_vectors().

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

layer_ID

The text layer.

 
+
+
+

Returns

+

The vectors of the text layer.

+
+

Since: 2.6

+
+
+
+

gimp_vectors_copy ()

+
gint32
+gimp_vectors_copy (gint32 vectors_ID);
+

Copy a vectors object.

+

This procedure copies the specified vectors object and returns the +copy.

+
+

Parameters

+
+++++ + + + + + +

vectors_ID

The vectors object to copy.

 
+
+
+

Returns

+

The newly copied vectors object.

+
+

Since: 2.6

+
+
+
+

gimp_vectors_is_valid ()

+
gboolean
+gimp_vectors_is_valid (gint32 vectors_ID);
+
+

gimp_vectors_is_valid is deprecated and should not be used in newly-written code.

+

Use gimp_item_is_valid() instead.

+
+
+

Parameters

+
+++++ + + + + + +

vectors_ID

The vectors object to check.

 
+
+
+

Returns

+

Whether the vectors ID is valid.

+
+

Since: 2.4

+
+
+
+

gimp_vectors_get_strokes ()

+
gint *
+gimp_vectors_get_strokes (gint32 vectors_ID,
+                          gint *num_strokes);
+

List the strokes associated with the passed path.

+

Returns an Array with the stroke-IDs associated with the passed +path.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

vectors_ID

The vectors object.

 

num_strokes

The number of strokes returned.

 
+
+
+

Returns

+

List of the strokes belonging to the path.

+
+

Since: 2.4

+
+
+
+

gimp_vectors_get_image ()

+
gint32
+gimp_vectors_get_image (gint32 vectors_ID);
+
+

gimp_vectors_get_image is deprecated and should not be used in newly-written code.

+

Use gimp_item_get_image() instead.

+
+
+

Parameters

+
+++++ + + + + + +

vectors_ID

The vectors object.

 
+
+
+

Returns

+

The vectors image.

+
+

Since: 2.4

+
+
+
+

gimp_vectors_get_name ()

+
gchar *
+gimp_vectors_get_name (gint32 vectors_ID);
+
+

gimp_vectors_get_name is deprecated and should not be used in newly-written code.

+

Use gimp_item_get_name() instead.

+
+
+

Parameters

+
+++++ + + + + + +

vectors_ID

The vectors object.

 
+
+
+

Returns

+

The name of the vectors object.

+
+

Since: 2.4

+
+
+
+

gimp_vectors_set_name ()

+
gboolean
+gimp_vectors_set_name (gint32 vectors_ID,
+                       const gchar *name);
+
+

gimp_vectors_set_name is deprecated and should not be used in newly-written code.

+

Use gimp_item_set_name() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

vectors_ID

The vectors object.

 

name

the new name of the path.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_vectors_get_visible ()

+
gboolean
+gimp_vectors_get_visible (gint32 vectors_ID);
+
+

gimp_vectors_get_visible is deprecated and should not be used in newly-written code.

+

Use gimp_item_get_visible() instead.

+
+
+

Parameters

+
+++++ + + + + + +

vectors_ID

The vectors object.

 
+
+
+

Returns

+

TRUE if the path is visible, FALSE otherwise.

+
+

Since: 2.4

+
+
+
+

gimp_vectors_set_visible ()

+
gboolean
+gimp_vectors_set_visible (gint32 vectors_ID,
+                          gboolean visible);
+
+

gimp_vectors_set_visible is deprecated and should not be used in newly-written code.

+

Use gimp_item_set_visible() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

vectors_ID

The vectors object.

 

visible

Whether the path is visible.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_vectors_get_linked ()

+
gboolean
+gimp_vectors_get_linked (gint32 vectors_ID);
+
+

gimp_vectors_get_linked is deprecated and should not be used in newly-written code.

+

Use gimp_item_get_linked() instead.

+
+
+

Parameters

+
+++++ + + + + + +

vectors_ID

The vectors object.

 
+
+
+

Returns

+

TRUE if the path is linked, FALSE otherwise.

+
+

Since: 2.4

+
+
+
+

gimp_vectors_set_linked ()

+
gboolean
+gimp_vectors_set_linked (gint32 vectors_ID,
+                         gboolean linked);
+
+

gimp_vectors_set_linked is deprecated and should not be used in newly-written code.

+

Use gimp_item_set_linked() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

vectors_ID

The vectors object.

 

linked

Whether the path is linked.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_vectors_get_tattoo ()

+
gint
+gimp_vectors_get_tattoo (gint32 vectors_ID);
+
+

gimp_vectors_get_tattoo is deprecated and should not be used in newly-written code.

+

Use gimp_item_get_tattoo() instead.

+
+
+

Parameters

+
+++++ + + + + + +

vectors_ID

The vectors object.

 
+
+
+

Returns

+

The vectors tattoo.

+
+

Since: 2.4

+
+
+
+

gimp_vectors_set_tattoo ()

+
gboolean
+gimp_vectors_set_tattoo (gint32 vectors_ID,
+                         gint tattoo);
+
+

gimp_vectors_set_tattoo is deprecated and should not be used in newly-written code.

+

Use gimp_item_set_tattoo() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

vectors_ID

The vectors object.

 

tattoo

the new tattoo.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_vectors_remove_stroke ()

+
gboolean
+gimp_vectors_remove_stroke (gint32 vectors_ID,
+                            gint stroke_id);
+

remove the stroke from a vectors object.

+

Remove the stroke from a vectors object.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

vectors_ID

The vectors object.

 

stroke_id

The stroke ID.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_vectors_to_selection ()

+
gboolean
+gimp_vectors_to_selection (gint32 vectors_ID,
+                           GimpChannelOps operation,
+                           gboolean antialias,
+                           gboolean feather,
+                           gdouble feather_radius_x,
+                           gdouble feather_radius_y);
+
+

gimp_vectors_to_selection is deprecated and should not be used in newly-written code.

+

Use gimp_image_select_item() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

vectors_ID

The vectors object to render to the selection.

 

operation

The desired operation with current selection.

 

antialias

Antialias selection.

 

feather

Feather selection.

 

feather_radius_x

Feather radius x.

 

feather_radius_y

Feather radius y.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_vectors_export_to_file ()

+
gboolean
+gimp_vectors_export_to_file (gint32 image_ID,
+                             const gchar *filename,
+                             gint32 vectors_ID);
+

save a path as an SVG file.

+

This procedure creates an SVG file to save a Vectors object, that +is, a path. The resulting file can be edited using a vector graphics +application, or later reloaded into GIMP. If you pass 0 as the +'vectors' argument, then all paths in the image will be exported.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

filename

The name of the SVG file to create.

 

vectors_ID

The vectors object to be saved, or 0 for all in the image.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.6

+
+
+
+

gimp_vectors_export_to_string ()

+
gchar *
+gimp_vectors_export_to_string (gint32 image_ID,
+                               gint32 vectors_ID);
+

Save a path as an SVG string.

+

This procedure works like gimp_vectors_export_to_file() but creates +a string rather than a file. The contents are a NUL-terminated +string that holds a complete XML document. If you pass 0 as the +'vectors' argument, then all paths in the image will be exported.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

image_ID

The image.

 

vectors_ID

The vectors object to save, or 0 for all in the image.

 
+
+
+

Returns

+

A string whose contents are a complete SVG document.

+
+

Since: 2.6

+
+
+
+

gimp_vectors_import_from_file ()

+
gboolean
+gimp_vectors_import_from_file (gint32 image_ID,
+                               const gchar *filename,
+                               gboolean merge,
+                               gboolean scale,
+                               gint *num_vectors,
+                               gint32 **vectors_ids);
+

Import paths from an SVG file.

+

This procedure imports paths from an SVG file. SVG elements other +than paths and basic shapes are ignored.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

filename

The name of the SVG file to import.

 

merge

Merge paths into a single vectors object.

 

scale

Scale the SVG to image dimensions.

 

num_vectors

The number of newly created vectors.

 

vectors_ids

The list of newly created vectors.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_vectors_import_from_string ()

+
gboolean
+gimp_vectors_import_from_string (gint32 image_ID,
+                                 const gchar *string,
+                                 gint length,
+                                 gboolean merge,
+                                 gboolean scale,
+                                 gint *num_vectors,
+                                 gint32 **vectors_ids);
+

Import paths from an SVG string.

+

This procedure works like gimp_vectors_import_from_file() but takes +a string rather than reading the SVG from a file. This allows you to +write scripts that generate SVG and feed it to GIMP.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

image_ID

The image.

 

string

A string that must be a complete and valid SVG document.

 

length

Number of bytes in string or -1 if the string is NULL terminated.

 

merge

Merge paths into a single vectors object.

 

scale

Scale the SVG to image dimensions.

 

num_vectors

The number of newly created vectors.

 

vectors_ids

The list of newly created vectors.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_vectors_parasite_attach ()

+
gboolean
+gimp_vectors_parasite_attach (gint32 vectors_ID,
+                              const GimpParasite *parasite);
+
+

gimp_vectors_parasite_attach is deprecated and should not be used in newly-written code.

+

Use gimp_item_attach_parasite() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

vectors_ID

The vectors object.

 

parasite

The parasite to attach to a vectors object.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_vectors_parasite_detach ()

+
gboolean
+gimp_vectors_parasite_detach (gint32 vectors_ID,
+                              const gchar *name);
+
+

gimp_vectors_parasite_detach is deprecated and should not be used in newly-written code.

+

Use gimp_item_detach_parasite() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

vectors_ID

The vectors object.

 

name

The name of the parasite to detach from a vectors object.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_vectors_parasite_find ()

+
GimpParasite *
+gimp_vectors_parasite_find (gint32 vectors_ID,
+                            const gchar *name);
+
+

gimp_vectors_parasite_find is deprecated and should not be used in newly-written code.

+

Use gimp_item_get_parasite() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + +

vectors_ID

The vectors object.

 

name

The name of the parasite to find.

 
+
+
+

Returns

+

The found parasite.

+
+

Since: 2.4

+
+
+
+

gimp_vectors_parasite_list ()

+
gboolean
+gimp_vectors_parasite_list (gint32 vectors_ID,
+                            gint *num_parasites,
+                            gchar ***parasites);
+
+

gimp_vectors_parasite_list is deprecated and should not be used in newly-written code.

+

Use gimp_item_get_parasite_list() instead.

+
+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

vectors_ID

The vectors object.

 

num_parasites

The number of attached parasites.

 

parasites

The names of currently attached parasites.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_vectors_stroke_new_from_points ()

+
gint
+gimp_vectors_stroke_new_from_points (gint32 vectors_ID,
+                                     GimpVectorsStrokeType type,
+                                     gint num_points,
+                                     const gdouble *controlpoints,
+                                     gboolean closed);
+

Adds a stroke of a given type to the vectors object.

+

Adds a stroke of a given type to the vectors object. The coordinates +of the control points can be specified. For now only strokes of the +type GIMP_VECTORS_STROKE_TYPE_BEZIER are supported. The control +points are specified as a pair of float values for the x- and +y-coordinate. The Bezier stroke type needs a multiple of three +control points. Each Bezier segment endpoint (anchor, A) has two +additional control points (C) associated. They are specified in the +order CACCACCAC...

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

vectors_ID

The vectors object.

 

type

type of the stroke (always GIMP_VECTORS_STROKE_TYPE_BEZIER for now).

 

num_points

The number of elements in the array, i.e. the number of controlpoints in the stroke * 2 (x- and y-coordinate).

 

controlpoints

List of the x- and y-coordinates of the control points.

 

closed

Whether the stroke is to be closed or not.

 
+
+
+

Returns

+

The stroke ID of the newly created stroke.

+
+

Since: 2.4

+
+
+
+

gimp_vectors_stroke_close ()

+
gboolean
+gimp_vectors_stroke_close (gint32 vectors_ID,
+                           gint stroke_id);
+

closes the specified stroke.

+

Closes the specified stroke.

+
+

Parameters

+
+++++ + + + + + + + + + + + + +

vectors_ID

The vectors object.

 

stroke_id

The stroke ID.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_vectors_stroke_get_length ()

+
gdouble
+gimp_vectors_stroke_get_length (gint32 vectors_ID,
+                                gint stroke_id,
+                                gdouble precision);
+

Measure the length of the given stroke.

+

Measure the length of the given stroke.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

vectors_ID

The vectors object.

 

stroke_id

The stroke ID.

 

precision

The precision used for the approximation.

 
+
+
+

Returns

+

The length (in pixels) of the given stroke.

+
+

Since: 2.4

+
+
+
+

gimp_vectors_stroke_get_points ()

+
GimpVectorsStrokeType
+gimp_vectors_stroke_get_points (gint32 vectors_ID,
+                                gint stroke_id,
+                                gint *num_points,
+                                gdouble **controlpoints,
+                                gboolean *closed);
+

returns the control points of a stroke.

+

returns the control points of a stroke. The interpretation of the +coordinates returned depends on the type of the stroke. For Gimp 2.4 +this is always a bezier stroke, where the coordinates are the +control points.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

vectors_ID

The vectors object.

 

stroke_id

The stroke ID.

 

num_points

The number of floats returned.

 

controlpoints

List of the control points for the stroke (x0, y0, x1, y1, ...).

 

closed

Whether the stroke is closed or not.

 
+
+
+

Returns

+

type of the stroke (always GIMP_VECTORS_STROKE_TYPE_BEZIER +for now).

+
+

Since: 2.4

+
+
+
+

gimp_vectors_stroke_get_point_at_dist ()

+
gboolean
+gimp_vectors_stroke_get_point_at_dist (gint32 vectors_ID,
+                                       gint stroke_id,
+                                       gdouble dist,
+                                       gdouble precision,
+                                       gdouble *x_point,
+                                       gdouble *y_point,
+                                       gdouble *slope,
+                                       gboolean *valid);
+

Get point at a specified distance along the stroke.

+

This will return the x,y position of a point at a given distance +along the stroke. The distance will be obtained by first digitizing +the curve internally and then walking along the curve. For a closed +stroke the start of the path is the first point on the path that was +created. This might not be obvious. If the stroke is not long +enough, a \"valid\" flag will be FALSE.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

vectors_ID

The vectors object.

 

stroke_id

The stroke ID.

 

dist

The given distance.

 

precision

The precision used for the approximation.

 

x_point

The x position of the point.

 

y_point

The y position of the point.

 

slope

The slope (dy / dx) at the specified point.

 

valid

Indicator for the validity of the returned data.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_vectors_stroke_interpolate ()

+
gdouble *
+gimp_vectors_stroke_interpolate (gint32 vectors_ID,
+                                 gint stroke_id,
+                                 gdouble precision,
+                                 gint *num_coords,
+                                 gboolean *closed);
+

returns polygonal approximation of the stroke.

+

returns polygonal approximation of the stroke.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

vectors_ID

The vectors object.

 

stroke_id

The stroke ID.

 

precision

The precision used for the approximation.

 

num_coords

The number of floats returned.

 

closed

Whether the stroke is closed or not.

 
+
+
+

Returns

+

List of the coords along the path (x0, y0, x1, y1, ...).

+
+

Since: 2.4

+
+
+
+

gimp_vectors_stroke_scale ()

+
gboolean
+gimp_vectors_stroke_scale (gint32 vectors_ID,
+                           gint stroke_id,
+                           gdouble scale_x,
+                           gdouble scale_y);
+

scales the given stroke.

+

Scale the given stroke.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

vectors_ID

The vectors object.

 

stroke_id

The stroke ID.

 

scale_x

Scale factor in x direction.

 

scale_y

Scale factor in y direction.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_vectors_stroke_translate ()

+
gboolean
+gimp_vectors_stroke_translate (gint32 vectors_ID,
+                               gint stroke_id,
+                               gint off_x,
+                               gint off_y);
+

translate the given stroke.

+

Translate the given stroke.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

vectors_ID

The vectors object.

 

stroke_id

The stroke ID.

 

off_x

Offset in x direction.

 

off_y

Offset in y direction.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_vectors_stroke_flip ()

+
gboolean
+gimp_vectors_stroke_flip (gint32 vectors_ID,
+                          gint stroke_id,
+                          GimpOrientationType flip_type,
+                          gdouble axis);
+

flips the given stroke.

+

Rotates the given stroke around given center by angle (in degrees).

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

vectors_ID

The vectors object.

 

stroke_id

The stroke ID.

 

flip_type

Flip orientation, either vertical or horizontal.

 

axis

axis coordinate about which to flip, in pixels.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_vectors_stroke_flip_free ()

+
gboolean
+gimp_vectors_stroke_flip_free (gint32 vectors_ID,
+                               gint stroke_id,
+                               gdouble x1,
+                               gdouble y1,
+                               gdouble x2,
+                               gdouble y2);
+

flips the given stroke about an arbitrary axis.

+

Flips the given stroke about an arbitrary axis. Axis is defined by +two coordinates in the image (in pixels), through which the flipping +axis passes.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

vectors_ID

The vectors object.

 

stroke_id

The stroke ID.

 

x1

X coordinate of the first point of the flipping axis.

 

y1

Y coordinate of the first point of the flipping axis.

 

x2

X coordinate of the second point of the flipping axis.

 

y2

Y coordinate of the second point of the flipping axis.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_vectors_stroke_rotate ()

+
gboolean
+gimp_vectors_stroke_rotate (gint32 vectors_ID,
+                            gint stroke_id,
+                            gdouble center_x,
+                            gdouble center_y,
+                            gdouble angle);
+

rotates the given stroke.

+

Rotates the given stroke around given center by angle (in degrees).

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

vectors_ID

The vectors object.

 

stroke_id

The stroke ID.

 

center_x

X coordinate of the rotation center.

 

center_y

Y coordinate of the rotation center.

 

angle

angle to rotate about.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_vectors_bezier_stroke_conicto ()

+
gboolean
+gimp_vectors_bezier_stroke_conicto (gint32 vectors_ID,
+                                    gint stroke_id,
+                                    gdouble x0,
+                                    gdouble y0,
+                                    gdouble x1,
+                                    gdouble y1);
+

Extends a bezier stroke with a conic bezier spline.

+

Extends a bezier stroke with a conic bezier spline. Actually a cubic +bezier spline gets added that realizes the shape of a conic bezier +spline.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

vectors_ID

The vectors object.

 

stroke_id

The stroke ID.

 

x0

The x-coordinate of the control point.

 

y0

The y-coordinate of the control point.

 

x1

The x-coordinate of the end point.

 

y1

The y-coordinate of the end point.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_vectors_bezier_stroke_cubicto ()

+
gboolean
+gimp_vectors_bezier_stroke_cubicto (gint32 vectors_ID,
+                                    gint stroke_id,
+                                    gdouble x0,
+                                    gdouble y0,
+                                    gdouble x1,
+                                    gdouble y1,
+                                    gdouble x2,
+                                    gdouble y2);
+

Extends a bezier stroke with a cubic bezier spline.

+

Extends a bezier stroke with a cubic bezier spline.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

vectors_ID

The vectors object.

 

stroke_id

The stroke ID.

 

x0

The x-coordinate of the first control point.

 

y0

The y-coordinate of the first control point.

 

x1

The x-coordinate of the second control point.

 

y1

The y-coordinate of the second control point.

 

x2

The x-coordinate of the end point.

 

y2

The y-coordinate of the end point.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_vectors_bezier_stroke_lineto ()

+
gboolean
+gimp_vectors_bezier_stroke_lineto (gint32 vectors_ID,
+                                   gint stroke_id,
+                                   gdouble x0,
+                                   gdouble y0);
+

Extends a bezier stroke with a lineto.

+

Extends a bezier stroke with a lineto.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

vectors_ID

The vectors object.

 

stroke_id

The stroke ID.

 

x0

The x-coordinate of the lineto.

 

y0

The y-coordinate of the lineto.

 
+
+
+

Returns

+

TRUE on success.

+
+

Since: 2.4

+
+
+
+

gimp_vectors_bezier_stroke_new_ellipse ()

+
gint
+gimp_vectors_bezier_stroke_new_ellipse
+                               (gint32 vectors_ID,
+                                gdouble x0,
+                                gdouble y0,
+                                gdouble radius_x,
+                                gdouble radius_y,
+                                gdouble angle);
+

Adds a bezier stroke describing an ellipse the vectors object.

+

Adds a bezier stroke describing an ellipse the vectors object.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

vectors_ID

The vectors object.

 

x0

The x-coordinate of the center.

 

y0

The y-coordinate of the center.

 

radius_x

The radius in x direction.

 

radius_y

The radius in y direction.

 

angle

The angle the x-axis of the ellipse (radians, counterclockwise).

 
+
+
+

Returns

+

The resulting stroke.

+
+

Since: 2.4

+
+
+
+

gimp_vectors_bezier_stroke_new_moveto ()

+
gint
+gimp_vectors_bezier_stroke_new_moveto (gint32 vectors_ID,
+                                       gdouble x0,
+                                       gdouble y0);
+

Adds a bezier stroke with a single moveto to the vectors object.

+

Adds a bezier stroke with a single moveto to the vectors object.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

vectors_ID

The vectors object.

 

x0

The x-coordinate of the moveto.

 

y0

The y-coordinate of the moveto.

 
+
+
+

Returns

+

The resulting stroke.

+
+

Since: 2.4

+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-image.html b/devel-docs/libgimp/html/libgimp-image.html new file mode 100644 index 0000000..7574339 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-image.html @@ -0,0 +1,139 @@ + + + + +Manipulating Images and their Properties: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+

+Manipulating Images and their Properties

+
+
+gimpchannel — Functions for manipulating channels. +
+
+gimpcolor — Functions for manipulating color. +
+
+gimpdisplay — Functions to create, delete and flush displays (views) on an image. +
+
+gimpdrawable — Functions to manipulate drawables. +
+
+gimpdrawablecolor — Functions for manipulating a drawable's color. +
+
+gimpdrawableedit — Drawable edit functions (clear, fill, gradient, stroke etc.) +
+
+gimpdrawabletransform — Functions to perform transformatrions on drawables. +
+
+gimpedit — Edit menu functions (cut, copy, paste, clear, etc.) +
+
+gimpfileops — Image file operations (load, save, etc.) +
+
+gimpfloatingsel — Functions for removing or attaching floating selections. +
+
+gimpimage — Operations on complete images. +
+
+gimpimagecolorprofile — Operations on an image's color profile. +
+
+gimpimageconvert — Conversions between RGB, indexed, and grayscale modes. +
+
+gimpimagegrid — Functions manuipulating an image's grid. +
+
+gimpimageguides — Functions for manipulating an image's guides. +
+
+gimpimagesamplepoints — Functions for manipulating an image's sample points. +
+
+gimpimageselect — Modify the image's selection. +
+
+gimpimagetransform — Transformations on images. +
+
+gimpimageundo — Control of image undo/redo. +
+
+gimpmetadata +
+
+gimpitem — Functions to manipulate items. +
+
+gimpitemtransform — Functions to perform transformations on items. +
+
+gimplayer — Operations on a single layer. +
+
+gimppaths — Deprecated operations related to paths. +
+
+gimppixbuf — Get a thumbnail pixbuf for a drawable or image. +
+
+gimppixelfetcher — Functions for operating on pixel regions. +
+
+gimppixelrgn — Functions for operating on pixel regions. +
+
+gimpregioniterator — Functions to traverse a pixel regions. +
+
+gimpselection — Functions for manipulating selections. +
+
+gimptextlayer — Functions for querying and manipulating text layers. +
+
+gimptexttool — Functions for controlling the text tool. +
+
+gimptile — Functions for working with tiles. +
+
+gimppainttools — Access to toolbox paint tools. +
+
+gimpselectiontools — Access to toolbox selection tools. +
+
+gimptransformtools — Access to toolbox transform tools. +
+
+gimpvectors — Functions for querying and manipulating vectors. +
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp-selectors.html b/devel-docs/libgimp/html/libgimp-selectors.html new file mode 100644 index 0000000..e9a61ae --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-selectors.html @@ -0,0 +1,64 @@ + + + + +Controlling the Core's Selection Dialogs: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+

+Controlling the Core's Selection Dialogs

+
+
+GimpSelectButton — The base class of the data select buttons. +
+
+gimpbrushselectbutton — A button that pops up a brush selection dialog. +
+
+GimpFontSelectButton — A button which pops up a font selection dialog. +
+
+GimpGradientSelectButton — A button which pops up a gradient select dialog. +
+
+GimpPaletteSelect — A button which pops up a palette select dialog. +
+
+GimpPatternSelectButton — A button which pops up a pattern select dialog. +
+
+gimpbrushselect — Functions providing a brush selection dialog. +
+
+gimpfontselect — Functions providing a font selection dialog. +
+
+gimpgradientselect — Functions providing a gradient selection dialog. +
+
+gimppaletteselect — Functions providing a palette selection dialog. +
+
+gimppatternselect — Functions providing a pattern selection dialog. +
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimp.devhelp2 b/devel-docs/libgimp/html/libgimp.devhelp2 new file mode 100644 index 0000000..65c68d1 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp.devhelp2 @@ -0,0 +1,1343 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/devel-docs/libgimp/html/libgimp.html b/devel-docs/libgimp/html/libgimp.html new file mode 100644 index 0000000..5178a57 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp.html @@ -0,0 +1,258 @@ + + + + +Part I. GIMP Library: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+

+Part I. GIMP Library

+
+
+

+ GIMP's Procedural Database (PDB) offers an interface to core + functions and to functionality provided by plug-ins. The role + of libgimp is to provide C bindings for this interface. +

+
+

Table of Contents

+
+
Functions not Related to Specific Images
+
+
+gimp — Miscellaneous procedures +
+
+gimpenums +
+
+gimpbuffer — Functions for manipulating cut buffers. +
+
+gimpcontext — Functions to manipulate a plug-in's context. +
+
+gimpgimprc — Interactions with settings from gimprc. +
+
+gimphelp — Loading help pages using gimp_help. +
+
+gimpmessage — Display a dialog box with a message. +
+
+gimpplugin — Functions useful for plug-ins, e.g. registration and progress indicators. +
+
+gimpproceduraldb — Functions for querying and changing procedural database (PDB) entries. +
+
+gimpprogress — Functions for embedding the progress bar into a plug-in's GUI. +
+
+gimpdebug — Debug utility functions +
+
+
Manipulating Images and their Properties
+
+
+gimpchannel — Functions for manipulating channels. +
+
+gimpcolor — Functions for manipulating color. +
+
+gimpdisplay — Functions to create, delete and flush displays (views) on an image. +
+
+gimpdrawable — Functions to manipulate drawables. +
+
+gimpdrawablecolor — Functions for manipulating a drawable's color. +
+
+gimpdrawableedit — Drawable edit functions (clear, fill, gradient, stroke etc.) +
+
+gimpdrawabletransform — Functions to perform transformatrions on drawables. +
+
+gimpedit — Edit menu functions (cut, copy, paste, clear, etc.) +
+
+gimpfileops — Image file operations (load, save, etc.) +
+
+gimpfloatingsel — Functions for removing or attaching floating selections. +
+
+gimpimage — Operations on complete images. +
+
+gimpimagecolorprofile — Operations on an image's color profile. +
+
+gimpimageconvert — Conversions between RGB, indexed, and grayscale modes. +
+
+gimpimagegrid — Functions manuipulating an image's grid. +
+
+gimpimageguides — Functions for manipulating an image's guides. +
+
+gimpimagesamplepoints — Functions for manipulating an image's sample points. +
+
+gimpimageselect — Modify the image's selection. +
+
+gimpimagetransform — Transformations on images. +
+
+gimpimageundo — Control of image undo/redo. +
+
+gimpmetadata +
+
+gimpitem — Functions to manipulate items. +
+
+gimpitemtransform — Functions to perform transformations on items. +
+
+gimplayer — Operations on a single layer. +
+
+gimppaths — Deprecated operations related to paths. +
+
+gimppixbuf — Get a thumbnail pixbuf for a drawable or image. +
+
+gimppixelfetcher — Functions for operating on pixel regions. +
+
+gimppixelrgn — Functions for operating on pixel regions. +
+
+gimpregioniterator — Functions to traverse a pixel regions. +
+
+gimpselection — Functions for manipulating selections. +
+
+gimptextlayer — Functions for querying and manipulating text layers. +
+
+gimptexttool — Functions for controlling the text tool. +
+
+gimptile — Functions for working with tiles. +
+
+gimppainttools — Access to toolbox paint tools. +
+
+gimpselectiontools — Access to toolbox selection tools. +
+
+gimptransformtools — Access to toolbox transform tools. +
+
+gimpvectors — Functions for querying and manipulating vectors. +
+
+
Data Objects
+
+
+gimpbrush — Functions operating on a single brush. +
+
+gimpbrushes — Functions for manipulating brushes. +
+
+gimpdynamics — Operations related to paint dynamics. +
+
+gimpfonts — Operations related to fonts. +
+
+gimpgradient — Functions operating on a single gradient. +
+
+gimpgradients — Operations related to gradients. +
+
+gimppalette — Functions operating on a single palette. +
+
+gimppalettes — Operations related to palettes. +
+
+gimppattern — Functions operating on a single pattern. +
+
+gimppatterns — Functions relating to patterns. +
+
+
Controlling the Core's Selection Dialogs
+
+
+GimpSelectButton — The base class of the data select buttons. +
+
+gimpbrushselectbutton — A button that pops up a brush selection dialog. +
+
+GimpFontSelectButton — A button which pops up a font selection dialog. +
+
+GimpGradientSelectButton — A button which pops up a gradient select dialog. +
+
+GimpPaletteSelect — A button which pops up a palette select dialog. +
+
+GimpPatternSelectButton — A button which pops up a pattern select dialog. +
+
+gimpbrushselect — Functions providing a brush selection dialog. +
+
+gimpfontselect — Functions providing a font selection dialog. +
+
+gimpgradientselect — Functions providing a gradient selection dialog. +
+
+gimppaletteselect — Functions providing a palette selection dialog. +
+
+gimppatternselect — Functions providing a pattern selection dialog. +
+
+
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimpui-hierarchy.html b/devel-docs/libgimp/html/libgimpui-hierarchy.html new file mode 100644 index 0000000..de6d15e --- /dev/null +++ b/devel-docs/libgimp/html/libgimpui-hierarchy.html @@ -0,0 +1,63 @@ + + + + +Object Hierarchy: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+

+Object Hierarchy

+
+    GObject
+    ╰── GInitiallyUnowned
+        ╰── GtkObject
+            ╰── GtkWidget
+                ├── GtkContainer
+                │   ├── GtkBox
+                │   │   ├── GimpPreview
+                │   │   │   ├── GimpAspectPreview
+                │   │   │   ╰── GimpScrolledPreview
+                │   │   │       ├── GimpDrawablePreview
+                │   │   │       ╰── GimpZoomPreview
+                │   │   ╰── GimpSelectButton
+                │   │       ├── GimpBrushSelectButton
+                │   │       ├── GimpFontSelectButton
+                │   │       ├── GimpGradientSelectButton
+                │   │       ├── GimpPaletteSelectButton
+                │   │       ╰── GimpPatternSelectButton
+                │   ╰── GtkBin
+                │       ├── GtkComboBox
+                │       │   ╰── GimpIntComboBox
+                │       │       ├── GimpChannelComboBox
+                │       │       ├── GimpDrawableComboBox
+                │       │       ├── GimpImageComboBox
+                │       │       ├── GimpLayerComboBox
+                │       │       ╰── GimpVectorsComboBox
+                │       ╰── GtkWindow
+                │           ╰── GtkDialog
+                │               ╰── GimpDialog
+                │                   ╰── GimpProcBrowserDialog
+                ╰── GtkProgress
+                    ╰── GtkProgressBar
+                        ╰── GimpProgressBar
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/libgimpui.html b/devel-docs/libgimp/html/libgimpui.html new file mode 100644 index 0000000..7238369 --- /dev/null +++ b/devel-docs/libgimp/html/libgimpui.html @@ -0,0 +1,85 @@ + + + + +Part II. GIMP User Interface Library: GIMP Library Reference Manual + + + + + + + + + + + + + + + + +
+

+Part II. GIMP User Interface Library

+
+

Table of Contents

+
+
Object Hierarchy
+
+gimpui — Common user interface functions. This header includes +all other GIMP User Interface Library headers. +
+
+gimpexport — Export an image before it is saved. +
+
+GimpDrawablePreview — A widget providing a preview of a GimpDrawable. +
+
+GimpAspectPreview — A widget providing a preview with fixed aspect ratio. +
+
+GimpZoomPreview — A drawable preview with zooming capabilities. +
+
+GimpItemComboBox — Widgets providing popup menus of items. +
+
+GimpImageComboBox — A widget providing a popup menu of images. +
+
+GimpProgressBar — A widget providing a progress bar. +
+
+gimpmenu — Menus for selecting images, layers, channels +and drawables. +
+
+gimpbrushmenu — A widget for selecting brushes. +
+
+gimpfontmenu — A widget for selecting fonts. +
+
+gimpgradientmenu — A widget for selecting gradients. +
+
+gimppalettemenu — A widget for selecting palettes. +
+
+gimppatternmenu — A widget for selecting patterns. +
+
+GimpProcBrowserDialog — The dialog for the procedure and plugin browsers. +
+
+GimpProcView — A widget showing information about a PDB procedure. +
+
+
+
+
+
Generated by GTK-Doc V1.32
+ + \ No newline at end of file diff --git a/devel-docs/libgimp/html/right-insensitive.png b/devel-docs/libgimp/html/right-insensitive.png new file mode 100644 index 0000000..e4a5684 Binary files /dev/null and b/devel-docs/libgimp/html/right-insensitive.png differ diff --git a/devel-docs/libgimp/html/right.png b/devel-docs/libgimp/html/right.png new file mode 100644 index 0000000..2a405d3 Binary files /dev/null and b/devel-docs/libgimp/html/right.png differ diff --git a/devel-docs/libgimp/html/style.css b/devel-docs/libgimp/html/style.css new file mode 100644 index 0000000..b4a1493 --- /dev/null +++ b/devel-docs/libgimp/html/style.css @@ -0,0 +1,533 @@ +body +{ + font-family: cantarell, sans-serif; +} +.synopsis, .classsynopsis +{ + /* tango:aluminium 1/2 */ + background: #eeeeec; + background: rgba(238, 238, 236, 0.5); + border: solid 1px rgb(238, 238, 236); + padding: 0.5em; +} +.programlisting +{ + /* tango:sky blue 0/1 */ + /* fallback for no rgba support */ + background: #e6f3ff; + border: solid 1px #729fcf; + background: rgba(114, 159, 207, 0.1); + border: solid 1px rgba(114, 159, 207, 0.2); + padding: 0.5em; +} +.variablelist +{ + padding: 4px; + margin-left: 3em; +} +.variablelist td:first-child +{ + vertical-align: top; +} + +span.nowrap { + white-space: nowrap; +} + +div.gallery-float +{ + float: left; + padding: 10px; +} +div.gallery-float img +{ + border-style: none; +} +div.gallery-spacer +{ + clear: both; +} + +a, a:visited +{ + text-decoration: none; + /* tango:sky blue 2 */ + color: #3465a4; +} +a:hover +{ + text-decoration: underline; + /* tango:sky blue 1 */ + color: #729fcf; +} + +div.informaltable table +{ + border-collapse: separate; + border-spacing: 1em 0.3em; + border: none; +} + +div.informaltable table td, div.informaltable table th +{ + vertical-align: top; +} + +.function_type, +.variable_type, +.property_type, +.signal_type, +.parameter_name, +.struct_member_name, +.union_member_name, +.define_keyword, +.datatype_keyword, +.typedef_keyword +{ + text-align: right; +} + +/* dim non-primary columns */ +.c_punctuation, +.function_type, +.variable_type, +.property_type, +.signal_type, +.define_keyword, +.datatype_keyword, +.typedef_keyword, +.property_flags, +.signal_flags, +.parameter_annotations, +.enum_member_annotations, +.struct_member_annotations, +.union_member_annotations +{ + color: #888a85; +} + +.function_type a, +.function_type a:visited, +.function_type a:hover, +.property_type a, +.property_type a:visited, +.property_type a:hover, +.signal_type a, +.signal_type a:visited, +.signal_type a:hover, +.signal_flags a, +.signal_flags a:visited, +.signal_flags a:hover +{ + color: #729fcf; +} + +td p +{ + margin: 0.25em; +} + +div.table table +{ + border-collapse: collapse; + border-spacing: 0px; + /* tango:aluminium 3 */ + border: solid 1px #babdb6; +} + +div.table table td, div.table table th +{ + /* tango:aluminium 3 */ + border: solid 1px #babdb6; + padding: 3px; + vertical-align: top; +} + +div.table table th +{ + /* tango:aluminium 2 */ + background-color: #d3d7cf; +} + +h4 +{ + color: #555753; + margin-top: 1em; + margin-bottom: 1em; +} + +hr +{ + /* tango:aluminium 1 */ + color: #d3d7cf; + background: #d3d7cf; + border: none 0px; + height: 1px; + clear: both; + margin: 2.0em 0em 2.0em 0em; +} + +dl.toc dt +{ + padding-bottom: 0.25em; +} + +dl.toc > dt +{ + padding-top: 0.25em; + padding-bottom: 0.25em; + font-weight: bold; +} + +dl.toc > dl +{ + padding-bottom: 0.5em; +} + +.parameter +{ + font-style: normal; +} + +.footer +{ + padding-top: 3.5em; + /* tango:aluminium 3 */ + color: #babdb6; + text-align: center; + font-size: 80%; +} + +.informalfigure, +.figure +{ + margin: 1em; +} + +.informalexample, +.example +{ + margin-top: 1em; + margin-bottom: 1em; +} + +.warning +{ + /* tango:orange 0/1 */ + background: #ffeed9; + background: rgba(252, 175, 62, 0.1); + border-color: #ffb04f; + border-color: rgba(252, 175, 62, 0.2); +} +.note +{ + /* tango:chameleon 0/0.5 */ + background: #d8ffb2; + background: rgba(138, 226, 52, 0.1); + border-color: #abf562; + border-color: rgba(138, 226, 52, 0.2); +} +div.blockquote +{ + border-color: #eeeeec; +} +.note, .warning, div.blockquote +{ + padding: 0.5em; + border-width: 1px; + border-style: solid; + margin: 2em; +} +.note p, .warning p +{ + margin: 0; +} + +div.warning h3.title, +div.note h3.title +{ + display: none; +} + +p + div.section +{ + margin-top: 1em; +} + +div.refnamediv, +div.refsynopsisdiv, +div.refsect1, +div.refsect2, +div.toc, +div.section +{ + margin-bottom: 1em; +} + +/* blob links */ +h2 .extralinks, h3 .extralinks +{ + float: right; + /* tango:aluminium 3 */ + color: #babdb6; + font-size: 80%; + font-weight: normal; +} + +.lineart +{ + color: #d3d7cf; + font-weight: normal; +} + +.annotation +{ + /* tango:aluminium 5 */ + color: #555753; + font-weight: normal; +} + +.structfield +{ + font-style: normal; + font-weight: normal; +} + +acronym,abbr +{ + border-bottom: 1px dotted gray; +} + +.listing_frame { + /* tango:sky blue 1 */ + border: solid 1px #729fcf; + border: solid 1px rgba(114, 159, 207, 0.2); + padding: 0px; +} + +.listing_lines, .listing_code { + margin-top: 0px; + margin-bottom: 0px; + padding: 0.5em; +} +.listing_lines { + /* tango:sky blue 0.5 */ + background: #a6c5e3; + background: rgba(114, 159, 207, 0.2); + /* tango:aluminium 6 */ + color: #2e3436; +} +.listing_code { + /* tango:sky blue 0 */ + background: #e6f3ff; + background: rgba(114, 159, 207, 0.1); +} +.listing_code .programlisting { + /* override from previous */ + border: none 0px; + padding: 0px; + background: none; +} +.listing_lines pre, .listing_code pre { + margin: 0px; +} + +@media screen { + /* these have a as a first child, but since there are no parent selectors + * we can't use that. */ + a.footnote + { + position: relative; + top: 0em ! important; + } + /* this is needed so that the local anchors are displayed below the naviagtion */ + div.footnote a[name], div.refnamediv a[name], div.refsect1 a[name], div.refsect2 a[name], div.index a[name], div.glossary a[name], div.sect1 a[name] + { + display: inline-block; + position: relative; + top:-5em; + } + /* this seems to be a bug in the xsl style sheets when generating indexes */ + div.index div.index + { + top: 0em; + } + /* make space for the fixed navigation bar and add space at the bottom so that + * link targets appear somewhat close to top + */ + body + { + padding-top: 2.5em; + padding-bottom: 500px; + max-width: 60em; + } + p + { + max-width: 60em; + } + /* style and size the navigation bar */ + table.navigation#top + { + position: fixed; + background: #e2e2e2; + border-bottom: solid 1px #babdb6; + border-spacing: 5px; + margin-top: 0; + margin-bottom: 0; + top: 0; + left: 0; + z-index: 10; + } + table.navigation#top td + { + padding-left: 6px; + padding-right: 6px; + } + .navigation a, .navigation a:visited + { + /* tango:sky blue 3 */ + color: #204a87; + } + .navigation a:hover + { + /* tango:sky blue 2 */ + color: #3465a4; + } + td.shortcuts + { + /* tango:sky blue 2 */ + color: #3465a4; + font-size: 80%; + white-space: nowrap; + } + td.shortcuts .dim + { + color: #babdb6; + } + .navigation .title + { + font-size: 80%; + max-width: none; + margin: 0px; + font-weight: normal; + } +} +@media screen and (min-width: 60em) { + /* screen larger than 60em */ + body { margin: auto; } +} +@media screen and (max-width: 60em) { + /* screen less than 60em */ + #nav_hierarchy { display: none; } + #nav_interfaces { display: none; } + #nav_prerequisites { display: none; } + #nav_derived_interfaces { display: none; } + #nav_implementations { display: none; } + #nav_child_properties { display: none; } + #nav_style_properties { display: none; } + #nav_index { display: none; } + #nav_glossary { display: none; } + .gallery_image { display: none; } + .property_flags { display: none; } + .signal_flags { display: none; } + .parameter_annotations { display: none; } + .enum_member_annotations { display: none; } + .struct_member_annotations { display: none; } + .union_member_annotations { display: none; } + /* now that a column is hidden, optimize space */ + col.parameters_name { width: auto; } + col.parameters_description { width: auto; } + col.struct_members_name { width: auto; } + col.struct_members_description { width: auto; } + col.enum_members_name { width: auto; } + col.enum_members_description { width: auto; } + col.union_members_name { width: auto; } + col.union_members_description { width: auto; } + .listing_lines { display: none; } +} +@media print { + table.navigation { + visibility: collapse; + display: none; + } + div.titlepage table.navigation { + visibility: visible; + display: table; + background: #e2e2e2; + border: solid 1px #babdb6; + margin-top: 0; + margin-bottom: 0; + top: 0; + left: 0; + height: 3em; + } +} + +.hll { background-color: #ffffcc } +.c { color: #408080; font-style: italic } /* Comment */ +.err { border: 1px solid #FF0000 } /* Error */ +.k { color: #008000; font-weight: bold } /* Keyword */ +.o { color: #666666 } /* Operator */ +.ch { color: #408080; font-style: italic } /* Comment.Hashbang */ +.cm { color: #408080; font-style: italic } /* Comment.Multiline */ +.cp { color: #BC7A00 } /* Comment.Preproc */ +.cpf { color: #408080; font-style: italic } /* Comment.PreprocFile */ +.c1 { color: #408080; font-style: italic } /* Comment.Single */ +.cs { color: #408080; font-style: italic } /* Comment.Special */ +.gd { color: #A00000 } /* Generic.Deleted */ +.ge { font-style: italic } /* Generic.Emph */ +.gr { color: #FF0000 } /* Generic.Error */ +.gh { color: #000080; font-weight: bold } /* Generic.Heading */ +.gi { color: #00A000 } /* Generic.Inserted */ +.go { color: #888888 } /* Generic.Output */ +.gp { color: #000080; font-weight: bold } /* Generic.Prompt */ +.gs { font-weight: bold } /* Generic.Strong */ +.gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +.gt { color: #0044DD } /* Generic.Traceback */ +.kc { color: #008000; font-weight: bold } /* Keyword.Constant */ +.kd { color: #008000; font-weight: bold } /* Keyword.Declaration */ +.kn { color: #008000; font-weight: bold } /* Keyword.Namespace */ +.kp { color: #008000 } /* Keyword.Pseudo */ +.kr { color: #008000; font-weight: bold } /* Keyword.Reserved */ +.kt { color: #B00040 } /* Keyword.Type */ +.m { color: #666666 } /* Literal.Number */ +.s { color: #BA2121 } /* Literal.String */ +.na { color: #7D9029 } /* Name.Attribute */ +.nb { color: #008000 } /* Name.Builtin */ +.nc { color: #0000FF; font-weight: bold } /* Name.Class */ +.no { color: #880000 } /* Name.Constant */ +.nd { color: #AA22FF } /* Name.Decorator */ +.ni { color: #999999; font-weight: bold } /* Name.Entity */ +.ne { color: #D2413A; font-weight: bold } /* Name.Exception */ +.nf { color: #0000FF } /* Name.Function */ +.nl { color: #A0A000 } /* Name.Label */ +.nn { color: #0000FF; font-weight: bold } /* Name.Namespace */ +.nt { color: #008000; font-weight: bold } /* Name.Tag */ +.nv { color: #19177C } /* Name.Variable */ +.ow { color: #AA22FF; font-weight: bold } /* Operator.Word */ +.w { color: #bbbbbb } /* Text.Whitespace */ +.mb { color: #666666 } /* Literal.Number.Bin */ +.mf { color: #666666 } /* Literal.Number.Float */ +.mh { color: #666666 } /* Literal.Number.Hex */ +.mi { color: #666666 } /* Literal.Number.Integer */ +.mo { color: #666666 } /* Literal.Number.Oct */ +.sa { color: #BA2121 } /* Literal.String.Affix */ +.sb { color: #BA2121 } /* Literal.String.Backtick */ +.sc { color: #BA2121 } /* Literal.String.Char */ +.dl { color: #BA2121 } /* Literal.String.Delimiter */ +.sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */ +.s2 { color: #BA2121 } /* Literal.String.Double */ +.se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */ +.sh { color: #BA2121 } /* Literal.String.Heredoc */ +.si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */ +.sx { color: #008000 } /* Literal.String.Other */ +.sr { color: #BB6688 } /* Literal.String.Regex */ +.s1 { color: #BA2121 } /* Literal.String.Single */ +.ss { color: #19177C } /* Literal.String.Symbol */ +.bp { color: #008000 } /* Name.Builtin.Pseudo */ +.fm { color: #0000FF } /* Name.Function.Magic */ +.vc { color: #19177C } /* Name.Variable.Class */ +.vg { color: #19177C } /* Name.Variable.Global */ +.vi { color: #19177C } /* Name.Variable.Instance */ +.vm { color: #19177C } /* Name.Variable.Magic */ +.il { color: #666666 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/devel-docs/libgimp/html/up-insensitive.png b/devel-docs/libgimp/html/up-insensitive.png new file mode 100644 index 0000000..b159d01 Binary files /dev/null and b/devel-docs/libgimp/html/up-insensitive.png differ diff --git a/devel-docs/libgimp/html/up.png b/devel-docs/libgimp/html/up.png new file mode 100644 index 0000000..8fad884 Binary files /dev/null and b/devel-docs/libgimp/html/up.png differ -- cgit v1.2.3