Referencia de la Clase Yukino::Surface

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

#include <Surface.h>

Diagrama de herencias de Yukino::Surface

Yukino::Sprite Lista de todos los miembros.

Métodos públicos

 Surface ()
 Constructor de la clase Surface.
 Surface (int w, int h, int bpp)
 Constructor de la clase Surface.
 Surface (const string &file)
 Constructor de la clase Surface.
 Surface (const char *file)
 Constructor de la clase Surface.
 Surface (SDL_Surface *surface)
 Constructor de la clase Surface.
 Surface (const Surface &obj)
 Constructor copia de la clase Surface.
virtual Surfaceoperator= (Surface &obj)
 Operador = de la clase Surface.
 ~Surface ()
 Destructor de la clase Surface.
UINT Create (int w, int h, int bpp)
 Función para crear una imagen en blanco en la Surface.
UINT SetColorKey (Uint32 color=COLOR_PINK)
 Función para poner un color de transparencia a la imagen.
UINT Transform (void)
 Función para transformar el formato de la imagen al de la pantalla.
UINT Fill (Uint32 color, Rect *rect=NULL)
 Función para rellenar con un color una región de la imagen.
virtual UINT Load (const char *file)
 Función para cargar una Surface de un fichero.
virtual UINT Load (const string &file)
 Función para cargar una Surface de un fichero.
virtual UINT Save (const char *file)
 Función para salvar una Surface en un fichero BMP.
virtual UINT Save (const string &file)
 Función para salvar una Surface en un fichero BMP.
virtual void Free (void)
 Función para liberar los datos del objeto Surface.
UINT Copy (const Surface &objsrc, Rect *dst=NULL, Rect *src=NULL)
 Función para poner en la imagen una región de una Surface.
UINT Copy (const Surface &objsrc, int x, int y, Rect *src=NULL)
 Función para poner en la imagen una región de una Surface.
UINT Paste (Surface &objdst, Rect *dst=NULL, Rect *src=NULL) const
 Función para copiar una región de la imagen en una Surface.
UINT Paste (Surface &objdst, int x, int y, Rect *src=NULL) const
 Función para copiar una región de la imagen en una Surface.
UINT Copy (SDL_Surface *srfsrc, Rect *dst=NULL, Rect *src=NULL)
 Función para poner en la imagen una región de una SDL_Surface.
UINT Copy (SDL_Surface *srfsrc, int x, int y, Rect *src=NULL)
 Función para poner en la imagen una región de una SDL_Surface.
UINT Paste (SDL_Surface *srfdst, Rect *dst=NULL, Rect *src=NULL) const
 Función para copiar una región de la imagen 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 imagen en una SDL_Surface.

Descripción detallada

Clase para almacenar una imagen.

La clase Surface sirve para almacenar en memoria una imagen contenida en un fichero BMP, PNG, TGA, JPG, PCX, GIF, TIF, PNM, XPM, XCF o LBM. Una vez almacenada podemos manejarla para copiar regiones de una Surface a otra. Y añadir algunos efectos.


Documentación del constructor y destructor

Yukino::Surface::Surface (  ) 

Constructor de la clase Surface.

Constructor por defecto de la clase Surface.

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

Yukino::Surface::Surface ( int  w,
int  h,
int  bpp 
)

Constructor de la clase Surface.

Constructor de la clase Surface, que crea una imagen en blanco.

Parámetros:
w Ancho de la imagen.
h Alto de la imagen.
bpp Profundidad de color de la imagen.
Ver también:
operator=(), ~Surface().

Yukino::Surface::Surface ( const string &  file  ) 

Constructor de la clase Surface.

Constructor de la clase Surface, que carga un fichero.

Parámetros:
file Ruta del fichero.
Ver también:
operator=(), ~Surface().

Yukino::Surface::Surface ( const char *  file  ) 

Constructor de la clase Surface.

Constructor de la clase Surface, que carga un fichero.

Parámetros:
file Ruta del fichero.
Ver también:
operator=(), ~Surface().

Yukino::Surface::Surface ( SDL_Surface *  surface  ) 

Constructor de la clase Surface.

Constructor de la clase Surface, que recive una imagen.

Parámetros:
surface La imagen.
Ver también:
operator=(), ~Surface().

Yukino::Surface::Surface ( const Surface obj  ) 

Constructor copia de la clase Surface.

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

Yukino::Surface::~Surface (  ) 

Destructor de la clase Surface.

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


Documentación de las funciones miembro

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

Función para poner en la imagen una región de una SDL_Surface.

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

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: SURFACE_ERROR_COPY.

UINT Yukino::Surface::Copy ( SDL_Surface *  srfsrc,
Rect dst = NULL,
Rect src = NULL 
)

Función para poner en la imagen una región de 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 imagen.

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: SURFACE_ERROR_COPY.

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

Función para poner en la imagen una región de una Surface.

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

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: SURFACE_ERROR_COPY.

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

Función para poner en la imagen una región de 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 imagen.

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: SURFACE_ERROR_COPY.

UINT Yukino::Surface::Create ( int  w,
int  h,
int  bpp 
)

Función para crear una imagen en blanco en la Surface.

Esta función sirve para crear una imagen en blanco en la Surface.

Parámetros:
w Ancho de la imagen.
h Alto de la imagen.
bpp Profundidad de color de la imagen.
Ver también:
Load(), Save(), Free().
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: SURFACE_ERROR_CREATESURF.

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

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

Esta función sirve para rellenar una región de la imagen, 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: SURFACE_ERROR_FILLRECT.

void Yukino::Surface::Free ( void   )  [virtual]

Función para liberar los datos del objeto Surface.

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

Ver también:
Create(), Load(), Save().

Reimplementado en Yukino::Sprite.

virtual UINT Yukino::Surface::Load ( const string &  file  )  [inline, virtual]

Función para cargar una Surface de un fichero.

Esta función sirve para cargar una Surface de un fichero.

Parámetros:
file Ruta del fichero.
Ver también:
Create(), Save(), Free().
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: SURFACE_ERROR_RWFROMFILE, SURFACE_ERROR_UNKOWNFORMAT, SURFACE_ERROR_LOADINGFILE.

Reimplementado en Yukino::Sprite.

UINT Yukino::Surface::Load ( const char *  file  )  [virtual]

Función para cargar una Surface de un fichero.

Esta función sirve para cargar una Surface de un fichero.

Parámetros:
file Ruta del fichero.
Ver también:
Create(), Save(), Free().
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: SURFACE_ERROR_RWFROMFILE, SURFACE_ERROR_UNKOWNFORMAT, SURFACE_ERROR_LOADINGFILE.

Reimplementado en Yukino::Sprite.

Surface & Yukino::Surface::operator= ( Surface obj  )  [virtual]

Operador = de la clase Surface.

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

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

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

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

Esta función sirve para copiar una región determinada de la imagen, 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: SURFACE_ERROR_PASTE.

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

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

Esta función sirve para copiar una región determinada de la imagen, 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: SURFACE_ERROR_PASTE.

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

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

Esta función sirve para copiar una región determinada de la imagen, 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: SURFACE_ERROR_PASTE.

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

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

Esta función sirve para copiar una región determinada de la imagen, 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: SURFACE_ERROR_PASTE.

virtual UINT Yukino::Surface::Save ( const string &  file  )  [inline, virtual]

Función para salvar una Surface en un fichero BMP.

Esta función sirve para salvar la Surface en un fichero BMP.

Parámetros:
file Ruta del fichero.
Ver también:
Create(), Load(), Free().
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: SURFACE_ERROR_SAVINGFILE.

UINT Yukino::Surface::Save ( const char *  file  )  [virtual]

Función para salvar una Surface en un fichero BMP.

Esta función sirve para salvar la Surface en un fichero BMP.

Parámetros:
file Ruta del fichero.
Ver también:
Create(), Load(), Free().
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: SURFACE_ERROR_SAVINGFILE.

UINT Yukino::Surface::SetColorKey ( Uint32  color = COLOR_PINK  ) 

Función para poner un color de transparencia a la imagen.

Esta función sirve para que la imagen pueda tener transparencia.

Parámetros:
color Color clave.
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: SURFACE_ERROR_SETCOLORKEY.

UINT Yukino::Surface::Transform ( void   ) 

Función para transformar el formato de la imagen al de la pantalla.

Esta función sirve para transformar el formato de la imagen almacenada en la Surface, al mismo formato que tiene el buffer de pantalla.

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


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