Files
gimp/devel-docs/libgimp/xml/gimpenums.xml
2010-08-11 01:13:56 -04:00

526 lines
15 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="libgimp-gimpenums">
<refmeta>
<refentrytitle>gimpenums</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMP Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>gimpenums</refname><refpurpose>Enums and definitions.</refpurpose>
</refnamediv>
<refsynopsisdiv><title>Synopsis</title>
<synopsis>
enum <link linkend="GimpAddMaskType">GimpAddMaskType</link>;
enum <link linkend="GimpBlendMode">GimpBlendMode</link>;
enum <link linkend="GimpBrushApplicationMode">GimpBrushApplicationMode</link>;
enum <link linkend="GimpBucketFillMode">GimpBucketFillMode</link>;
enum <link linkend="GimpChannelOps">GimpChannelOps</link>;
enum <link linkend="GimpChannelType">GimpChannelType</link>;
enum <link linkend="GimpCloneType">GimpCloneType</link>;
enum <link linkend="GimpConvertDitherType">GimpConvertDitherType</link>;
enum <link linkend="GimpConvertPaletteType">GimpConvertPaletteType</link>;
enum <link linkend="GimpConvolutionType">GimpConvolutionType</link>;
enum <link linkend="GimpConvolveType">GimpConvolveType</link>;
enum <link linkend="GimpDodgeBurnType">GimpDodgeBurnType</link>;
enum <link linkend="GimpFillType">GimpFillType</link>;
enum <link linkend="GimpGradientSegmentColor">GimpGradientSegmentColor</link>;
enum <link linkend="GimpGradientSegmentType">GimpGradientSegmentType</link>;
enum <link linkend="GimpGradientType">GimpGradientType</link>;
enum <link linkend="GimpHistogramChannel">GimpHistogramChannel</link>;
enum <link linkend="GimpHueRange">GimpHueRange</link>;
enum <link linkend="GimpIconType">GimpIconType</link>;
enum <link linkend="GimpInterpolationType">GimpInterpolationType</link>;
enum <link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link>;
enum <link linkend="GimpMaskApplyMode">GimpMaskApplyMode</link>;
enum <link linkend="GimpMergeType">GimpMergeType</link>;
enum <link linkend="GimpOffsetType">GimpOffsetType</link>;
enum <link linkend="GimpOrientationType">GimpOrientationType</link>;
enum <link linkend="GimpPaintApplicationMode">GimpPaintApplicationMode</link>;
enum <link linkend="GimpRepeatMode">GimpRepeatMode</link>;
enum <link linkend="GimpRotationType">GimpRotationType</link>;
enum <link linkend="GimpRunMode">GimpRunMode</link>;
enum <link linkend="GimpSizeType">GimpSizeType</link>;
enum <link linkend="GimpTransferMode">GimpTransferMode</link>;
enum <link linkend="GimpTransformDirection">GimpTransformDirection</link>;
const <link linkend="gchar">gchar</link>** <link linkend="gimp-enums-get-type-names">gimp_enums_get_type_names</link> (<link linkend="gint">gint</link> *n_type_names);
</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
Enums and definitions.
</para>
</refsect1>
<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="GimpAddMaskType"/>enum GimpAddMaskType</title>
<indexterm><primary>GimpAddMaskType</primary></indexterm><programlisting>typedef enum
{
GIMP_ADD_WHITE_MASK,
GIMP_ADD_BLACK_MASK,
GIMP_ADD_ALPHA_MASK,
GIMP_ADD_ALPHA_TRANSFER_MASK,
GIMP_ADD_SELECTION_MASK,
GIMP_ADD_COPY_MASK
} GimpAddMaskType;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpBlendMode"/>enum GimpBlendMode</title>
<indexterm><primary>GimpBlendMode</primary></indexterm><programlisting>typedef enum
{
GIMP_FG_BG_RGB_MODE,
GIMP_FG_BG_HSV_MODE,
GIMP_FG_TRANSPARENT_MODE,
GIMP_CUSTOM_MODE
} GimpBlendMode;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpBrushApplicationMode"/>enum GimpBrushApplicationMode</title>
<indexterm><primary>GimpBrushApplicationMode</primary></indexterm><programlisting>typedef enum
{
GIMP_BRUSH_HARD,
GIMP_BRUSH_SOFT
} GimpBrushApplicationMode;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpBucketFillMode"/>enum GimpBucketFillMode</title>
<indexterm><primary>GimpBucketFillMode</primary></indexterm><programlisting>typedef enum
{
GIMP_FG_BUCKET_FILL,
GIMP_BG_BUCKET_FILL,
GIMP_PATTERN_BUCKET_FILL
} GimpBucketFillMode;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpChannelOps"/>enum GimpChannelOps</title>
<indexterm><primary>GimpChannelOps</primary></indexterm><programlisting>typedef enum
{
GIMP_CHANNEL_OP_ADD,
GIMP_CHANNEL_OP_SUBTRACT,
GIMP_CHANNEL_OP_REPLACE,
GIMP_CHANNEL_OP_INTERSECT
} GimpChannelOps;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpChannelType"/>enum GimpChannelType</title>
<indexterm><primary>GimpChannelType</primary></indexterm><programlisting>typedef enum
{
GIMP_RED_CHANNEL,
GIMP_GREEN_CHANNEL,
GIMP_BLUE_CHANNEL,
GIMP_GRAY_CHANNEL,
GIMP_INDEXED_CHANNEL,
GIMP_ALPHA_CHANNEL
} GimpChannelType;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpCloneType"/>enum GimpCloneType</title>
<indexterm><primary>GimpCloneType</primary></indexterm><programlisting>typedef enum
{
GIMP_IMAGE_CLONE,
GIMP_PATTERN_CLONE
} GimpCloneType;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpConvertDitherType"/>enum GimpConvertDitherType</title>
<indexterm><primary>GimpConvertDitherType</primary></indexterm><programlisting>typedef enum
{
GIMP_NO_DITHER,
GIMP_FS_DITHER,
GIMP_FSLOWBLEED_DITHER,
GIMP_FIXED_DITHER
} GimpConvertDitherType;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpConvertPaletteType"/>enum GimpConvertPaletteType</title>
<indexterm><primary>GimpConvertPaletteType</primary></indexterm><programlisting>typedef enum
{
GIMP_MAKE_PALETTE,
GIMP_REUSE_PALETTE,
GIMP_WEB_PALETTE,
GIMP_MONO_PALETTE,
GIMP_CUSTOM_PALETTE
} GimpConvertPaletteType;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpConvolutionType"/>enum GimpConvolutionType</title>
<indexterm><primary>GimpConvolutionType</primary></indexterm><programlisting>typedef enum
{
GIMP_NORMAL_CONVOL,
GIMP_ABSOLUTE_CONVOL,
GIMP_NEGATIVE_CONVOL
} GimpConvolutionType;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpConvolveType"/>enum GimpConvolveType</title>
<indexterm><primary>GimpConvolveType</primary></indexterm><programlisting>typedef enum
{
GIMP_BLUR_CONVOLVE,
GIMP_SHARPEN_CONVOLVE
} GimpConvolveType;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpDodgeBurnType"/>enum GimpDodgeBurnType</title>
<indexterm><primary>GimpDodgeBurnType</primary></indexterm><programlisting>typedef enum
{
GIMP_DODGE,
GIMP_BURN
} GimpDodgeBurnType;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpFillType"/>enum GimpFillType</title>
<indexterm><primary>GimpFillType</primary></indexterm><programlisting>typedef enum
{
GIMP_FOREGROUND_FILL,
GIMP_BACKGROUND_FILL,
GIMP_WHITE_FILL,
GIMP_TRANSPARENT_FILL,
GIMP_PATTERN_FILL
} GimpFillType;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpGradientSegmentColor"/>enum GimpGradientSegmentColor</title>
<indexterm><primary>GimpGradientSegmentColor</primary></indexterm><programlisting>typedef enum
{
GIMP_GRADIENT_SEGMENT_RGB,
GIMP_GRADIENT_SEGMENT_HSV_CCW,
GIMP_GRADIENT_SEGMENT_HSV_CW
} GimpGradientSegmentColor;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpGradientSegmentType"/>enum GimpGradientSegmentType</title>
<indexterm><primary>GimpGradientSegmentType</primary></indexterm><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;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpGradientType"/>enum GimpGradientType</title>
<indexterm><primary>GimpGradientType</primary></indexterm><programlisting>typedef enum
{
GIMP_GRADIENT_LINEAR,
GIMP_GRADIENT_BILINEAR,
GIMP_GRADIENT_RADIAL,
GIMP_GRADIENT_SQUARE,
GIMP_GRADIENT_CONICAL_SYMMETRIC,
GIMP_GRADIENT_CONICAL_ASYMMETRIC,
GIMP_GRADIENT_SHAPEBURST_ANGULAR,
GIMP_GRADIENT_SHAPEBURST_SPHERICAL,
GIMP_GRADIENT_SHAPEBURST_DIMPLED,
GIMP_GRADIENT_SPIRAL_CLOCKWISE,
GIMP_GRADIENT_SPIRAL_ANTICLOCKWISE
} GimpGradientType;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpHistogramChannel"/>enum GimpHistogramChannel</title>
<indexterm><primary>GimpHistogramChannel</primary></indexterm><programlisting>typedef enum
{
GIMP_HISTOGRAM_VALUE,
GIMP_HISTOGRAM_RED,
GIMP_HISTOGRAM_GREEN,
GIMP_HISTOGRAM_BLUE,
GIMP_HISTOGRAM_ALPHA
} GimpHistogramChannel;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpHueRange"/>enum GimpHueRange</title>
<indexterm><primary>GimpHueRange</primary></indexterm><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;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpIconType"/>enum GimpIconType</title>
<indexterm><primary>GimpIconType</primary></indexterm><programlisting>typedef enum
{
GIMP_ICON_TYPE_STOCK_ID,
GIMP_ICON_TYPE_INLINE_PIXBUF,
GIMP_ICON_TYPE_IMAGE_FILE
} GimpIconType;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpInterpolationType"/>enum GimpInterpolationType</title>
<indexterm><primary>GimpInterpolationType</primary></indexterm><programlisting>typedef enum
{
GIMP_INTERPOLATION_NONE,
GIMP_INTERPOLATION_LINEAR,
GIMP_INTERPOLATION_CUBIC
} GimpInterpolationType;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpLayerModeEffects"/>enum GimpLayerModeEffects</title>
<indexterm><primary>GimpLayerModeEffects</primary></indexterm><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;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpMaskApplyMode"/>enum GimpMaskApplyMode</title>
<indexterm><primary>GimpMaskApplyMode</primary></indexterm><programlisting>typedef enum
{
GIMP_MASK_APPLY,
GIMP_MASK_DISCARD
} GimpMaskApplyMode;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpMergeType"/>enum GimpMergeType</title>
<indexterm><primary>GimpMergeType</primary></indexterm><programlisting>typedef enum
{
GIMP_EXPAND_AS_NECESSARY,
GIMP_CLIP_TO_IMAGE,
GIMP_CLIP_TO_BOTTOM_LAYER,
GIMP_FLATTEN_IMAGE
} GimpMergeType;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpOffsetType"/>enum GimpOffsetType</title>
<indexterm><primary>GimpOffsetType</primary></indexterm><programlisting>typedef enum
{
GIMP_OFFSET_BACKGROUND,
GIMP_OFFSET_TRANSPARENT
} GimpOffsetType;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpOrientationType"/>enum GimpOrientationType</title>
<indexterm><primary>GimpOrientationType</primary></indexterm><programlisting>typedef enum
{
GIMP_ORIENTATION_HORIZONTAL,
GIMP_ORIENTATION_VERTICAL,
GIMP_ORIENTATION_UNKNOWN
} GimpOrientationType;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpPaintApplicationMode"/>enum GimpPaintApplicationMode</title>
<indexterm><primary>GimpPaintApplicationMode</primary></indexterm><programlisting>typedef enum
{
GIMP_PAINT_CONSTANT,
GIMP_PAINT_INCREMENTAL
} GimpPaintApplicationMode;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpRepeatMode"/>enum GimpRepeatMode</title>
<indexterm><primary>GimpRepeatMode</primary></indexterm><programlisting>typedef enum
{
GIMP_REPEAT_NONE,
GIMP_REPEAT_SAWTOOTH,
GIMP_REPEAT_TRIANGULAR
} GimpRepeatMode;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpRotationType"/>enum GimpRotationType</title>
<indexterm><primary>GimpRotationType</primary></indexterm><programlisting>typedef enum
{
GIMP_ROTATE_90,
GIMP_ROTATE_180,
GIMP_ROTATE_270
} GimpRotationType;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpRunMode"/>enum GimpRunMode</title>
<indexterm><primary>GimpRunMode</primary></indexterm><programlisting>typedef enum
{
GIMP_RUN_INTERACTIVE,
GIMP_RUN_NONINTERACTIVE,
GIMP_RUN_WITH_LAST_VALS
} GimpRunMode;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpSizeType"/>enum GimpSizeType</title>
<indexterm><primary>GimpSizeType</primary></indexterm><programlisting>typedef enum
{
GIMP_PIXELS,
GIMP_POINTS
} GimpSizeType;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpTransferMode"/>enum GimpTransferMode</title>
<indexterm><primary>GimpTransferMode</primary></indexterm><programlisting>typedef enum
{
GIMP_SHADOWS,
GIMP_MIDTONES,
GIMP_HIGHLIGHTS
} GimpTransferMode;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GimpTransformDirection"/>enum GimpTransformDirection</title>
<indexterm><primary>GimpTransformDirection</primary></indexterm><programlisting>typedef enum
{
GIMP_TRANSFORM_FORWARD,
GIMP_TRANSFORM_BACKWARD
} GimpTransformDirection;
</programlisting>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="gimp-enums-get-type-names"/>gimp_enums_get_type_names ()</title>
<indexterm role="GIMP"><primary>gimp_enums_get_type_names</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>** gimp_enums_get_type_names (<link linkend="gint">gint</link> *n_type_names);</programlisting>
<para>
This function gives access to the list of enums registered by libgimp.
The returned array is static and must not be modified.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>n_type_names</parameter>&nbsp;:</term>
<listitem><simpara> return location for the number of names
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> an array with type names
</simpara></listitem></varlistentry>
</variablelist><para>Since GIMP 2.2
</para></refsect2>
</refsect1>
</refentry>