Richard Boegli's CnC_Generals_Zero_Hour Fork WIP
This is documentation of Richard Boegil's Zero Hour Fork
 
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
Sound3DHandleClass Class Reference

#include <sound3dhandle.h>

Inherits SoundHandleClass.

Inherited by ListenerHandleClass.

Public Member Functions

 Sound3DHandleClass (void)
 
 ~Sound3DHandleClass (void)
 
Sound3DHandleClass * As_Sound3DHandleClass (void)
 
H3DSAMPLE Get_H3DSAMPLE (void)
 
void Set_Miles_Handle (uint32 handle)
 
void Initialize (SoundBufferClass *buffer)
 
void Start_Sample (void)
 
void Stop_Sample (void)
 
void Resume_Sample (void)
 
void End_Sample (void)
 
void Set_Sample_Pan (S32 pan)
 
S32 Get_Sample_Pan (void)
 
void Set_Sample_Volume (S32 volume)
 
S32 Get_Sample_Volume (void)
 
void Set_Sample_Loop_Count (U32 count)
 
U32 Get_Sample_Loop_Count (void)
 
void Set_Sample_MS_Position (U32 ms)
 
void Get_Sample_MS_Position (S32 *len, S32 *pos)
 
void Set_Sample_User_Data (S32 i, U32 val)
 
U32 Get_Sample_User_Data (S32 i)
 
S32 Get_Sample_Playback_Rate (void)
 
void Set_Sample_Playback_Rate (S32 rate)
 
- Public Member Functions inherited from SoundHandleClass
 SoundHandleClass (void)
 
virtual ~SoundHandleClass (void)
 
virtual Sound2DHandleClass * As_Sound2DHandleClass (void)
 
virtual SoundStreamHandleClass * As_SoundStreamHandleClass (void)
 
virtual ListenerHandleClass * As_ListenerHandleClass (void)
 
virtual HSAMPLE Get_HSAMPLE (void)
 
virtual HSTREAM Get_HSTREAM (void)
 

Protected Attributes

H3DSAMPLE SampleHandle
 
- Protected Attributes inherited from SoundHandleClass
SoundBufferClass * Buffer
 

Detailed Description

Definition at line 52 of file sound3dhandle.h.

Constructor & Destructor Documentation

◆ Sound3DHandleClass()

Sound3DHandleClass::Sound3DHandleClass ( void )

Definition at line 46 of file sound3dhandle.cpp.

◆ ~Sound3DHandleClass()

Sound3DHandleClass::~Sound3DHandleClass ( void )

Definition at line 58 of file sound3dhandle.cpp.

Member Function Documentation

◆ As_Sound3DHandleClass()

Sound3DHandleClass * Sound3DHandleClass::As_Sound3DHandleClass ( void )
inlinevirtual

Reimplemented from SoundHandleClass.

Definition at line 69 of file sound3dhandle.h.

◆ End_Sample()

void Sound3DHandleClass::End_Sample ( void )
virtual

Implements SoundHandleClass.

Definition at line 151 of file sound3dhandle.cpp.

◆ Get_H3DSAMPLE()

H3DSAMPLE Sound3DHandleClass::Get_H3DSAMPLE ( void )
inlinevirtual

Reimplemented from SoundHandleClass.

Definition at line 74 of file sound3dhandle.h.

◆ Get_Sample_Loop_Count()

U32 Sound3DHandleClass::Get_Sample_Loop_Count ( void )
virtual

Implements SoundHandleClass.

Definition at line 241 of file sound3dhandle.cpp.

◆ Get_Sample_MS_Position()

void Sound3DHandleClass::Get_Sample_MS_Position ( S32 * len,
S32 * pos )
virtual

Implements SoundHandleClass.

Definition at line 280 of file sound3dhandle.cpp.

◆ Get_Sample_Pan()

S32 Sound3DHandleClass::Get_Sample_Pan ( void )
virtual

Implements SoundHandleClass.

Definition at line 179 of file sound3dhandle.cpp.

◆ Get_Sample_Playback_Rate()

S32 Sound3DHandleClass::Get_Sample_Playback_Rate ( void )
virtual

Implements SoundHandleClass.

Definition at line 343 of file sound3dhandle.cpp.

◆ Get_Sample_User_Data()

U32 Sound3DHandleClass::Get_Sample_User_Data ( S32 i)
virtual

Implements SoundHandleClass.

Definition at line 325 of file sound3dhandle.cpp.

◆ Get_Sample_Volume()

S32 Sound3DHandleClass::Get_Sample_Volume ( void )
virtual

Implements SoundHandleClass.

Definition at line 207 of file sound3dhandle.cpp.

◆ Initialize()

void Sound3DHandleClass::Initialize ( SoundBufferClass * buffer)
virtual

Reimplemented from SoundHandleClass.

Definition at line 70 of file sound3dhandle.cpp.

◆ Resume_Sample()

void Sound3DHandleClass::Resume_Sample ( void )
virtual

Implements SoundHandleClass.

Definition at line 136 of file sound3dhandle.cpp.

◆ Set_Miles_Handle()

void Sound3DHandleClass::Set_Miles_Handle ( uint32 handle)
virtual

Implements SoundHandleClass.

Definition at line 377 of file sound3dhandle.cpp.

◆ Set_Sample_Loop_Count()

void Sound3DHandleClass::Set_Sample_Loop_Count ( U32 count)
virtual

Implements SoundHandleClass.

Definition at line 225 of file sound3dhandle.cpp.

◆ Set_Sample_MS_Position()

void Sound3DHandleClass::Set_Sample_MS_Position ( U32 ms)
virtual

Implements SoundHandleClass.

Definition at line 259 of file sound3dhandle.cpp.

◆ Set_Sample_Pan()

void Sound3DHandleClass::Set_Sample_Pan ( S32 pan)
virtual

Implements SoundHandleClass.

Definition at line 167 of file sound3dhandle.cpp.

◆ Set_Sample_Playback_Rate()

void Sound3DHandleClass::Set_Sample_Playback_Rate ( S32 rate)
virtual

Implements SoundHandleClass.

Definition at line 361 of file sound3dhandle.cpp.

◆ Set_Sample_User_Data()

void Sound3DHandleClass::Set_Sample_User_Data ( S32 i,
U32 val )
virtual

Implements SoundHandleClass.

Definition at line 310 of file sound3dhandle.cpp.

◆ Set_Sample_Volume()

void Sound3DHandleClass::Set_Sample_Volume ( S32 volume)
virtual

Implements SoundHandleClass.

Definition at line 191 of file sound3dhandle.cpp.

◆ Start_Sample()

void Sound3DHandleClass::Start_Sample ( void )
virtual

Implements SoundHandleClass.

Definition at line 105 of file sound3dhandle.cpp.

◆ Stop_Sample()

void Sound3DHandleClass::Stop_Sample ( void )
virtual

Implements SoundHandleClass.

Definition at line 120 of file sound3dhandle.cpp.

Member Data Documentation

◆ SampleHandle

H3DSAMPLE Sound3DHandleClass::SampleHandle
protected

Definition at line 108 of file sound3dhandle.h.

The documentation for this class was generated from the following files: