font.h

Go to the documentation of this file.

/*
**  ClanLib SDK
**  Copyright (c) 1997-2009 The ClanLib Team
**
**  This software is provided 'as-is', without any express or implied
**  warranty.  In no event will the authors be held liable for any damages
**  arising from the use of this software.
**
**  Permission is granted to anyone to use this software for any purpose,
**  including commercial applications, and to alter it and redistribute it
**  freely, subject to the following restrictions:
**
**  1. The origin of this software must not be misrepresented; you must not
**     claim that you wrote the original software. If you use this software
**     in a product, an acknowledgment in the product documentation would be
**     appreciated but is not required.
**  2. Altered source versions must be plainly marked as such, and must not be
**     misrepresented as being the original software.
**  3. This notice may not be removed or altered from any source distribution.
**
**  Note: Some of the libraries ClanLib may link to may have additional
**  requirements or restrictions.
**
**  File Author(s):
**
**    Magnus Norddahl
*/


#pragma once

#include "../api_display.h"
#include "../../Core/System/sharedptr.h"
#include "../Render/graphic_context.h"
#include "../Image/pixel_buffer.h"
#include "font_description.h"

class CL_FontProvider;
class CL_Font_Impl;

class CL_API_DISPLAY CL_Font
{

public:
        CL_Font();

        // \brief Constructs standard font - Currently this defaults to CL_Font_System
        CL_Font( CL_GraphicContext &context, const CL_StringRef &typeface_name, int height);

        // \brief Constructs standard font - Currently this defaults to CL_Font_System
        CL_Font( CL_GraphicContext &context, const CL_FontDescription &desc);

        CL_Font(CL_FontProvider *provider);

        CL_Font(const CL_Font &copy);

        virtual ~CL_Font();


public:

        bool is_null();

        CL_FontProvider *get_provider() const;


public:

        void draw_text(CL_GraphicContext &gc, int x, int y, const CL_StringRef &text, const CL_Colorf &color = CL_Colorf::white);

        void draw_text(CL_GraphicContext &gc, float x, float y, const CL_StringRef &text, const CL_Colorf &color = CL_Colorf::white);

        void draw_text(CL_GraphicContext &gc, const CL_Pointf &position, const CL_StringRef &text, const CL_Colorf &color = CL_Colorf::white);

        CL_Size get_text_size(CL_GraphicContext &gc, const CL_StringRef &text);

        CL_FontMetrics get_font_metrics(CL_GraphicContext &gc);

        int get_character_index(CL_GraphicContext &gc, const CL_String &text, const CL_Point &point);


private:
        CL_SharedPtr<CL_Font_Impl> impl;
};

class CL_API_DISPLAY CL_FontPixelBuffer
{
public:
        CL_FontPixelBuffer() : glyph(0), empty_buffer(true), offset(0,0), increment(0,0) { };

        unsigned int glyph;

        bool empty_buffer;

        CL_PixelBuffer buffer;


        CL_Point offset;


        CL_Point increment;
};

---