dali/public-api/images/image-operations.h

   1 #ifndef __DALI_IMAGE_OPERATIONS_H__
   2 #define __DALI_IMAGE_OPERATIONS_H__
   3
   4 /*
   5  * Copyright (c) 2015 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22
  23 // INTERNAL INCLUDES
  24 #include <dali/public-api/math/uint-16-pair.h>
  25
  26 namespace Dali
  27 {
  28
  29 /**
  30  * @brief The integer dimensions of an image or a region of an image packed into
  31  *        16 bits per component.
  32  *
  33  * This can only be used for images of up to 65535 x 65535 pixels.
  34  */
  35 typedef Uint16Pair ImageDimensions;
  36
  37 /**
  38  * @brief Fitting options, used when resizing images to fit desired dimensions.
  39  *
  40  * A fitting mode controls the region of a loaded image to be mapped to the
  41  * desired image rectangle.
  42  * All fitting modes preserve the aspect ratio of the image contents.
  43  */
  44 namespace FittingMode
  45 {
  46   enum Type
  47   {
  48     SHRINK_TO_FIT, ///< Fit full image inside desired width & height, potentially not
  49                    ///  filling one of either the desired image width or height with
  50                    ///  pixels.
  51     SCALE_TO_FILL, ///< Image fills whole desired width & height with image data. The
  52                    ///  image is centred in the desired dimensions, exactly touching
  53                    ///  in one dimension, with image regions outside the other desired
  54                    ///  dimension cropped away.
  55     FIT_WIDTH,     ///< Image fills whole width. Height is scaled proportionately to
  56                    ///  maintain aspect ratio.
  57     FIT_HEIGHT     ///< Image fills whole height. Width is scaled proportionately to
  58                    ///  maintain aspect ratio.
  59   };
  60   const Type DEFAULT = SHRINK_TO_FIT;
  61 }
  62
  63 /**
  64  * @brief Filtering options, used when resizing images to sample original pixels.
  65  *
  66  * A SamplingMode controls how pixels in an input image are sampled and
  67  * combined to generate each pixel of a destination image during a scaling.
  68  *
  69  * NoFilter and Box modes do not guarantee that the output pixel array
  70  * exactly matches the rectangle specified by the desired dimensions and
  71  * FittingMode, but all other filter modes do if the desired dimensions are
  72  * `<=` the raw dimensions of the input image file.
  73  */
  74 namespace SamplingMode
  75 {
  76   enum Type
  77   {
  78     BOX,              ///< Iteratively box filter to generate an image of 1/2, 1/4,
  79                       ///  1/8, etc width and height and approximately the desired
  80                       ///  size. This is the default.
  81     NEAREST,          ///< For each output pixel, read one input pixel.
  82     LINEAR,           ///< For each output pixel, read a quad of four input pixels
  83                       ///  and write a weighted average of them.
  84     BOX_THEN_NEAREST, ///< Iteratively box filter to generate an image of 1/2, 1/4,
  85                       ///  1/8 etc width and height and approximately the desired
  86                       ///  size, then for each output pixel, read one pixel from the
  87                       ///  last level of box filtering.
  88     BOX_THEN_LINEAR,  ///< Iteratively box filter to almost the right size, then for
  89                       ///  each output pixel, read four pixels from the last level of
  90                       ///  box filtering and write their weighted average.
  91     NO_FILTER,        ///< No filtering is performed. If the SCALE_TO_FILL scaling mode
  92                       ///  is enabled, the borders of the image may be trimmed to
  93                       ///  match the aspect ratio of the desired dimensions.
  94     DONT_CARE         ///< For caching algorithms where a client strongly prefers a
  95                       ///  cache-hit to reuse a cached image.
  96   };
  97   const Type DEFAULT = BOX;
  98 }
  99
 100 } // namespace Dali
 101
 102 #endif // __DALI_IMAGE_OPERATIONS_H__