summaryrefslogtreecommitdiff
path: root/src/lib/elementary/elm_mapbuf_eo.legacy.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/elementary/elm_mapbuf_eo.legacy.h')
-rw-r--r--src/lib/elementary/elm_mapbuf_eo.legacy.h181
1 files changed, 181 insertions, 0 deletions
diff --git a/src/lib/elementary/elm_mapbuf_eo.legacy.h b/src/lib/elementary/elm_mapbuf_eo.legacy.h
new file mode 100644
index 0000000..c139e1d
--- /dev/null
+++ b/src/lib/elementary/elm_mapbuf_eo.legacy.h
@@ -0,0 +1,181 @@
1#ifndef _ELM_MAPBUF_EO_LEGACY_H_
2#define _ELM_MAPBUF_EO_LEGACY_H_
3
4#ifndef _ELM_MAPBUF_EO_CLASS_TYPE
5#define _ELM_MAPBUF_EO_CLASS_TYPE
6
7typedef Eo Elm_Mapbuf;
8
9#endif
10
11#ifndef _ELM_MAPBUF_EO_TYPES
12#define _ELM_MAPBUF_EO_TYPES
13
14
15#endif
16
17/**
18 * @brief Set or unset auto flag for map rendering.
19 *
20 * When a ampbuf object has "auto mode" enabled, then it will enable and
21 * disable map mode based on current visibility. Mapbuf will track if you show
22 * or hide it AND if the object is inside the canvas viewport or not when it is
23 * moved or resized. Note that if you turn automode off, then map mode will be
24 * in a disabled state at this point. When you turn it on for the first time,
25 * the current state will be evaluated base on current properties of the mapbuf
26 * object.
27 *
28 * Auto mode is disabled by default.
29 *
30 * @param[in] obj The object.
31 * @param[in] on The auto mode state.
32 *
33 * @ingroup Elm_Mapbuf_Group
34 */
35EAPI void elm_mapbuf_auto_set(Elm_Mapbuf *obj, Eina_Bool on);
36
37/**
38 * @brief Get a value whether auto mode is enabled or not.
39 *
40 * @param[in] obj The object.
41 *
42 * @return The auto mode state.
43 *
44 * @ingroup Elm_Mapbuf_Group
45 */
46EAPI Eina_Bool elm_mapbuf_auto_get(const Elm_Mapbuf *obj);
47
48/**
49 * @brief Enable or disable smooth map rendering.
50 *
51 * This sets smoothing for map rendering. If the object is a type that has its
52 * own smoothing settings, then both the smooth settings for this object and
53 * the map must be turned off.
54 *
55 * By default smooth maps are enabled.
56 *
57 * @param[in] obj The object.
58 * @param[in] smooth The smooth mode state.
59 *
60 * @ingroup Elm_Mapbuf_Group
61 */
62EAPI void elm_mapbuf_smooth_set(Elm_Mapbuf *obj, Eina_Bool smooth);
63
64/**
65 * @brief Get a value whether smooth map rendering is enabled or not.
66 *
67 * @param[in] obj The object.
68 *
69 * @return The smooth mode state.
70 *
71 * @ingroup Elm_Mapbuf_Group
72 */
73EAPI Eina_Bool elm_mapbuf_smooth_get(const Elm_Mapbuf *obj);
74
75/**
76 * @brief Set or unset alpha flag for map rendering.
77 *
78 * This sets alpha flag for map rendering. If the object is a type that has its
79 * own alpha settings, then this will take precedence. Only image objects have
80 * this currently. It stops alpha blending of the map area, and is useful if
81 * you know the object and/or all sub-objects is 100% solid.
82 *
83 * Alpha is enabled by default.
84 *
85 * @param[in] obj The object.
86 * @param[in] alpha The alpha state.
87 *
88 * @ingroup Elm_Mapbuf_Group
89 */
90EAPI void elm_mapbuf_alpha_set(Elm_Mapbuf *obj, Eina_Bool alpha);
91
92/**
93 * @brief Get a value whether alpha blending is enabled or not.
94 *
95 * @param[in] obj The object.
96 *
97 * @return The alpha state.
98 *
99 * @ingroup Elm_Mapbuf_Group
100 */
101EAPI Eina_Bool elm_mapbuf_alpha_get(const Elm_Mapbuf *obj);
102
103/**
104 * @brief Enable or disable the map.
105 *
106 * This enables the map that is set or disables it. On enable, the object
107 * geometry will be saved, and the new geometry will change (position and size)
108 * to reflect the map geometry set.
109 *
110 * Also, when enabled, alpha and smooth states will be used, so if the content
111 * isn't solid, alpha should be enabled, for example, otherwise a black
112 * rectangle will fill the content.
113 *
114 * When disabled, the stored map will be freed and geometry prior to enabling
115 * the map will be restored.
116 *
117 * It's disabled by default.
118 *
119 * @param[in] obj The object.
120 * @param[in] enabled The enabled state.
121 *
122 * @ingroup Elm_Mapbuf_Group
123 */
124EAPI void elm_mapbuf_enabled_set(Elm_Mapbuf *obj, Eina_Bool enabled);
125
126/**
127 * @brief Get a value whether map is enabled or not.
128 *
129 * @param[in] obj The object.
130 *
131 * @return The enabled state.
132 *
133 * @ingroup Elm_Mapbuf_Group
134 */
135EAPI Eina_Bool elm_mapbuf_enabled_get(const Elm_Mapbuf *obj);
136
137/**
138 * @brief The color of a point (vertex) in the mapbuf.
139 *
140 * This represents the color of the vertex in the mapbuf. Colors will be
141 * linearly interpolated between vertex points through the mapbuf. Color will
142 * multiply the "texture" pixels (like GL_MODULATE in OpenGL). The default
143 * color of a vertex in a mapbuf is white solid (255, 255, 255, 255) which
144 * means it will have no effect on modifying the texture pixels.
145 *
146 * @param[in] obj The object.
147 * @param[in] idx Index of point to change, from 0 to 3.
148 * @param[in] r Red (0 - 255)
149 * @param[in] g Green (0 - 255)
150 * @param[in] b Blue (0 - 255)
151 * @param[in] a Alpha (0 - 255)
152 *
153 * @since 1.9
154 *
155 * @ingroup Elm_Mapbuf_Group
156 */
157EAPI void elm_mapbuf_point_color_set(Elm_Mapbuf *obj, int idx, int r, int g, int b, int a);
158
159/**
160 * @brief The color of a point (vertex) in the mapbuf.
161 *
162 * This represents the color of the vertex in the mapbuf. Colors will be
163 * linearly interpolated between vertex points through the mapbuf. Color will
164 * multiply the "texture" pixels (like GL_MODULATE in OpenGL). The default
165 * color of a vertex in a mapbuf is white solid (255, 255, 255, 255) which
166 * means it will have no effect on modifying the texture pixels.
167 *
168 * @param[in] obj The object.
169 * @param[in] idx Index of point to change, from 0 to 3.
170 * @param[out] r Red (0 - 255)
171 * @param[out] g Green (0 - 255)
172 * @param[out] b Blue (0 - 255)
173 * @param[out] a Alpha (0 - 255)
174 *
175 * @since 1.9
176 *
177 * @ingroup Elm_Mapbuf_Group
178 */
179EAPI void elm_mapbuf_point_color_get(const Elm_Mapbuf *obj, int idx, int *r, int *g, int *b, int *a);
180
181#endif