2 * @defgroup Caches Caches
4 * These are functions which let one fine-tune some cache values for
5 * Elementary applications, thus allowing for performance adjustments.
11 * @brief Flush all caches.
13 * Frees all data that was in cache and is not currently being used to reduce
14 * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
15 * to calling all of the following functions:
16 * @li edje_file_cache_flush()
17 * @li edje_collection_cache_flush()
18 * @li eet_clearcache()
19 * @li evas_image_cache_flush()
20 * @li evas_font_cache_flush()
21 * @li evas_render_dump()
22 * @note Evas caches are flushed for every canvas associated with a window.
26 EAPI void elm_cache_all_flush(void);
29 * Get the configured cache flush interval time
31 * This gets the globally configured cache flush interval time, in
34 * @return The cache flush interval time
37 * @see elm_cache_all_flush()
39 EAPI int elm_cache_flush_interval_get(void);
42 * Set the configured cache flush interval time
44 * This sets the globally configured cache flush interval time, in ticks
46 * @param size The cache flush interval time
49 * @see elm_cache_all_flush()
51 EAPI void elm_cache_flush_interval_set(int size);
54 * Get the configured cache flush enabled state
56 * This gets the globally configured cache flush state - if it is enabled
57 * or not. When cache flushing is enabled, elementary will regularly
58 * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
59 * memory and allow usage to re-seed caches and data in memory where it
60 * can do so. An idle application will thus minimize its memory usage as
61 * data will be freed from memory and not be re-loaded as it is idle and
62 * not rendering or doing anything graphically right now.
64 * @return The cache flush state
67 * @see elm_cache_all_flush()
69 EAPI Eina_Bool elm_cache_flush_enabled_get(void);
72 * Set the configured cache flush enabled state
74 * This sets the globally configured cache flush enabled state.
76 * @param enabled The cache flush enabled state
79 * @see elm_cache_all_flush()
81 EAPI void elm_cache_flush_enabled_set(Eina_Bool enabled);
84 * Get the configured font cache size
86 * This gets the globally configured font cache size, in bytes.
88 * @return The font cache size
91 // XXX: how about using elm_cache prefix for all following APIs???
92 EAPI int elm_font_cache_get(void);
95 * Set the configured font cache size
97 * This sets the globally configured font cache size, in bytes
99 * @param size The font cache size
102 EAPI void elm_font_cache_set(int size);
105 * Get the configured image cache size
107 * This gets the globally configured image cache size, in bytes
109 * @return The image cache size
112 EAPI int elm_image_cache_get(void);
115 * Set the configured image cache size
117 * This sets the globally configured image cache size, in bytes
119 * @param size The image cache size
122 EAPI void elm_image_cache_set(int size);
126 * Get the configured edje file cache size.
128 * This gets the globally configured edje file cache size, in number
131 * @return The edje file cache size
134 EAPI int elm_edje_file_cache_get(void);
137 * Set the configured edje file cache size
139 * This sets the globally configured edje file cache size, in number
142 * @param size The edje file cache size
145 EAPI void elm_edje_file_cache_set(int size);
148 * Get the configured edje collections (groups) cache size.
150 * This gets the globally configured edje collections cache size, in
151 * number of collections.
153 * @return The edje collections cache size
156 EAPI int elm_edje_collection_cache_get(void);
159 * Set the configured edje collections (groups) cache size
161 * This sets the globally configured edje collections cache size, in
162 * number of collections.
164 * @param size The edje collections cache size
167 EAPI void elm_edje_collection_cache_set(int size);