Files
gimp/devel-docs/libgimp/html/libgimp-gimpenums.html
2010-08-11 01:26:23 -04:00

428 lines
13 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gimpenums</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="GIMP Library Reference Manual">
<link rel="up" href="libgimp-general.html" title="Functions not Related to Specific Images">
<link rel="prev" href="libgimp-gimp.html" title="gimp">
<link rel="next" href="libgimp-gimpbuffer.html" title="gimpbuffer">
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="libgimp.html" title="Part I. GIMP Library">
<link rel="chapter" href="libgimp-general.html" title="Functions not Related to Specific Images">
<link rel="chapter" href="libgimp-image.html" title="Manupulating Images and their Properties">
<link rel="chapter" href="libgimp-data.html" title="Data Objects">
<link rel="chapter" href="libgimp-selectors.html" title="Controlling the Core's Selection Dialogs">
<link rel="part" href="libgimpui.html" title="Part II. GIMP User Interface Library">
<link rel="chapter" href="libgimpui-hierarchy.html" title="Object Hierarchy">
<link rel="index" href="libgimp-index.html" title="Index">
<link rel="index" href="libgimp-index-new-in-2-2.html" title="Index of new symbols in GIMP 2.2">
<link rel="index" href="libgimp-index-new-in-2-4.html" title="Index of new symbols in GIMP 2.4">
<link rel="index" href="libgimp-index-new-in-2-6.html" title="Index of new symbols in GIMP 2.6">
<link rel="index" href="libgimp-index-deprecated.html" title="Index of deprecated symbols">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libgimp-gimp.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgimp-general.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GIMP Library Reference Manual</th>
<td><a accesskey="n" href="libgimp-gimpbuffer.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#libgimp-gimpenums.synopsis" class="shortcut">Top</a>
 | 
<a href="#libgimp-gimpenums.description" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libgimp-gimpenums"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgimp-gimpenums.top_of_page"></a>gimpenums</span></h2>
<p>gimpenums — Enums and definitions.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgimp-gimpenums.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
void <a class="link" href="libgimp-gimpenums.html#gimp-enums-init" title="gimp_enums_init ()">gimp_enums_init</a> (void);
enum <a class="link" href="libgimp-gimpenums.html#GimpBrushApplicationMode" title="enum GimpBrushApplicationMode">GimpBrushApplicationMode</a>;
enum <a class="link" href="libgimp-gimpenums.html#GimpBrushGeneratedShape" title="enum GimpBrushGeneratedShape">GimpBrushGeneratedShape</a>;
enum <a class="link" href="libgimp-gimpenums.html#GimpConvertDitherType" title="enum GimpConvertDitherType">GimpConvertDitherType</a>;
enum <a class="link" href="libgimp-gimpenums.html#GimpConvertPaletteType" title="enum GimpConvertPaletteType">GimpConvertPaletteType</a>;
enum <a class="link" href="libgimp-gimpenums.html#GimpConvolutionType" title="enum GimpConvolutionType">GimpConvolutionType</a>;
enum <a class="link" href="libgimp-gimpenums.html#GimpConvolveType" title="enum GimpConvolveType">GimpConvolveType</a>;
enum <a class="link" href="libgimp-gimpenums.html#GimpFillType" title="enum GimpFillType">GimpFillType</a>;
enum <a class="link" href="libgimp-gimpenums.html#GimpGradientSegmentColor" title="enum GimpGradientSegmentColor">GimpGradientSegmentColor</a>;
enum <a class="link" href="libgimp-gimpenums.html#GimpGradientSegmentType" title="enum GimpGradientSegmentType">GimpGradientSegmentType</a>;
enum <a class="link" href="libgimp-gimpenums.html#GimpHistogramChannel" title="enum GimpHistogramChannel">GimpHistogramChannel</a>;
enum <a class="link" href="libgimp-gimpenums.html#GimpHueRange" title="enum GimpHueRange">GimpHueRange</a>;
enum <a class="link" href="libgimp-gimpenums.html#GimpLayerModeEffects" title="enum GimpLayerModeEffects">GimpLayerModeEffects</a>;
enum <a class="link" href="libgimp-gimpenums.html#GimpMaskApplyMode" title="enum GimpMaskApplyMode">GimpMaskApplyMode</a>;
enum <a class="link" href="libgimp-gimpenums.html#GimpMergeType" title="enum GimpMergeType">GimpMergeType</a>;
enum <a class="link" href="libgimp-gimpenums.html#GimpOffsetType" title="enum GimpOffsetType">GimpOffsetType</a>;
enum <a class="link" href="libgimp-gimpenums.html#GimpOrientationType" title="enum GimpOrientationType">GimpOrientationType</a>;
enum <a class="link" href="libgimp-gimpenums.html#GimpRotationType" title="enum GimpRotationType">GimpRotationType</a>;
enum <a class="link" href="libgimp-gimpenums.html#GimpSelectCriterion" title="enum GimpSelectCriterion">GimpSelectCriterion</a>;
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>** <a class="link" href="libgimp-gimpenums.html#gimp-enums-get-type-names" title="gimp_enums_get_type_names ()">gimp_enums_get_type_names</a> (<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> *n_type_names);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="libgimp-gimpenums.description"></a><h2>Description</h2>
<p>
Enums and definitions.
</p>
</div>
<div class="refsect1" lang="en">
<a name="libgimp-gimpenums.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="gimp-enums-init"></a><h3>gimp_enums_init ()</h3>
<pre class="programlisting">void gimp_enums_init (void);</pre>
<p>
This function makes sure all the enum types are registered
with the GObject type 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,
as the normal plug-in initialization code will handle it
implicitly.</p>
<p>
</p>
<p class="since">Since GIMP 2.4
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="GimpBrushApplicationMode"></a><h3>enum GimpBrushApplicationMode</h3>
<pre class="programlisting">typedef enum
{
GIMP_BRUSH_HARD,
GIMP_BRUSH_SOFT
} GimpBrushApplicationMode;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="GimpBrushGeneratedShape"></a><h3>enum GimpBrushGeneratedShape</h3>
<pre class="programlisting">typedef enum
{
GIMP_BRUSH_GENERATED_CIRCLE,
GIMP_BRUSH_GENERATED_SQUARE,
GIMP_BRUSH_GENERATED_DIAMOND
} GimpBrushGeneratedShape;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="GimpConvertDitherType"></a><h3>enum GimpConvertDitherType</h3>
<pre class="programlisting">typedef enum
{
GIMP_NO_DITHER,
GIMP_FS_DITHER,
GIMP_FSLOWBLEED_DITHER,
GIMP_FIXED_DITHER
} GimpConvertDitherType;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="GimpConvertPaletteType"></a><h3>enum GimpConvertPaletteType</h3>
<pre class="programlisting">typedef enum
{
GIMP_MAKE_PALETTE,
GIMP_REUSE_PALETTE,
GIMP_WEB_PALETTE,
GIMP_MONO_PALETTE,
GIMP_CUSTOM_PALETTE
} GimpConvertPaletteType;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="GimpConvolutionType"></a><h3>enum GimpConvolutionType</h3>
<pre class="programlisting">typedef enum
{
GIMP_NORMAL_CONVOL,
GIMP_ABSOLUTE_CONVOL,
GIMP_NEGATIVE_CONVOL
} GimpConvolutionType;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="GimpConvolveType"></a><h3>enum GimpConvolveType</h3>
<pre class="programlisting">typedef enum
{
GIMP_BLUR_CONVOLVE,
GIMP_SHARPEN_CONVOLVE
} GimpConvolveType;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="GimpFillType"></a><h3>enum GimpFillType</h3>
<pre class="programlisting">typedef enum
{
GIMP_FOREGROUND_FILL,
GIMP_BACKGROUND_FILL,
GIMP_WHITE_FILL,
GIMP_TRANSPARENT_FILL,
GIMP_PATTERN_FILL
} GimpFillType;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="GimpGradientSegmentColor"></a><h3>enum GimpGradientSegmentColor</h3>
<pre class="programlisting">typedef enum
{
GIMP_GRADIENT_SEGMENT_RGB,
GIMP_GRADIENT_SEGMENT_HSV_CCW,
GIMP_GRADIENT_SEGMENT_HSV_CW
} GimpGradientSegmentColor;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="GimpGradientSegmentType"></a><h3>enum GimpGradientSegmentType</h3>
<pre class="programlisting">typedef enum
{
GIMP_GRADIENT_SEGMENT_LINEAR,
GIMP_GRADIENT_SEGMENT_CURVED,
GIMP_GRADIENT_SEGMENT_SINE,
GIMP_GRADIENT_SEGMENT_SPHERE_INCREASING,
GIMP_GRADIENT_SEGMENT_SPHERE_DECREASING
} GimpGradientSegmentType;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="GimpHistogramChannel"></a><h3>enum GimpHistogramChannel</h3>
<pre class="programlisting">typedef enum
{
GIMP_HISTOGRAM_VALUE,
GIMP_HISTOGRAM_RED,
GIMP_HISTOGRAM_GREEN,
GIMP_HISTOGRAM_BLUE,
GIMP_HISTOGRAM_ALPHA
} GimpHistogramChannel;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="GimpHueRange"></a><h3>enum GimpHueRange</h3>
<pre class="programlisting">typedef enum
{
GIMP_ALL_HUES,
GIMP_RED_HUES,
GIMP_YELLOW_HUES,
GIMP_GREEN_HUES,
GIMP_CYAN_HUES,
GIMP_BLUE_HUES,
GIMP_MAGENTA_HUES
} GimpHueRange;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="GimpLayerModeEffects"></a><h3>enum GimpLayerModeEffects</h3>
<pre class="programlisting">typedef enum
{
GIMP_NORMAL_MODE,
GIMP_DISSOLVE_MODE,
GIMP_BEHIND_MODE,
GIMP_MULTIPLY_MODE,
GIMP_SCREEN_MODE,
GIMP_OVERLAY_MODE,
GIMP_DIFFERENCE_MODE,
GIMP_ADDITION_MODE,
GIMP_SUBTRACT_MODE,
GIMP_DARKEN_ONLY_MODE,
GIMP_LIGHTEN_ONLY_MODE,
GIMP_HUE_MODE,
GIMP_SATURATION_MODE,
GIMP_COLOR_MODE,
GIMP_VALUE_MODE,
GIMP_DIVIDE_MODE,
GIMP_DODGE_MODE,
GIMP_BURN_MODE,
GIMP_HARDLIGHT_MODE,
GIMP_SOFTLIGHT_MODE,
GIMP_GRAIN_EXTRACT_MODE,
GIMP_GRAIN_MERGE_MODE,
GIMP_COLOR_ERASE_MODE
} GimpLayerModeEffects;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="GimpMaskApplyMode"></a><h3>enum GimpMaskApplyMode</h3>
<pre class="programlisting">typedef enum
{
GIMP_MASK_APPLY,
GIMP_MASK_DISCARD
} GimpMaskApplyMode;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="GimpMergeType"></a><h3>enum GimpMergeType</h3>
<pre class="programlisting">typedef enum
{
GIMP_EXPAND_AS_NECESSARY,
GIMP_CLIP_TO_IMAGE,
GIMP_CLIP_TO_BOTTOM_LAYER,
GIMP_FLATTEN_IMAGE
} GimpMergeType;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="GimpOffsetType"></a><h3>enum GimpOffsetType</h3>
<pre class="programlisting">typedef enum
{
GIMP_OFFSET_BACKGROUND,
GIMP_OFFSET_TRANSPARENT
} GimpOffsetType;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="GimpOrientationType"></a><h3>enum GimpOrientationType</h3>
<pre class="programlisting">typedef enum
{
GIMP_ORIENTATION_HORIZONTAL,
GIMP_ORIENTATION_VERTICAL,
GIMP_ORIENTATION_UNKNOWN
} GimpOrientationType;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="GimpRotationType"></a><h3>enum GimpRotationType</h3>
<pre class="programlisting">typedef enum
{
GIMP_ROTATE_90,
GIMP_ROTATE_180,
GIMP_ROTATE_270
} GimpRotationType;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="GimpSelectCriterion"></a><h3>enum GimpSelectCriterion</h3>
<pre class="programlisting">typedef enum
{
GIMP_SELECT_CRITERION_COMPOSITE,
GIMP_SELECT_CRITERION_R,
GIMP_SELECT_CRITERION_G,
GIMP_SELECT_CRITERION_B,
GIMP_SELECT_CRITERION_H,
GIMP_SELECT_CRITERION_S,
GIMP_SELECT_CRITERION_V
} GimpSelectCriterion;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="gimp-enums-get-type-names"></a><h3>gimp_enums_get_type_names ()</h3>
<pre class="programlisting">const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>** gimp_enums_get_type_names (<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> *n_type_names);</pre>
<p>
This function gives access to the list of enums registered by libgimp.
The returned array is static and must not be modified.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>n_type_names</code></em> :</span></p></td>
<td> return location for the number of names
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> an array with type names
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since GIMP 2.2
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.10</div>
</body>
</html>