1 #ifndef __DALI_IMAGE_OPERATIONS_H__
2 #define __DALI_IMAGE_OPERATIONS_H__
5 * Copyright (c) 2015 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
24 #include <dali/public-api/math/uint-16-pair.h>
29 * @addtogroup dali_core_images
34 * @brief The integer dimensions of an image or a region of an image packed into
35 * 16 bits per component.
37 * This can only be used for images of up to 65535 x 65535 pixels.
40 typedef Dali::Uint16Pair ImageDimensions;
43 * @brief Fitting options, used when resizing images to fit desired dimensions.
45 * A fitting mode controls the region of a loaded image to be mapped to the
46 * desired image rectangle.
47 * All fitting modes preserve the aspect ratio of the image contents.
54 SHRINK_TO_FIT, ///< Fit full image inside desired width & height, potentially not @SINCE_1_0.0
55 /// filling one of either the desired image width or height with
57 SCALE_TO_FILL, ///< Image fills whole desired width & height with image data. The @SINCE_1_0.0
58 /// image is centred in the desired dimensions, exactly touching
59 /// in one dimension, with image regions outside the other desired
60 /// dimension cropped away.
61 FIT_WIDTH, ///< Image fills whole width. Height is scaled proportionately to @SINCE_1_0.0
62 /// maintain aspect ratio.
63 FIT_HEIGHT ///< Image fills whole height. Width is scaled proportionately to @SINCE_1_0.0
64 /// maintain aspect ratio.
66 const Type DEFAULT = SHRINK_TO_FIT;
70 * @brief Filtering options, used when resizing images to sample original pixels.
72 * A SamplingMode controls how pixels in an input image are sampled and
73 * combined to generate each pixel of a destination image during a scaling.
75 * NoFilter and Box modes do not guarantee that the output pixel array
76 * exactly matches the rectangle specified by the desired dimensions and
77 * FittingMode, but all other filter modes do if the desired dimensions are
78 * `<=` the raw dimensions of the input image file.
81 namespace SamplingMode
85 BOX, ///< Iteratively box filter to generate an image of 1/2, 1/4, @SINCE_1_0.0
86 /// 1/8, etc width and height and approximately the desired
87 /// size. This is the default.
88 NEAREST, ///< For each output pixel, read one input pixel. @SINCE_1_0.0
89 LINEAR, ///< For each output pixel, read a quad of four input pixels @SINCE_1_0.0
90 /// and write a weighted average of them.
91 BOX_THEN_NEAREST, ///< Iteratively box filter to generate an image of 1/2, 1/4, @SINCE_1_0.0
92 /// 1/8 etc width and height and approximately the desired
93 /// size, then for each output pixel, read one pixel from the
94 /// last level of box filtering.
95 BOX_THEN_LINEAR, ///< Iteratively box filter to almost the right size, then for @SINCE_1_0.0
96 /// each output pixel, read four pixels from the last level of
97 /// box filtering and write their weighted average.
98 NO_FILTER, ///< No filtering is performed. If the SCALE_TO_FILL scaling mode @SINCE_1_0.0
99 /// is enabled, the borders of the image may be trimmed to
100 /// match the aspect ratio of the desired dimensions.
101 DONT_CARE ///< For caching algorithms where a client strongly prefers a @SINCE_1_0.0
102 /// cache-hit to reuse a cached image.
104 const Type DEFAULT = BOX;
112 #endif // __DALI_IMAGE_OPERATIONS_H__