---

CL_Font_Description Class Reference

#include <font_description.h>

Collaboration diagram for CL_Font_Description:

[legend]List of all members.

Public Methods
	CL_Font_Description (CL_InputSource *input)
	CL_Font_Description (CL_SurfaceProvider *p, int x, int y, int *tcols, int num_tcols, int spacelen, int subtract_width, const char *letters)
	CL_Font_Description (CL_SurfaceProvider *source, float trans_limit, int space_len, int subtract_width, const char *letters)
	param: p - Image which contain the font letters.param: x - Start x coordinate on top-left most font letter.param: y - Start y coordinate on top-left most font letter.param: tcols - Array of colors to be transparent.param: num_tcols - Number of elements in the tcols array.param: spacelen - Pixel width of the space character.param: subtract_width - Width to subtract from each letter when drawing the font (aka. font kerning).param: letters - String containing all the letters listed in the image file. Must be ordered in the same way as in the image file.
	CL_Font_Description (std::vector< CL_SurfaceProvider *> letter_provider, int space_len, int subtract_width, std::string letters)
	param: source - Image which contain the font letters.param: trans_limit - The maximum amount of alpha allowed before a pixel is no longer considered transparent.param: space_len - Pixel width of the space character.param: subtract_width - Width to subtract from each letter when drawing the font (aka. font kerning).param: letters - String containing all the letters listed in the image file. Must be ordered in the same way as in the image file.
void	lock ()
	param: letters - A vector array of pointers to the letters themselvesparam: space_len - Pixel width of the space characterparam: subtract_width - Width to subtract from each letter when drawing the font (aka. font kerning).param: letters - String containing all the letters listed in the image file. Must be ordered in the same way as in the image file.
void	unlock ()
Public Attributes
std::vector<CL_SurfaceProvider*>	letter_providers
int	space_len
int	subtract_width
std::string	letters
Private Attributes
CL_SurfaceProvider*	source

---

Constructor & Destructor Documentation

CL_Font_Description::CL_Font_Description ( CL_InputSource * input )

CL_Font_Description::CL_Font_Description ( CL_SurfaceProvider * p, int x, int y, int * tcols, int num_tcols, int spacelen, int subtract_width, const char * letters )

CL_Font_Description::CL_Font_Description ( CL_SurfaceProvider * source, float trans_limit, int space_len, int subtract_width, const char * letters )

param: p - Image which contain the font letters.param: x - Start x coordinate on top-left most font letter.param: y - Start y coordinate on top-left most font letter.param: tcols - Array of colors to be transparent.param: num_tcols - Number of elements in the tcols array.param: spacelen - Pixel width of the space character.param: subtract_width - Width to subtract from each letter when drawing the font (aka. font kerning).param: letters - String containing all the letters listed in the image file. Must be ordered in the same way as in the image file.

CL_Font_Description::CL_Font_Description ( std::vector< CL_SurfaceProvider *> letter_provider, int space_len, int subtract_width, std::string letters )

param: source - Image which contain the font letters.param: trans_limit - The maximum amount of alpha allowed before a pixel is no longer considered transparent.param: space_len - Pixel width of the space character.param: subtract_width - Width to subtract from each letter when drawing the font (aka. font kerning).param: letters - String containing all the letters listed in the image file. Must be ordered in the same way as in the image file.

---

Member Function Documentation

void CL_Font_Description::lock ( )

param: letters - A vector array of pointers to the letters themselvesparam: space_len - Pixel width of the space characterparam: subtract_width - Width to subtract from each letter when drawing the font (aka. font kerning).param: letters - String containing all the letters listed in the image file. Must be ordered in the same way as in the image file.

void CL_Font_Description::unlock ( )

---

Member Data Documentation

std::vector<CL_SurfaceProvider*> CL_Font_Description::letter_providers

Definition at line 59 of file font_description.h.

std::string CL_Font_Description::letters

Definition at line 62 of file font_description.h.

CL_SurfaceProvider* CL_Font_Description::source [private]

Definition at line 122 of file font_description.h.

int CL_Font_Description::space_len

Definition at line 60 of file font_description.h.

int CL_Font_Description::subtract_width

Definition at line 61 of file font_description.h.

---

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

• font_description.h

---