2000-06-09 03:42:36 +08:00
|
|
|
<!-- ##### SECTION Title ##### -->
|
|
|
|
gimpdrawable
|
|
|
|
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
2002-12-03 18:04:56 +08:00
|
|
|
Functions to manipulate drawables.
|
2000-06-09 03:42:36 +08:00
|
|
|
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
|
|
<para>
|
2002-12-03 18:04:56 +08:00
|
|
|
Functions to manipulate drawables.
|
2000-06-09 03:42:36 +08:00
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
2005-07-08 00:33:31 +08:00
|
|
|
<!-- ##### SECTION Stability_Level ##### -->
|
|
|
|
|
|
|
|
|
2000-06-09 03:42:36 +08:00
|
|
|
<!-- ##### STRUCT GimpDrawable ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
2002-03-08 20:36:40 +08:00
|
|
|
@drawable_id:
|
2001-05-05 04:39:29 +08:00
|
|
|
@width:
|
|
|
|
@height:
|
|
|
|
@bpp:
|
|
|
|
@ntile_rows:
|
|
|
|
@ntile_cols:
|
|
|
|
@tiles:
|
|
|
|
@shadow_tiles:
|
2000-06-09 03:42:36 +08:00
|
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_drawable_get ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_drawable_detach ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_drawable_flush ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_drawable_delete ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
2003-12-04 01:47:15 +08:00
|
|
|
@drawable_ID:
|
|
|
|
@Returns:
|
2000-06-09 03:42:36 +08:00
|
|
|
|
|
|
|
|
2007-01-13 03:59:36 +08:00
|
|
|
<!-- ##### FUNCTION gimp_drawable_is_valid ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2003-12-04 00:39:32 +08:00
|
|
|
<!-- ##### FUNCTION gimp_drawable_get_name ##### -->
|
2000-06-09 03:42:36 +08:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2003-12-04 00:39:32 +08:00
|
|
|
<!-- ##### FUNCTION gimp_drawable_set_name ##### -->
|
2000-06-09 03:42:36 +08:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
2003-12-04 00:39:32 +08:00
|
|
|
@name:
|
2000-06-09 03:42:36 +08:00
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2003-12-04 00:39:32 +08:00
|
|
|
<!-- ##### FUNCTION gimp_drawable_get_visible ##### -->
|
2000-06-09 03:42:36 +08:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
2003-12-04 00:39:32 +08:00
|
|
|
@Returns:
|
2000-06-09 03:42:36 +08:00
|
|
|
|
|
|
|
|
2000-07-29 21:22:35 +08:00
|
|
|
<!-- ##### FUNCTION gimp_drawable_set_visible ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
|
|
|
@visible:
|
2003-12-04 00:39:32 +08:00
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2003-12-04 19:10:20 +08:00
|
|
|
<!-- ##### FUNCTION gimp_drawable_get_linked ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_drawable_set_linked ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
|
|
|
@linked:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2009-09-08 21:05:09 +08:00
|
|
|
<!-- ##### FUNCTION gimp_drawable_set_lock_content ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
|
|
|
@lock_content:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_drawable_get_lock_content ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2003-12-04 00:39:32 +08:00
|
|
|
<!-- ##### FUNCTION gimp_drawable_get_tattoo ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_drawable_set_tattoo ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
|
|
|
@tattoo:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_drawable_get_pixel ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
|
|
|
@x_coord:
|
|
|
|
@y_coord:
|
|
|
|
@num_channels:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_drawable_set_pixel ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
|
|
|
@x_coord:
|
|
|
|
@y_coord:
|
|
|
|
@num_channels:
|
|
|
|
@pixel:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2000-06-09 03:42:36 +08:00
|
|
|
<!-- ##### FUNCTION gimp_drawable_get_tile ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable:
|
|
|
|
@shadow:
|
|
|
|
@row:
|
|
|
|
@col:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_drawable_get_tile2 ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable:
|
|
|
|
@shadow:
|
|
|
|
@x:
|
|
|
|
@y:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_drawable_get_thumbnail_data ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
|
|
|
@width:
|
|
|
|
@height:
|
|
|
|
@bpp:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2004-12-14 07:39:31 +08:00
|
|
|
<!-- ##### FUNCTION gimp_drawable_get_sub_thumbnail_data ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
|
|
|
@src_x:
|
|
|
|
@src_y:
|
|
|
|
@src_width:
|
|
|
|
@src_height:
|
|
|
|
@dest_width:
|
|
|
|
@dest_height:
|
|
|
|
@bpp:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2004-03-13 07:18:00 +08:00
|
|
|
<!-- ##### FUNCTION gimp_drawable_get_color_uchar ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
|
|
|
@color:
|
|
|
|
@color_uchar:
|
|
|
|
|
|
|
|
|
2000-06-09 03:42:36 +08:00
|
|
|
<!-- ##### FUNCTION gimp_drawable_merge_shadow ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
|
|
|
@undo:
|
2000-08-24 23:17:38 +08:00
|
|
|
@Returns:
|
2000-06-09 03:42:36 +08:00
|
|
|
|
|
|
|
|
2008-05-29 20:00:27 +08:00
|
|
|
<!-- ##### FUNCTION gimp_drawable_free_shadow ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2000-06-09 03:42:36 +08:00
|
|
|
<!-- ##### FUNCTION gimp_drawable_fill ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
|
|
|
@fill_type:
|
2000-08-24 23:17:38 +08:00
|
|
|
@Returns:
|
2000-06-09 03:42:36 +08:00
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_drawable_update ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
|
|
|
@x:
|
|
|
|
@y:
|
|
|
|
@width:
|
|
|
|
@height:
|
2000-08-24 23:17:38 +08:00
|
|
|
@Returns:
|
2000-06-09 03:42:36 +08:00
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_drawable_mask_bounds ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
|
|
|
@x1:
|
|
|
|
@y1:
|
|
|
|
@x2:
|
|
|
|
@y2:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2004-10-24 05:54:58 +08:00
|
|
|
<!-- ##### FUNCTION gimp_drawable_mask_intersect ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
|
|
|
@x:
|
|
|
|
@y:
|
|
|
|
@width:
|
|
|
|
@height:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2003-12-04 21:21:27 +08:00
|
|
|
<!-- ##### FUNCTION gimp_drawable_get_image ##### -->
|
2000-06-09 03:42:36 +08:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2003-12-04 21:21:27 +08:00
|
|
|
<!-- ##### FUNCTION gimp_drawable_set_image ##### -->
|
2000-06-09 03:42:36 +08:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
2003-12-04 21:21:27 +08:00
|
|
|
@image_ID:
|
2000-06-09 03:42:36 +08:00
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_drawable_has_alpha ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_drawable_type_with_alpha ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2003-12-04 21:21:27 +08:00
|
|
|
<!-- ##### FUNCTION gimp_drawable_type ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2000-06-09 03:42:36 +08:00
|
|
|
<!-- ##### FUNCTION gimp_drawable_is_rgb ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_drawable_is_gray ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_drawable_is_indexed ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2003-12-05 22:51:11 +08:00
|
|
|
<!-- ##### FUNCTION gimp_drawable_bpp ##### -->
|
2000-06-09 03:42:36 +08:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_drawable_width ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_drawable_height ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_drawable_offsets ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
|
|
|
@offset_x:
|
|
|
|
@offset_y:
|
2000-08-24 23:17:38 +08:00
|
|
|
@Returns:
|
2000-06-09 03:42:36 +08:00
|
|
|
|
|
|
|
|
2008-04-10 00:44:48 +08:00
|
|
|
<!-- ##### FUNCTION gimp_drawable_is_channel ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2000-06-09 03:42:36 +08:00
|
|
|
<!-- ##### FUNCTION gimp_drawable_is_layer ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_drawable_is_layer_mask ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2008-04-10 00:44:48 +08:00
|
|
|
<!-- ##### FUNCTION gimp_drawable_is_text_layer ##### -->
|
2000-06-09 03:42:36 +08:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2001-05-05 04:39:29 +08:00
|
|
|
<!-- ##### FUNCTION gimp_drawable_offset ##### -->
|
2000-06-09 09:56:34 +08:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
2001-05-05 04:39:29 +08:00
|
|
|
@drawable_ID:
|
|
|
|
@wrap_around:
|
|
|
|
@fill_type:
|
|
|
|
@offset_x:
|
|
|
|
@offset_y:
|
|
|
|
@Returns:
|
2000-06-09 09:56:34 +08:00
|
|
|
|
|
|
|
|
2005-08-03 20:24:05 +08:00
|
|
|
<!-- ##### FUNCTION gimp_drawable_foreground_extract ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
|
|
|
@mode:
|
|
|
|
@mask_ID:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2001-05-26 04:44:40 +08:00
|
|
|
<!-- ##### FUNCTION gimp_drawable_parasite_find ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
|
|
|
@name:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_drawable_parasite_list ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
|
|
|
@num_parasites:
|
|
|
|
@parasites:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_drawable_parasite_attach ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
|
|
|
@parasite:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_drawable_parasite_detach ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
|
|
|
@name:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gimp_drawable_attach_new_parasite ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@drawable_ID:
|
|
|
|
@name:
|
|
|
|
@flags:
|
|
|
|
@size:
|
|
|
|
@data:
|
2005-03-03 19:58:26 +08:00
|
|
|
@Returns:
|
2001-05-26 04:44:40 +08:00
|
|
|
|
|
|
|
|