Referencia de la Clase Yukino::Core

Clase que gestiona el sistema base. Más...

#include <Core.h>

Lista de todos los miembros.

Métodos públicos

UINT Init (const char *name)
 Función para inicializar el objeto Core.
UINT InitAll (const char *name, int w, int h, int bpp=32, bool winmode=false, int frequency=DEFAULT_FREQUENCY22, word format=DEFAULT_FORMAT, int channels=DEFAULT_NUM_CHANNELS, int chunksize=DEFAULT_CHUNKSIZE)
 Función para inicializar la librería entera.
void Release (void)
 Función para finalizar el objeto Core.
void ReleaseAll (void)
 Función para finalizar la librería entera.
void ErrMsg (const char *msg)
 Función para enviar un mensaje de error por pantalla.
void Delay (UINT ms)
 Función para provocar un paro en la ejecución.
dword GetTime (void)
 Función para obtener el tiempo transcurrido.

Métodos públicos estáticos

static CoreGetInstance (void)
 Función para obtener la instancia de Core.

Atributos públicos

GraphicsAppGraphics
 Objeto para manejar el apartado gráfico.
InputAppInput
 Objeto para manejar la entrada del programa.
AudioAppAudio
 Objeto para manejar el apartado del audio.
ScriptAppScript
 Objeto para manejar el apartado del scripting con Lua.


Descripción detallada

Clase que gestiona el sistema base.

El principal motivo para la existencia de la clase Core es inicializar el sistema base de la librería, sobre el que se montan el resto de funcionalidades de la librería. Para hacer más comodo el uso de los otros apartados, Core contiene punteros a las clases Graphics, Input, Audio y Script.


Documentación de las funciones miembro

void Yukino::Core::Delay ( UINT  ms  )  [inline]

Función para provocar un paro en la ejecución.

Esta función sirve para parar la ejecución del programa durante un número determinado de milisegundos.

Parámetros:
ms Número de milisegundos que paramos la ejecución.

void Yukino::Core::ErrMsg ( const char *  msg  )  [inline]

Función para enviar un mensaje de error por pantalla.

Esta función sirve para que la aplicación muestre un mensaje de error al usuario, en caso de que tras encontrar un error, querramos mostrar una explicación de qué es lo que ha pasado.

Parámetros:
msg Mensaje de error que queremos mostrar al usuario.

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

Función para obtener la instancia de Core.

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

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

dword Yukino::Core::GetTime ( void   )  [inline]

Función para obtener el tiempo transcurrido.

Esta función sirve para obtener el tiempo transcurrido desde el inicio de la aplicación. Normalmente se emplea para cronometrar partes del código.

Devuelve:
Devuelve el número de milisegundos que ha pasado desde que se inició la ejecución del programa.

UINT Yukino::Core::Init ( const char *  name  ) 

Función para inicializar el objeto Core.

Esta función sirve para inicializar tan solo el objeto Core, pasándole el nombre de la aplicación, que va a usar la librería.

Parámetros:
name Nombre de la aplicación.
Ver también:
InitAll(), Release(), ReleaseAll().
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: CORE_ERROR_SDLINIT.

UINT Yukino::Core::InitAll ( const char *  name,
int  w,
int  h,
int  bpp = 32,
bool  winmode = false,
int  frequency = DEFAULT_FREQUENCY22,
word  format = DEFAULT_FORMAT,
int  channels = DEFAULT_NUM_CHANNELS,
int  chunksize = DEFAULT_CHUNKSIZE 
)

Función para inicializar la librería entera.

Esta función sirve para inicializar la librería entera, pasándole los parametros necesarios para iniciar Core, Graphics, Input, Audio y Script.

Parámetros:
name Nombre de la aplicación.
w Ancho de la aplicación.
h Alto de la aplicación.
bpp Profundidad de color de la aplicación.
winmode Modo ventana activado.
frequency Frecuencia del audio.
format Formato del audio.
channels Número de canales del audio.
chunksize Tamaño del buffer del audio.
Ver también:
Init(), Release(), ReleaseAll().
Devuelve:
Si todo va bien devuelve 0, sino devuelve los siguientes errores: CORE_ERROR_SDLINIT, GRAPHICS_ERROR_VIDEOMODEOK, GRAPHICS_ERROR_SETVIDEOMODE, GRAPHICS_ERROR_TTFINIT, INPUT_ERROR_GETKEYSTATE, AUDIO_ERROR_OPEN, AUDIO_ERROR_QUERYSPEC, AUDIO_ERROR_NOTEQU, SCRIPT_ERROR_LUAOPEN.

void Yukino::Core::Release ( void   ) 

Función para finalizar el objeto Core.

Esta función sirve para finalizar tan solo el objeto Core.

Ver también:
Init(), InitAll(), ReleaseAll().

void Yukino::Core::ReleaseAll ( void   ) 

Función para finalizar la librería entera.

Esta función sirve para finalizar la librería entera.

Ver también:
Init(), InitAll(), Release().


Documentación de los datos miembro

Audio* Yukino::Core::AppAudio

Objeto para manejar el apartado del audio.

Esta variable es un puntero al objeto que maneja el apartado del audio de la librería. Desde él podremos manejar el audio y reproducir sonidos.

Graphics* Yukino::Core::AppGraphics

Objeto para manejar el apartado gráfico.

Esta variable es un puntero al objeto que maneja el apartado gráfico de la librería. Desde él podremos hacer llamadas para pintar cualquier Surface que tengamos en la pantalla de la aplicación.

Input* Yukino::Core::AppInput

Objeto para manejar la entrada del programa.

Esta variable es un puntero al objeto que maneja el apartado de la entrada de la librería. Desde él podremos manejar el teclado y el ratón.

Script* Yukino::Core::AppScript

Objeto para manejar el apartado del scripting con Lua.

Esta variable es un puntero al objeto que maneja el apartado del scripting con Lua de la librería. Desde él podremos configurar el interprete, y manejar mínimamente la pila de Lua, al crearnos nuestras funciones.


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