Public Member Functions | Friends

sp::video::Font Class Reference

#include <spRenderSystemFont.hpp>

List of all members.

Public Member Functions

 Font ()
 Font (void *BufferRawData, const io::stringc &FontName, const dim::size2di &Size, const std::vector< SFontGlyph > &GlyphList, video::Texture *FontTexture=0)
 ~Font ()
s32 getStringWidth (const io::stringc &Text) const
 Returns the width of the specified text.
s32 getStringHeight (const io::stringc &Text) const
 Returns the height of the specified text with regard to the line breaks.
void * getBufferRawData () const
dim::size2di getSize () const
 Returns the font's size.
io::stringc getName () const
 Returns the font's name (e.g. "Times New Roman").
s32 getHeight () const
dim::size2di getStringSize (const io::stringc &Text) const
 Returns the size of the specified text.
video::TexturegetTexture () const
 Returns the texture if this font is a texture font.
const std::vector< SFontGlyph > & getGlyphList () const

Friends

class Direct3D11Driver
class GLFixedFunctionPipeline

Constructor & Destructor Documentation

sp::video::Font::Font (  ) 
sp::video::Font::Font ( void *  BufferRawData,
const io::stringc FontName,
const dim::size2di Size,
const std::vector< SFontGlyph > &  GlyphList,
video::Texture FontTexture = 0 
)
sp::video::Font::~Font (  ) 

Member Function Documentation

void* sp::video::Font::getBufferRawData (  )  const [inline]

Returns a pointer to the renderer specific buffer raw data. This is only used internally. Only use this when you have created the font manually.

const std::vector<SFontGlyph>& sp::video::Font::getGlyphList (  )  const [inline]
s32 sp::video::Font::getHeight (  )  const [inline]

Returns the font's height. This is equivalent to "getSize().Height".

Note:
To get the font's width use the "getSize" function. This is an exeptional case because normally only the font's height is important.
See also:
getSize
io::stringc sp::video::Font::getName (  )  const [inline]

Returns the font's name (e.g. "Times New Roman").

dim::size2di sp::video::Font::getSize (  )  const [inline]

Returns the font's size.

s32 sp::video::Font::getStringHeight ( const io::stringc Text  )  const

Returns the height of the specified text with regard to the line breaks.

dim::size2di sp::video::Font::getStringSize ( const io::stringc Text  )  const [inline]

Returns the size of the specified text.

s32 sp::video::Font::getStringWidth ( const io::stringc Text  )  const

Returns the width of the specified text.

video::Texture* sp::video::Font::getTexture (  )  const [inline]

Returns the texture if this font is a texture font.


Friends And Related Function Documentation

friend class Direct3D11Driver [friend]
friend class GLFixedFunctionPipeline [friend]

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines