Métodos públicos | Métodos protegidos

Referencia de la Clase SoundFX

Recurso que representa a los ficheros con efectos de sonido .wav. Más...

#include <soundFX.h>

Lista de todos los miembros.

Métodos públicos

 SoundFX (Ogre::ResourceManager *creator, const Ogre::String &name, Ogre::ResourceHandle handle, const Ogre::String &group, bool isManual=false, Ogre::ManualResourceLoader *loader=0)
 ~SoundFX ()
int play (int loop=0)

Métodos protegidos

void loadImpl ()
void unloadImpl ()
size_t calculateSize () const

Descripción detallada

Recurso que representa a los ficheros con efectos de sonido .wav.

Autor:
David Saltares Márquez
Fecha:
29-12-2010

La clase SoundFX es un tipo de Recurso utilizado para reproducir efectos de sonido el formato .wav. Para pistas de audio largas es recomendable utilizar la clase Musica.

Para acceder a un recurso de este tipo se utiliza la clase SoundFXManager. Lo usual es obtener un objeto de tipo SoundFXPtr a través de SoundFXManager.


Documentación del constructor y destructor

SoundFX::SoundFX ( Ogre::ResourceManager *  creator,
const Ogre::String &  name,
Ogre::ResourceHandle  handle,
const Ogre::String &  group,
bool  isManual = false,
Ogre::ManualResourceLoader *  loader = 0 
)

Constructor

Parámetros:
creator gestor de recursos que crea el sonido.
name nombre que identifica al recurso.
handle identificador para obtener el recurso de forma más eficiente.
group nombre del grupo al que pertenece el sonido.
isManual si su valor es tru indica que el recurso está siendo cargado mediante un Ogre::ManualResourceLoader.
loader Ogre::ManualResourceLoader encargado de crear el recurso. Solo tiene sentido si isManual vale true.

Crea pero no carga el recurso.

SoundFX::~SoundFX (  ) 

Destruye el recurso y libera la memoria ocupada.


Documentación de las funciones miembro

size_t SoundFX::calculateSize (  )  const [protected]
Devuelve:
espacio en memoria que ocupa el objeto
void SoundFX::loadImpl (  )  [protected]

Carga el efecto de sonido

int SoundFX::play ( int  loop = 0  ) 
Parámetros:
loop número de veces que se repite el sonido. Su valor por defecto es 0, sólo se reproduce una vez. Si vale -1 se reproducirá infinitas veces. Para valores n, se reproduce n+1 veces.
Devuelve:
canal en el que se está reproduciendo el efecto.

Reproduce el efecto de sonido

void SoundFX::unloadImpl (  )  [protected]

Libera la memoria ocupada por el efecto de sonido


La documentación para esta clase fue generada a partir de los siguientes ficheros: