FTGlyph Class Reference

#include <FTGlyph.h>

Inheritance diagram for FTGlyph:

List of all members.

Public Member Functions
	FTGlyph (FT_GlyphSlot glyph, bool useDisplayList=true)
virtual	~FTGlyph ()
virtual const FTPoint &	Render (const FTPoint &pen)=0
const FTPoint &	Advance () const
const FTBBox &	BBox () const
FT_Error	Error () const
	FTGlyph (FT_GlyphSlot glyph, bool useDisplayList=true)
virtual	~FTGlyph ()
virtual const FTPoint &	Render (const FTPoint &pen)=0
const FTPoint &	Advance () const
const FTBBox &	BBox () const
FT_Error	Error () const
Protected Attributes
FTPoint	advance
FTBBox	bBox
bool	useDisplayList
FT_Error	err

---

Detailed Description

FTGlyph is the base class for FTGL glyphs.

It provides the interface between Freetype glyphs and their openGL renderable counterparts. This is an abstract class and derived classes must implement the render function.

See also:

FTGlyphContainer

FTBBox

FTPoint

Definition at line 25 of file FTGlyph.h.

---

Constructor & Destructor Documentation

FTGlyph::FTGlyph	(	FT_GlyphSlot	glyph,
		bool	useDisplayList = true
	)

Constructor

Parameters:

	glyph	The Freetype glyph to be processed
	useDisplayList	Enable or disable the use of Display Lists for this glyph true turns ON display lists. false turns OFF display lists.

Definition at line 4 of file FTGlyph.cxx.

References advance, FT_GlyphSlotRec_::advance, bBox, FT_Vector_::x, and FT_Vector_::y.

FTGlyph::~FTGlyph

(

)

[virtual]

Destructor

Definition at line 16 of file FTGlyph.cxx.

FTGlyph::FTGlyph	(	FT_GlyphSlot	glyph,
		bool	useDisplayList = true
	)

Constructor

Parameters:

	glyph	The Freetype glyph to be processed
	useDisplayList	Enable or disable the use of Display Lists for this glyph true turns ON display lists. false turns OFF display lists.

virtual FTGlyph::~FTGlyph

(

)

[virtual]

Destructor

---

Member Function Documentation

virtual const FTPoint& FTGlyph::Render

(

const FTPoint &

pen

)

[pure virtual]

Renders this glyph at the current pen position.

Parameters:

pen

The current pen position.

Returns:

The advance distance for this glyph.

const FTPoint& FTGlyph::Advance

(

)

const [inline]

Return the advance width for this glyph.

Returns:

advance width.

Definition at line 56 of file FTGlyph.h.

const FTBBox& FTGlyph::BBox

(

)

const [inline]

Return the bounding box for this glyph.

Returns:

bounding box.

Definition at line 63 of file FTGlyph.h.

Referenced by FTGLTextureFont::MakeGlyph().

FT_Error FTGlyph::Error

(

)

const [inline]

Queries for errors.

Returns:

The current error code.

Definition at line 70 of file FTGlyph.h.

virtual const FTPoint& FTGlyph::Render

(

const FTPoint &

pen

)

[pure virtual]

Renders this glyph at the current pen position.

Parameters:

pen

The current pen position.

Returns:

The advance distance for this glyph.

const FTPoint& FTGlyph::Advance

(

)

const [inline]

Return the advance width for this glyph.

Returns:

advance width.

Definition at line 56 of file FTGlyph.h.

const FTBBox& FTGlyph::BBox

(

)

const [inline]

Return the bounding box for this glyph.

Returns:

bounding box.

Definition at line 63 of file FTGlyph.h.

FT_Error FTGlyph::Error

(

)

const [inline]

Queries for errors.

Returns:

The current error code.

Definition at line 70 of file FTGlyph.h.

---

Member Data Documentation

FTPoint FTGlyph::advance [protected]

The advance distance for this glyph

Definition at line 76 of file FTGlyph.h.

Referenced by FTGlyph(), FTPolyGlyph::Render(), FTExtrdGlyph::Render(), FTTextureGlyph::Render(), FTOutlineGlyph::Render(), FTBitmapGlyph::Render(), and FTPixmapGlyph::Render().

FTBBox FTGlyph::bBox [protected]

The bounding box of this glyph.

Definition at line 81 of file FTGlyph.h.

Referenced by FTExtrdGlyph::FTExtrdGlyph(), and FTGlyph().

bool FTGlyph::useDisplayList [protected]

Flag to enable or disable the use of Display Lists inside FTGL true turns ON display lists. false turns OFF display lists.

Definition at line 88 of file FTGlyph.h.

FT_Error FTGlyph::err [protected]

Current error code. Zero means no error.

Definition at line 93 of file FTGlyph.h.

Referenced by FTBitmapGlyph::FTBitmapGlyph(), FTExtrdGlyph::FTExtrdGlyph(), FTOutlineGlyph::FTOutlineGlyph(), FTPixmapGlyph::FTPixmapGlyph(), FTPolyGlyph::FTPolyGlyph(), and FTTextureGlyph::FTTextureGlyph().

---

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

• graf3d/ftgl/inc/FTGlyph.h
• include/FTGlyph.h
• graf3d/ftgl/src/FTGlyph.cxx

---