The reference we all need, compiled from the GIMP API and GIMP itself
GIMP Python enums, and more
If you’re developing plug-ins or scripts for GIMP 3, one of the most frustrating challenges is tracking down the correct enum values for Python’s gi-repository, Gimp module or Script-Fu procedures.
The official GIMP 3 API documentation is written primarily for C developers. Until now, Python plug-in authors and Script-Fu scripters had to piece together enum values from source code, forum posts, and trial and error.
This reference compiles every enum available in GIMP 3.0 and later into a single, searchable resource. It’s collected directly from a live GIMP 3.0.8 instance to guarantee accuracy.
Structure of this reference documentation
Each table is sorted alphabetically and includes five columns, with a sixth for Gimp.LayerMode:
| UI Name | The human-readable label as it appears in GIMP’s interface, useful for cross-referencing with what you see on screen. |
| Code Name | The uppercase identifier used internally by GIMP and in the PDB (Procedural Database). It’s the form most commonly seen in C documentation. If you’re porting code from GIMP 2.x Script-Fu scripts, or following examples from the C documentation, the code name is the form you’re most likely to encounter. Python plug-in developers should ignore it in favour of the python enum column. Even so, it’s useful for cross-referencing with the official docs and the GIMP Procedure Browser (Help > Procedure Browser). |
| Integer Value | The raw numeric value of the enum, useful when debugging or working with legacy Script-Fu code that passes modes as numbers. |
| Python Enum | What you use in your GIMP 3 Python plug-ins. For example Gimp.LayerMode.NORMAL or Gimp.FillType.TRANSPARENT. |
| GEGL Nickname | The lowercase identifier used by GIMP’s underlying GEGL graphics engine, primarily useful for serialisation and config file work. |
| GEGL Operation | For Gimp.LayerMode only, GEGL Nicknamethe GEGL Operation column shows the full operation string used when working directly with GEGL layer compositing. |
Note: Some values use hyphens as separators (e.g. ABSOLUTE-COLORIMETRIC) while others use underscores (e.g. BLACK_POINT_COMPENSATION). This is an inconsistency in GIMP’s own C codebase rather than an error in this reference. The code names are derived directly from the GEGL nickname. Also, different enums may have been registered by different developers at different times following slightly different naming conventions.
How this reference was compiled
All of the data in this reference was generated using a Python script that inspects the live GIMP module directly using GIMP’s built-in Python-Fu console. So the values are guaranteed to reflect your exact installed version rather than outdated documentation.
The script is available as a free download. Simply paste it into the Python-Fu console in your own GIMP 3 installation (Filters > Development > Python-Fu > Python Console). It will generate the complete enum listing for any future GIMP 3 release. This makes it easy to check for new or changed enum values as GIMP continues to develop.
Gimp.AddMaskType
Controls how a new layer mask is initialised when added to a layer. For example, WHITE makes the full layer visible; BLACK hides it entirely; SELECTION initialises the mask from the current selection.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Alpha | ALPHA | 2 | Gimp.AddMaskType.ALPHA | alpha |
| Alpha Transfer | ALPHA-TRANSFER | 3 | Gimp.AddMaskType.ALPHA_TRANSFER | alpha-transfer |
| Black | BLACK | 1 | Gimp.AddMaskType.BLACK | black |
| Channel | CHANNEL | 6 | Gimp.AddMaskType.CHANNEL | channel |
| Copy | COPY | 5 | Gimp.AddMaskType.COPY | copy |
| Selection | SELECTION | 4 | Gimp.AddMaskType.SELECTION | selection |
| White | WHITE | 0 | Gimp.AddMaskType.WHITE | white |
Gimp.ArgumentSync
Controls whether a plug-in’s argument values are automatically saved and restored between sessions. PARASITE syncs the value via a GIMP parasite (persistent storage); NONE means no syncing.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| None | NONE | 0 | Gimp.ArgumentSync.NONE | none |
| Parasite | PARASITE | 1 | Gimp.ArgumentSync.PARASITE | parasite |
Gimp.BrushApplicationMode
Determines whether a brush is applied with a hard edge (HARD) or with its built-in softness/opacity falloff (SOFT).
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Hard | HARD | 0 | Gimp.BrushApplicationMode.HARD | hard |
| Soft | SOFT | 1 | Gimp.BrushApplicationMode.SOFT | soft |
Gimp.BrushGeneratedShape
The geometric shape used when generating a procedural brush: circle, square, or diamond.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Circle | CIRCLE | 0 | Gimp.BrushGeneratedShape.CIRCLE | circle |
| Diamond | DIAMOND | 2 | Gimp.BrushGeneratedShape.DIAMOND | diamond |
| Square | SQUARE | 1 | Gimp.BrushGeneratedShape.SQUARE | square |
Gimp.CapStyle
The style applied to the ends of stroked lines: flat (BUTT), rounded (ROUND), or square extending past the endpoint (SQUARE).
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Butt | BUTT | 0 | Gimp.CapStyle.BUTT | butt |
| Round | ROUND | 1 | Gimp.CapStyle.ROUND | round |
| Square | SQUARE | 2 | Gimp.CapStyle.SQUARE | square |
Gimp.ChannelOps
How a selection or channel is combined with an existing selection: add to, subtract from, replace, or intersect with the current selection.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Add | ADD | 0 | Gimp.ChannelOps.ADD | add |
| Intersect | INTERSECT | 3 | Gimp.ChannelOps.INTERSECT | intersect |
| Replace | REPLACE | 2 | Gimp.ChannelOps.REPLACE | replace |
| Subtract | SUBTRACT | 1 | Gimp.ChannelOps.SUBTRACT | subtract |
Gimp.ChannelType
Identifies a specific colour or alpha channel component within a drawable (red, green, blue, gray, alpha, or indexed).
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Alpha | ALPHA | 5 | Gimp.ChannelType.ALPHA | alpha |
| Blue | BLUE | 2 | Gimp.ChannelType.BLUE | blue |
| Gray | GRAY | 3 | Gimp.ChannelType.GRAY | gray |
| Green | GREEN | 1 | Gimp.ChannelType.GREEN | green |
| Indexed | INDEXED | 4 | Gimp.ChannelType.INDEXED | indexed |
| Red | RED | 0 | Gimp.ChannelType.RED | red |
Gimp.CheckSize
The size of the checkerboard pattern used in the canvas to indicate transparent areas.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Large Checks | LARGE-CHECKS | 2 | Gimp.CheckSize.LARGE_CHECKS | large-checks |
| Medium Checks | MEDIUM-CHECKS | 1 | Gimp.CheckSize.MEDIUM_CHECKS | medium-checks |
| Small Checks | SMALL-CHECKS | 0 | Gimp.CheckSize.SMALL_CHECKS | small-checks |
Gimp.CheckType
The colour scheme of the transparency checkerboard. Useful when your image colours make the default grey checks hard to see.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Black Only | BLACK-ONLY | 5 | Gimp.CheckType.BLACK_ONLY | black-only |
| Custom Checks | CUSTOM-CHECKS | 6 | Gimp.CheckType.CUSTOM_CHECKS | Custom-checks |
| Dark Checks | DARK-CHECKS | 2 | Gimp.CheckType.DARK_CHECKS | dark-checks |
| Gray Checks | GRAY-CHECKS | 1 | Gimp.CheckType.GRAY_CHECKS | gray-checks |
| Gray Only | GRAY-ONLY | 4 | Gimp.CheckType.GRAY_ONLY | gray-only |
| Light Checks | LIGHT-CHECKS | 0 | Gimp.CheckType.LIGHT_CHECKS | light-checks |
| White Only | WHITE-ONLY | 3 | Gimp.CheckType.WHITE_ONLY | white-only |
Gimp.CloneType
The source used by the Clone tool: either another area of an image (IMAGE) or a named pattern (PATTERN).
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Image | IMAGE | 0 | Gimp.CloneType.IMAGE | image |
| Pattern | PATTERN | 1 | Gimp.CloneType.PATTERN | pattern |
Gimp.ColorManagementMode
Whether colour management is disabled (OFF), applied for accurate screen display (DISPLAY), or used to simulate output on another device (SOFTPROOF).
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Display | DISPLAY | 1 | Gimp.ColorManagementMode.DISPLAY | display |
| Off | OFF | 0 | Gimp.ColorManagementMode.OFF | off |
| Soft Proof | SOFTPROOF | 2 | Gimp.ColorManagementMode.SOFTPROOF | softproof |
Gimp.ColorRenderingIntent
The method used to map colours when converting between colour spaces with different gamuts. PERCEPTUAL is generally best for photos; RELATIVE_COLORIMETRIC with black point compensation is common for print.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Absolute Colorimetric | ABSOLUTE-COLORIMETRIC | 3 | Gimp.ColorRenderingIntent.ABSOLUTE_COLORIMETRIC | absolute-colorimetric |
| Perceptual | PERCEPTUAL | 0 | Gimp.ColorRenderingIntent.PERCEPTUAL | perceptual |
| Relative Colorimetric | RELATIVE-COLORIMETRIC | 1 | Gimp.ColorRenderingIntent.RELATIVE_COLORIMETRIC | relative-colorimetric |
| Saturation | SATURATION | 2 | Gimp.ColorRenderingIntent.SATURATION | saturation |
Gimp.ColorTag
A colour label that can be assigned to layers or channels in the Layers panel, useful for visual organisation.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Blue | BLUE | 1 | Gimp.ColorTag.BLUE | blue |
| Brown | BROWN | 5 | Gimp.ColorTag.BROWN | brown |
| Gray | GRAY | 8 | Gimp.ColorTag.GRAY | gray |
| Green | GREEN | 2 | Gimp.ColorTag.GREEN | green |
| None | NONE | 0 | Gimp.ColorTag.NONE | none |
| Orange | ORANGE | 4 | Gimp.ColorTag.ORANGE | orange |
| Red | RED | 6 | Gimp.ColorTag.RED | red |
| Violet | VIOLET | 7 | Gimp.ColorTag.VIOLET | violet |
| Yellow | YELLOW | 3 | Gimp.ColorTag.YELLOW | yellow |
Gimp.ColorTransformFlags
Flags that modify the behaviour of a GimpColorTransform. Use BLACK_POINT_COMPENSATION to improve shadow detail in profile conversions; GAMUT_CHECK highlights out-of-gamut colours; NOOPTIMIZE disables speed optimisations (useful for debugging).
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Black Point Compensation | BLACK_POINT_COMPENSATION | 8192 | Gimp.ColorTransformFlags.BLACK_POINT_COMPENSATION | black_point_compensation |
| Gamut Check | GAMUT_CHECK | 4096 | Gimp.ColorTransformFlags.GAMUT_CHECK | gamut_check |
| No Optimize | NOOPTIMIZE | 256 | Gimp.ColorTransformFlags.NOOPTIMIZE | nooptimize |
Gimp.ComponentType
The data type used to store each channel value in an image: 8-bit integer (U8) through to 64-bit double-precision float (DOUBLE). Determines bit depth and precision.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Double | DOUBLE | 700 | Gimp.ComponentType.DOUBLE | double |
| Float | FLOAT | 600 | Gimp.ComponentType.FLOAT | float |
| Half | HALF | 500 | Gimp.ComponentType.HALF | half |
| U16 | U16 | 200 | Gimp.ComponentType.U16 | u16 |
| U32 | U32 | 300 | Gimp.ComponentType.U32 | u32 |
| U8 | U8 | 100 | Gimp.ComponentType.U8 | u8 |
Gimp.ConfigError
Error codes returned when reading or writing GIMP configuration files. Useful when catching GError exceptions around config I/O operations.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Open | OPEN | 0 | Gimp.ConfigError.OPEN | open |
| Open ENOENT | OPEN_ENOENT | 1 | Gimp.ConfigError.OPEN_ENOENT | open_enoent |
| Parse | PARSE | 3 | Gimp.ConfigError.PARSE | parse |
| Version | VERSION | 4 | Gimp.ConfigError.VERSION | version |
| Write | WRITE | 2 | Gimp.ConfigError.WRITE | write |
Gimp.ConfigPathType
Classifies a configuration file path as pointing to a single file, a single directory, or a searchpath list of either.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Dir | DIR | 2 | Gimp.ConfigPathType.DIR | dir |
| Dir List | DIR_LIST | 3 | Gimp.ConfigPathType.DIR_LIST | dir_list |
| File | FILE | 0 | Gimp.ConfigPathType.FILE | file |
| File List | FILE_LIST | 1 | Gimp.ConfigPathType.FILE_LIST | file_list |
Gimp.ConvertDitherType
The dithering algorithm used when converting a colour image to indexed mode. NONE is fastest; Floyd-Steinberg variants (FS, FS_LOWBLEED) give better results at the cost of speed.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Fixed | FIXED | 3 | Gimp.ConvertDitherType.FIXED | fixed |
| FS | FS | 1 | Gimp.ConvertDitherType.FS | fs |
| FS Low Bleed | FS-LOWBLEED | 2 | Gimp.ConvertDitherType.FS_LOWBLEED | fs-lowbleed |
| None | NONE | 0 | Gimp.ConvertDitherType.NONE | none |
Gimp.ConvertPaletteType
The palette to use when converting to indexed colour mode: auto-generated optimal palette (GENERATE), web-safe colours (WEB), black-and-white (MONO), or a named custom palette (CUSTOM).
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Custom | CUSTOM | 3 | Gimp.ConvertPaletteType.CUSTOM | custom |
| Generate | GENERATE | 0 | Gimp.ConvertPaletteType.GENERATE | generate |
| Mono | MONO | 2 | Gimp.ConvertPaletteType.MONO | mono |
| Web | WEB | 1 | Gimp.ConvertPaletteType.WEB | web |
Gimp.ConvolveType
Whether a convolution operation blurs (BLUR) or sharpens (SHARPEN) the drawable.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Blur | BLUR | 0 | Gimp.ConvolveType.BLUR | blur |
| Sharpen | SHARPEN | 1 | Gimp.ConvolveType.SHARPEN | sharpen |
Gimp.CpuAccelFlags
Flags indicating which CPU instruction set extensions are available at runtime (SSE, AVX, AltiVec, etc.). Used internally by GIMP and GEGL for performance optimisation; rarely needed directly in plug-ins.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| None | NONE | 0 | Gimp.CpuAccelFlags.NONE | none |
| PPC AltiVec | PPC_ALTIVEC | 67108864 | Gimp.CpuAccelFlags.PPC_ALTIVEC | ppc_altivec |
| x86 3DNow | X86_3DNOW | 1073741824 | Gimp.CpuAccelFlags.X86_3DNOW | x86_3dnow |
| x86 AVX | X86_AVX | 2097152 | Gimp.CpuAccelFlags.X86_AVX | x86_avx |
| x86 MMX | X86_MMX | -2147483648 | Gimp.CpuAccelFlags.X86_MMX | x86_mmx |
| x86 MMX Ext | X86_MMXEXT | 536870912 | Gimp.CpuAccelFlags.X86_MMXEXT | x86_mmxext |
| x86 SSE | X86_SSE | 268435456 | Gimp.CpuAccelFlags.X86_SSE | x86_sse |
| x86 SSE2 | X86_SSE2 | 134217728 | Gimp.CpuAccelFlags.X86_SSE2 | x86_sse2 |
| x86 SSE3 | X86_SSE3 | 33554432 | Gimp.CpuAccelFlags.X86_SSE3 | x86_sse3 |
| x86 SSE4.1 | X86_SSE4_1 | 8388608 | Gimp.CpuAccelFlags.X86_SSE4_1 | x86_sse4_1 |
| x86 SSE4.2 | X86_SSE4_2 | 4194304 | Gimp.CpuAccelFlags.X86_SSE4_2 | x86_sse4_2 |
| x86 SSSE3 | X86_SSSE3 | 16777216 | Gimp.CpuAccelFlags.X86_SSSE3 | x86_ssse3 |
Gimp.DesaturateMode
The algorithm used when converting a colour layer to greyscale. LUMA is perceptually accurate and usually the best default; LUMINANCE operates in linear light.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Average | AVERAGE | 2 | Gimp.DesaturateMode.AVERAGE | average |
| Lightness | LIGHTNESS | 0 | Gimp.DesaturateMode.LIGHTNESS | lightness |
| Luma | LUMA | 1 | Gimp.DesaturateMode.LUMA | luma |
| Luminance | LUMINANCE | 3 | Gimp.DesaturateMode.LUMINANCE | luminance |
| Value | VALUE | 4 | Gimp.DesaturateMode.VALUE | value |
Gimp.DodgeBurnType
Selects whether a dodge/burn operation lightens (DODGE) or darkens (BURN) the affected pixels.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Burn | BURN | 1 | Gimp.DodgeBurnType.BURN | burn |
| Dodge | DODGE | 0 | Gimp.DodgeBurnType.DODGE | dodge |
Gimp.ExportReturn
The return value from Gimp.ExportOptions.get_image(), indicating whether the image needs to be exported/flattened (EXPORT) or can be used as-is (IGNORE).
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Export | EXPORT | 1 | Gimp.ExportReturn.EXPORT | export |
| Ignore | IGNORE | 0 | Gimp.ExportReturn.IGNORE | ignore |
Gimp.FileChooserAction
Specifies what kind of file system item a file chooser dialog should select: a file to open, a save location, a folder, or a new folder. Maps directly to GtkFileChooserAction.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Any | ANY | -1 | Gimp.FileChooserAction.ANY | any |
| Create Folder | CREATE-FOLDER | 3 | Gimp.FileChooserAction.CREATE_FOLDER | create-folder |
| Open | OPEN | 0 | Gimp.FileChooserAction.OPEN | open |
| Save | SAVE | 1 | Gimp.FileChooserAction.SAVE | save |
| Select Folder | SELECT-FOLDER | 2 | Gimp.FileChooserAction.SELECT_FOLDER | select-folder |
Gimp.FillType
The fill content used when filling a selection, layer, or new layer: foreground colour, background colour, white, CIELab middle grey, a pattern, or transparent.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Background | BACKGROUND | 1 | Gimp.FillType.BACKGROUND | background |
| CIELab Middle Gray | CIELAB-MIDDLE-GRAY | 2 | Gimp.FillType.CIELAB_MIDDLE_GRAY | cielab-middle-gray |
| Foreground | FOREGROUND | 0 | Gimp.FillType.FOREGROUND | foreground |
| Pattern | PATTERN | 5 | Gimp.FillType.PATTERN | pattern |
| Transparent | TRANSPARENT | 4 | Gimp.FillType.TRANSPARENT | transparent |
| White | WHITE | 3 | Gimp.FillType.WHITE | white |
Gimp.ForegroundExtractMode
The engine used for foreground extraction (separating a subject from its background). Currently only MATTING is available.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Matting | MATTING | 0 | Gimp.ForegroundExtractMode.MATTING | matting |
Gimp.GradientBlendColorSpace
The colour space in which gradient colours are interpolated between stops. RGB_PERCEPTUAL is the typical default; CIE_LAB can give more visually even blends.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| CIE Lab | CIE-LAB | 2 | Gimp.GradientBlendColorSpace.CIE_LAB | cie-lab |
| RGB Linear | RGB-LINEAR | 1 | Gimp.GradientBlendColorSpace.RGB_LINEAR | rgb-linear |
| RGB Perceptual | RGB-PERCEPTUAL | 0 | Gimp.GradientBlendColorSpace.RGB_PERCEPTUAL | rgb-perceptual |
Gimp.GradientSegmentColor
The colour model used for interpolation within a single gradient segment: linear RGB, or HSV going clockwise or counter-clockwise around the colour wheel.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| HSV CCW | HSV-CCW | 1 | Gimp.GradientSegmentColor.HSV_CCW | hsv-ccw |
| HSV CW | HSV-CW | 2 | Gimp.GradientSegmentColor.HSV_CW | hsv-cw |
| RGB | RGB | 0 | Gimp.GradientSegmentColor.RGB | rgb |
Gimp.GradientSegmentType
The mathematical transition curve applied within a gradient segment (linear, curved, sinusoidal, etc.).
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Curved | CURVED | 1 | Gimp.GradientSegmentType.CURVED | curved |
| Linear | LINEAR | 0 | Gimp.GradientSegmentType.LINEAR | linear |
| Sine | SINE | 2 | Gimp.GradientSegmentType.SINE | sine |
| Sphere Decreasing | SPHERE-DECREASING | 4 | Gimp.GradientSegmentType.SPHERE_DECREASING | sphere-decreasing |
| Sphere Increasing | SPHERE-INCREASING | 3 | Gimp.GradientSegmentType.SPHERE_INCREASING | sphere-increasing |
| Step | STEP | 5 | Gimp.GradientSegmentType.STEP | step |
Gimp.GradientType
The geometric shape of a gradient fill: linear, radial, conical, square, shapeburst, or spiral.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Bilinear | BILINEAR | 1 | Gimp.GradientType.BILINEAR | bilinear |
| Conical Asymmetric | CONICAL-ASYMMETRIC | 5 | Gimp.GradientType.CONICAL_ASYMMETRIC | conical-asymmetric |
| Conical Symmetric | CONICAL-SYMMETRIC | 4 | Gimp.GradientType.CONICAL_SYMMETRIC | conical-symmetric |
| Linear | LINEAR | 0 | Gimp.GradientType.LINEAR | linear |
| Radial | RADIAL | 2 | Gimp.GradientType.RADIAL | radial |
| Shapeburst Angular | SHAPEBURST-ANGULAR | 6 | Gimp.GradientType.SHAPEBURST_ANGULAR | shapeburst-angular |
| Shapeburst Dimpled | SHAPEBURST-DIMPLED | 8 | Gimp.GradientType.SHAPEBURST_DIMPLED | shapeburst-dimpled |
| Shapeburst Spherical | SHAPEBURST-SPHERICAL | 7 | Gimp.GradientType.SHAPEBURST_SPHERICAL | shapeburst-spherical |
| Spiral Anticlockwise | SPIRAL-ANTICLOCKWISE | 10 | Gimp.GradientType.SPIRAL_ANTICLOCKWISE | spiral-anticlockwise |
| Spiral Clockwise | SPIRAL-CLOCKWISE | 9 | Gimp.GradientType.SPIRAL_CLOCKWISE | spiral-clockwise |
| Square | SQUARE | 3 | Gimp.GradientType.SQUARE | square |
Gimp.GridStyle
How the canvas grid is rendered: as dots, crosses at intersections, or various dash styles.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Dots | DOTS | 0 | Gimp.GridStyle.DOTS | dots |
| Double Dash | DOUBLE-DASH | 3 | Gimp.GridStyle.DOUBLE_DASH | double-dash |
| Intersections | INTERSECTIONS | 1 | Gimp.GridStyle.INTERSECTIONS | intersections |
| On Off Dash | ON-OFF-DASH | 2 | Gimp.GridStyle.ON_OFF_DASH | on-off-dash |
| Solid | SOLID | 4 | Gimp.GridStyle.SOLID | solid |
Gimp.HistogramChannel
Which channel’s histogram to analyse or display: the composite value, or individual R/G/B/Alpha/Luminance channels.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Alpha | ALPHA | 4 | Gimp.HistogramChannel.ALPHA | alpha |
| Blue | BLUE | 3 | Gimp.HistogramChannel.BLUE | blue |
| Green | GREEN | 2 | Gimp.HistogramChannel.GREEN | green |
| Luminance | LUMINANCE | 5 | Gimp.HistogramChannel.LUMINANCE | luminance |
| Red | RED | 1 | Gimp.HistogramChannel.RED | red |
| Value | VALUE | 0 | Gimp.HistogramChannel.VALUE | value |
Gimp.HueRange
Specifies which range of hues is affected by hue/saturation adjustments: all colours, or a specific colour family (reds, yellows, greens, etc.).
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| All | ALL | 0 | Gimp.HueRange.ALL | all |
| Blue | BLUE | 5 | Gimp.HueRange.BLUE | blue |
| Cyan | CYAN | 4 | Gimp.HueRange.CYAN | cyan |
| Green | GREEN | 3 | Gimp.HueRange.GREEN | green |
| Magenta | MAGENTA | 6 | Gimp.HueRange.MAGENTA | magenta |
| Red | RED | 1 | Gimp.HueRange.RED | red |
| Yellow | YELLOW | 2 | Gimp.HueRange.YELLOW | yellow |
Gimp.IconType
How a plug-in supplies its icon: as a named icon from the icon theme (ICON_NAME), a GdkPixbuf (PIXBUF), or an image file path (IMAGE_FILE).
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Icon Name | ICON-NAME | 0 | Gimp.IconType.ICON_NAME | icon-name |
| Image File | IMAGE-FILE | 2 | Gimp.IconType.IMAGE_FILE | image-file |
| Pixbuf | PIXBUF | 1 | Gimp.IconType.PIXBUF | pixbuf |
Gimp.ImageBaseType
The colour model of an image: RGB, GRAY (greyscale), or INDEXED. This is the top-level image mode, not the per-drawable type — see Gimp.ImageType for that.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Gray | GRAY | 1 | Gimp.ImageBaseType.GRAY | gray |
| Indexed | INDEXED | 2 | Gimp.ImageBaseType.INDEXED | indexed |
| RGB | RGB | 0 | Gimp.ImageBaseType.RGB | rgb |
Gimp.ImageType
The full drawable type including whether an alpha channel is present: e.g. RGB_IMAGE vs RGBA_IMAGE, GRAY_IMAGE vs GRAYA_IMAGE, etc.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Gray Image | GRAY‐IMAGE | 2 | Gimp.ImageType.GRAY_IMAGE | gray‐image |
| GRAYA Image | GRAYA‐IMAGE | 3 | Gimp.ImageType.GRAYA_IMAGE | graya‐image |
| Indexed Image | INDEXED‐IMAGE | 4 | Gimp.ImageType.INDEXED_IMAGE | indexed‐image |
| INDEXEDA Image | INDEXEDA‐IMAGE | 5 | Gimp.ImageType.INDEXEDA_IMAGE | indexeda‐image |
| RGB Image | RGB‐IMAGE | 0 | Gimp.ImageType.RGB_IMAGE | rgb‐image |
| RGBA Image | RGBA‐IMAGE | 1 | Gimp.ImageType.RGBA_IMAGE | rgba‐image |
Gimp.InkBlobType
The tip shape of the Ink tool: circle, square, or diamond.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Circle | CIRCLE | 0 | Gimp.InkBlobType.CIRCLE | circle |
| Diamond | DIAMOND | 2 | Gimp.InkBlobType.DIAMOND | diamond |
| Square | SQUARE | 1 | Gimp.InkBlobType.SQUARE | square |
Gimp.InterpolationType
The resampling algorithm used when scaling or transforming a drawable. CUBIC is a good general-purpose default; NOHALO and LOHALO give higher quality for downscaling.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Cubic | CUBIC | 2 | Gimp.InterpolationType.CUBIC | cubic |
| Linear | LINEAR | 1 | Gimp.InterpolationType.LINEAR | linear |
| LoHalo | LOHALO | 4 | Gimp.InterpolationType.LOHALO | lohalo |
| NoHalo | NOHALO | 3 | Gimp.InterpolationType.NOHALO | nohalo |
| None | NONE | 0 | Gimp.InterpolationType.NONE | none |
Gimp.JoinStyle
How the corners between two line segments are rendered when stroking: mitered (sharp point), rounded, or bevelled (flat cut).
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Bevel | BEVEL | 2 | Gimp.JoinStyle.BEVEL | bevel |
| Miter | MITER | 0 | Gimp.JoinStyle.MITER | miter |
| Round | ROUND | 1 | Gimp.JoinStyle.ROUND | round |
Gimp.LayerColorSpace
The colour space in which a layer’s blend mode is evaluated. AUTO lets GIMP choose; the others explicitly set linear, non-linear, perceptual RGB, or Lab blending.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Auto | AUTO | 0 | Gimp.LayerColorSpace.AUTO | auto |
| Lab | LAB | 3 | Gimp.LayerColorSpace.LAB | lab |
| RGB Linear | RGB‐LINEAR | 1 | Gimp.LayerColorSpace.RGB_LINEAR | rgb‐linear |
| RGB Non Linear | RGB‐NON‐LINEAR | 2 | Gimp.LayerColorSpace.RGB_NON_LINEAR | rgb‐non‐linear |
| RGB Perceptual | RGB‐PERCEPTUAL | 4 | Gimp.LayerColorSpace.RGB_PERCEPTUAL | rgb‐perceptual |
Gimp.LayerCompositeMode
Controls how the layer’s alpha channel is composited with the layers below it. AUTO is the correct default for almost all cases.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Auto | AUTO | 0 | Gimp.LayerCompositeMode.AUTO | auto |
| Clip To Backdrop | CLIP‐TO‐BACKDROP | 2 | Gimp.LayerCompositeMode.CLIP_TO_BACKDROP | clip‐to‐backdrop |
| Clip To Layer | CLIP‐TO‐LAYER | 3 | Gimp.LayerCompositeMode.CLIP_TO_LAYER | clip‐to‐layer |
| Intersection | INTERSECTION | 4 | Gimp.LayerCompositeMode.INTERSECTION | intersection |
| Union | UNION | 1 | Gimp.LayerCompositeMode.UNION | union |
Gimp.LayerMode
The blend mode applied to a layer when compositing it with layers below. Includes all current modes and their legacy equivalents for compatibility with files created in GIMP 2.x. Prefer the non-legacy variants (e.g. NORMAL over NORMAL_LEGACY) for new work.
| UI name | Code name | Integer value | Python enum | GEGL nickname | GEGL Operation |
|---|---|---|---|---|---|
| Addition | ADDITION | 33 | Gimp.LayerMode.ADDITION | addition | layer‐mode:addition |
| Addition Legacy | ADDITION‐LEGACY | 7 | Gimp.LayerMode.ADDITION_LEGACY | addition‐legacy | layer‐mode:addition‐legacy |
| Behind | BEHIND | 29 | Gimp.LayerMode.BEHIND | behind | layer‐mode:behind |
| Behind Legacy | BEHIND‐LEGACY | 2 | Gimp.LayerMode.BEHIND_LEGACY | behind‐legacy | layer‐mode:behind‐legacy |
| Burn | BURN | 43 | Gimp.LayerMode.BURN | burn | layer‐mode:burn |
| Burn Legacy | BURN‐LEGACY | 17 | Gimp.LayerMode.BURN_LEGACY | burn‐legacy | layer‐mode:burn‐legacy |
| Color Erase | COLOR‐ERASE | 57 | Gimp.LayerMode.COLOR_ERASE | color‐erase | layer‐mode:color‐erase |
| Color Erase Legacy | COLOR‐ERASE‐LEGACY | 22 | Gimp.LayerMode.COLOR_ERASE_LEGACY | color‐erase‐legacy | layer‐mode:color‐erase‐legacy |
| Darken Only | DARKEN‐ONLY | 35 | Gimp.LayerMode.DARKEN_ONLY | darken‐only | layer‐mode:darken‐only |
| Darken Only Legacy | DARKEN‐ONLY‐LEGACY | 9 | Gimp.LayerMode.DARKEN_ONLY_LEGACY | darken‐only‐legacy | layer‐mode:darken‐only‐legacy |
| Difference | DIFFERENCE | 32 | Gimp.LayerMode.DIFFERENCE | difference | layer‐mode:difference |
| Difference Legacy | DIFFERENCE‐LEGACY | 6 | Gimp.LayerMode.DIFFERENCE_LEGACY | difference‐legacy | layer‐mode:difference‐legacy |
| Dissolve | DISSOLVE | 1 | Gimp.LayerMode.DISSOLVE | dissolve | layer‐mode:dissolve |
| Divide | DIVIDE | 41 | Gimp.LayerMode.DIVIDE | divide | layer‐mode:divide |
| Divide Legacy | DIVIDE‐LEGACY | 15 | Gimp.LayerMode.DIVIDE_LEGACY | divide‐legacy | layer‐mode:divide‐legacy |
| Dodge | DODGE | 42 | Gimp.LayerMode.DODGE | dodge | layer‐mode:dodge |
| Dodge Legacy | DODGE‐LEGACY | 16 | Gimp.LayerMode.DODGE_LEGACY | dodge‐legacy | layer‐mode:dodge‐legacy |
| Erase | ERASE | 58 | Gimp.LayerMode.ERASE | erase | layer‐mode:erase |
| Exclusion | EXCLUSION | 52 | Gimp.LayerMode.EXCLUSION | exclusion | layer‐mode:exclusion |
| Grain Extract | GRAIN‐EXTRACT | 46 | Gimp.LayerMode.GRAIN_EXTRACT | grain‐extract | layer‐mode:grain‐extract |
| Grain Extract Legacy | GRAIN‐EXTRACT‐LEGACY | 20 | Gimp.LayerMode.GRAIN_EXTRACT_LEGACY | grain‐extract‐legacy | layer‐mode:grain‐extract‐legacy |
| Grain Merge | GRAIN‐MERGE | 47 | Gimp.LayerMode.GRAIN_MERGE | grain‐merge | layer‐mode:grain‐merge |
| Grain Merge Legacy | GRAIN‐MERGE‐LEGACY | 21 | Gimp.LayerMode.GRAIN_MERGE_LEGACY | grain‐merge‐legacy | layer‐mode:grain‐merge‐legacy |
| Hard Light | HARDLIGHT | 44 | Gimp.LayerMode.HARDLIGHT | hardlight | layer‐mode:hardlight |
| Hard Light Legacy | HARDLIGHT‐LEGACY | 18 | Gimp.LayerMode.HARDLIGHT_LEGACY | hardlight‐legacy | layer‐mode:hardlight‐legacy |
| Hard Mix | HARD‐MIX | 51 | Gimp.LayerMode.HARD_MIX | hard‐mix | layer‐mode:hard‐mix |
| HSL Color | HSL‐COLOR | 39 | Gimp.LayerMode.HSL_COLOR | hsl‐color | layer‐mode:hsl‐color |
| HSL Color Legacy | HSL‐COLOR‐LEGACY | 13 | Gimp.LayerMode.HSL_COLOR_LEGACY | hsl‐color‐legacy | layer‐mode:hsl‐color‐legacy |
| HSV Hue | HSV‐HUE | 37 | Gimp.LayerMode.HSV_HUE | hsv‐hue | layer‐mode:hsv‐hue |
| HSV Hue Legacy | HSV‐HUE‐LEGACY | 11 | Gimp.LayerMode.HSV_HUE_LEGACY | hsv‐hue‐legacy | layer‐mode:hsv‐hue‐legacy |
| HSV Saturation | HSV‐SATURATION | 38 | Gimp.LayerMode.HSV_SATURATION | hsv‐saturation | layer‐mode:hsv‐saturation |
| HSV Saturation Legacy | HSV‐SATURATION‐LEGACY | 12 | Gimp.LayerMode.HSV_SATURATION_LEGACY | hsv‐saturation‐legacy | layer‐mode:hsv‐saturation‐legacy |
| HSV Value | HSV‐VALUE | 40 | Gimp.LayerMode.HSV_VALUE | hsv‐value | layer‐mode:hsv‐value |
| HSV Value Legacy | HSV‐VALUE‐LEGACY | 14 | Gimp.LayerMode.HSV_VALUE_LEGACY | hsv‐value‐legacy | layer‐mode:hsv‐value‐legacy |
| LCH Chroma | LCH‐CHROMA | 25 | Gimp.LayerMode.LCH_CHROMA | lch‐chroma | layer‐mode:lch‐chroma |
| LCH Color | LCH‐COLOR | 26 | Gimp.LayerMode.LCH_COLOR | lch‐color | layer‐mode:lch‐color |
| LCH Hue | LCH‐HUE | 24 | Gimp.LayerMode.LCH_HUE | lch‐hue | layer‐mode:lch‐hue |
| LCH Lightness | LCH‐LIGHTNESS | 27 | Gimp.LayerMode.LCH_LIGHTNESS | lch‐lightness | layer‐mode:lch‐lightness |
| Lighten Only | LIGHTEN‐ONLY | 36 | Gimp.LayerMode.LIGHTEN_ONLY | lighten‐only | layer‐mode:lighten‐only |
| Lighten Only Legacy | LIGHTEN‐ONLY‐LEGACY | 10 | Gimp.LayerMode.LIGHTEN_ONLY_LEGACY | lighten‐only‐legacy | layer‐mode:lighten‐only‐legacy |
| Linear Burn | LINEAR‐BURN | 53 | Gimp.LayerMode.LINEAR_BURN | linear‐burn | layer‐mode:linear‐burn |
| Linear Light | LINEAR‐LIGHT | 50 | Gimp.LayerMode.LINEAR_LIGHT | linear‐light | layer‐mode:linear‐light |
| Luma Darken Only | LUMA‐DARKEN‐ONLY | 54 | Gimp.LayerMode.LUMA_DARKEN_ONLY | luma‐darken‐only | layer‐mode:luma‐darken‐only |
| Luma Lighten Only | LUMA‐LIGHTEN‐ONLY | 55 | Gimp.LayerMode.LUMA_LIGHTEN_ONLY | luma‐lighten‐only | layer‐mode:luma‐lighten‐only |
| Luminance | LUMINANCE | 56 | Gimp.LayerMode.LUMINANCE | luminance | layer‐mode:luminance |
| Merge | MERGE | 59 | Gimp.LayerMode.MERGE | merge | layer‐mode:merge |
| Multiply | MULTIPLY | 30 | Gimp.LayerMode.MULTIPLY | multiply | layer‐mode:multiply |
| Multiply Legacy | MULTIPLY‐LEGACY | 3 | Gimp.LayerMode.MULTIPLY_LEGACY | multiply‐legacy | layer‐mode:multiply‐legacy |
| Normal | NORMAL | 28 | Gimp.LayerMode.NORMAL | normal | layer‐mode:normal |
| Normal Legacy | NORMAL‐LEGACY | 0 | Gimp.LayerMode.NORMAL_LEGACY | normal‐legacy | layer‐mode:normal‐legacy |
| Overlay | OVERLAY | 23 | Gimp.LayerMode.OVERLAY | overlay | layer‐mode:overlay |
| Overlay Legacy | OVERLAY‐LEGACY | 5 | Gimp.LayerMode.OVERLAY_LEGACY | overlay‐legacy | layer‐mode:overlay‐legacy |
| Pass Through | PASS‐THROUGH | 61 | Gimp.LayerMode.PASS_THROUGH | pass‐through | layer‐mode:pass‐through |
| Pin Light | PIN‐LIGHT | 49 | Gimp.LayerMode.PIN_LIGHT | pin‐light | layer‐mode:pin‐light |
| Replace | REPLACE | 62 | Gimp.LayerMode.REPLACE | replace | layer‐mode:replace |
| Screen | SCREEN | 31 | Gimp.LayerMode.SCREEN | screen | layer‐mode:screen |
| Screen Legacy | SCREEN‐LEGACY | 4 | Gimp.LayerMode.SCREEN_LEGACY | screen‐legacy | layer‐mode:screen‐legacy |
| Soft Light | SOFTLIGHT | 45 | Gimp.LayerMode.SOFTLIGHT | softlight | layer‐mode:softlight |
| Soft Light Legacy | SOFTLIGHT‐LEGACY | 19 | Gimp.LayerMode.SOFTLIGHT_LEGACY | softlight‐legacy | layer‐mode:softlight‐legacy |
| Split | SPLIT | 60 | Gimp.LayerMode.SPLIT | split | layer‐mode:split |
| Subtract | SUBTRACT | 34 | Gimp.LayerMode.SUBTRACT | subtract | layer‐mode:subtract |
| Subtract Legacy | SUBTRACT‐LEGACY | 8 | Gimp.LayerMode.SUBTRACT_LEGACY | subtract‐legacy | layer‐mode:subtract‐legacy |
| Vivid Light | VIVID‐LIGHT | 48 | Gimp.LayerMode.VIVID_LIGHT | vivid‐light | layer‐mode:vivid‐light |
Gimp.MaskApplyMode
Whether applying a layer mask merges it into the layer’s alpha channel (APPLY) or simply removes it without applying any changes (DISCARD).
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Apply | APPLY | 0 | Gimp.MaskApplyMode.APPLY | apply |
| Discard | DISCARD | 1 | Gimp.MaskApplyMode.DISCARD | discard |
Gimp.MergeType
Controls the canvas size of the result when merging layers: expand to fit all layers, clip to the image bounds, clip to the bottom layer, or flatten with background fill.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Clip To Bottom Layer | CLIP‐TO‐BOTTOM‐LAYER | 2 | Gimp.MergeType.CLIP_TO_BOTTOM_LAYER | clip‐to‐bottom‐layer |
| Clip To Image | CLIP‐TO‐IMAGE | 1 | Gimp.MergeType.CLIP_TO_IMAGE | clip‐to‐image |
| Expand As Necessary | EXPAND‐AS‐NECESSARY | 0 | Gimp.MergeType.EXPAND_AS_NECESSARY | expand‐as‐necessary |
| Flatten Image | FLATTEN‐IMAGE | 3 | Gimp.MergeType.FLATTEN_IMAGE | flatten‐image |
Gimp.MessageHandlerType
Where GIMP directs its messages: a GUI dialog (MESSAGE_BOX), the console/terminal (CONSOLE), or the Script-Fu/error console (ERROR_CONSOLE).
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Console | CONSOLE | 1 | Gimp.MessageHandlerType.CONSOLE | console |
| Error Console | ERROR‐CONSOLE | 2 | Gimp.MessageHandlerType.ERROR_CONSOLE | error‐console |
| Message Box | MESSAGE‐BOX | 0 | Gimp.MessageHandlerType.MESSAGE_BOX | message‐box |
Gimp.MetadataColorspace
The colour space declared in an image file’s metadata (e.g. EXIF). Used when reading files to determine how to handle the embedded colour profile.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| AdobeRGB | ADOBERGB | 3 | Gimp.MetadataColorspace.ADOBERGB | adobergb |
| sRGB | SRGB | 2 | Gimp.MetadataColorspace.SRGB | srgb |
| Uncalibrated | UNCALIBRATED | 1 | Gimp.MetadataColorspace.UNCALIBRATED | uncalibrated |
| Unspecified | UNSPECIFIED | 0 | Gimp.MetadataColorspace.UNSPECIFIED | unspecified |
Gimp.ModuleError
Error codes returned by GIMP’s module system (plug-in/extension loader). Rarely needed directly in Python plug-ins.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Module Failed | MODULE_FAILED | 0 | Gimp.ModuleError.MODULE_FAILED | module_failed |
Gimp.ModuleState
The load state of a GIMP module: successfully loaded, failed to load, not yet loaded, or in an error state.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Error | ERROR | 0 | Gimp.ModuleState.ERROR | error |
| Load Failed | LOAD_FAILED | 2 | Gimp.ModuleState.LOAD_FAILED | load_failed |
| Loaded | LOADED | 1 | Gimp.ModuleState.LOADED | loaded |
| Not Loaded | NOT_LOADED | 3 | Gimp.ModuleState.NOT_LOADED | not_loaded |
Gimp.OffsetType
What fills the revealed area when offsetting (shifting) a layer: the layer’s own edge colour, transparency, or wrapping the opposite edge around.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Color | COLOR | 0 | Gimp.OffsetType.COLOR | color |
| Transparent | TRANSPARENT | 1 | Gimp.OffsetType.TRANSPARENT | transparent |
| Wrap Around | WRAP‐AROUND | 2 | Gimp.OffsetType.WRAP_AROUND | wrap‐around |
Gimp.OrientationType
A simple horizontal/vertical/unknown orientation flag, used in guides, transforms, and flip operations.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Horizontal | HORIZONTAL | 0 | Gimp.OrientationType.HORIZONTAL | horizontal |
| Unknown | UNKNOWN | 2 | Gimp.OrientationType.UNKNOWN | unknown |
| Vertical | VERTICAL | 1 | Gimp.OrientationType.VERTICAL | vertical |
Gimp.PDBErrorHandler
Controls which code handles errors from PDB procedure calls: GIMP’s internal handler, or the calling plug-in itself. Set to PLUGIN if you want to catch and handle PDB errors in your own code.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Internal | INTERNAL | 0 | Gimp.PDBErrorHandler.INTERNAL | internal |
| Plugin | PLUGIN | 1 | Gimp.PDBErrorHandler.PLUGIN | plugin |
Gimp.PDBProcType
The type of a registered PDB procedure: built-in (INTERNAL), a standard plug-in (PLUGIN), a persistent/server-style plug-in (PERSISTENT), or a temporary procedure registered at runtime (TEMPORARY).
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Internal | INTERNAL | 0 | Gimp.PDBProcType.INTERNAL | internal |
| Persistent | PERSISTENT | 2 | Gimp.PDBProcType.PERSISTENT | persistent |
| Plugin | PLUGIN | 1 | Gimp.PDBProcType.PLUGIN | plugin |
| Temporary | TEMPORARY | 3 | Gimp.PDBProcType.TEMPORARY | temporary |
Gimp.PDBStatusType
The return status of a PDB procedure call. Always check for SUCCESS or CANCEL; CALLING_ERROR indicates wrong arguments, EXECUTION_ERROR indicates a runtime failure.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Calling Error | CALLING‐ERROR | 1 | Gimp.PDBStatusType.CALLING_ERROR | calling‐error |
| Cancel | CANCEL | 4 | Gimp.PDBStatusType.CANCEL | cancel |
| Execution Error | EXECUTION‐ERROR | 0 | Gimp.PDBStatusType.EXECUTION_ERROR | execution‐error |
| Pass Through | PASS‐THROUGH | 2 | Gimp.PDBStatusType.PASS_THROUGH | pass‐through |
| Success | SUCCESS | 3 | Gimp.PDBStatusType.SUCCESS | success |
Gimp.PaintApplicationMode
How paint is applied during a stroke: CONSTANT applies paint uniformly along the stroke; INCREMENTAL builds up opacity with each dab, including where the stroke overlaps itself.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Constant | CONSTANT | 0 | Gimp.PaintApplicationMode.CONSTANT | constant |
| Incremental | INCREMENTAL | 1 | Gimp.PaintApplicationMode.INCREMENTAL | incremental |
Gimp.PathStrokeType
The type of curve used in a path stroke. Currently only Bézier curves are supported.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Bezier | BEZIER | 0 | Gimp.PathStrokeType.BEZIER | bezier |
Gimp.PixbufTransparency
How transparency is represented when a drawable is exported as a GdkPixbuf: preserve the alpha channel, or render it against a small or large checkerboard pattern.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Keep Alpha | KEEP_ALPHA | 0 | Gimp.PixbufTransparency.KEEP_ALPHA | keep_alpha |
| Large Checks | LARGE_CHECKS | 2 | Gimp.PixbufTransparency.LARGE_CHECKS | large_checks |
| Small Checks | SMALL_CHECKS | 1 | Gimp.PixbufTransparency.SMALL_CHECKS | small_checks |
Gimp.Precision
The full pixel encoding format of an image, combining bit depth (U8 through Double) with the tonal response curve (linear, non-linear, or perceptual). For example, U8_NON_LINEAR is the traditional 8-bit gamma-encoded format.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Double Linear | DOUBLE‐LINEAR | 700 | Gimp.Precision.DOUBLE_LINEAR | double‐linear |
| Double Non Linear | DOUBLE‐NON‐LINEAR | 750 | Gimp.Precision.DOUBLE_NON_LINEAR | double‐non‐linear |
| Double Perceptual | DOUBLE‐PERCEPTUAL | 775 | Gimp.Precision.DOUBLE_PERCEPTUAL | double‐perceptual |
| Float Linear | FLOAT‐LINEAR | 600 | Gimp.Precision.FLOAT_LINEAR | float‐linear |
| Float Non Linear | FLOAT‐NON‐LINEAR | 650 | Gimp.Precision.FLOAT_NON_LINEAR | float‐non‐linear |
| Float Perceptual | FLOAT‐PERCEPTUAL | 675 | Gimp.Precision.FLOAT_PERCEPTUAL | float‐perceptual |
| Half Linear | HALF‐LINEAR | 500 | Gimp.Precision.HALF_LINEAR | half‐linear |
| Half Non Linear | HALF‐NON‐LINEAR | 550 | Gimp.Precision.HALF_NON_LINEAR | half‐non‐linear |
| Half Perceptual | HALF‐PERCEPTUAL | 575 | Gimp.Precision.HALF_PERCEPTUAL | half‐perceptual |
| U16 Linear | U16‐LINEAR | 200 | Gimp.Precision.U16_LINEAR | u16‐linear |
| U16 Non Linear | U16‐NON‐LINEAR | 250 | Gimp.Precision.U16_NON_LINEAR | u16‐non‐linear |
| U16 Perceptual | U16‐PERCEPTUAL | 275 | Gimp.Precision.U16_PERCEPTUAL | u16‐perceptual |
| U32 Linear | U32‐LINEAR | 300 | Gimp.Precision.U32_LINEAR | u32‐linear |
| U32 Non Linear | U32‐NON‐LINEAR | 350 | Gimp.Precision.U32_NON_LINEAR | u32‐non‐linear |
| U32 Perceptual | U32‐PERCEPTUAL | 375 | Gimp.Precision.U32_PERCEPTUAL | u32‐perceptual |
| U8 Linear | U8‐LINEAR | 100 | Gimp.Precision.U8_LINEAR | u8‐linear |
| U8 Non Linear | U8‐NON‐LINEAR | 150 | Gimp.Precision.U8_NON_LINEAR | u8‐non‐linear |
| U8 Perceptual | U8‐PERCEPTUAL | 175 | Gimp.Precision.U8_PERCEPTUAL | u8‐perceptual |
Gimp.ProgressCommand
Commands for controlling GIMP’s progress bar from within a plug-in: start, update value or text, pulse (indeterminate), end, or retrieve the parent window handle.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| End | END | 1 | Gimp.ProgressCommand.END | end |
| Get Window | GET‐WINDOW | 5 | Gimp.ProgressCommand.GET_WINDOW | get‐window |
| Pulse | PULSE | 4 | Gimp.ProgressCommand.PULSE | pulse |
| Set Text | SET‐TEXT | 2 | Gimp.ProgressCommand.SET_TEXT | set‐text |
| Set Value | SET‐VALUE | 3 | Gimp.ProgressCommand.SET_VALUE | set‐value |
| Start | START | 0 | Gimp.ProgressCommand.START | start |
Gimp.RepeatMode
How a gradient behaves beyond its defined endpoints: no repeat (truncate to end colour), sawtooth repeat, or triangular (ping-pong) repeat.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| None | NONE | 0 | Gimp.RepeatMode.NONE | none |
| Sawtooth | SAWTOOTH | 2 | Gimp.RepeatMode.SAWTOOTH | sawtooth |
| Triangular | TRIANGULAR | 3 | Gimp.RepeatMode.TRIANGULAR | triangular |
| Truncate | TRUNCATE | 1 | Gimp.RepeatMode.TRUNCATE | truncate |
Gimp.RotationType
Simple 90-degree-increment rotation directions: 90°, 180°, or 270° clockwise.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| 180 Degrees | DEGREES180 | 1 | Gimp.RotationType.DEGREES180 | degrees180 |
| 270 Degrees | DEGREES270 | 2 | Gimp.RotationType.DEGREES270 | degrees270 |
| 90 Degrees | DEGREES90 | 0 | Gimp.RotationType.DEGREES90 | degrees90 |
Gimp.RunMode
How a plug-in is being invoked: INTERACTIVE (show a dialog), NONINTERACTIVE (use supplied arguments, no UI), or WITH_LAST_VALS (reuse the last-used settings without showing a dialog).
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Interactive | INTERACTIVE | 0 | Gimp.RunMode.INTERACTIVE | interactive |
| Non Interactive | NONINTERACTIVE | 1 | Gimp.RunMode.NONINTERACTIVE | noninteractive |
| With Last Values | WITH‐LAST‐VALS | 2 | Gimp.RunMode.WITH_LAST_VALS | with‐last‐vals |
Gimp.SelectCriterion
The colour attribute used to determine similarity when making fuzzy or by-colour selections: composite colour, individual RGB or HSV channels, LCH components, or alpha only.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Alpha | ALPHA | 10 | Gimp.SelectCriterion.ALPHA | alpha |
| Composite | COMPOSITE | 0 | Gimp.SelectCriterion.COMPOSITE | composite |
| HSV Hue | HSV‐HUE | 4 | Gimp.SelectCriterion.HSV_HUE | hsv‐hue |
| HSV Saturation | HSV‐SATURATION | 5 | Gimp.SelectCriterion.HSV_SATURATION | hsv‐saturation |
| HSV Value | HSV‐VALUE | 6 | Gimp.SelectCriterion.HSV_VALUE | hsv‐value |
| LCH Chroma | LCH‐CHROMA | 8 | Gimp.SelectCriterion.LCH_CHROMA | lch‐chroma |
| LCH Hue | LCH‐HUE | 9 | Gimp.SelectCriterion.LCH_HUE | lch‐hue |
| LCH Lightness | LCH‐LIGHTNESS | 7 | Gimp.SelectCriterion.LCH_LIGHTNESS | lch‐lightness |
| RGB Blue | RGB‐BLUE | 3 | Gimp.SelectCriterion.RGB_BLUE | rgb‐blue |
| RGB Green | RGB‐GREEN | 2 | Gimp.SelectCriterion.RGB_GREEN | rgb‐green |
| RGB Red | RGB‐RED | 1 | Gimp.SelectCriterion.RGB_RED | rgb‐red |
Gimp.SizeType
Unit used for text size in the legacy text API: pixels or points. Prefer the modern text API where possible.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Pixels | PIXELS | 0 | Gimp.SizeType.PIXELS | pixels |
| Points | POINTS | 1 | Gimp.SizeType.POINTS | points |
Gimp.StackTraceMode
Controls when GIMP generates a stack trace on error: never, always, or by prompting the user. Useful for debugging plug-ins during development.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Always | ALWAYS | 2 | Gimp.StackTraceMode.ALWAYS | always |
| Never | NEVER | 0 | Gimp.StackTraceMode.NEVER | never |
| Query | QUERY | 1 | Gimp.StackTraceMode.QUERY | query |
Gimp.StrokeMethod
How a selection or path is stroked: as a simple painted line (LINE) or using a specific paint tool/brush (PAINT_METHOD).
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Line | LINE | 0 | Gimp.StrokeMethod.LINE | line |
| Paint Method | PAINT‐METHOD | 1 | Gimp.StrokeMethod.PAINT_METHOD | paint‐method |
Gimp.TextDirection
The writing direction for a text layer: left-to-right, right-to-left, or top-to-bottom (with variants for upright glyphs). Important for Arabic, Hebrew, CJK, and other scripts.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| LTR | LTR | 0 | Gimp.TextDirection.LTR | ltr |
| RTL | RTL | 1 | Gimp.TextDirection.RTL | rtl |
| TTB LTR | TTB‐LTR | 4 | Gimp.TextDirection.TTB_LTR | ttb‐ltr |
| TTB LTR Upright | TTB‐LTR‐UPRIGHT | 5 | Gimp.TextDirection.TTB_LTR_UPRIGHT | ttb‐ltr‐upright |
| TTB RTL | TTB‐RTL | 2 | Gimp.TextDirection.TTB_RTL | ttb‐rtl |
| TTB RTL Upright | TTB‐RTL‐UPRIGHT | 3 | Gimp.TextDirection.TTB_RTL_UPRIGHT | ttb‐rtl‐upright |
Gimp.TextHintStyle
The strength of hinting applied when rendering text. Hinting adjusts glyph outlines to align with the pixel grid. Stronger hinting improves legibility at small sizes but reduces fidelity to the original letterforms.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Full | FULL | 3 | Gimp.TextHintStyle.FULL | full |
| Medium | MEDIUM | 2 | Gimp.TextHintStyle.MEDIUM | medium |
| None | NONE | 0 | Gimp.TextHintStyle.NONE | none |
| Slight | SLIGHT | 1 | Gimp.TextHintStyle.SLIGHT | slight |
Gimp.TextJustification
The horizontal alignment of text within a text layer: left, right, centre, or fully justified.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Center | CENTER | 2 | Gimp.TextJustification.CENTER | center |
| Fill | FILL | 3 | Gimp.TextJustification.FILL | fill |
| Left | LEFT | 0 | Gimp.TextJustification.LEFT | left |
| Right | RIGHT | 1 | Gimp.TextJustification.RIGHT | right |
Gimp.TransferMode
Which tonal range is affected by a curves or levels adjustment: shadows, midtones, or highlights.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Highlights | HIGHLIGHTS | 2 | Gimp.TransferMode.HIGHLIGHTS | highlights |
| Midtones | MIDTONES | 1 | Gimp.TransferMode.MIDTONES | midtones |
| Shadows | SHADOWS | 0 | Gimp.TransferMode.SHADOWS | shadows |
Gimp.TransformDirection
The direction of a geometric transform: FORWARD applies the transform as specified; BACKWARD applies the inverse transform.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Backward | BACKWARD | 1 | Gimp.TransformDirection.BACKWARD | backward |
| Forward | FORWARD | 0 | Gimp.TransformDirection.FORWARD | forward |
Gimp.TransformResize
How the layer or image canvas is resized after a transform operation: adjust to fit the result, clip to the original bounds, or crop (with or without maintaining aspect ratio).
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Adjust | ADJUST | 0 | Gimp.TransformResize.ADJUST | adjust |
| Clip | CLIP | 1 | Gimp.TransformResize.CLIP | clip |
| Crop | CROP | 2 | Gimp.TransformResize.CROP | crop |
| Crop With Aspect | CROP‐WITH‐ASPECT | 3 | Gimp.TransformResize.CROP_WITH_ASPECT | crop‐with‐aspect |
Gimp.TRCType
The tonal response curve type of a colour space: linear light, non-linear (gamma-encoded), or perceptual. Relevant when working with precision and colour space conversions.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| Linear | LINEAR | 0 | Gimp.TRCType.LINEAR | linear |
| Non Linear | NON‐LINEAR | 1 | Gimp.TRCType.NON_LINEAR | non‐linear |
| Perceptual | PERCEPTUAL | 2 | Gimp.TRCType.PERCEPTUAL | perceptual |
Gimp.UnitID
Built-in unit identifiers for image dimensions and resolution: pixels, inches, millimetres, points, picas, or percentage. User-created custom units have IDs above these built-in values.
| UI name | Code name | Integer value | Python enum | GEGL nickname |
|---|---|---|---|---|
| End | END | 5 | Gimp.UnitID.END | end |
| Inch | INCH | 1 | Gimp.UnitID.INCH | inch |
| MM | MM | 2 | Gimp.UnitID.MM | mm |
| Percent | PERCENT | 65536 | Gimp.UnitID.PERCENT | percent |
| Pica | PICA | 4 | Gimp.UnitID.PICA | pica |
| Pixel | PIXEL | 0 | Gimp.UnitID.PIXEL | pixel |
| Point | POINT | 3 | Gimp.UnitID.POINT | point |
Leave a Reply