
2003-05-20 Sven Neumann <sven@gimp.org> * libgimp/libgimp-sections.txt * libgimp/tmpl/gimpimage.sgml: added gimp_image_flip(). * libgimpcolor/libgimpcolor-sections.txt * libgimpcolor/tmpl/gimpcolorspace.sgml: added GimpHSL and removed gimp_rgb_to_hsv_double and gimp_hsv_to_rgb_double.
761 lines
8.5 KiB
Plaintext
761 lines
8.5 KiB
Plaintext
<!-- ##### SECTION Title ##### -->
|
|
gimpimage
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
|
Operations on complete images.
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
<para>
|
|
Operations on complete images: creation, resizing/rescaling,
|
|
and operations involving multiple layers.
|
|
|
|
</para>
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- ##### FUNCTION gimp_image_list ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@num_images:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_new ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@width:
|
|
@height:
|
|
@type:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_flip ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@flip_type:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_resize ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@new_width:
|
|
@new_height:
|
|
@offx:
|
|
@offy:
|
|
@Returns:
|
|
<!-- # Unused Parameters # -->
|
|
@offset_x:
|
|
@offset_y:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_scale ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@new_width:
|
|
@new_height:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_crop ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@new_width:
|
|
@new_height:
|
|
@offx:
|
|
@offy:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_delete ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_free_shadow ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_get_layers ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@num_layers:
|
|
@Returns:
|
|
<!-- # Unused Parameters # -->
|
|
@nlayers:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_get_channels ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@num_channels:
|
|
@Returns:
|
|
<!-- # Unused Parameters # -->
|
|
@nchannels:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_unset_active_channel ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_pick_correlate_layer ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@x:
|
|
@y:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_raise_layer ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@layer_ID:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_lower_layer ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@layer_ID:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_raise_layer_to_top ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@layer_ID:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_lower_layer_to_bottom ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@layer_ID:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_merge_visible_layers ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@merge_type:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_merge_down ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@merge_layer_ID:
|
|
@merge_type:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_flatten ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_add_layer ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@layer_ID:
|
|
@position:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_remove_layer ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@layer_ID:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_add_layer_mask ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@layer_ID:
|
|
@mask_ID:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_remove_layer_mask ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@layer_ID:
|
|
@mode:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_raise_channel ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@channel_ID:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_lower_channel ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@layer_ID:
|
|
@Returns:
|
|
<!-- # Unused Parameters # -->
|
|
@channel_ID:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_add_channel ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@channel_ID:
|
|
@position:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_remove_channel ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@channel_ID:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_active_drawable ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_base_type ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_undo_is_enabled ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_undo_enable ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_undo_disable ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_undo_freeze ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_undo_thaw ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_clean_all ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_is_dirty ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_floating_selection ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_floating_sel_attached_to ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_set_tattoo_state ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@tattoo:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_get_tattoo_state ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_width ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_height ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_get_active_layer ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_set_active_layer ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@active_layer_ID:
|
|
@Returns:
|
|
<!-- # Unused Parameters # -->
|
|
@layer_ID:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_get_active_channel ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_set_active_channel ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@active_channel_ID:
|
|
@Returns:
|
|
<!-- # Unused Parameters # -->
|
|
@channel_ID:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_get_selection ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_get_component_active ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@component:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_set_component_active ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@component:
|
|
@active:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_get_component_visible ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@component:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_set_component_visible ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@component:
|
|
@visible:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_get_filename ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_set_filename ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@filename:
|
|
@Returns:
|
|
<!-- # Unused Parameters # -->
|
|
@name:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_get_name ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_get_resolution ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@xresolution:
|
|
@yresolution:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_set_resolution ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@xresolution:
|
|
@yresolution:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_get_unit ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_set_unit ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@unit:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_get_layer_by_tattoo ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@tattoo:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_get_channel_by_tattoo ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@tattoo:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_get_cmap ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@num_colors:
|
|
@Returns:
|
|
<!-- # Unused Parameters # -->
|
|
@ncolors:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_set_cmap ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@cmap:
|
|
@num_colors:
|
|
@Returns:
|
|
<!-- # Unused Parameters # -->
|
|
@ncolors:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_get_thumbnail_data ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@width:
|
|
@height:
|
|
@bpp:
|
|
@Returns:
|
|
<!-- # Unused Parameters # -->
|
|
@bytes:
|
|
|
|
|
|
<!-- ##### MACRO gimp_image_convert_rgb ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- # Unused Parameters # -->
|
|
@image_ID:
|
|
|
|
|
|
<!-- ##### MACRO gimp_image_convert_grayscale ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- # Unused Parameters # -->
|
|
@image_ID:
|
|
|
|
|
|
<!-- ##### MACRO gimp_image_convert_indexed ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
<!-- # Unused Parameters # -->
|
|
@image_ID:
|
|
@dither_type:
|
|
@palette_type:
|
|
@num_colors:
|
|
@alpha_dither:
|
|
@remove_unused:
|
|
@palette:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_duplicate ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_parasite_find ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@name:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_parasite_list ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@num_parasites:
|
|
@parasites:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_parasite_attach ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@parasite:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_parasite_detach ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@name:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_image_attach_new_parasite ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@image_ID:
|
|
@name:
|
|
@flags:
|
|
@size:
|
|
@data:
|
|
|
|
|