Tizen 2.4.0 rev3 SDK Public Release

[framework/graphics/dali.git] / dali / public-api / images / image-operations.h

diff --git a/dali/public-api/images/image-operations.h b/dali/public-api/images/image-operations.h
index c84d4db..e30c9ed 100644 (file)
--- a/dali/public-api/images/image-operations.h
+++ b/dali/public-api/images/image-operations.h
@@ -51,17 +51,28 @@ namespace FittingMode
 {
   enum Type
   {
-    SHRINK_TO_FIT, ///< Fit full image inside desired width & height, potentially not
-                   ///  filling one of either the desired image width or height with
-                   ///  pixels.
-    SCALE_TO_FILL, ///< Image fills whole desired width & height with image data. The
-                   ///  image is centred in the desired dimensions, exactly touching
-                   ///  in one dimension, with image regions outside the other desired
-                   ///  dimension cropped away.
-    FIT_WIDTH,     ///< Image fills whole width. Height is scaled proportionately to
-                   ///  maintain aspect ratio.
-    FIT_HEIGHT     ///< Image fills whole height. Width is scaled proportionately to
-                   ///  maintain aspect ratio.
+    /// @brief Fit full image inside desired width & height, potentially not
+    /// filling one of either the desired image width or height with
+    /// pixels.
+    /// @since_tizen 2.4
+    SHRINK_TO_FIT,
+
+    /// @brief Image fills whole desired width & height with image data. The
+    /// image is centred in the desired dimensions, exactly touching
+    /// in one dimension, with image regions outside the other desired
+    /// dimension cropped away.
+    /// @since_tizen 2.4
+    SCALE_TO_FILL,
+
+    /// @brief Image fills whole width. Height is scaled proportionately to
+    /// maintain aspect ratio.
+    /// @since_tizen 2.4
+    FIT_WIDTH,
+
+    /// @brief Image fills whole height. Width is scaled proportionately to
+    /// maintain aspect ratio.
+    /// @since_tizen 2.4
+    FIT_HEIGHT
   };
   const Type DEFAULT = SHRINK_TO_FIT;
 }
@@ -82,24 +93,44 @@ namespace SamplingMode
 {
   enum Type
   {
-    BOX,              ///< Iteratively box filter to generate an image of 1/2, 1/4,
-                      ///  1/8, etc width and height and approximately the desired
-                      ///  size. This is the default.
-    NEAREST,          ///< For each output pixel, read one input pixel.
-    LINEAR,           ///< For each output pixel, read a quad of four input pixels
-                      ///  and write a weighted average of them.
-    BOX_THEN_NEAREST, ///< Iteratively box filter to generate an image of 1/2, 1/4,
-                      ///  1/8 etc width and height and approximately the desired
-                      ///  size, then for each output pixel, read one pixel from the
-                      ///  last level of box filtering.
-    BOX_THEN_LINEAR,  ///< Iteratively box filter to almost the right size, then for
-                      ///  each output pixel, read four pixels from the last level of
-                      ///  box filtering and write their weighted average.
-    NO_FILTER,        ///< No filtering is performed. If the SCALE_TO_FILL scaling mode
-                      ///  is enabled, the borders of the image may be trimmed to
-                      ///  match the aspect ratio of the desired dimensions.
-    DONT_CARE         ///< For caching algorithms where a client strongly prefers a
-                      ///  cache-hit to reuse a cached image.
+    /// @brief Iteratively box filter to generate an image of 1/2, 1/4,
+    /// 1/8, etc width and height and approximately the desired
+    /// size. This is the default.
+    /// @since_tizen 2.4
+    BOX,
+
+    /// @brief For each output pixel, read one input pixel.
+    /// @since_tizen 2.4
+    NEAREST,
+
+    /// @brief For each output pixel, read a quad of four input pixels
+    /// and write a weighted average of them.
+    /// @since_tizen 2.4
+    LINEAR,
+
+    /// @brief Iteratively box filter to generate an image of 1/2, 1/4,
+    /// 1/8 etc width and height and approximately the desired
+    /// size, then for each output pixel, read one pixel from the
+    /// last level of box filtering.
+    /// @since_tizen 2.4
+    BOX_THEN_NEAREST,
+
+    /// @brief Iteratively box filter to almost the right size, then for
+    /// each output pixel, read four pixels from the last level of
+    /// box filtering and write their weighted average.
+    /// @since_tizen 2.4
+    BOX_THEN_LINEAR,
+
+    /// @brief No filtering is performed. If the SCALE_TO_FILL scaling mode
+    /// is enabled, the borders of the image may be trimmed to
+    /// match the aspect ratio of the desired dimensions.
+    /// @since_tizen 2.4
+    NO_FILTER,
+
+    /// @brief For caching algorithms where a client strongly prefers a
+    /// cache-hit to reuse a cached image.
+    /// @since_tizen 2.4
+    DONT_CARE
   };
   const Type DEFAULT = BOX;
 }