record TSoundInfo

DescriptionHierarchyFieldsMethodsProperties

Unit

Declaration

type TSoundInfo = record

Description

This is an internal type used within TGameSoundEngine.

Although you still may want to familiarize with it's fields, as they correspond to appropriate fields in your sounds/index.xml file. All of the fields besides Buffer are initialized only by ReadSoundInfos.

From the point of view of end-user playing the game the number of sounds is constant for given game and their properties (expressed in TSoundInfo below) are also constant. However, for the sake of debugging/testing the game, and for content designers, the actual values of SoundInfos are loaded at initialization by ReadSoundInfos (called automatically by ALContextInit) from sounds/index.xml file, and later can be changed by calling ReadSoundInfos once again during the game (debug menu may have command like "Reload sounds/index.xml").

Overview

Fields

FileName: string;
Gain: Single;
MinGain: Single;
MaxGain: Single;
DefaultImportance: Cardinal;
Buffer: TALuint;

Description

Fields

FileName: string;

'' means that this sound is not implemented and will have no OpenAL buffer associated with it.

Gain: Single;

XxxGain are mapped directly on respective OpenAL source properties. Note that Gain > 1 is allowed (because OpenAL allows it), although OpenAL may clip them for the resulting sound (after all calculations taking into account 3d position will be done). MaxGain is not allowed to be > 1 (under Windows impl, Linux impl allows it, but that's about it).

When sound is used for MusicPlayer.PlayedSound: 1. MinGain, MaxGain are ignored 2. Gain is always multiplied by MusicVolume when setting AL_GAIN of the music source.

MinGain: Single;

XxxGain are mapped directly on respective OpenAL source properties. Note that Gain > 1 is allowed (because OpenAL allows it), although OpenAL may clip them for the resulting sound (after all calculations taking into account 3d position will be done). MaxGain is not allowed to be > 1 (under Windows impl, Linux impl allows it, but that's about it).

When sound is used for MusicPlayer.PlayedSound: 1. MinGain, MaxGain are ignored 2. Gain is always multiplied by MusicVolume when setting AL_GAIN of the music source.

MaxGain: Single;

XxxGain are mapped directly on respective OpenAL source properties. Note that Gain > 1 is allowed (because OpenAL allows it), although OpenAL may clip them for the resulting sound (after all calculations taking into account 3d position will be done). MaxGain is not allowed to be > 1 (under Windows impl, Linux impl allows it, but that's about it).

When sound is used for MusicPlayer.PlayedSound: 1. MinGain, MaxGain are ignored 2. Gain is always multiplied by MusicVolume when setting AL_GAIN of the music source.

DefaultImportance: Cardinal;

Importance, as passed to TALSourceAllocator. This is ignored when sound is used for MusicPlayer.PlayedSound.

Buffer: TALuint;

OpenAL buffer of this sound. This is usable only when ALContextInited and only for sounds with FileName <> ''.


Generated by PasDoc 0.10.0 on 2008-02-25 00:00:30