D:/SoftwareEntwicklung/C++/HLC/Tools/SoftPixelEngine/repository/sources/RenderSystem/spRenderSystemFont.hpp

Go to the documentation of this file.

/*
 * Font header
 * 
 * This file is part of the "SoftPixel Engine" (Copyright (c) 2008 by Lukas Hermanns)
 * See "SoftPixelEngine.hpp" for license information.
 */

#ifndef __SP_VIDEODRIVER_FONT_H__
#define __SP_VIDEODRIVER_FONT_H__


#include "Base/spStandard.hpp"
#include "Base/spInputOutputString.hpp"
#include "Base/spDimension.hpp"
#include "Base/spMaterialColor.hpp"
#include "RenderSystem/spTextureBase.hpp"


namespace sp
{
namespace video
{


enum EFontFlags
{
    FONT_BOLD       = 0x01, 
    FONT_ITALIC     = 0x02, 
    FONT_UNDERLINED = 0x04, 
    FONT_STRIKEOUT  = 0x08, 
    FONT_SYMBOLS    = 0x10, 
    FONT_BITMAP     = 0x20, 
};

struct SP_EXPORT SFontGlyph
{
    SFontGlyph();
    SFontGlyph(const dim::rect2di &GlyphRect);
    SFontGlyph(const dim::rect2di &GlyphRect, s32 GlyphStartOffset, s32 GlyphDrawnWidth, s32 GlyphWhiteSpace);
    SFontGlyph(const SFontGlyph &Other);
    virtual ~SFontGlyph();
    
    /* Functions */
    
    inline s32 getWidth() const
    {
        return DrawnWidth + StartOffset + WhiteSpace;
    }
    
    /* Members */
    dim::rect2di Rect;
    s32 StartOffset;
    s32 DrawnWidth;
    s32 WhiteSpace;
};


class SP_EXPORT Font
{
    
    public:
        
        Font();
        Font(
            void* BufferRawData, const io::stringc &FontName,
            const dim::size2di &Size, const std::vector<SFontGlyph> &GlyphList,
            video::Texture* FontTexture = 0
        );
        ~Font();
        
        /* === Functions === */
        
        s32 getStringWidth(const io::stringc &Text) const;
        
        s32 getStringHeight(const io::stringc &Text) const;
        
        /* === Inline functions === */
        
        inline void* getBufferRawData() const
        {
            return BufferRawData_;
        }
        
        inline dim::size2di getSize() const
        {
            return Size_;
        }
        inline io::stringc getName() const
        {
            return FontName_;
        };
        
        inline s32 getHeight() const
        {
            return Size_.Height;
        }
        
        inline dim::size2di getStringSize(const io::stringc &Text) const
        {
            return dim::size2di(getStringWidth(Text), Size_.Height);
        }
        
        inline video::Texture* getTexture() const
        {
            return Texture_;
        }
        
        inline const std::vector<SFontGlyph>& getGlyphList() const
        {
            return GlyphList_;
        }
        
    private:
        
        #ifdef SP_COMPILE_WITH_DIRECT3D11
        friend class Direct3D11Driver;
        #endif
        #if defined(SP_COMPILE_WITH_OPENGL) || defined(SP_COMPILE_WITH_OPENGLES1)
        friend class GLFixedFunctionPipeline;
        #endif
        
        /* Members */
        
        void* BufferRawData_;
        
        io::stringc FontName_;
        dim::size2di Size_;
        
        std::vector<SFontGlyph> GlyphList_;
        
        video::Texture* Texture_;
        
};


} // /namespace video

} // /namespace sp


#endif



// ================================================================================