[gimp] libgimpbase: update gimp_unit_get_digits() description...



commit 695a1c26aa096d9125e696f1468cfaf54decc1ff
Author: Jehan <jehan girinstud io>
Date:   Sat May 6 22:36:23 2017 +0200

    libgimpbase: update gimp_unit_get_digits() description...
    
    ... to favor the usage of gimp_unit_get_scaled_digits() when
    appropriate.

 libgimpbase/gimpunit.c |    5 +++++
 1 files changed, 5 insertions(+), 0 deletions(-)
---
diff --git a/libgimpbase/gimpunit.c b/libgimpbase/gimpunit.c
index 2b6ad57..824fdbb 100644
--- a/libgimpbase/gimpunit.c
+++ b/libgimpbase/gimpunit.c
@@ -244,6 +244,11 @@ gimp_unit_get_factor (GimpUnit unit)
  * Built-in units' accuracy is approximately the same as an inch with
  * two digits. User-defined units can suggest a different accuracy.
  *
+ * Note: the value is as-set by defaults or by the user and does not
+ * necessary provide enough precision on high-resolution images.
+ * When the information is needed for a specific image, the use of
+ * gimp_unit_get_scaled_digits() may be more appropriate.
+ *
  * Returns 0 for @unit == GIMP_UNIT_PIXEL.
  *
  * Returns: The suggested number of digits.


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