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  * @addtogroup dali-core-images
  30  * @{
  31  */
  32
  33 /**
  34  * @brief The integer dimensions of an image or a region of an image packed into
  35  *        16 bits per component.
  36  *
  37  * This can only be used for images of up to 65535 x 65535 pixels.
  38  */
  39 typedef Uint16Pair ImageDimensions;
  40
  41 /**
  42  * @brief Fitting options, used when resizing images to fit desired dimensions.
  43  *
  44  * A fitting mode controls the region of a loaded image to be mapped to the
  45  * desired image rectangle.
  46  * All fitting modes preserve the aspect ratio of the image contents.
  47  */
  48 namespace FittingMode
  49 {
  50   enum Type
  51   {
  52     SHRINK_TO_FIT, ///< Fit full image inside desired width & height, potentially not
  53                    ///  filling one of either the desired image width or height with
  54                    ///  pixels.
  55     SCALE_TO_FILL, ///< Image fills whole desired width & height with image data. The
  56                    ///  image is centred in the desired dimensions, exactly touching
  57                    ///  in one dimension, with image regions outside the other desired
  58                    ///  dimension cropped away.
  59     FIT_WIDTH,     ///< Image fills whole width. Height is scaled proportionately to
  60                    ///  maintain aspect ratio.
  61     FIT_HEIGHT     ///< Image fills whole height. Width is scaled proportionately to
  62                    ///  maintain aspect ratio.
  63   };
  64   const Type DEFAULT = SHRINK_TO_FIT;
  65 }
  66
  67 /**
  68  * @brief Filtering options, used when resizing images to sample original pixels.
  69  *
  70  * A SamplingMode controls how pixels in an input image are sampled and
  71  * combined to generate each pixel of a destination image during a scaling.
  72  *
  73  * NoFilter and Box modes do not guarantee that the output pixel array
  74  * exactly matches the rectangle specified by the desired dimensions and
  75  * FittingMode, but all other filter modes do if the desired dimensions are
  76  * `<=` the raw dimensions of the input image file.
  77  */
  78 namespace SamplingMode
  79 {
  80   enum Type
  81   {
  82     BOX,              ///< Iteratively box filter to generate an image of 1/2, 1/4,
  83                       ///  1/8, etc width and height and approximately the desired
  84                       ///  size. This is the default.
  85     NEAREST,          ///< For each output pixel, read one input pixel.
  86     LINEAR,           ///< For each output pixel, read a quad of four input pixels
  87                       ///  and write a weighted average of them.
  88     BOX_THEN_NEAREST, ///< Iteratively box filter to generate an image of 1/2, 1/4,
  89                       ///  1/8 etc width and height and approximately the desired
  90                       ///  size, then for each output pixel, read one pixel from the
  91                       ///  last level of box filtering.
  92     BOX_THEN_LINEAR,  ///< Iteratively box filter to almost the right size, then for
  93                       ///  each output pixel, read four pixels from the last level of
  94                       ///  box filtering and write their weighted average.
  95     NO_FILTER,        ///< No filtering is performed. If the SCALE_TO_FILL scaling mode
  96                       ///  is enabled, the borders of the image may be trimmed to
  97                       ///  match the aspect ratio of the desired dimensions.
  98     DONT_CARE         ///< For caching algorithms where a client strongly prefers a
  99                       ///  cache-hit to reuse a cached image.
 100   };
 101   const Type DEFAULT = BOX;
 102 }
 103
 104 /**
 105  * @}
 106  */
 107 } // namespace Dali
 108
 109 #endif // __DALI_IMAGE_OPERATIONS_H__