[gimp] pdb: gimp-image-new's doc updated.



commit 1351226c80c3a8cfbc6be2b9ba98042c22bfcec0
Author: Jehan <jehan girinstud io>
Date:   Sat Oct 5 01:47:05 2013 +1300

    pdb: gimp-image-new's doc updated.
    
    Add the precision that indexed images must be set a colormap after
    creation, otherwise colors won't be right.

 app/pdb/image-cmds.c       |    4 +++-
 libgimp/gimpimage_pdb.c    |    6 +++++-
 tools/pdbgen/pdb/image.pdb |    7 ++++++-
 3 files changed, 14 insertions(+), 3 deletions(-)
---
diff --git a/app/pdb/image-cmds.c b/app/pdb/image-cmds.c
index 8bdf500..78c9a3e 100644
--- a/app/pdb/image-cmds.c
+++ b/app/pdb/image-cmds.c
@@ -2944,7 +2944,9 @@ register_image_procs (GimpPDB *pdb)
   gimp_procedure_set_static_strings (procedure,
                                      "gimp-image-new",
                                      "Creates a new image with the specified width, height, and type.",
-                                     "Creates a new image, undisplayed with the specified extents and type. 
A layer should be created and added before this image is displayed, or subsequent calls to 'gimp-display-new' 
with this image as an argument will fail. Layers can be created using the 'gimp-layer-new' commands. They can 
be added to an image using the 'gimp-image-insert-layer' command.",
+                                     "Creates a new image, undisplayed, with the specified extents and type. 
A layer should be created and added before this image is displayed, or subsequent calls to 'gimp-display-new' 
with this image as an argument will fail. Layers can be created using the 'gimp-layer-new' commands. They can 
be added to an image using the 'gimp-image-insert-layer' command.\n"
+                                     "\n"
+                                     "If your image's type if INDEXED, a colormap must also be added with 
'gimp-image-set-colormap'. An indexed image without a colormap will output unexpected colors.",
                                      "Spencer Kimball & Peter Mattis",
                                      "Spencer Kimball & Peter Mattis",
                                      "1995-1996",
diff --git a/libgimp/gimpimage_pdb.c b/libgimp/gimpimage_pdb.c
index 2ad70c6..fc8fc04 100644
--- a/libgimp/gimpimage_pdb.c
+++ b/libgimp/gimpimage_pdb.c
@@ -116,12 +116,16 @@ gimp_image_list (gint *num_images)
  *
  * Creates a new image with the specified width, height, and type.
  *
- * Creates a new image, undisplayed with the specified extents and
+ * Creates a new image, undisplayed, with the specified extents and
  * type. A layer should be created and added before this image is
  * displayed, or subsequent calls to gimp_display_new() with this image
  * as an argument will fail. Layers can be created using the
  * gimp_layer_new() commands. They can be added to an image using the
  * gimp_image_insert_layer() command.
+ * 
+ * If your image's type if INDEXED, a colormap must also be added with
+ * gimp_image_set_colormap(). An indexed image without a colormap will
+ * output unexpected colors.
  *
  * Returns: The ID of the newly created image.
  **/
diff --git a/tools/pdbgen/pdb/image.pdb b/tools/pdbgen/pdb/image.pdb
index f75fd94..50a9342 100644
--- a/tools/pdbgen/pdb/image.pdb
+++ b/tools/pdbgen/pdb/image.pdb
@@ -86,12 +86,17 @@ sub image_new {
     $blurb = 'Creates a new image with the specified width, height, and type.';
 
     $help = <<'HELP';
-Creates a new image, undisplayed with the specified extents and
+Creates a new image, undisplayed, with the specified extents and
 type. A layer should be created and added before this image is
 displayed, or subsequent calls to gimp_display_new() with this image
 as an argument will fail. Layers can be created using the
 gimp_layer_new() commands. They can be added to an image using the
 gimp_image_insert_layer() command.
+
+
+If your image's type if INDEXED, a colormap must also be added with
+gimp_image_set_colormap(). An indexed image without a colormap will
+output unexpected colors.
 HELP
 
     &std_pdb_misc;


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]