---

font_description.h

Go to the documentation of this file.

/*
        $Id: font_description.h,v 1.1 2001/03/06 15:09:10 mbn Exp $

        ------------------------------------------------------------------------
        ClanLib, the platform independent game SDK.

        This library is distributed under the GNU LIBRARY GENERAL PUBLIC LICENSE
        version 2. See COPYING for details.

        For a total list of contributers see CREDITS.

        ------------------------------------------------------------------------

        File purpose:
                Simple font support.
*/


#ifndef header_font_description
#define header_font_description

#include <vector>
#include <string>

class CL_SurfaceProvider;
class CL_InputSource;

class CL_Font_Description
//: Font provider interface.
// <p>The font description class is used by the <a class="CL_Font">font
// class</a> to load the font.</p>
//
// <p>Currently ClanLib support two types of fonts:</p>
//
// <p><b>The old method.</b></p>
//
// <p>You may find some 256 color indexed fonts with some of ClanLib's
// example applications. They use the three last colors in the palette to
// seperate the letters, break the line, and to determine the size of the
// font. The method is deprecated.</p>
//
// <p><b>The new method.</b></p>
//
// <p>The font description class constructs the font letters from an image
// with alpha values. Each letter is seperated with transparent lines and
// the font description class uses this information to determine where it so
// seperate the letters.</p>
//
// <p>CL_Font_Description allows you to adjust how much transparent a line
// must be before it consideres it as a letter seperator line. The
// trans_limit parameter handles this.</p>
//
// <p>If your font is italic you can use the subtract_width parameter to
// move the printed letters "closer to each other". This is, with a fine
// word, called the kerning of the font.</p>
{
public:
        std::vector<CL_SurfaceProvider*> letter_providers;
        int space_len;
        int subtract_width;
        std::string letters;
        
        CL_Font_Description(CL_InputSource *input);
        // <p>This constructor is used to load the font from an input source.
        // Usually this from a resource datafile.</p>
        //
        // <p>Normally you do not use this constructor directly. It is much
        // easier to use CL_Font::load() when retrieving a font from a
        // datafile.</p>
        
        CL_Font_Description(
                CL_SurfaceProvider *p,
                int x, int y,
                int *tcols, int num_tcols,
                int spacelen,
                int subtract_width,
                const char *letters);
        // <p>This constructs a font description using the old font method. It
        // is obsolete and only provided for backward compatibility. Please
        // don't use it.</p>

        CL_Font_Description(
                CL_SurfaceProvider *source,
                float trans_limit,
                int space_len,
                int subtract_width,
                const char *letters);
        // <p>This constructs a font description using the new alpha cutter
        // method.</p>
        // <p>Please have a look on the class overview reference page for more
        // information.</p>

  CL_Font_Description(
    std::vector<CL_SurfaceProvider*> letter_provider,
          int space_len,
          int subtract_width,
          std::string letters);
  // <p>This is primarily used by the TTF resource loader to handle fonts

        void lock();
        void unlock();

private:
        CL_SurfaceProvider *source;
};

#endif

---