Namespace
Gimp – 3.0
GIMP library
Dependencies
| Babl—0.1 | Pixel encoding and color space conversion engine |
| Browse documentation | |
| GLib—2.0 | C Utility Library |
| Browse documentation | |
| GObject—2.0 | The base type system library |
| Browse documentation | |
| Gio—2.0 | GObject interfaces and objects |
| Browse documentation | |
| GdkPixbuf—2.0 | Image loading and scaling |
| Browse documentation | |
| Gegl—0.4 | Generic Graphics Library |
| Browse documentation |
Classes
| BatchProcedure | |
| Channel | Functions for manipulating channels. |
| ColorConfig | Color management settings. |
| ColorProfile | Definitions and Functions relating to LCMS. |
| ColorTransform | Definitions and Functions relating to LCMS. |
| ConfigPath | |
| Display | Functions to create, delete and flush displays (views) on an image. |
| Drawable | Functions to manipulate drawables. |
| FileProcedure | |
| Image | Operations on complete images: creation, resizing/rescaling, and operations involving multiple layers. |
| ImageProcedure | A |
| Item | Functions to manipulate items. |
| Layer | Operations on a single layer. |
| LayerMask | |
| LoadProcedure | A |
| Memsize | Functions to (de)serialize a given memory size. |
| Metadata | Basic functions for handling |
| Module |
|
| ModuleDB | Keeps a list of |
| ParamArray | |
| ParamChannel | |
| ParamConfigPath | |
| ParamDisplay | |
| ParamDrawable | |
| ParamFloatArray | |
| ParamImage | |
| ParamInt32Array | |
| ParamItem | |
| ParamLayer | |
| ParamLayerMask | |
| ParamMatrix2 | |
| ParamMatrix3 | |
| ParamMemsize | |
| ParamObjectArray | |
| ParamParasite | |
| ParamRGB | |
| ParamRGBArray | |
| ParamSelection | |
| ParamUInt8Array | |
| ParamUnit | |
| ParamValueArray | |
| ParamVectors | |
| PDB | Provides access to the Procedural DataBase (PDB). |
| PlugIn | The base class for plug-ins to derive from. |
| Procedure | |
| ProcedureConfig | The base class for |
| SaveProcedure | |
| Selection | Functions for manipulating selections. |
| ThumbnailProcedure | |
| Unit | Provides a collection of predefined units and functions for creating user-defined units. |
| Vectors | Functions for querying and manipulating vectors. |
Interfaces
| ColorManaged | An interface dealing with color profiles. |
| ConfigInterface |
Structs
| Array | |
| CMYK | Definitions and Functions relating to CMYK colors. |
| Config | |
| ConfigWriter | Functions for writing config info to a file for libgimpconfig. |
| EnumDesc | This structure is used to register translatable descriptions and help texts for enum values. See gimp_enum_set_value_descriptions(). |
| FlagsDesc | This structure is used to register translatable descriptions and help texts for flag values. See gimp_flags_set_value_descriptions(). |
| HSL | Used to keep HSL and HSLA colors. All components are in a range of [0.0..1.0]. |
| HSV | Definitions and Functions relating to HSV colors. |
| Matrix2 | A two by two matrix. |
| Matrix3 | A three by three matrix. |
| Matrix4 | A four by four matrix. |
| ModuleInfo | This structure contains information about a loadable module. |
| ObjectArray | |
| ParamSpecArray | |
| ParamSpecChannel | |
| ParamSpecDisplay | |
| ParamSpecDrawable | |
| ParamSpecFloatArray | |
| ParamSpecImage | |
| ParamSpecInt32Array | |
| ParamSpecItem | |
| ParamSpecLayer | |
| ParamSpecLayerMask | |
| ParamSpecObjectArray | |
| ParamSpecParasite | |
| ParamSpecRGB | |
| ParamSpecRGBArray | |
| ParamSpecSelection | |
| ParamSpecUInt8Array | |
| ParamSpecUnit | |
| ParamSpecValueArray | A |
| ParamSpecVectors | |
| Parasite | Arbitrary pieces of data which can be attached to various GIMP objects. |
| PixPipeParams | PLease somebody help documenting this. |
| ProgressVtable | |
| RGB | Definitions and Functions relating to RGB colors. |
| Scanner | A wrapper around |
| ValueArray | The prime purpose of a |
| Vector2 | A two dimensional vector. |
| Vector3 | A three dimensional vector. |
| Vector4 | A four dimensional vector. |
Enumerations
| AddMaskType | Modes of initialising a layer mask. |
| ArgumentSync | Methods of syncing procedure arguments. |
| BrushApplicationMode | Extracted from app/paint/paint-enums.h. |
| BrushGeneratedShape | Shapes of generated brushes. |
| CapStyle | Style of line endings. |
| ChannelOps | Operations to combine channels and selections. |
| ChannelType | Channels (as in color components). |
| CheckSize | Size of the checkerboard indicating transparency. |
| CheckType | Color/Brightness of the checkerboard indicating transparency. |
| CloneType | Clone sources. |
| ColorManagementMode | Modes of color management. |
| ColorRenderingIntent | Intents for color management. |
| ColorTag | Possible tag colors. |
| ColorTransformFlags | Flags for modifying |
| ComponentType | Encoding types of image components. |
| ConfigPathType | Types of config paths. |
| ConvertDitherType | Extracted from app/core/core-enums.h. |
| ConvertPaletteType | Types of palettes for indexed conversion. |
| ConvolveType | Types of convolutions. |
| CpuAccelFlags | Types of detectable CPU accelerations. |
| DesaturateMode | Grayscale conversion methods. |
| DodgeBurnType | Methods for the dodge/burn operation. |
| FillType | Types of filling. |
| ForegroundExtractMode | Foreground extract engines. |
| GradientBlendColorSpace | Color space for blending gradients. |
| GradientSegmentColor | Coloring types for gradient segments. |
| GradientSegmentType | Transition functions for gradient segments. |
| GradientType | Gradient shapes. |
| GridStyle | Rendering types for the display grid. |
| HistogramChannel | Extracted from app/core/core-enums.h. |
| HueRange | Hue ranges. |
| IconType | Icon types for plug-ins to register. |
| ImageBaseType | Image color models. |
| ImageType | Possible drawable types. |
| InkBlobType | Ink tool tips. |
| InterpolationType | Interpolation types. |
| JoinStyle | Line join styles. |
| LayerColorSpace | Extracted from app/operations/operations-enums.h. |
| LayerCompositeMode | Extracted from app/operations/operations-enums.h. |
| LayerMode | Extracted from app/operations/operations-enums.h. |
| MaskApplyMode | Layer mask apply modes. |
| MergeType | Types of merging layers. |
| MessageHandlerType | How to present messages. |
| MetadataColorspace | Well-defined colorspace information available from metadata. |
| ModuleError | Types of errors returned by modules. |
| ModuleState | The possible states a |
| OffsetType | Background fill types for the offset operation. |
| OrientationType | Orientations for various purposes. |
| PaintApplicationMode | Paint application modes. |
| PDBErrorHandler | PDB error handlers. |
| PDBProcType | Types of PDB procedures. |
| PDBStatusType | Return status of PDB calls. |
| PixbufTransparency | How to deal with transparency when creating thubnail pixbufs from images and drawables. |
| Precision | Precisions for pixel encoding. |
| ProgressCommand | Commands for the progress API. |
| RepeatMode | Repeat modes for example for gradients. |
| RGBCompositeMode | |
| RotationType | Types of simple rotations. |
| RunMode | Run modes for plug-ins. |
| SelectCriterion | Criterions for color similarity. |
| SizeType | Size types for the old-style text API. |
| StackTraceMode | When to generate stack traces in case of an error. |
| StrokeMethod | Methods of stroking selections and paths. |
| TextDirection | Text directions. |
| TextHintStyle | Text hint strengths. |
| TextJustification | Text justifications. |
| TransferMode | For choosing which brightness ranges to transform. |
| TransformDirection | Transform directions. |
| TransformResize | Ways of clipping the result when transforming drawables. |
| VectorsStrokeType | Possible type of strokes in vectors objects. |
Bitfields
| MetadataLoadFlags | What metadata to load when importing images. |
| MetadataSaveFlags | What kinds of metadata to save when exporting images. |
| ProcedureSensitivityMask | The cases when a |
Error Domains
| ConfigError | The possible values of a |
Callbacks
| BatchFunc | The batch function is run during the lifetime of the GIMP session, each time a plug-in batch procedure is called. |
| ModuleQueryFunc | The signature of the query function a loadable GIMP module must
implement. In the module, the function must be called |
| ModuleRegisterFunc | The signature of the register function a loadable GIMP module must
implement. In the module, the function must be called
|
| ProgressFunc | |
| ProgressVtableEndFunc | Ends the progress. |
| ProgressVtableGetWindowFunc | |
| ProgressVtablePulseFunc | Makes the progress pulse. |
| ProgressVtableSetTextFunc | Sets a new text on the progress. |
| ProgressVtableSetValueFunc | Sets a new percentage on the progress. |
| ProgressVtableStartFunc | Starts the progress. |
| PutPixelFunc | |
| RenderFunc | |
| RunBrushCallback | |
| RunFontCallback | |
| RunFunc | The run function is run during the lifetime of the GIMP session, each time a plug-in procedure is called. |
| RunGradientCallback | |
| RunImageFunc | The image function is run during the lifetime of the GIMP session, each time a plug-in image procedure is called. |
| RunLoadFunc | The load function is run during the lifetime of the GIMP session, each time a plug-in load procedure is called. |
| RunPaletteCallback | |
| RunPatternCallback | |
| RunSaveFunc | The save function is run during the lifetime of the GIMP session, each time a plug-in save procedure is called. |
| RunThumbnailFunc | The thumbnail function is run during the lifetime of the GIMP session, each time a plug-in thumbnail procedure is called. |
| SignalHandlerFunc | A prototype for a reference to a signal handler functions. Note
that each function which takes or returns a variable of this type
also accepts or may return special values defined by your system’s
signal.h header file (like |
Functions
| adaptive_supersample_area | |
| airbrush | Paint in the current brush with varying pressure. Paint application is time-dependent. |
| airbrush_default | Paint in the current brush with varying pressure. Paint application is time-dependent. |
| any_to_utf8 | This function takes any string (UTF-8 or not) and always returns a valid UTF-8 string. |
| attach_parasite | Add a global parasite. |
| bilinear | |
| bilinear_16 | |
| bilinear_32 | |
| bilinear_8 | |
| bilinear_rgb | |
| bilinear_rgba | |
| brush_delete | Deletes a brush. |
| brush_duplicate | Duplicates a brush. |
| brush_get_angle | Gets the rotation angle of a generated brush. |
| brush_get_aspect_ratio | Gets the aspect ratio of a generated brush. |
| brush_get_hardness | Gets the hardness of a generated brush. |
| brush_get_info | Retrieves information about the specified brush. |
| brush_get_pixels | Retrieves information about the specified brush. |
| brush_get_radius | Gets the radius of a generated brush. |
| brush_get_shape | Gets the shape of a generated brush. |
| brush_get_spacing | Gets the brush spacing. |
| brush_get_spikes | Gets the number of spikes for a generated brush. |
| brush_is_editable | Tests if brush can be edited. |
| brush_is_generated | Tests if brush is generated. |
| brush_new | Creates a new brush. |
| brush_rename | Renames a brush. |
| brush_select_destroy | |
| brush_select_new | Invokes a brush selection dialog then run |
| brush_set_angle | Sets the rotation angle of a generated brush. |
| brush_set_aspect_ratio | Sets the aspect ratio of a generated brush. |
| brush_set_hardness | Sets the hardness of a generated brush. |
| brush_set_radius | Sets the radius of a generated brush. |
| brush_set_shape | Sets the shape of a generated brush. |
| brush_set_spacing | Sets the brush spacing. |
| brush_set_spikes | Sets the number of spikes for a generated brush. |
| brushes_close_popup | Close the brush selection dialog. |
| brushes_get_list | Retrieve a complete listing of the available brushes. |
| brushes_popup | Invokes the Gimp brush selection. |
| brushes_refresh | Refresh current brushes. This function always succeeds. |
| brushes_set_popup | Sets the current brush in a brush selection dialog. |
| buffer_delete | Deletes a named buffer. |
| buffer_get_bytes | Retrieves the specified buffer’s bytes. |
| buffer_get_height | Retrieves the specified buffer’s height. |
| buffer_get_image_type | Retrieves the specified buffer’s image type. |
| buffer_get_width | Retrieves the specified buffer’s width. |
| buffer_rename | Renames a named buffer. |
| buffers_get_list | Retrieve a complete listing of the available buffers. |
| cache_directory | Returns the default top directory for GIMP cached files. If the
environment variable GIMP3_CACHEDIR exists, that is used. It
should be an absolute pathname. Otherwise, a subdirectory of the
directory returned by |
| cairo_checkerboard_create | Create a repeating checkerboard pattern. |
| cairo_set_source_rgb | Sets the source pattern within |
| cairo_set_source_rgba | Sets the source pattern within |
| cairo_surface_create_buffer | This function returns a |
| cairo_surface_get_format | This function returns a |
| canonicalize_identifier | Turns any input string into a canonicalized string. |
| check_custom_color1 | Returns the first checkerboard custom color that can be used in previews. |
| check_custom_color2 | Returns the second checkerboard custom color that can be used in previews. |
| check_size | Returns the size of the checkerboard to be used in previews. |
| check_type | Returns the type of the checkerboard to be used in previews. |
| checks_get_colors | Retrieves the colors to use when drawing a checkerboard for a certain
|
| clone | Clone from the source to the dest drawable using the current brush. |
| clone_default | Clone from the source to the dest drawable using the current brush. |
| cmyka_get_uchar | Retrieve individual channel values from a |
| cmyka_set | Initialiser for the internal |
| cmyka_set_uchar | The same as gimp_cmyka_set(), except that channel values are unsigned chars in the range 0 to 255. |
| context_are_dynamics_enabled | Inform whether the currently active paint dynamics will be applied to painting. |
| context_enable_dynamics | Set the specified paint dynamics as the active paint dynamics. |
| context_get_antialias | Get the antialias setting. |
| context_get_background | Get the current GIMP background color. |
| context_get_brush | Retrieve the currently active brush. |
| context_get_brush_angle | Get brush angle in degrees. |
| context_get_brush_aspect_ratio | Get brush aspect ratio. |
| context_get_brush_force | Get brush force in paint options. |
| context_get_brush_hardness | Get brush hardness in paint options. |
| context_get_brush_size | Get brush size in pixels. |
| context_get_brush_spacing | Get brush spacing as percent of size. |
| context_get_diagonal_neighbors | Get the diagonal neighbors setting. |
| context_get_distance_metric | Get the distance metric used in some computations. |
| context_get_dynamics | Retrieve the currently active paint dynamics. |
| context_get_feather | Get the feather setting. |
| context_get_feather_radius | Get the feather radius setting. |
| context_get_font | Retrieve the currently active font. |
| context_get_foreground | Get the current GIMP foreground color. |
| context_get_gradient | Retrieve the currently active gradient. |
| context_get_gradient_blend_color_space | Get the gradient blend color space. |
| context_get_gradient_repeat_mode | Get the gradient repeat mode. |
| context_get_gradient_reverse | Get the gradient reverse setting. |
| context_get_ink_angle | Get ink angle in degrees. |
| context_get_ink_blob_angle | Get ink blob angle in degrees. |
| context_get_ink_blob_aspect_ratio | Get ink blob aspect ratio. |
| context_get_ink_blob_type | Get ink blob type. |
| context_get_ink_size | Get ink blob size in pixels. |
| context_get_ink_size_sensitivity | Get ink size sensitivity. |
| context_get_ink_speed_sensitivity | Get ink speed sensitivity. |
| context_get_ink_tilt_sensitivity | Get ink tilt sensitivity. |
| context_get_interpolation | Get the interpolation type. |
| context_get_line_cap_style | Get the line cap style setting. |
| context_get_line_dash_offset | Get the line dash offset setting. |
| context_get_line_dash_pattern | Get the line dash pattern setting. |
| context_get_line_join_style | Get the line join style setting. |
| context_get_line_miter_limit | Get the line miter limit setting. |
| context_get_line_width | Get the line width setting. |
| context_get_line_width_unit | Get the line width unit setting. |
| context_get_mypaint_brush | Retrieve the currently active MyPaint brush. |
| context_get_opacity | Get the opacity. |
| context_get_paint_method | Retrieve the currently active paint method. |
| context_get_paint_mode | Get the paint mode. |
| context_get_palette | Retrieve the currently active palette. |
| context_get_pattern | Retrieve the currently active pattern. |
| context_get_sample_criterion | Get the sample criterion setting. |
| context_get_sample_merged | Get the sample merged setting. |
| context_get_sample_threshold | Get the sample threshold setting. |
| context_get_sample_threshold_int | Get the sample threshold setting as an integer value. |
| context_get_sample_transparent | Get the sample transparent setting. |
| context_get_stroke_method | Retrieve the currently active stroke method. |
| context_get_transform_direction | Get the transform direction. |
| context_get_transform_resize | Get the transform resize type. |
| context_list_paint_methods | Lists the available paint methods. |
| context_pop | Pops the topmost context from the plug-in’s context stack. |
| context_push | Pushes a context to the top of the plug-in’s context stack. |
| context_set_antialias | Set the antialias setting. |
| context_set_background | Set the current GIMP background color. |
| context_set_brush | Set the specified brush as the active brush. |
| context_set_brush_angle | Set brush angle in degrees. |
| context_set_brush_aspect_ratio | Set brush aspect ratio. |
| context_set_brush_default_hardness | Set brush spacing to its default. |
| context_set_brush_default_size | Set brush size to its default. |
| context_set_brush_default_spacing | Set brush spacing to its default. |
| context_set_brush_force | Set brush application force. |
| context_set_brush_hardness | Set brush hardness. |
| context_set_brush_size | Set brush size in pixels. |
| context_set_brush_spacing | Set brush spacing as percent of size. |
| context_set_default_colors | Set the current GIMP foreground and background colors to black and white. |
| context_set_defaults | Reset context settings to their default values. |
| context_set_diagonal_neighbors | Set the diagonal neighbors setting. |
| context_set_distance_metric | Set the distance metric used in some computations. |
| context_set_dynamics | Set the specified paint dynamics as the active paint dynamics. |
| context_set_feather | Set the feather setting. |
| context_set_feather_radius | Set the feather radius setting. |
| context_set_font | Set the specified font as the active font. |
| context_set_foreground | Set the current GIMP foreground color. |
| context_set_gradient | Sets the specified gradient as the active gradient. |
| context_set_gradient_blend_color_space | Set the gradient blend color space. |
| context_set_gradient_fg_bg_hsv_ccw | Sets the built-in FG-BG HSV (ccw) gradient as the active gradient. |
| context_set_gradient_fg_bg_hsv_cw | Sets the built-in FG-BG HSV (cw) gradient as the active gradient. |
| context_set_gradient_fg_bg_rgb | Sets the built-in FG-BG RGB gradient as the active gradient. |
| context_set_gradient_fg_transparent | Sets the built-in FG-Transparent gradient as the active gradient. |
| context_set_gradient_repeat_mode | Set the gradient repeat mode. |
| context_set_gradient_reverse | Set the gradient reverse setting. |
| context_set_ink_angle | Set ink angle in degrees. |
| context_set_ink_blob_angle | Set ink blob angle in degrees. |
| context_set_ink_blob_aspect_ratio | Set ink blob aspect ratio. |
| context_set_ink_blob_type | Set ink blob type. |
| context_set_ink_size | Set ink blob size in pixels. |
| context_set_ink_size_sensitivity | Set ink size sensitivity. |
| context_set_ink_speed_sensitivity | Set ink speed sensitivity. |
| context_set_ink_tilt_sensitivity | Set ink tilt sensitivity. |
| context_set_interpolation | Set the interpolation type. |
| context_set_line_cap_style | Set the line cap style setting. |
| context_set_line_dash_offset | Set the line dash offset setting. |
| context_set_line_dash_pattern | Set the line dash pattern setting. |
| context_set_line_join_style | Set the line join style setting. |
| context_set_line_miter_limit | Set the line miter limit setting. |
| context_set_line_width | Set the line width setting. |
| context_set_line_width_unit | Set the line width unit setting. |
| context_set_mypaint_brush | Set the specified MyPaint brush as the active MyPaint brush. |
| context_set_opacity | Set the opacity. |
| context_set_paint_method | Set the specified paint method as the active paint method. |
| context_set_paint_mode | Set the paint mode. |
| context_set_palette | Set the specified palette as the active palette. |
| context_set_pattern | Set the specified pattern as the active pattern. |
| context_set_sample_criterion | Set the sample criterion setting. |
| context_set_sample_merged | Set the sample merged setting. |
| context_set_sample_threshold | Set the sample threshold setting. |
| context_set_sample_threshold_int | Set the sample threshold setting as an integer value. |
| context_set_sample_transparent | Set the sample transparent setting. |
| context_set_stroke_method | Set the specified stroke method as the active stroke method. |
| context_set_transform_direction | Set the transform direction. |
| context_set_transform_resize | Set the transform resize type. |
| context_swap_colors | Swap the current GIMP foreground and background colors. |
| convolve | Convolve (Blur, Sharpen) using the current brush. |
| convolve_default | Convolve (Blur, Sharpen) using the current brush. |
| cpu_accel_get_support | Query for CPU acceleration support. |
| cpu_accel_set_use | This function is for internal use only. |
| data_directory | Returns the default top directory for GIMP data. If the environment variable GIMP3_DATADIR exists, that is used. It should be an absolute pathname. Otherwise, on Unix the compile-time defined directory is used. On Windows, the installation directory as deduced from the executable’s full filename is used. |
| data_directory_file | Returns a |
| debug_timer_end | Finishes measuring elapsed time. |
| debug_timer_start | Starts measuring elapsed time. |
| default_display | Returns the default display ID. This corresponds to the display the running procedure’s menu entry was invoked from. |
| detach_parasite | Removes a global parasite. |
| directory | Returns the user-specific GIMP settings directory. If the environment variable GIMP3_DIRECTORY exists, it is used. If it is an absolute path, it is used as is. If it is a relative path, it is taken to be a subdirectory of the home directory. If it is a relative path, and no home directory can be determined, it is taken to be a subdirectory of gimp_data_directory(). |
| directory_file | Returns a |
| displays_flush | Flush all internal changes to the user interface. |
| displays_reconnect | Reconnect displays from one image to another image. |
| dodgeburn | Dodgeburn image with varying exposure. |
| dodgeburn_default | Dodgeburn image with varying exposure. This is the same as the
|
| dynamics_get_list | Retrieve the list of loaded paint dynamics. |
| dynamics_refresh | Refresh current paint dynamics. This function always succeeds. |
| edit_copy | Copy from the specified drawables. |
| edit_copy_visible | Copy from the projection. |
| edit_cut | Cut from the specified drawables. |
| edit_named_copy | Copy into a named buffer. |
| edit_named_copy_visible | Copy from the projection into a named buffer. |
| edit_named_cut | Cut into a named buffer. |
| edit_named_paste | Paste named buffer to the specified drawable. |
| edit_named_paste_as_new_image | Paste named buffer to a new image. |
| edit_paste | Paste buffer to the specified drawable. |
| edit_paste_as_new_image | Paste buffer to a new image. |
| enum_get_desc | Retrieves |
| enum_get_value | Checks if |
| enum_get_value_descriptions | Retrieves the array of human readable and translatable descriptions and help texts for enum values. |
| enum_set_value_descriptions | Sets the array of human readable and translatable descriptions and help texts for enum values. |
| enum_value_get_abbrev | Retrieves the translated abbreviation for a given |
| enum_value_get_desc | Retrieves the translated description for a given |
| enum_value_get_help | Retrieves the translated help for a given |
| enums_get_type_names | This function gives access to the list of enums registered by libgimp. The returned array is static and must not be modified. |
| enums_init | This function makes sure all the enum types are registered
with the |
| env_init | You don’t need to care about this function. It is being called for you automatically (by means of the MAIN() macro that every plug-in runs). Calling it again will cause a fatal error. |
| eraser | Erase using the current brush. |
| eraser_default | Erase using the current brush. |
| escape_uline | This function returns a copy of |
| export_color_profile | Returns whether file plug-ins should default to exporting the image’s color profile. |
| export_comment | Returns whether file plug-ins should default to exporting the image’s comment. |
| export_exif | Returns whether file plug-ins should default to exporting Exif
metadata, according preferences (original settings is |
| export_iptc | Returns whether file plug-ins should default to exporting IPTC
metadata, according preferences (original settings is |
| export_thumbnail | Returns whether file plug-ins should default to exporting the image’s comment. |
| export_xmp | Returns whether file plug-ins should default to exporting XMP
metadata, according preferences (original settings is |
| file_get_config_path | Unexpands |
| file_get_utf8_name | This function works like |
| file_has_extension | This function checks if |
| file_load | Loads an image file by invoking the right load handler. |
| file_load_layer | Loads an image file as a layer for an existing image. |
| file_load_layers | Loads an image file as layers for an existing image. |
| file_new_for_config_path | Expands |
| file_save | Saves a file by extension. |
| file_save_thumbnail | Saves a thumbnail for the given image. |
| file_show_in_file_manager | Shows |
| filename_to_utf8 | Convert a filename in the filesystem’s encoding to UTF-8 temporarily. The return value is a pointer to a string that is guaranteed to be valid only during the current iteration of the main loop or until the next call to gimp_filename_to_utf8(). |
| flags_get_first_desc | Retrieves the first |
| flags_get_first_value | Checks if |
| flags_get_value_descriptions | Retrieves the array of human readable and translatable descriptions and help texts for flags values. |
| flags_set_value_descriptions | Sets the array of human readable and translatable descriptions and help texts for flags values. |
| flags_value_get_abbrev | Retrieves the translated abbreviation for a given |
| flags_value_get_desc | Retrieves the translated description for a given |
| flags_value_get_help | Retrieves the translated help for a given |
| floating_sel_anchor | Anchor the specified floating selection to its associated drawable. |
| floating_sel_attach | Attach the specified layer as floating to the specified drawable. |
| floating_sel_remove | Remove the specified floating selection from its associated drawable. |
| floating_sel_to_layer | Transforms the specified floating selection into a layer. |
| font_select_destroy | |
| font_select_new | |
| fonts_close_popup | Close the font selection dialog. |
| fonts_get_list | Retrieve the list of loaded fonts. |
| fonts_popup | Invokes the Gimp font selection. |
| fonts_refresh | Refresh current fonts. This function always succeeds. |
| fonts_set_popup | Sets the current font in a font selection dialog. |
| get_color_configuration | Retrieve a copy of the current color management configuration. |
| get_default_comment | Get the default image comment as specified in the Preferences. |
| get_default_unit | Get the default unit (taken from the user’s locale). |
| get_images | Returns the list of images currently open. |
| get_module_load_inhibit | Get the list of modules which should not be loaded. |
| get_monitor_resolution | Get the monitor resolution as specified in the Preferences. |
| get_num_processors | Returns the number of threads set explicitly by the user in the preferences. This information can be used by plug-ins wishing to follow user settings for multi-threaded implementations. |
| get_parasite | Look up a global parasite. |
| get_parasite_list | List all parasites. |
| get_pdb | This function returns the plug-in’s |
| get_plug_in | This function returns the plug-in’s |
| get_progname | Returns the plug-in’s executable name. |
| getpid | Returns the PID of the host GIMP process. |
| gimprc_query | Queries the gimprc file parser for information on a specified token. |
| gimprc_set | Sets a gimprc token to a value and saves it in the gimprc. |
| gradient_delete | Deletes a gradient. |
| gradient_duplicate | Duplicates a gradient. |
| gradient_get_custom_samples | Sample the specified gradient in custom positions. |
| gradient_get_number_of_segments | Returns the number of segments of the specified gradient. |
| gradient_get_uniform_samples | Sample the specified in uniform parts. |
| gradient_is_editable | Tests if gradient can be edited. |
| gradient_new | Creates a new gradient. |
| gradient_rename | Rename a gradient. |
| gradient_segment_get_blending_function | Retrieves the gradient segment’s blending function. |
| gradient_segment_get_coloring_type | Retrieves the gradient segment’s coloring type. |
| gradient_segment_get_left_color | Retrieves the left endpoint color of the specified segment. |
| gradient_segment_get_left_pos | Retrieves the left endpoint position of the specified segment. |
| gradient_segment_get_middle_pos | Retrieves the middle point position of the specified segment. |
| gradient_segment_get_right_color | Retrieves the right endpoint color of the specified segment. |
| gradient_segment_get_right_pos | Retrieves the right endpoint position of the specified segment. |
| gradient_segment_range_blend_colors | Blend the colors of the segment range. |
| gradient_segment_range_blend_opacity | Blend the opacity of the segment range. |
| gradient_segment_range_delete | Delete the segment range. |
| gradient_segment_range_flip | Flip the segment range. |
| gradient_segment_range_move | Move the position of an entire segment range by a delta. |
| gradient_segment_range_redistribute_handles | Uniformly redistribute the segment range’s handles. |
| gradient_segment_range_replicate | Replicate the segment range. |
| gradient_segment_range_set_blending_function | Change the blending function of a segments range. |
| gradient_segment_range_set_coloring_type | Change the coloring type of a segments range. |
| gradient_segment_range_split_midpoint | Splits each segment in the segment range at midpoint. |
| gradient_segment_range_split_uniform | Splits each segment in the segment range uniformly. |
| gradient_segment_set_left_color | Sets the left endpoint color of the specified segment. |
| gradient_segment_set_left_pos | Sets the left endpoint position of the specified segment. |
| gradient_segment_set_middle_pos | Sets the middle point position of the specified segment. |
| gradient_segment_set_right_color | Sets the right endpoint color of the specified segment. |
| gradient_segment_set_right_pos | Sets the right endpoint position of the specified segment. |
| gradient_select_destroy | |
| gradient_select_new | |
| gradients_close_popup | Close the gradient selection dialog. |
| gradients_get_list | Retrieve the list of loaded gradients. |
| gradients_popup | Invokes the Gimp gradients selection. |
| gradients_refresh | Refresh current gradients. This function always succeeds. |
| gradients_set_popup | Sets the current gradient in a gradient selection dialog. |
| heal | Heal from the source to the dest drawable using the current brush. |
| heal_default | Heal from the source to the dest drawable using the current brush. |
| help | Load a help page. |
| hsva_set | |
| icon_theme_dir | Returns the directory of the current icon theme. |
| installation_directory | Returns the top installation directory of GIMP. On Unix the compile-time defined installation prefix is used. On Windows, the installation directory as deduced from the executable’s full filename is used. On OSX we ask [NSBundle mainBundle] for the resource path to check if GIMP is part of a relocatable bundle. |
| installation_directory_file | Returns a |
| is_canonical_identifier | Checks if |
| list_images | Returns the list of images currently open. |
| locale_directory | Returns the top directory for GIMP locale files. If the environment variable GIMP3_LOCALEDIR exists, that is used. It should be an absolute pathname. Otherwise, on Unix the compile-time defined directory is used. On Windows, the installation directory as deduced from the executable’s full filename is used. |
| locale_directory_file | Returns a |
| main | The main plug-in function that must be called with the plug-in’s
|
| message | Displays a dialog box with a message. |
| message_get_handler | Returns the current state of where warning messages are displayed. |
| message_set_handler | Controls where warning messages are displayed. |
| monitor_number | Returns the monitor number to be used for plug-in windows. |
| paintbrush | Paint in the current brush with optional fade out parameter and pull colors from a gradient. |
| paintbrush_default | 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. |
| palette_add_entry | Adds a palette entry to the specified palette. |
| palette_delete | Deletes a palette. |
| palette_delete_entry | Deletes a palette entry from the specified palette. |
| palette_duplicate | Duplicates a palette. |
| palette_entry_get_color | Gets the specified palette entry from the specified palette. |
| palette_entry_get_name | Gets the specified palette entry from the specified palette. |
| palette_entry_set_color | Sets the specified palette entry in the specified palette. |
| palette_entry_set_name | Sets the specified palette entry in the specified palette. |
| palette_get_colors | Gets all colors from the specified palette. |
| palette_get_columns | Retrieves the number of columns to use to display this palette. |
| palette_get_info | Retrieve information about the specified palette. |
| palette_is_editable | Tests if palette can be edited. |
| palette_new | Creates a new palette. |
| palette_rename | Rename a palette. |
| palette_select_destroy | |
| palette_select_new | |
| palette_set_columns | Sets the number of columns to use when displaying the palette. |
| palettes_close_popup | Close the palette selection dialog. |
| palettes_get_list | Retrieves a list of all of the available palettes. |
| palettes_popup | Invokes the Gimp palette selection. |
| palettes_refresh | Refreshes current palettes. This function always succeeds. |
| palettes_set_popup | Sets the current palette in a palette selection dialog. |
| param_spec_array | Creates a new GIMP_TYPE_ARRAY property. |
| param_spec_channel | Creates a new GIMP_TYPE_CHANNEL property. |
| param_spec_config_path | Creates a param spec to hold a filename, dir name,
or list of file or dir names.
See |
| param_spec_config_path_type | Tells whether the path param encodes a filename, dir name, or list of file or dir names. |
| param_spec_display | Creates a new GIMP_TYPE_DISPLAY property. |
| param_spec_drawable | Creates a new GIMP_TYPE_DRAWABLE property. |
| param_spec_float_array | Creates a new GIMP_TYPE_FLOAT_ARRAY property. |
| param_spec_image | Creates a new GIMP_TYPE_IMAGE property. |
| param_spec_int32_array | Creates a new GIMP_TYPE_INT32_ARRAY property. |
| param_spec_item | Creates a new GIMP_TYPE_ITEM property. |
| param_spec_layer | Creates a new GIMP_TYPE_LAYER property. |
| param_spec_layer_mask | Creates a new GIMP_TYPE_LAYER_MASK property. |
| param_spec_matrix2 | Creates a param spec to hold a |
| param_spec_matrix3 | Creates a param spec to hold a |
| param_spec_memsize | Creates a param spec to hold a memory size value.
See |
| param_spec_object_array | Creates a new GIMP_TYPE_OBJECT_ARRAY property. |
| param_spec_parasite | Creates a new GIMP_TYPE_PARASITE property. |
| param_spec_rgb | Creates a param spec to hold an |
| param_spec_rgb_array | Creates a new GIMP_TYPE_RGB_ARRAY property. |
| param_spec_selection | Creates a new GIMP_TYPE_SELECTION property. |
| param_spec_uint8_array | Creates a new GIMP_TYPE_UINT8_ARRAY property. |
| param_spec_unit | Creates a param spec to hold a units param.
See |
| param_spec_value_array | Creates a new G_TYPE_VALUE_ARRAY property. |
| param_spec_vectors | Creates a new GIMP_TYPE_VECTORS property. |
| path_free | This function frees the memory allocated for the list and the strings it contains. |
| path_get_user_writable_dir | Note that you have to |
| path_parse | |
| path_to_str | |
| pattern_get_info | Retrieve information about the specified pattern. |
| pattern_get_pixels | Retrieve information about the specified pattern (including pixels). |
| pattern_select_destroy | |
| pattern_select_new | |
| patterns_close_popup | Close the pattern selection dialog. |
| patterns_get_list | Retrieve a complete listing of the available patterns. |
| patterns_popup | Invokes the Gimp pattern selection. |
| patterns_refresh | Refresh current patterns. This function always succeeds. |
| patterns_set_popup | Sets the current pattern in a pattern selection dialog. |
| pencil | Paint in the current brush without sub-pixel sampling. |
| pixbuf_create_buffer | Returns a |
| pixbuf_get_format | Returns the Babl format that corresponds to the |
| pixbuf_get_icc_profile | Returns the ICC profile attached to the |
| pixels_to_units | Converts a |
| pixpipe_params_build | |
| pixpipe_params_free | |
| pixpipe_params_init | |
| pixpipe_params_parse | |
| progress_cancel | Cancels a running progress. |
| progress_end | Ends the progress bar for the current plug-in. |
| progress_get_window_handle | Returns the native window ID of the toplevel window this plug-in’s progress is displayed in. |
| progress_init | Initializes the progress bar for the current plug-in. |
| progress_init_printf | Initializes the progress bar for the current plug-in. |
| progress_install_vtable | |
| progress_pulse | Pulses the progress bar for the current plug-in. |
| progress_set_text | Changes the text in the progress bar for the current plug-in. |
| progress_set_text_printf | Changes the text in the progress bar for the current plug-in. |
| progress_uninstall | Uninstalls a temporary progress procedure that was installed using gimp_progress_install(). |
| progress_update | Updates the progress bar for the current plug-in. |
| quit | Forcefully causes the GIMP library to exit and close down its connection to main gimp application. This function never returns. |
| range_estimate_settings | This function proposes reasonable settings for increments and display
digits. These can be used for instance on |
| rectangle_intersect | Calculates the intersection of two rectangles. |
| rectangle_union | Calculates the union of two rectangles. |
| rgba_add | |
| rgba_distance | |
| rgba_get_pixel | Writes the red, green, blue and alpha components of |
| rgba_get_uchar | Gets the 8bit red, green, blue and alpha components of |
| rgba_multiply | |
| rgba_parse_css | Similar to |
| rgba_set | Sets the red, green, blue and alpha components of |
| rgba_set_pixel | Sets the red, green, blue and alpha components of |
| rgba_set_uchar | Sets the red, green, blue and alpha components of |
| rgba_subtract | |
| show_help_button | Returns whether or not GimpDialog should automatically add a help button if help_func and help_id are given. |
| signal_private | This function furnishes a workalike for signal(2) but which internally invokes sigaction(2) after certain sa_flags are set; these primarily to ensure restarting of interrupted system calls. See sigaction(2) It is a aid to transition and not new development: that effort should employ sigaction directly. [gosgood 18.04.2000] |
| smudge | Smudge image with varying pressure. |
| smudge_default | Smudge image with varying pressure. |
| stack_trace_available | Returns |
| stack_trace_print | Attempts to generate a stack trace at current code position in
|
| stack_trace_query | This is mostly the same as |
| strip_uline | This function returns a copy of |
| sysconf_directory | Returns the top directory for GIMP config files. If the environment variable GIMP3_SYSCONFDIR exists, that is used. It should be an absolute pathname. Otherwise, on Unix the compile-time defined directory is used. On Windows, the installation directory as deduced from the executable’s full filename is used. |
| sysconf_directory_file | Returns a |
| temp_directory | Returns the default top directory for GIMP temporary files. If the
environment variable GIMP3_TEMPDIR exists, that is used. It
should be an absolute pathname. Otherwise, a subdirectory of the
directory returned by |
| temp_file | Generates a unique temporary file. |
| text_fontname | Add text at the specified location as a floating selection or a new layer. |
| text_get_extents_fontname | Get extents of the bounding box for the specified text. |
| text_layer_get_antialias | Check if antialiasing is used in the text layer. |
| text_layer_get_base_direction | Get the base direction used for rendering the text layer. |
| text_layer_get_color | Get the color of the text in a text layer. |
| text_layer_get_font | Get the font from a text layer as string. |
| text_layer_get_font_size | Get the font size from a text layer. |
| text_layer_get_hint_style | Get information about hinting in the specified text layer. |
| text_layer_get_indent | Get the line indentation of text layer. |
| text_layer_get_justification | Get the text justification information of the text layer. |
| text_layer_get_kerning | Check if kerning is used in the text layer. |
| text_layer_get_language | Get the language used in the text layer. |
| text_layer_get_letter_spacing | Get the letter spacing used in a text layer. |
| text_layer_get_line_spacing | Get the spacing between lines of text. |
| text_layer_get_markup | Get the markup from a text layer as string. |
| text_layer_get_text | Get the text from a text layer as string. |
| text_layer_new | Creates a new text layer. |
| text_layer_resize | Resize the box of a text layer. |
| text_layer_set_antialias | Enable/disable anti-aliasing in a text layer. |
| text_layer_set_base_direction | Set the base direction in the text layer. |
| text_layer_set_color | Set the color of the text in the text layer. |
| text_layer_set_font | Set the font of a text layer. |
| text_layer_set_font_size | Set the font size. |
| text_layer_set_hint_style | Control how font outlines are hinted in a text layer. |
| text_layer_set_indent | Set the indentation of the first line in a text layer. |
| text_layer_set_justification | Set the justification of the text in a text layer. |
| text_layer_set_kerning | Enable/disable kerning in a text layer. |
| text_layer_set_language | Set the language of the text layer. |
| text_layer_set_letter_spacing | Adjust the letter spacing in a text layer. |
| text_layer_set_line_spacing | Adjust the line spacing in a text layer. |
| text_layer_set_text | Set the text of a text layer. |
| tile_height | Returns the tile height GIMP is using. |
| tile_width | Returns the tile width GIMP is using. |
| type_get_translation_context | Retrieves the translation context that has been previously set
using gimp_type_set_translation_context(). You should not need to
use this function directly, use |
| type_get_translation_domain | Retrieves the gettext translation domain identifier that has been
previously set using gimp_type_set_translation_domain(). You should
not need to use this function directly, use |
| type_set_translation_context | This function attaches a constant string as a translation context
to a |
| type_set_translation_domain | This function attaches a constant string as a gettext translation
domain identifier to a |
| units_to_pixels | Converts a |
| units_to_points | Converts a |
| user_time | 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. |
| utf8_strtrim | Creates a (possibly trimmed) copy of |
| value_dup_float_array | Gets the contents of a |
| value_dup_int32_array | Gets the contents of a |
| value_dup_object_array | |
| value_dup_rgb_array | Gets the contents of a |
| value_dup_uint8_array | Gets the contents of a |
| value_get_float_array | Gets the contents of a |
| value_get_int32_array | Gets the contents of a |
| value_get_object_array | |
| value_get_rgb | |
| value_get_rgb_array | Gets the contents of a |
| value_get_uint8_array | Gets the contents of a |
| value_set_float_array | Sets the contents of |
| value_set_int32_array | Sets the contents of |
| value_set_object_array | Sets the contents of |
| value_set_rgb | |
| value_set_rgb_array | Sets the contents of |
| value_set_static_float_array | Sets the contents of |
| value_set_static_int32_array | Sets the contents of |
| value_set_static_object_array | Sets the contents of |
| value_set_static_rgb_array | Sets the contents of |
| value_set_static_uint8_array | Sets the contents of |
| value_set_uint8_array | Sets the contents of |
| value_take_float_array | Sets the contents of |
| value_take_int32_array | Sets the contents of |
| value_take_object_array | Sets the contents of |
| value_take_rgb_array | Sets the contents of |
| value_take_uint8_array | Sets the contents of |
| vector_2d_to_3d | "Compute screen (sx, sy) - (sx + w, sy + h) to 3D unit square mapping. The plane to map to is given in the z field of p. The observer is located at position vp (vp->z != 0.0)." |
| vector_2d_to_3d_val | This function is identical to |
| vector_3d_to_2d | Convert the given 3D point to 2D (project it onto the viewing plane, (sx, sy, 0) - (sx + w, sy + h, 0). The input is assumed to be in the unit square (0, 0, z) - (1, 1, z). The viewpoint of the observer is passed in vp. |
| version | Returns the host GIMP version. |
| wm_class | Returns the window manager class to be used for plug-in windows. |
Function Macros
Constants
| API_VERSION | |
| CHECK_DARK | The dark gray value for the default checkerboard pattern. |
| CHECK_LIGHT | The dark light value for the default checkerboard pattern. |
| CHECK_SIZE | The default checkerboard size in pixels. This is configurable in the core but GIMP plug-ins can’t access the user preference and should use this constant instead. |
| CHECK_SIZE_SM | The default small checkerboard size in pixels. |
| CONFIG_PARAM_AGGREGATE | The object property is to be treated as part of the parent object. |
| CONFIG_PARAM_CONFIRM | Changes to this property should be confirmed by the user before being applied. |
| CONFIG_PARAM_DEFAULTS | Don’t serialize this property if it has the default value. |
| CONFIG_PARAM_DONT_COMPARE | Ignore this property when comparing objects. |
| CONFIG_PARAM_FLAGS | The default flags that should be used for serializable |
| CONFIG_PARAM_IGNORE | This property exists for obscure reasons or is needed for backward compatibility. Ignore the value read and don’t serialize it. |
| CONFIG_PARAM_RESTART | Changes to this property take effect only after a restart. |
| CONFIG_PARAM_SERIALIZE | A property that can and should be serialized and deserialized. |
| MAJOR_VERSION | The major GIMP version number. |
| MAX_IMAGE_SIZE | The maximum width and height of a GIMP image in pixels. This is a somewhat arbitrary value that can be used when an upper value for pixel sizes is needed; for example to give a spin button an upper limit. |
| MAX_MEMSIZE | A large but arbitrary value that can be used when an upper limit
for a memory size (in bytes) is needed. It is smaller than
|
| MAX_RESOLUTION | The maximum resolution of a GIMP image in pixels per inch. This is a somewhat arbitrary value that can be used to when an upper value for a resolution is needed. GIMP will not accept resolutions larger than this value. |
| MICRO_VERSION | The micro GIMP version number. |
| MIN_IMAGE_SIZE | The minimum width and height of a GIMP image in pixels. |
| MIN_RESOLUTION | The minimum resolution of a GIMP image in pixels per inch. This is a somewhat arbitrary value that can be used when a lower value for a resolution is needed. GIMP will not accept resolutions smaller than this value. |
| MINOR_VERSION | The minor GIMP version number. |
| MODULE_ABI_VERSION | The version of the module system’s ABI. Modules put this value into
|
| PARAM_NO_VALIDATE | Since 3.0 |
| PARAM_READABLE | |
| PARAM_READWRITE | |
| PARAM_STATIC_STRINGS | |
| PARAM_WRITABLE | |
| PARASITE_ATTACH_GRANDPARENT | |
| PARASITE_ATTACH_PARENT | |
| PARASITE_GRANDPARENT_PERSISTENT | |
| PARASITE_GRANDPARENT_UNDOABLE | |
| PARASITE_PARENT_PERSISTENT | |
| PARASITE_PARENT_UNDOABLE | |
| PARASITE_PERSISTENT | |
| PARASITE_UNDOABLE | |
| PIXPIPE_MAXDIM | |
| RGB_LUMINANCE_BLUE | |
| RGB_LUMINANCE_GREEN | |
| RGB_LUMINANCE_RED | |
| VERSION | The GIMP version as a string. |