textrenderpool.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005-2019 by the FIFE team                              *
 *   http://www.fifengine.net                                              *
 *   This file is part of FIFE.                                            *
 *                                                                         *
 *   FIFE is free software; you can redistribute it and/or                 *
 *   modify it under the terms of the GNU Lesser General Public            *
 *   License as published by the Free Software Foundation; either          *
 *   version 2.1 of the License, or (at your option) any later version.    *
 *                                                                         *
 *   This library 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     *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with this library; if not, write to the                 *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, 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;

    class TextRenderPool {
        public:
            TextRenderPool(size_t poolSize = 200);

            ~TextRenderPool();

            void invalidateCachedText();

            Image* getRenderedText( FontBase* fontbase, const std::string& text);

            void addRenderedText( FontBase* fontbase, const std::string& text, Image* image);

            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