Mercurial > fife-parpg

comparison engine/core/video/fonts/textrenderpool.h @ 0:4a0efb7baf70

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Datasets becomes the new trunk and retires after that :-)
author mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
date Sun, 29 Jun 2008 18:44:17 +0000
parents
children 90005975cdbb
comparison
equal deleted inserted replaced
-1:000000000000 0:4a0efb7baf70
1 /***************************************************************************
2 * Copyright (C) 2005-2008 by the FIFE team *
3 * http://www.fifengine.de *
4 * This file is part of FIFE. *
5 * *
6 * FIFE is free software; you can redistribute it and/or modify *
7 * it under the terms of the GNU General Public License as published by *
8 * the Free Software Foundation; either version 2 of the License, or *
9 * (at your option) any later version. *
10 * *
11 * This program is distributed in the hope that it will be useful, *
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
14 * GNU General Public License for more details. *
15 * *
16 * You should have received a copy of the GNU General Public License *
17 * along with this program; if not, write to the *
18 * Free Software Foundation, Inc., *
19 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA *
20 ***************************************************************************/
21
22 #ifndef FIFE_FONTS_TEXTRENDERPOOL_H
23 #define FIFE_FONTS_TEXTRENDERPOOL_H
24
25 // Standard C++ library includes
26 #include <list>
27 #include <string>
28
29 // Platform specific includes
30
31 // 3rd party library includes
32 #include <SDL.h>
33
34 // FIFE includes
35 // These includes are split up in two parts, separated by one empty line
36 // First block: files included from the FIFE root src directory
37 // Second block: files included from the same folder
38 #include "util/time/timer.h"
39
40 struct SDL_Surface;
41 namespace FIFE {
42 class FontBase;
43 class Image;
44
45 /** Generic pool for rendered text
46 * Caches a number of Images with text, as rendered by a Font.
47 * Makes sure no more than a maximum number of strings is pooled at a time.
48 * Automatically removes pooled strings not used for a minute.
49 * Doesn't use resources (apart from a minimum) if not used after a while.
50 *
51 * @todo Should probably use a @c std::map instead of a @c std::list
52 */
53 class TextRenderPool {
54 public:
55 /** Constructor
56 * Constructs a pool with a maximum of poolSize entries
57 */
58 TextRenderPool(size_t poolSize = 200);
59
60 /** Destructor
61 */
62 ~TextRenderPool();
63
64 /** Get a string image
65 */
66 Image* getRenderedText( FontBase* fontbase, const std::string& text);
67
68 /** Add a string image
69 */
70 void addRenderedText( FontBase* fontbase, const std::string& text, Image* image);
71
72 /** Remove entries not used since a minute
73 * Is a timer callback.
74 */
75 void removeOldEntries();
76
77 protected:
78 typedef struct {
79 std::string text;
80 SDL_Color color;
81 bool antialias;
82 int glyph_spacing;
83 int row_spacing;
84 uint32_t timestamp;
85
86 Image* image;
87 } s_pool_entry;
88
89 typedef std::list<s_pool_entry> type_pool;
90 type_pool m_pool;
91 size_t m_poolSize;
92 size_t m_poolMaxSize;
93
94 Timer m_collectTimer;
95 };
96 }
97 #endif