dnrops
/
gimp
mirror of https://github.com/GNOME/gimp.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

clarify some usecases for gimp_pixel_rgn_init(). 

* libgimp/gimppixelrgn.c: clarify some usecases for
  gimp_pixel_rgn_init().
This commit is contained in:
David Odin 2004-10-17 19:17:09 +00:00
parent ed18600818
commit cbc6650c06
2 changed files with 28 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
ChangeLog
View File

@ -1,3 +1,8 @@
2004-10-17 DindinX <dindinx@gimp.org>
* libgimp/gimppixelrgn.c: clarify some usecases for
gimp_pixel_rgn_init().
2004-10-17 DindinX <dindinx@gimp.org>
* plug-ins/common/colortoalpha.c: Added a preview.

23
libgimp/gimppixelrgn.c
View File

@ -89,6 +89,29 @@ static void gimp_pixel_rgn_configure (GimpPixelRgnHolder *prh,
* shadow tiles or the real @drawable tiles.
*
* Initialize the pixel region pointed by @pr with the specified parameters.
*
* Note: here are some useful usecases for the @dirty/@shadow combination:
* - dirty = FALSE, shadow = FALSE: the region will be used to read the actual
* drawable datas. This is useful for save
* plug-ins or for filters.
*
* - dirty = FALSE, shadow = TRUE: the region will be used to read the shadow
* tiles. This is used in some filter
* plug-ins which operate in two passes such
* as gaussian blur. The first one read the
* actual drawable data and write to the
* shadow tiles, and the second one read from
* and write to the shadow tiles.
*
* - dirty = TRUE, shadow = TRUE: the region will be used to write to the
* shadow tiles. This is a very common
* practice to write to the shadow tiles and
* then use #gimp_drawable_merge_shadow () to
* merge the changes from the shadow tiles
* using the current selection as a mask.
*
* - dirty = TRUE, shadow = FALSE: the region will be used to directly change
* the drawable content. Don't do this.
**/
void
gimp_pixel_rgn_init (GimpPixelRgn *pr,