ImageFont Class Reference

a font created from an Image More...

#include <imagefont.h>

Public Member Functions
	ImageFont ()
	Standardconstructor. More...
	ImageFont (const String &fname, const String &glyphs)
	~ImageFont () ROLAND_DEFAULT void init()
	Standarddestructor. More...
void	clear ()
	Frees all used resources. More...
void	load (const String &fname, const String &glyphs, uchar alpha=255)
const Rect &	glyph (Uint8 chr) const
const Image &	image ()
void	setSpacing (Uint16 spacing)
Uint16	spacing () const

Private Attributes
Image	mImage
String	mGlyphs
Rect	mGlyphRect [256]
Uint16	mSpacing

Detailed Description

a font created from an Image

Author

Fred Klaus devel.nosp@m.opme.nosp@m.nt@fk.nosp@m.web..nosp@m.de

Constructor & Destructor Documentation

ImageFont ( )

inline

Standardconstructor.

References ImageFont::clear(), ImageFont::glyph(), init(), ImageFont::load(), ROLAND_DEFAULT, and ImageFont::~ImageFont().

ImageFont	(	const String &	fname,
		const String &	glyphs
	)

Constructor, calls ImageFont::load to load an Image

Parameters

fname	= the filename of an Image
glyphs	= the available glyphs in the Image

References Image::height(), init(), ImageFont::load(), ImageFont::mGlyphRect, ImageFont::mImage, Image::pixel(), Rect::setHeight(), Rect::setPos(), Rect::setWidth(), Image::width(), and x.

~ImageFont

(

)

Standarddestructor.

Check whether the Image is valid and sets up the glyphs and their Rect class

Referenced by ImageFont::ImageFont().

Member Function Documentation

void clear

(

)

Frees all used resources.

References Image::clear(), and ImageFont::mImage.

Referenced by ImageFont::ImageFont(), and ImageFont::load().

const Rect & glyph ( Uint8  chr ) const

inline

References ImageFont::mGlyphRect, and ImageFont::mGlyphs.

Referenced by ImageFont::ImageFont(), Canvas::textHeight(), Canvas::textSize(), and Canvas::write().

const Image& image ( )

inline

References ImageFont::mImage, ImageFont::setSpacing(), and ImageFont::spacing().

Referenced by Canvas::write().

void load	(	const String &	fname,
		const String &	glyphs,
		uchar	alpha = 255
	)

loads an Image and calls ImageFont::init to set up the glyphs

Parameters

fname	= the filename of an Image
glyphs	= the available glyphs in the Image

References ImageFont::clear(), Image::convert(), init(), Image::load(), ImageFont::mGlyphs, and ImageFont::mImage.

Referenced by ImageFont::ImageFont(), and Canvas::setFont().

void setSpacing

(

Uint16

spacing

)

Referenced by ImageFont::image().

Uint16 spacing ( ) const

inline

References ImageFont::mSpacing.

Referenced by ImageFont::image(), Canvas::textSize(), and Canvas::write().

Member Data Documentation

Rect mGlyphRect[256]

private

Referenced by ImageFont::glyph(), and ImageFont::ImageFont().

String mGlyphs

private

Referenced by ImageFont::glyph(), and ImageFont::load().

Image mImage

private

Referenced by ImageFont::clear(), ImageFont::image(), ImageFont::ImageFont(), and ImageFont::load().

Uint16 mSpacing

private

Referenced by ImageFont::spacing().

---

The documentation for this class was generated from the following files:

• imagefont.h
• imagefont.cpp