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-2012 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  * Creates an image cache with maximal memory size.
  36  *
  37  * When memory size is set to zero it's set to 10% of total machine memory
  38  * (as reported by /proc/meminfo).
  39  */
  40 struct image_cache *image_cache_create(unsigned int max_size);
  41
  42 /*
  43  * Returns cached image, or NULL.
  44  *
  45  * If elevate set and image is found, the image is elevated to the top so
  46  * it has lesser chance of being freed.
  47  */
  48 GP_Context *image_cache_get(struct image_cache *self, const char *path,
  49                             long cookie1, long cookie2, int elevate);
  50
  51 /*
  52  * Puts an image into a cache.
  53  */
  54 int image_cache_put(struct image_cache *self, GP_Context *img,
  55                     const char *path, long cookie1, long cookie2);
  56
  57 /*
  58  * Destroys image cache and all it's images.
  59  */
  60 void image_cache_destroy(struct image_cache *self);
  61
  62 /*
  63  * Print the image cache content.
  64  */
  65 void image_cache_print(struct image_cache *self);
  66
  67 #endif /* __IMAGE_CACHE_H__ */