add doc for API reference
[platform/core/uifw/dali-core.git] / dali / public-api / actors / sampling.h
1 #ifndef __DALI_SAMPLING_H__
2 #define __DALI_SAMPLING_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 // INTERNAL INCLUDES
22 #include <dali/public-api/common/dali-common.h>
23
24 namespace Dali
25 {
26 /**
27  * @addtogroup dali_core_actors
28  * @{
29  */
30
31 namespace FilterMode
32 {
33 /**
34  * @brief Enumeration for texture filtering mode.
35  * @SINCE_1_0.0
36  */
37 enum Type
38 {
39   /**
40    * @brief Use GL defaults (minification NEAREST_MIPMAP_LINEAR, magnification LINEAR).
41    * @SINCE_1_0.0
42    */
43   NONE = 0,
44
45   /**
46    * @brief Use Dali defaults (minification LINEAR, magnification LINEAR).
47    * @SINCE_1_0.0
48    */
49   DEFAULT,
50
51   /**
52    * @brief Filter nearest.
53    * @SINCE_1_0.0
54    */
55   NEAREST,
56
57   /**
58    * @brief Filter linear.
59    * @SINCE_1_0.0
60    */
61   LINEAR,
62
63   /**
64    * @brief Chooses the mipmap that most closely matches the size of the pixel being
65    * textured and uses the GL_NEAREST criterion (the texture element closest to
66    * the specified texture coordinates) to produce a texture value.
67    * @SINCE_1_1.38
68    */
69   NEAREST_MIPMAP_NEAREST,
70
71   /**
72    * @brief Chooses the mipmap that most closely matches the size of the pixel being textured
73    * and uses the GL_LINEAR criterion (a weighted average of the four texture elements
74    * that are closest to the specified texture coordinates) to produce a texture value.
75    * @SINCE_1_1.38
76    */
77   LINEAR_MIPMAP_NEAREST,
78
79   /**
80    * @brief Chooses the two mipmaps that most closely match the size of the pixel being textured
81    * and uses the GL_NEAREST criterion (the texture element closest to the specified texture
82    * coordinates ) to produce a texture value from each mipmap. The final texture value is a
83    * weighted average of those two values.
84    * @SINCE_1_1.38
85    */
86   NEAREST_MIPMAP_LINEAR,
87
88   /**
89    * @brief Chooses the two mipmaps that most closely match the size of the pixel being textured and
90    * uses the GL_LINEAR criterion (a weighted average of the texture elements that are closest
91    * to the specified texture coordinates) to produce a texture value from each mipmap. The final
92    * texture value is a weighted average of those two values.
93    * @SINCE_1_1.38
94    */
95   LINEAR_MIPMAP_LINEAR
96
97 };
98
99 } //namespace FilterMode
100
101 namespace WrapMode
102 {
103 /**
104  * @brief Enumeration for Wrap mode.
105  * @SINCE_1_0.0
106  */
107 enum Type
108 {
109   DEFAULT = 0,    ///< Clamp to edge @SINCE_1_0.0
110   CLAMP_TO_EDGE,  ///< Clamp to edge @SINCE_1_0.0
111   REPEAT,         ///< Repeat @SINCE_1_0.0
112   MIRRORED_REPEAT ///< Mirrored repeat @SINCE_1_0.0
113 };
114
115 } //namespace WrapMode
116
117 /**
118  * @}
119  */
120 } // namespace Dali
121
122 #endif // __DALI_SAMPLING_H__