demos/spiv/image_cache.h

   1 /*****************************************************************************
   2  * This file is part of gfxprim library.                                     *
   3  *                                                                           *
   4  * Gfxprim is free software; you can redistribute it and/or                  *
   5  * modify it under the terms of the GNU Lesser General Public                *
   6  * License as published by the Free Software Foundation; either              *
   7  * version 2.1 of the License, or (at your option) any later version.        *
   8  *                                                                           *
   9  * Gfxprim is distributed in the hope that it will be useful,                *
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of            *
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU         *
  12  * Lesser General Public License for more details.                           *
  13  *                                                                           *
  14  * You should have received a copy of the GNU Lesser General Public          *
  15  * License along with gfxprim; if not, write to the Free Software            *
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor,                        *
  17  * Boston, MA  02110-1301  USA                                               *
  18  *                                                                           *
  19  * Copyright (C) 2009-2013 Cyril Hrubis <metan@ucw.cz>                       *
  20  *                                                                           *
  21  *****************************************************************************/
  22
  23  /*
  24
  25    Image loader chache.
  26
  27   */
  28
  29 #ifndef __IMAGE_CACHE_H__
  30 #define __IMAGE_CACHE_H__
  31
  32 struct image_cache;
  33
  34 /*
  35  * Returns size of the ram in kbytes.
  36  */
  37 size_t image_cache_get_ram_size(void);
  38
  39 /*
  40  * Creates an image cache with maximal memory size of max_size_kbytes.
  41  */
  42 struct image_cache *image_cache_create(unsigned int max_size_kbytes);
  43
  44 /*
  45  * Returns cached image, or NULL.
  46  *
  47  * If elevate set and image is found, the image is elevated to the top so
  48  * it has lesser chance of being freed.
  49  */
  50 int image_cache_get(struct image_cache *self, GP_Pixmap **img,
  51                     GP_DataStorage **meta_data, int elevate,
  52                     const char *key);
  53
  54 GP_Pixmap *image_cache_get2(struct image_cache *self, int elevate,
  55                              const char *fmt, ...)
  56                              __attribute__ ((format (printf, 3, 4)));
  57 /*
  58  * Puts an image into a cache.
  59  */
  60 int image_cache_put(struct image_cache *self, GP_Pixmap *img,
  61                     GP_DataStorage *meta_data, const char *key);
  62
  63 int image_cache_put2(struct image_cache *self, GP_Pixmap *img,
  64                      GP_DataStorage *meta_data, const char *fmt, ...)
  65                      __attribute__ ((format (printf, 4, 5)));
  66
  67 /*
  68  * Drop all image in cache.
  69  */
  70 void image_cache_drop(struct image_cache *self);
  71
  72 /*
  73  * Destroys image cache and all it's images.
  74  */
  75 void image_cache_destroy(struct image_cache *self);
  76
  77 /*
  78  * Print the image cache content.
  79  */
  80 void image_cache_print(struct image_cache *self);
  81
  82 #endif /* __IMAGE_CACHE_H__ */