Referencia de la Clase Yukino::Font

Clase para almacenar una fuente. Más...

#include <Font.h>

Lista de todos los miembros.

Métodos públicos

 Font ()
 Constructor de la clase Font.
 Font (const char *file, int ptsize, long index=0)
 Constructor de la clase Font.
 Font (const string &file, int ptsize, long index=0)
 Constructor de la clase Font.
 Font (const Font &obj)
 Constructor copia de la clase Font.
Fontoperator= (Font &obj)
 Operador = de la clase Font.
 ~Font ()
 Destructor de la clase Font.
UINT Load (const char *file, int ptsize, long index=0)
 Función para cargar un fuente de un fichero.
UINT Load (const string &file, int ptsize, long index=0)
 Función para cargar un fuente de un fichero.
void Free (void)
 Función para liberar los datos del objeto Font.
int GetStyle (void)
 Función para obtener el estilo de la fuente.
void SetStyle (int style)
 Función para cambiar el estilo de la fuente.
int GetHeight (void)
 Función para obtener el alto de la fuente.
int GetAscent (void)
 Función para obtener el ascendente de la fuente.
int GetDescent (void)
 Función para obtener el descendente de la fuente.
int GetLineSkip (void)
 Función para obtener la distancia del salto de linea de la fuente.
int GetSize (void)
 Función para obtener el tamaño de la fuente.
int GetSizeText (const char *text, int *w=NULL, int *h=NULL)
 Función para obtener el tamaño de una cadena de texto renderizada.
SDL_Surface * RenderText (const char *text, dword fc)
 Función para renderizar una cadena de texto.
SDL_Surface * RenderText2 (const char *text, SDL_Color color)
 Función para renderizar una cadena de texto.
SDL_Surface * RenderUNICODE (const word *text, dword fc)
 Función para renderizar una cadena de texto.
SDL_Surface * RenderUNICODE2 (const word *text, SDL_Color color)
 Función para renderizar una cadena de texto.


Descripción detallada

Clase para almacenar una fuente.

La clase Font sirve para almacenar en memoria un tipo de fuente True-Type.


Documentación del constructor y destructor

Yukino::Font::Font (  ) 

Constructor de la clase Font.

Constructor por defecto de la clase Font.

Ver también:
operator=(), ~Font().

Yukino::Font::Font ( const char *  file,
int  ptsize,
long  index = 0 
)

Constructor de la clase Font.

Constructor de la clase Font, que carga un fichero.

Parámetros:
file Ruta del fichero.
ptsize Tamaño de la fuente.
index Indice de la fuente.
Ver también:
operator=(), ~Font().

Yukino::Font::Font ( const string &  file,
int  ptsize,
long  index = 0 
)

Constructor de la clase Font.

Constructor de la clase Font, que carga un fichero.

Parámetros:
file Ruta del fichero.
ptsize Tamaño de la fuente.
index Indice de la fuente.
Ver también:
operator=(), ~Font().

Yukino::Font::Font ( const Font obj  ) 

Constructor copia de la clase Font.

Parámetros:
obj Objeto Font a copiar.
Ver también:
operator=(), ~Font().

Yukino::Font::~Font (  ) 

Destructor de la clase Font.

Ver también:
Font(), operator=().


Documentación de las funciones miembro

void Yukino::Font::Free ( void   ) 

Función para liberar los datos del objeto Font.

Esta función sirve para liberar el contenido del objeto Font.

Ver también:
Load().

int Yukino::Font::GetAscent ( void   )  [inline]

Función para obtener el ascendente de la fuente.

Esta función sirve para obtener el ascendente de la fuente.

Ver también:
GetDescent().
Devuelve:
El ascendente de la fuente.

int Yukino::Font::GetDescent ( void   )  [inline]

Función para obtener el descendente de la fuente.

Esta función sirve para obtener el descendente de la fuente.

Ver también:
GetAscent().
Devuelve:
El descendente de la fuente.

int Yukino::Font::GetHeight ( void   )  [inline]

Función para obtener el alto de la fuente.

Esta función sirve para obtener el alto de la fuente.

Devuelve:
El alto de la fuente.

int Yukino::Font::GetLineSkip ( void   )  [inline]

Función para obtener la distancia del salto de linea de la fuente.

Esta función sirve para obtener la distancia del salto de linea.

Devuelve:
La distancia del salto de linea.

int Yukino::Font::GetSize ( void   )  [inline]

Función para obtener el tamaño de la fuente.

Esta función sirve para obtener el tamaño de la fuente.

Devuelve:
El tamaño de la fuente.

int Yukino::Font::GetSizeText ( const char *  text,
int *  w = NULL,
int *  h = NULL 
) [inline]

Función para obtener el tamaño de una cadena de texto renderizada.

Esta función sirve para obtener el tamaño de un texto renderizado.

Devuelve:
El tamaño de una cadena de texto.

int Yukino::Font::GetStyle ( void   )  [inline]

Función para obtener el estilo de la fuente.

Esta función sirve para obtener el estilo de la fuente.

Ver también:
SetStyle().
Devuelve:
TTF_STYLE_BOLD, TTF_STYLE_ITALIC, TTF_STYLE_UNDERLINE, TTF_STYLE_NORMAL.

UINT Yukino::Font::Load ( const string &  file,
int  ptsize,
long  index = 0 
) [inline]

Función para cargar un fuente de un fichero.

Esta función sirve para cargar un fuente de un fichero.

Parámetros:
file Ruta del fichero.
ptsize Tamaño de la fuente.
index Indice de la fuente.
Ver también:
Free().
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: FONT_ERROR_OPEN.

UINT Yukino::Font::Load ( const char *  file,
int  ptsize,
long  index = 0 
)

Función para cargar un fuente de un fichero.

Esta función sirve para cargar un fuente de un fichero.

Parámetros:
file Ruta del fichero.
ptsize Tamaño de la fuente.
index Indice de la fuente.
Ver también:
Free().
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: FONT_ERROR_OPEN.

Font & Yukino::Font::operator= ( Font obj  ) 

Operador = de la clase Font.

Copia el objeto obj en el objeto actual, y este es devuelto.

Ver también:
Font(), ~Font().

SDL_Surface* Yukino::Font::RenderText ( const char *  text,
dword  fc 
) [inline]

Función para renderizar una cadena de texto.

Esta función sirve para renderizar una cadena de texto con un color.

Parámetros:
text Cadena a renderizar.
fc Color de la cadena.
Ver también:
RenderText2(), RenderUNICODE(), RenderUNICODE2().
Devuelve:
Devuelve un puntero a un SDL_Surface si todo ha ido bien, en caso de no haber memoria para el buffer devuelve NULL.

SDL_Surface* Yukino::Font::RenderText2 ( const char *  text,
SDL_Color  color 
) [inline]

Función para renderizar una cadena de texto.

Esta función sirve para renderizar una cadena de texto con un color.

Parámetros:
text Cadena a renderizar.
color Color de la cadena.
Ver también:
RenderText(), RenderUNICODE(), RenderUNICODE2().
Devuelve:
Devuelve un puntero a un SDL_Surface si todo ha ido bien, en caso de no haber memoria para el buffer devuelve NULL.

SDL_Surface* Yukino::Font::RenderUNICODE ( const word text,
dword  fc 
) [inline]

Función para renderizar una cadena de texto.

Esta función sirve para renderizar una cadena de texto con un color.

Parámetros:
text Cadena a renderizar.
fc Color de la cadena.
Ver también:
RenderText(), RenderText2(), RenderUNICODE2().
Devuelve:
Devuelve un puntero a un SDL_Surface si todo ha ido bien, en caso de no haber memoria para el buffer devuelve NULL.

SDL_Surface* Yukino::Font::RenderUNICODE2 ( const word text,
SDL_Color  color 
) [inline]

Función para renderizar una cadena de texto.

Esta función sirve para renderizar una cadena de texto con un color.

Parámetros:
text Cadena a renderizar.
color Color de la cadena.
Ver también:
RenderText(), RenderText2(), RenderUNICODE().
Devuelve:
Devuelve un puntero a un SDL_Surface si todo ha ido bien, en caso de no haber memoria para el buffer devuelve NULL.

void Yukino::Font::SetStyle ( int  style  )  [inline]

Función para cambiar el estilo de la fuente.

Esta función sirve para cambiar el estilo de la fuente.

Parámetros:
style Estilo de la fuente.
Ver también:
GetStyle().


La documentación para esta clase fué generada a partir de los siguientes archivos:
Generado el Sun Jun 25 03:44:44 2006 para Yukino por  doxygen 1.4.7