Irrlicht 3D Engine
irr::gui::IGUIFontBitmap Class Referenceabstract

Font interface. More...

#include <IGUIFontBitmap.h>

+ Inheritance diagram for irr::gui::IGUIFontBitmap:

Public Member Functions

virtual s32 getKerningWidth (const wchar_t *thisLetter=0, const wchar_t *previousLetter=0) const =0
 Gets kerning values (distance between letters) for the font. If no parameters are provided,. More...
 
virtual IGUISpriteBankgetSpriteBank () const =0
 returns the parsed Symbol Information More...
 
virtual u32 getSpriteNoFromChar (const wchar_t *c) const =0
 returns the sprite number from a given character More...
 
virtual EGUI_FONT_TYPE getType () const
 Returns the type of this font. More...
 
- Public Member Functions inherited from irr::gui::IGUIFont
virtual void draw (const core::stringw &text, const core::rect< s32 > &position, video::SColor color, bool hcenter=false, bool vcenter=false, const core::rect< s32 > *clip=0)=0
 Draws some text and clips it to the specified rectangle if wanted. More...
 
virtual s32 getCharacterFromPos (const wchar_t *text, s32 pixel_x) const =0
 Calculates the index of the character in the text which is on a specific position. More...
 
virtual core::dimension2d< u32getDimension (const wchar_t *text) const =0
 Calculates the width and height of a given string of text. More...
 
virtual s32 getKerningHeight () const =0
 Returns the distance between letters. More...
 
virtual void setInvisibleCharacters (const wchar_t *s)=0
 Define which characters should not be drawn by the font. More...
 
virtual void setKerningHeight (s32 kerning)=0
 Sets global kerning height for the font. More...
 
virtual void setKerningWidth (s32 kerning)=0
 Sets global kerning width for the font. More...
 
- Public Member Functions inherited from irr::IReferenceCounted
 IReferenceCounted ()
 Constructor. More...
 
virtual ~IReferenceCounted ()
 Destructor. More...
 
bool drop () const
 Drops the object. Decrements the reference counter by one. More...
 
const c8getDebugName () const
 Returns the debug name of the object. More...
 
s32 getReferenceCount () const
 Get the reference count. More...
 
void grab () const
 Grabs the object. Increments the reference counter by one. More...
 

Additional Inherited Members

- Protected Member Functions inherited from irr::IReferenceCounted
void setDebugName (const c8 *newName)
 Sets the debug name of the object. More...
 

Detailed Description

Font interface.

Definition at line 17 of file IGUIFontBitmap.h.

Member Function Documentation

§ getKerningWidth()

virtual s32 irr::gui::IGUIFontBitmap::getKerningWidth ( const wchar_t *  thisLetter = 0,
const wchar_t *  previousLetter = 0 
) const
pure virtual

Gets kerning values (distance between letters) for the font. If no parameters are provided,.

the global kerning distance is returned.

Parameters
thisLetterIf this parameter is provided, the left side kerning for this letter is added to the global kerning value. For example, a space might only be one pixel wide, but it may be displayed as several pixels.
previousLetterIf provided, kerning is calculated for both letters and added to the global kerning value. For example, EGFT_BITMAP will add the right kerning value of previousLetter to the left side kerning value of thisLetter, then add the global value.

Implements irr::gui::IGUIFont.

Referenced by getType().

§ getSpriteBank()

virtual IGUISpriteBank* irr::gui::IGUIFontBitmap::getSpriteBank ( ) const
pure virtual

returns the parsed Symbol Information

Referenced by getType().

§ getSpriteNoFromChar()

virtual u32 irr::gui::IGUIFontBitmap::getSpriteNoFromChar ( const wchar_t *  c) const
pure virtual

returns the sprite number from a given character

Referenced by getType().

§ getType()

virtual EGUI_FONT_TYPE irr::gui::IGUIFontBitmap::getType ( ) const
inlinevirtual

Returns the type of this font.

Reimplemented from irr::gui::IGUIFont.

Definition at line 22 of file IGUIFontBitmap.h.

References irr::gui::EGFT_BITMAP, getKerningWidth(), getSpriteBank(), and getSpriteNoFromChar().


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