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

* 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
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/engine/core/video/fonts/textrenderpool.h	Sun Jun 29 18:44:17 2008 +0000
@@ -0,0 +1,97 @@
+/***************************************************************************
+ *   Copyright (C) 2005-2008 by the FIFE team                              *
+ *   http://www.fifengine.de                                               *
+ *   This file is part of FIFE.                                            *
+ *                                                                         *
+ *   FIFE is free software; you can redistribute it and/or modify          *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 2 of the License, or     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+ *   GNU General Public License for more details.                          *
+ *                                                                         *
+ *   You should have received a copy of the GNU General Public License     *
+ *   along with this program; if not, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA              *
+ ***************************************************************************/
+
+#ifndef FIFE_FONTS_TEXTRENDERPOOL_H
+#define FIFE_FONTS_TEXTRENDERPOOL_H
+
+// Standard C++ library includes
+#include <list>
+#include <string>
+
+// Platform specific includes
+
+// 3rd party library includes
+#include <SDL.h>
+
+// FIFE includes
+// These includes are split up in two parts, separated by one empty line
+// First block: files included from the FIFE root src directory
+// Second block: files included from the same folder
+#include "util/time/timer.h"
+
+struct SDL_Surface;
+namespace FIFE {
+	class FontBase;
+	class Image;
+
+	/** Generic pool for rendered text
+	 *  Caches a number of Images with text, as rendered by a Font.
+	 *  Makes sure no more than a maximum number of strings is pooled at a time.
+	 *  Automatically removes pooled strings not used for a minute.
+	 *  Doesn't use resources (apart from a minimum) if not used after a while.
+	 *
+	 *  @todo Should probably use a @c std::map instead of a @c std::list
+	 */
+	class TextRenderPool {
+		public:
+			/** Constructor
+			 *  Constructs a pool with a maximum of poolSize entries
+			 */
+			TextRenderPool(size_t poolSize = 200);
+
+			/** Destructor
+			 */
+			~TextRenderPool();
+
+			/** Get a string image
+			 */
+			Image* getRenderedText( FontBase* fontbase, const std::string& text);
+
+			/** Add a string image
+			 */
+			void addRenderedText( FontBase* fontbase, const std::string& text, Image* image);
+
+			/** Remove entries not used since a minute
+			 *  Is a timer callback.
+			 */
+			void removeOldEntries();
+
+		protected:
+			typedef struct {
+				std::string text;
+				SDL_Color color;
+				bool antialias;
+				int glyph_spacing;
+				int row_spacing;
+				uint32_t timestamp;
+
+				Image* image;
+			} s_pool_entry;
+
+			typedef std::list<s_pool_entry> type_pool;
+			type_pool m_pool;
+			size_t m_poolSize;
+			size_t m_poolMaxSize;
+
+			Timer m_collectTimer;
+	};
+}
+#endif