Referencia de la Clase Yukino::Graphics

Clase que gestiona el sistema de video. Más...

#include <Graphics.h>

Lista de todos los miembros.

Métodos públicos

UINT Init (int w, int h, int bpp=32, bool winmode=false)
 Función para inicializar el objeto Graphics.
void Release (void)
 Función para finalizar el objeto Graphics.
void SetTitle (const char *title, const char *icon=NULL)
 Función para cambiar el título de la ventana.
void HideCursor (void)
 Función para ocultar el cursor del ratón.
void ShowCursor (void)
 Función para mostrar el cursor del ratón.
UINT Update (void)
 Función para actualizar el contenido de la pantalla.
UINT Fill (Uint32 color, Rect *rect=NULL)
 Función para rellenar con un color una región de la pantalla.
UINT Blit (const Surface &objsrc, Rect *dst=NULL, Rect *src=NULL)
 Función para poner en pantalla una Surface.
UINT Blit (const Surface &objsrc, int x, int y, Rect *src=NULL)
 Función para poner en pantalla una Surface.
UINT Blit (SDL_Surface *srfsrc, Rect *dst=NULL, Rect *src=NULL)
 Función para poner en pantalla una SDL_Surface.
UINT Blit (SDL_Surface *srfsrc, int x, int y, Rect *src=NULL)
 Función para poner en pantalla una SDL_Surface.
UINT Blit (const Sprite &objsrc, Rect *dst=NULL)
 Función para poner en pantalla un Sprite.
UINT Blit (const Sprite &objsrc, int x, int y)
 Función para poner en pantalla un Sprite.
UINT Paste (Surface &objdst, Rect *dst=NULL, Rect *src=NULL) const
 Función para copiar una región de la pantalla en una Surface.
UINT Paste (Surface &objdst, int x, int y, Rect *src=NULL) const
 Función para copiar una región de la pantalla en una Surface.
UINT Paste (SDL_Surface *srfdst, Rect *dst=NULL, Rect *src=NULL) const
 Función para copiar una región de la pantalla en una SDL_Surface.
UINT Paste (SDL_Surface *srfdst, int x, int y, Rect *src=NULL) const
 Función para copiar una región de la pantalla en una SDL_Surface.
UINT PutText (Font &font, const char *text, dword fc, Rect *dst=NULL)
 Función para poner en pantalla un texto.
UINT PutText (Font &font, const char *text, dword fc, int x, int y)
 Función para poner en pantalla un texto.
UINT PutUNICODE (Font &font, const word *text, dword fc, Rect *dst=NULL)
 Función para poner en pantalla un texto UNICODE.
UINT PutUNICODE (Font &font, const word *text, dword fc, int x, int y)
 Función para poner en pantalla un texto UNICODE.
SDL_Surface * GetBuffer (void)
 Función para obtener el buffer de pantalla.

Métodos públicos estáticos

static GraphicsGetInstance (void)
 Función para obtener la instancia de Graphics.


Descripción detallada

Clase que gestiona el sistema de video.

La clase Graphics gestiona los temas relacionados con el sistema de video, tales como crear la ventana y cambiar la resolución, pintar imagenes contenidas en una Surface o un Sprite en pantalla, o pintar texto en una posición.


Documentación de las funciones miembro

UINT Yukino::Graphics::Blit ( const Sprite objsrc,
int  x,
int  y 
)

Función para poner en pantalla un Sprite.

Esta función sirve para poner el frame actual del Sprite origen, en unas coordenadas de la pantalla.

Parámetros:
objsrc Imagen origen.
x Coordenada x.
y Coordenada y.
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: GRAPHICS_ERROR_BLITSURFACE.

UINT Yukino::Graphics::Blit ( const Sprite objsrc,
Rect dst = NULL 
)

Función para poner en pantalla un Sprite.

Esta función sirve para poner el frame actual del Sprite origen, en una región determinada de la pantalla.

Parámetros:
objsrc Imagen origen.
dst Región destino.
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: GRAPHICS_ERROR_BLITSURFACE.

UINT Yukino::Graphics::Blit ( SDL_Surface *  srfsrc,
int  x,
int  y,
Rect src = NULL 
)

Función para poner en pantalla una SDL_Surface.

Esta función sirve para poner una región determinada de una imagen origen, en unas coordenadas de la pantalla.

Parámetros:
srfsrc Imagen origen.
x Coordenada x.
y Coordenada y.
src Región origen.
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: GRAPHICS_ERROR_BLITSURFACE.

UINT Yukino::Graphics::Blit ( SDL_Surface *  srfsrc,
Rect dst = NULL,
Rect src = NULL 
)

Función para poner en pantalla una SDL_Surface.

Esta función sirve para poner una región determinada de una imagen origen, en una región también determinada de la pantalla.

Parámetros:
srfsrc Imagen origen.
dst Región destino.
src Región origen.
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: GRAPHICS_ERROR_BLITSURFACE.

UINT Yukino::Graphics::Blit ( const Surface objsrc,
int  x,
int  y,
Rect src = NULL 
)

Función para poner en pantalla una Surface.

Esta función sirve para poner una región determinada de una imagen origen, en unas coordenadas de la pantalla.

Parámetros:
objsrc Imagen origen.
x Coordenada x.
y Coordenada y.
src Región origen.
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: GRAPHICS_ERROR_BLITSURFACE.

UINT Yukino::Graphics::Blit ( const Surface objsrc,
Rect dst = NULL,
Rect src = NULL 
)

Función para poner en pantalla una Surface.

Esta función sirve para poner una región determinada de una imagen origen, en una región también determinada de la pantalla.

Parámetros:
objsrc Imagen origen.
dst Región destino.
src Región origen.
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: GRAPHICS_ERROR_BLITSURFACE.

UINT Yukino::Graphics::Fill ( Uint32  color,
Rect rect = NULL 
)

Función para rellenar con un color una región de la pantalla.

Esta función sirve para rellenar una región de la pantalla, con un color.

Parámetros:
color Color de relleno.
rect Región destino a rellenar.
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: GRAPHICS_ERROR_FILLRECT.

SDL_Surface* Yukino::Graphics::GetBuffer ( void   )  [inline]

Función para obtener el buffer de pantalla.

Esta función sirve para obtener el buffer de pantalla.

Devuelve:
Devuelve un puntero al buffer de pantalla si todo ha ido bien, en caso de no haber memoria para el buffer devuelve NULL.

Graphics * Yukino::Graphics::GetInstance ( void   )  [static]

Función para obtener la instancia de Graphics.

Esta función crea una instancia de Graphics, en caso de no estar creada, y devuelve un puntero a esta si tiene exito pidiendo memoria.

Devuelve:
Devuelve un puntero al objeto Graphics si todo ha ido bien, en caso de no haber memoria para el objeto devuelve NULL.

void Yukino::Graphics::HideCursor ( void   ) 

Función para ocultar el cursor del ratón.

Esta función sirve para ocultar el cursor del ratón en la aplicación.

Ver también:
ShowCursor().

UINT Yukino::Graphics::Init ( int  w,
int  h,
int  bpp = 32,
bool  winmode = false 
)

Función para inicializar el objeto Graphics.

Esta función sirve para inicializar el objeto Graphics, pasándole el ancho, el alto, la profundidad de color y si se está en modo ventana o no.

Parámetros:
w Ancho de la aplicación.
h Alto de la aplicación.
bpp Profundidad de color de la aplicación.
winmode Modo ventana activado.
Ver también:
Release().
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: GRAPHICS_ERROR_VIDEOMODEOK, GRAPHICS_ERROR_SETVIDEOMODE, GRAPHICS_ERROR_TTFINIT.

UINT Yukino::Graphics::Paste ( SDL_Surface *  srfdst,
int  x,
int  y,
Rect src = NULL 
) const

Función para copiar una región de la pantalla en una SDL_Surface.

Esta función sirve para copiar una región determinada de la pantalla, en unas coordenadas de una imagen destino.

Parámetros:
srfdst Imagen destino.
x Coordenada x.
y Coordenada y.
src Región origen.
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: GRAPHICS_ERROR_COPYSCREEN.

UINT Yukino::Graphics::Paste ( SDL_Surface *  srfdst,
Rect dst = NULL,
Rect src = NULL 
) const

Función para copiar una región de la pantalla en una SDL_Surface.

Esta función sirve para copiar una región determinada de la pantalla, en una región también determinada de una imagen destino.

Parámetros:
srfdst Imagen destino.
dst Región destino.
src Región origen.
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: GRAPHICS_ERROR_COPYSCREEN.

UINT Yukino::Graphics::Paste ( Surface objdst,
int  x,
int  y,
Rect src = NULL 
) const

Función para copiar una región de la pantalla en una Surface.

Esta función sirve para copiar una región determinada de la pantalla, en unas coordenadas de una imagen destino.

Parámetros:
objdst Imagen destino.
x Coordenada x.
y Coordenada y.
src Región origen.
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: GRAPHICS_ERROR_COPYSCREEN.

UINT Yukino::Graphics::Paste ( Surface objdst,
Rect dst = NULL,
Rect src = NULL 
) const

Función para copiar una región de la pantalla en una Surface.

Esta función sirve para copiar una región determinada de la pantalla, en una región también determinada de una imagen destino.

Parámetros:
objdst Imagen destino.
dst Región destino.
src Región origen.
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: GRAPHICS_ERROR_COPYSCREEN.

UINT Yukino::Graphics::PutText ( Font font,
const char *  text,
dword  fc,
int  x,
int  y 
)

Función para poner en pantalla un texto.

Esta función sirve para poner en pantalla una cadena de texto, con una fuente y color determinados, en unas coordenadas de la pantalla.

Parámetros:
font Fuente del texto.
text Cadena con el texto.
fc Color del texto.
x Coordenada x.
y Coordenada y.
Devuelve:
If everything goes well returns 0, on errors returns: GRAPHICS_ERROR_RENDERTEXT, GRAPHICS_ERROR_BLITSURFACE.

UINT Yukino::Graphics::PutText ( Font font,
const char *  text,
dword  fc,
Rect dst = NULL 
)

Función para poner en pantalla un texto.

Esta función sirve para poner en pantalla una cadena de texto, con una fuente y color determinados, en una región destino de la pantalla.

Parámetros:
font Fuente del texto.
text Cadena con el texto.
fc Color del texto.
dst Región destino.
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: GRAPHICS_ERROR_RENDERTEXT, GRAPHICS_ERROR_BLITSURFACE.

UINT Yukino::Graphics::PutUNICODE ( Font font,
const word text,
dword  fc,
int  x,
int  y 
)

Función para poner en pantalla un texto UNICODE.

Esta función sirve para poner en pantalla una cadena de texto, con una fuente y color determinados, en unas coordenadas de la pantalla.

Parámetros:
font Fuente del texto.
text Cadena con el texto.
fc Color del texto.
x Coordenada x.
y Coordenada y.
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: GRAPHICS_ERROR_RENDERTEXT, GRAPHICS_ERROR_BLITSURFACE.

UINT Yukino::Graphics::PutUNICODE ( Font font,
const word text,
dword  fc,
Rect dst = NULL 
)

Función para poner en pantalla un texto UNICODE.

Esta función sirve para poner en pantalla una cadena de texto, con una fuente y color determinados, en una región destino de la pantalla.

Parámetros:
font Fuente del texto.
text Cadena con el texto.
fc Color del texto.
dst Región destino.
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: GRAPHICS_ERROR_RENDERTEXT, GRAPHICS_ERROR_BLITSURFACE.

void Yukino::Graphics::Release ( void   ) 

Función para finalizar el objeto Graphics.

Esta función sirve para finalizar el objeto Graphics.

Ver también:
Init().

void Yukino::Graphics::SetTitle ( const char *  title,
const char *  icon = NULL 
)

Función para cambiar el título de la ventana.

Esta función sirve para cambiar el título de la ventana creada, y el icono de esta, por otro contenido en un fichero.

Parámetros:
title Nuevo título de la ventana.
icon Ruta del nuevo icono.

void Yukino::Graphics::ShowCursor ( void   ) 

Función para mostrar el cursor del ratón.

Esta función sirve para mostrar el cursor del ratón en la aplicación.

Ver también:
HideCursor().

UINT Yukino::Graphics::Update ( void   ) 

Función para actualizar el contenido de la pantalla.

Esta función sirve para actualizar el contenido de la pantalla, ya que la librería por defecto tiene activado el doble buffering.

Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: GRAPHICS_ERROR_UPDATE.


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