Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

IEAXBuffer Class Reference

Public EAX buffer interface extension. More...

#include <IAudioExt.h>

List of all members.

Public Methods

virtual void SetDirect (int32 iDirect)=0
virtual void SetDirectHF (int32 iDirectHF)=0
virtual void SetRoom (int32 iRoom)=0
virtual void SetRoomHF (int32 iRoomHF)=0
virtual void SetRoomRolloffFactor (float fRoomRolloffFactor)=0
virtual void SetObstruction (int32 iObstruction)=0
virtual void SetObstructionLFRatio (float fObstructionLFRatio)=0
virtual void SetOcclusion (int32 iOcclusion)=0
virtual void SetOcclusionLFRatio (float fOcclusionLFRatio)=0
virtual void SetOcclusionRoomRatio (float fOcclusionRoomRatio)=0
virtual void SetOutsideVolumeHF (int32 iOutsideVolumeHF)=0
virtual void SetAirAbsorptionFactor (float fAirAbsorptionFactor)=0
virtual void SetFlags (uint32 nFlags)=0
virtual void SetProperties (const EAXBufferProps &props)=0
virtual void GetProperties (EAXBufferProps &props)=0


Detailed Description

Public EAX buffer interface extension.

IEAXBuffer is a public interface class designed to provide an easy-to-use interface to a buffer's EAX properties. The interface is obtained through the function ISound3D::EAX(), and it always guaranteed to return a valid interface, even if EAX is disabled. The specialized interface is much easier to use than a generic property set interface. IEAXBuffer and any related structures and interfaces are based on the EAX 2.0 specifications.

See also:
IEAXListener, ISound3D, ISound3D::EAX()


Member Function Documentation

void IEAXBuffer::GetProperties ( EAXBufferProps & props ) [pure virtual]
 

Gets all current EAX buffer parameters

Parameters:
props   all EAX buffer properties

void IEAXBuffer::SetAirAbsorptionFactor ( float fAirAbsorptionFactor ) [pure virtual]
 

Sets the air absorption factor

Parameters:
fAirAbsorption   Valid range from 0.0 to 10.0. Defaults to 1.0

void IEAXBuffer::SetDirect ( int32 iDirect ) [pure virtual]
 

Sets the direct path audio level

Parameters:
iDirect   Valid range from -10000 to 1000. Defaults to 0

void IEAXBuffer::SetDirectHF ( int32 iDirectHF ) [pure virtual]
 

Sets the direct path audio level at high frequencies

Parameters:
iDirectHF   Valid range from -10000 to 0. Defaults to 0

void IEAXBuffer::SetFlags ( uint32 nFlags ) [pure virtual]
 

Sets all EAX buffer flags - see EAX documentation for details

Parameters:
fEnvironmentDiffusion   all EAX buffer flags

void IEAXBuffer::SetObstruction ( int32 iObstruction ) [pure virtual]
 

Sets the buffer's obstruction level

Parameters:
iObstruction   Valid range from -10000 to 0. Defaults to 0

void IEAXBuffer::SetObstructionLFRatio ( float fObstructionLFRatio ) [pure virtual]
 

Sets the buffer's obstruction low-frequency level

Parameters:
fObstructionLFRatio   Valid range from 0.0 to 1.0. Defaults to 0.0

void IEAXBuffer::SetOcclusion ( int32 iOcclusion ) [pure virtual]
 

Sets the buffer's occlusion level

Parameters:
iOcclusion   Valid range from -10000 to 0. Defaults to 0

void IEAXBuffer::SetOcclusionLFRatio ( float fOcclusionLFRatio ) [pure virtual]
 

Sets the buffer's occlusion low-frequency level

Parameters:
fOcclusionLFRatio   Valid range from 0.0 to 1.0. Defaults to 0.25

void IEAXBuffer::SetOcclusionRoomRatio ( float fOcclusionRoomRatio ) [pure virtual]
 

Sets the buffer's room-level occlusion control

Parameters:
fOcclusionRoomRatio   Valid range from 0.0 to 10.0. Defaults to 0.5

void IEAXBuffer::SetOutsideVolumeHF ( int32 iOutsideVolumeHF ) [pure virtual]
 

Sets the buffer's outside volume for high frequencies

Parameters:
iOutsideVolumeHF   Valid range from -10000 to 0. Defaults to 0

void IEAXBuffer::SetProperties ( const EAXBufferProps & props ) [pure virtual]
 

Sets all current EAX buffer parameters

Parameters:
props   all EAX buffer properties

void IEAXBuffer::SetRoom ( int32 iRoom ) [pure virtual]
 

Sets the room effect level

Parameters:
iRoom   Valid range from -10000 to 1000. Defaults to 0

void IEAXBuffer::SetRoomHF ( int32 iRoomHF ) [pure virtual]
 

Sets the room effect level at high frequencies

Parameters:
iRoomHF   Valid range from -10000 to 0. Defaults to 0

void IEAXBuffer::SetRoomRolloffFactor ( float fRoomRolloffFactor ) [pure virtual]
 

Sets the room effect rolloff factor

Parameters:
fRoomRolloffFactor   Valid range from 0.0 to 10.0. Defaults to 0.0


The documentation for this class was generated from the following file:
Generated at Sun Jul 28 23:17:42 2002 for GAP Audio System by doxygen1.2.8.1 written by Dimitri van Heesch, © 1997-2001