FontFile Class Reference

Handles font files. More...

#include <FontFile.h>

Inheritance diagram for FontFile:

Collaboration diagram for FontFile:

Public Member Functions
	FontFile (File *file)
	Constructor. More...
	FontFile (File *file, const u32 &offset, const u32 &length)
	Constructor. More...
	FontFile (u8 *buffer, const u32 &offset, const u32 &length)
	Constructor. More...
virtual	~FontFile (void)
	Desrtuctor/. More...
Surface *	GetSurface (void)
	Retrieves the font surface. More...
Public Member Functions inherited from File
	File (const Ogre::String &file)
	Opens a file. More...
	File (const File *file)
	Opens a file. More...
	File (const File *file, u32 offset, u32 length)
	Loads a file fragment. More...
	File (const u8 *buffer, u32 offset, u32 length)
	Loads a file fragment from a buffer. More...
virtual	~File ()
	Destructor. More...
void	WriteFile (const Ogre::String &file) const
	Writes the contents of the buffer to a file. More...
const Ogre::String &	GetFileName () const
	Retrieves the file name. More...
u32	GetFileSize () const
	Retrieves the file size. More...
void	GetFileBuffer (u8 *buffer, const u32 &start, const u32 &length) const
	Loads a buffer with the file data. More...
u8	GetU8 (u32 offset) const
	Retrieves a pointer to a byte address in the file. More...
u16	GetU16LE (u32 offset) const
	Retrieves a pointer to a two-byte address in the file. More...
u32	GetU32LE (u32 offset) const
	Retrieves a pointer to a four-byte address in the file. More...
u8	readU8 ()
	Reads a byte from the file. More...
u16	readU16LE ()
	Reads two bytes from the file (little endian). More...
u32	readU32LE ()
	Reads four bytes from the file (little endian). More...
u32	GetCurrentOffset ()
	Checks the current offset of the file. More...
void	SetOffset (u32 offset)
	Sets the file offset for reading. More...

Additional Inherited Members
Protected Attributes inherited from File
Ogre::String	file_name_
	The file name. More...
u32	offset_ = 0
	Current offset of the file. More...
u8 *	buffer_
	The file buffer. More...
u32	buffer_size_
	The allocated size of {. More...

Detailed Description

Handles font files.

Constructor & Destructor Documentation

FontFile() [1/3]

FontFile::FontFile ( File *  file )

explicit

Constructor.

Parameters

[in]

file

The font file.

FontFile() [2/3]

FontFile::FontFile	(	File *	file,
		const u32 &	offset,
		const u32 &	length
	)

Constructor.

Parameters

[in]	file	The font file.
[in]	offset	The offset at which to start reading the file.
[in]	length	Length of the data to read.

FontFile() [3/3]

FontFile::FontFile	(	u8 *	buffer,
		const u32 &	offset,
		const u32 &	length
	)

Constructor.

Parameters

[in]	buffer	Buffer with the contents of the font file.
[in]	offset	The offset at which to start reading the file.
[in]	length	Length of the data to read.

~FontFile()

FontFile::~FontFile ( void  )

virtual

Desrtuctor/.

Member Function Documentation

GetSurface()

Surface * FontFile::GetSurface

(

void

)

Retrieves the font surface.

CLUT colour.

CLUT stands for Color LookUp Table.

Red component in the CLUT.

Green component in the CLUT.

Blue component in the CLUT.

Alpha component in the CLUT.

---

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

• src/installer/common/FontFile.h
• src/installer/common/FontFile.cpp