diff options
author | Jean-Philippe Andre <jp.andre@samsung.com> | 2015-05-26 14:58:56 +0900 |
---|---|---|
committer | Jean-Philippe Andre <jp.andre@samsung.com> | 2015-06-25 14:36:08 +0900 |
commit | ed09b3af6db3db98630b365fe557fa7235d2988d (patch) | |
tree | 49bf9914c6ef9a57e8b5a213635b54c72ccf2142 | |
parent | 148a886cc78281028a7877e05d0d0290c44ee111 (diff) |
Evas filters: Add some @internal flags to the doxygen docs
-rw-r--r-- | src/lib/evas/include/evas_filter.h | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/src/lib/evas/include/evas_filter.h b/src/lib/evas/include/evas_filter.h index b8b23616ad..c537ae288c 100644 --- a/src/lib/evas/include/evas_filter.h +++ b/src/lib/evas/include/evas_filter.h | |||
@@ -52,6 +52,7 @@ typedef void (* Evas_Filter_Cb) (Evas_Filter_Context *ctx, void *data, Eina_Bool | |||
52 | #define EVAS_FILTER_BUFFER_INPUT_ID 1 | 52 | #define EVAS_FILTER_BUFFER_INPUT_ID 1 |
53 | #define EVAS_FILTER_BUFFER_OUTPUT_ID 2 | 53 | #define EVAS_FILTER_BUFFER_OUTPUT_ID 2 |
54 | 54 | ||
55 | /** @internal */ | ||
55 | enum _Evas_Filter_Mode | 56 | enum _Evas_Filter_Mode |
56 | { | 57 | { |
57 | EVAS_FILTER_MODE_BLEND, /**< Blend with current context render_op */ | 58 | EVAS_FILTER_MODE_BLEND, /**< Blend with current context render_op */ |
@@ -66,6 +67,7 @@ enum _Evas_Filter_Mode | |||
66 | EVAS_FILTER_MODE_LAST | 67 | EVAS_FILTER_MODE_LAST |
67 | }; | 68 | }; |
68 | 69 | ||
70 | /** @internal */ | ||
69 | enum _Evas_Filter_Blur_Type | 71 | enum _Evas_Filter_Blur_Type |
70 | { | 72 | { |
71 | EVAS_FILTER_BLUR_DEFAULT = 0x0, // Default blur (GAUSSIAN or series of BOX) | 73 | EVAS_FILTER_BLUR_DEFAULT = 0x0, // Default blur (GAUSSIAN or series of BOX) |
@@ -74,6 +76,7 @@ enum _Evas_Filter_Blur_Type | |||
74 | EVAS_FILTER_BLUR_LAST, | 76 | EVAS_FILTER_BLUR_LAST, |
75 | }; | 77 | }; |
76 | 78 | ||
79 | /** @internal */ | ||
77 | enum _Evas_Filter_Channel | 80 | enum _Evas_Filter_Channel |
78 | { | 81 | { |
79 | EVAS_FILTER_CHANNEL_ALPHA = 0, | 82 | EVAS_FILTER_CHANNEL_ALPHA = 0, |
@@ -83,6 +86,7 @@ enum _Evas_Filter_Channel | |||
83 | EVAS_FILTER_CHANNEL_RGB = 4 | 86 | EVAS_FILTER_CHANNEL_RGB = 4 |
84 | }; | 87 | }; |
85 | 88 | ||
89 | /** @internal */ | ||
86 | enum _Evas_Filter_Displacement_Flags | 90 | enum _Evas_Filter_Displacement_Flags |
87 | { | 91 | { |
88 | EVAS_FILTER_DISPLACE_NEAREST = 0x0, /**< Interpolate between pixels (linear interpolation) */ | 92 | EVAS_FILTER_DISPLACE_NEAREST = 0x0, /**< Interpolate between pixels (linear interpolation) */ |
@@ -92,12 +96,14 @@ enum _Evas_Filter_Displacement_Flags | |||
92 | EVAS_FILTER_DISPLACE_BITMASK = 0x3 | 96 | EVAS_FILTER_DISPLACE_BITMASK = 0x3 |
93 | }; | 97 | }; |
94 | 98 | ||
99 | /** @internal */ | ||
95 | enum _Evas_Filter_Bump_Flags | 100 | enum _Evas_Filter_Bump_Flags |
96 | { | 101 | { |
97 | EVAS_FILTER_BUMP_NORMAL = 0x0, | 102 | EVAS_FILTER_BUMP_NORMAL = 0x0, |
98 | EVAS_FILTER_BUMP_COMPENSATE = 0x1 /**< Compensate for darkening (diffuse light) or brightening (specular light) of zero gradient surfaces */ | 103 | EVAS_FILTER_BUMP_COMPENSATE = 0x1 /**< Compensate for darkening (diffuse light) or brightening (specular light) of zero gradient surfaces */ |
99 | }; | 104 | }; |
100 | 105 | ||
106 | /** @internal */ | ||
101 | enum _Evas_Filter_Fill_Mode | 107 | enum _Evas_Filter_Fill_Mode |
102 | { | 108 | { |
103 | EVAS_FILTER_FILL_MODE_NONE = 0x0, | 109 | EVAS_FILTER_FILL_MODE_NONE = 0x0, |
@@ -111,6 +117,7 @@ enum _Evas_Filter_Fill_Mode | |||
111 | EVAS_FILTER_FILL_MODE_STRETCH_XY = EVAS_FILTER_FILL_MODE_STRETCH_X | EVAS_FILTER_FILL_MODE_STRETCH_Y | 117 | EVAS_FILTER_FILL_MODE_STRETCH_XY = EVAS_FILTER_FILL_MODE_STRETCH_X | EVAS_FILTER_FILL_MODE_STRETCH_Y |
112 | }; | 118 | }; |
113 | 119 | ||
120 | /** @internal */ | ||
114 | enum _Evas_Filter_Transform_Flags | 121 | enum _Evas_Filter_Transform_Flags |
115 | { | 122 | { |
116 | EVAS_FILTER_TRANSFORM_VFLIP = 1 | 123 | EVAS_FILTER_TRANSFORM_VFLIP = 1 |
@@ -156,6 +163,7 @@ Eina_Bool evas_filter_target_set(Evas_Filter_Context *ctx, void * | |||
156 | * @param oy Y offset in the destination buffer | 163 | * @param oy Y offset in the destination buffer |
157 | * @param fillmode Specifies whether to repeat or stretch the input onto its destination, and on which axes | 164 | * @param fillmode Specifies whether to repeat or stretch the input onto its destination, and on which axes |
158 | * @return Filter command ID or -1 in case of error | 165 | * @return Filter command ID or -1 in case of error |
166 | * @internal | ||
159 | */ | 167 | */ |
160 | int evas_filter_command_blend_add(Evas_Filter_Context *ctx, void *draw_context, int inbuf, int outbuf, int ox, int oy, Evas_Filter_Fill_Mode fillmode); | 168 | int evas_filter_command_blend_add(Evas_Filter_Context *ctx, void *draw_context, int inbuf, int outbuf, int ox, int oy, Evas_Filter_Fill_Mode fillmode); |
161 | 169 | ||
@@ -172,6 +180,7 @@ int evas_filter_command_blend_add(Evas_Filter_Context *ctx, | |||
172 | * @param oy Y offset in the destination buffer | 180 | * @param oy Y offset in the destination buffer |
173 | * @param count Number of times to repeat the operation (used for smooth fast blurs with box blur) | 181 | * @param count Number of times to repeat the operation (used for smooth fast blurs with box blur) |
174 | * @return Filter command ID or -1 in case of error | 182 | * @return Filter command ID or -1 in case of error |
183 | * @internal | ||
175 | */ | 184 | */ |
176 | int evas_filter_command_blur_add(Evas_Filter_Context *ctx, void *draw_context, int inbuf, int outbuf, Evas_Filter_Blur_Type type, int dx, int dy, int ox, int oy, int count); | 185 | int evas_filter_command_blur_add(Evas_Filter_Context *ctx, void *draw_context, int inbuf, int outbuf, Evas_Filter_Blur_Type type, int dx, int dy, int ox, int oy, int count); |
177 | 186 | ||
@@ -182,6 +191,7 @@ int evas_filter_command_blur_add(Evas_Filter_Context *ctx, | |||
182 | * @param buf Buffer: ALPHA or RGBA | 191 | * @param buf Buffer: ALPHA or RGBA |
183 | * @return Filter command ID or -1 in case of error | 192 | * @return Filter command ID or -1 in case of error |
184 | * @note The current draw context's render operation is ignored (always uses COPY mode). | 193 | * @note The current draw context's render operation is ignored (always uses COPY mode). |
194 | * @internal | ||
185 | */ | 195 | */ |
186 | int evas_filter_command_fill_add(Evas_Filter_Context *ctx, void *draw_context, int buf); | 196 | int evas_filter_command_fill_add(Evas_Filter_Context *ctx, void *draw_context, int buf); |
187 | 197 | ||
@@ -194,6 +204,7 @@ int evas_filter_command_fill_add(Evas_Filter_Context *ctx, | |||
194 | * @param curve The data points to use, must contain 256 values. | 204 | * @param curve The data points to use, must contain 256 values. |
195 | * @param channel Which channel to apply the curve (red, green, blue, alpha or RGB) | 205 | * @param channel Which channel to apply the curve (red, green, blue, alpha or RGB) |
196 | * @return Filter command ID or -1 in case of error | 206 | * @return Filter command ID or -1 in case of error |
207 | * @internal | ||
197 | */ | 208 | */ |
198 | int evas_filter_command_curve_add(Evas_Filter_Context *ctx, void *draw_context, int inbuf, int outbuf, DATA8 *curve /* 256 elements */, Evas_Filter_Channel channel); | 209 | int evas_filter_command_curve_add(Evas_Filter_Context *ctx, void *draw_context, int inbuf, int outbuf, DATA8 *curve /* 256 elements */, Evas_Filter_Channel channel); |
199 | 210 | ||
@@ -206,6 +217,7 @@ int evas_filter_command_curve_add(Evas_Filter_Context *ctx, | |||
206 | * @param radius Number of pixels to grow by. If negative, shrink instead of grow | 217 | * @param radius Number of pixels to grow by. If negative, shrink instead of grow |
207 | * @param smooth Use smooth blur and curve for grow (default: true) | 218 | * @param smooth Use smooth blur and curve for grow (default: true) |
208 | * @return Filter command ID or -1 in case of error | 219 | * @return Filter command ID or -1 in case of error |
220 | * @internal | ||
209 | */ | 221 | */ |
210 | int evas_filter_command_grow_add(Evas_Filter_Context *ctx, void *draw_context, int inbuf, int outbuf, int radius, Eina_Bool smooth); | 222 | int evas_filter_command_grow_add(Evas_Filter_Context *ctx, void *draw_context, int inbuf, int outbuf, int radius, Eina_Bool smooth); |
211 | 223 | ||
@@ -220,6 +232,7 @@ int evas_filter_command_grow_add(Evas_Filter_Context *ctx, | |||
220 | * @param intensity Maximum offset possible, if the map's value is maximal at this point (ie. 0 or 255) | 232 | * @param intensity Maximum offset possible, if the map's value is maximal at this point (ie. 0 or 255) |
221 | * @param fillmode Specifies how to repeat and stretch the map to fit the target size | 233 | * @param fillmode Specifies how to repeat and stretch the map to fit the target size |
222 | * @return Filter command ID or -1 in case of error | 234 | * @return Filter command ID or -1 in case of error |
235 | * @internal | ||
223 | */ | 236 | */ |
224 | int evas_filter_command_displacement_map_add(Evas_Filter_Context *ctx, void *draw_context, int inbuf, int outbuf, int dispbuf, Evas_Filter_Displacement_Flags flags, int intensity, Evas_Filter_Fill_Mode fillmode); | 237 | int evas_filter_command_displacement_map_add(Evas_Filter_Context *ctx, void *draw_context, int inbuf, int outbuf, int dispbuf, Evas_Filter_Displacement_Flags flags, int intensity, Evas_Filter_Fill_Mode fillmode); |
225 | 238 | ||
@@ -233,6 +246,7 @@ int evas_filter_command_displacement_map_add(Evas_Filter_Co | |||
233 | * @param fillmode Specifies how to repeat and stretch the mask to fit the target size | 246 | * @param fillmode Specifies how to repeat and stretch the mask to fit the target size |
234 | * @return Filter command ID or -1 in case of error | 247 | * @return Filter command ID or -1 in case of error |
235 | * @note For the moment, inbuf can only be ALPHA, and output must be RGBA if mask is RGBA as well | 248 | * @note For the moment, inbuf can only be ALPHA, and output must be RGBA if mask is RGBA as well |
249 | * @internal | ||
236 | */ | 250 | */ |
237 | int evas_filter_command_mask_add(Evas_Filter_Context *ctx, void *draw_context, int inbuf, int maskbuf, int outbuf, Evas_Filter_Fill_Mode fillmode); | 251 | int evas_filter_command_mask_add(Evas_Filter_Context *ctx, void *draw_context, int inbuf, int maskbuf, int outbuf, Evas_Filter_Fill_Mode fillmode); |
238 | 252 | ||
@@ -253,6 +267,7 @@ int evas_filter_command_mask_add(Evas_Filter_Context *ctx, | |||
253 | * @param flags Optional flags: compensation for darkening | 267 | * @param flags Optional flags: compensation for darkening |
254 | * @param fillmode Specifies how to repeat and stretch the map to fit the target size | 268 | * @param fillmode Specifies how to repeat and stretch the map to fit the target size |
255 | * @return Filter command ID or -1 in case of error | 269 | * @return Filter command ID or -1 in case of error |
270 | * @internal | ||
256 | */ | 271 | */ |
257 | int evas_filter_command_bump_map_add(Evas_Filter_Context *ctx, void *draw_context, int inbuf, int bumpbuf, int outbuf, float azimuth, float elevation, float depth, float specular_factor, DATA32 black, DATA32 color, DATA32 white, Evas_Filter_Bump_Flags flags, Evas_Filter_Fill_Mode fillmode); | 272 | int evas_filter_command_bump_map_add(Evas_Filter_Context *ctx, void *draw_context, int inbuf, int bumpbuf, int outbuf, float azimuth, float elevation, float depth, float specular_factor, DATA32 black, DATA32 color, DATA32 white, Evas_Filter_Bump_Flags flags, Evas_Filter_Fill_Mode fillmode); |
258 | 273 | ||
@@ -266,6 +281,7 @@ int evas_filter_command_bump_map_add(Evas_Filter_Context *c | |||
266 | * @param ox X offset | 281 | * @param ox X offset |
267 | * @param oy Y offset | 282 | * @param oy Y offset |
268 | * @return Filter command ID or -1 in case of error | 283 | * @return Filter command ID or -1 in case of error |
284 | * @internal | ||
269 | */ | 285 | */ |
270 | int evas_filter_command_transform_add(Evas_Filter_Context *ctx, void *draw_context, int inbuf, int outbuf, Evas_Filter_Transform_Flags flags, int ox, int oy); | 286 | int evas_filter_command_transform_add(Evas_Filter_Context *ctx, void *draw_context, int inbuf, int outbuf, Evas_Filter_Transform_Flags flags, int ox, int oy); |
271 | 287 | ||