Commit dd7b550d authored by Sven Neumann's avatar Sven Neumann Committed by Sven Neumann
Browse files

removed wrong note about using _gimp_tile_cache_flush_drawable() from the

2004-06-28  Sven Neumann  <sven@gimp.org>

	* libgimp/gimpdrawable.c: removed wrong note about using
	_gimp_tile_cache_flush_drawable() from the API docs.
parent 6d4d1d2f
2004-06-28 Sven Neumann <sven@gimp.org>
* libgimp/gimpdrawable.c: removed wrong note about using
_gimp_tile_cache_flush_drawable() from the API docs.
2004-06-28 Sven Neumann <sven@gimp.org>
* plug-ins/common/dog.c (dog): ifdef'ed out calls to
......
......@@ -32,19 +32,19 @@
* gimp_drawable_get:
* @drawable_ID: the ID (in the core) of the drawable
*
* This function creates a #GimpDrawable structure, and sets its values to
* This function creates a #GimpDrawable structure, and sets its values to
* the correct ones for @drawable_id. The returned structure contains some
* basic information about the drawable, and also provides a list to hold
* tile data for transfer to and from the core. The tile list is
* initially empty.
*
* Note that the name of this function is somewhat misleading, because it
* Note that the name of this function is somewhat misleading, because it
* suggests that it simply returns a handle. This is not the case: if the
* function is called multiple times, it creates separate tile lists each
* time, which will usually produce undesired results.
*
* When a plug-in has finished working with a drawable, before exiting
* it should call gimp_drawable_detach() to make sure that all tile data is
* it should call gimp_drawable_detach() to make sure that all tile data is
* transferred back to the core.
*/
GimpDrawable *
......@@ -80,7 +80,8 @@ gimp_drawable_get (gint32 drawable_ID)
* This function is called when a plug-in is finished working
* with a drawable. It forces all tile data held in the tile
* list of the #GimpDrawable to be transferred to the core, and
* then frees all associated memory.
* then frees all associated memory. You must not access the
* @drawable after having called gimp_drawable_detach().
*/
void
gimp_drawable_detach (GimpDrawable *drawable)
......@@ -102,17 +103,14 @@ gimp_drawable_detach (GimpDrawable *drawable)
/*
* gimp_drawable_flush:
* @drawable: The #GimpDrawable whose tile data is to be transferred to the core.
* @drawable: The #GimpDrawable whose tile data is to be transferred
* to the core.
*
* This function causes all tile data in the tile list of @drawable to be
* transferred to the core. It is usually called in situations where a
* plug-in acts on a drawable, and then needs to read the results of its
* actions. Data transferred back from the core will not generally be valid
* unless gimp_drawable_flush() has been called beforehand.
*
* Note that in some situations where a tile cache is used, it is necessary to
* call _gimp_tile_cache_flush_drawable() after gimp_drawable_flush() in
* order to get valid results.
*/
void
gimp_drawable_flush (GimpDrawable *drawable)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment