HGE::Effect_Load

Загружает звуковой эффект из памяти, архива ресурсов или с диска.

HEFFECT Effect_Load(
  const char *filename,
  DWORD size = 0
);

Параметры

filename
Имя файла звукового эффекта.
size
Если этот параметр не равен 0, то он означает размер блоков памяти, содержащих звуковой эффект в одном из известных форматов и параметр filename рассматривается как указатель на память этого блока.

Возвращаемое значение

В случае успеха, возвращается идентификатор эффекта, который можно использовать в функциях Effect_Play и Effect_PlayEx. В противном случае возвращается 0.

Примечания

Поддерживаются аудио форматы WAV, MP3, MP2, MP1 and OGG.

Если filename определяет относительный путь, звуковой файл сначала ищется во всех присоединенных ресурсаз функцией Resource_AttachPack файлах ресурсов, затем в директории приложения. Если filename определяет абсолютный путь, звуковой файл загружается напрямую с диска.

Если функция завершается аварийно, вы можете получить сообщение об ошибке вызовом функции System_GetErrorMessage. Если установлена переменная системы HGE_LOGFILE, сообщение об ошибке будет записано в файл протокола.

Когда звуковой эффект больше не нужен, необходимо удалить его вызовом функции Effect_Free.

Требования

Заголовок: hge.h
Библиотека импорта: hge.lib

Смотрите также

Effect_Free, Effect_Play, Effect_PlayEx