Richard Boegli's CnC_Generals_Zero_Hour Fork WIP
This is documentation of Richard Boegil's Zero Hour Fork
 
Loading...
Searching...
No Matches
SoundBufferClass Class Reference

#include <SoundBuffer.h>

Inherits RefCountClass.

Inherited by StreamSoundBufferClass.

Public Member Functions

 SoundBufferClass (void)
 
virtual ~SoundBufferClass (void)
 
 operator unsigned char * (void)
 
virtual bool Load_From_File (const char *filename)
 
virtual bool Load_From_File (FileClass &file)
 
virtual bool Load_From_Memory (unsigned char *mem_buffer, unsigned long size)
 
virtual unsigned char * Get_Raw_Buffer (void) const
 
virtual unsigned long Get_Raw_Length (void) const
 
virtual const char * Get_Filename (void) const
 
virtual void Set_Filename (const char *name)
 
virtual unsigned long Get_Duration (void) const
 
virtual unsigned long Get_Rate (void) const
 
virtual unsigned long Get_Bits (void) const
 
virtual unsigned long Get_Channels (void) const
 
virtual unsigned long Get_Type (void) const
 
virtual bool Is_Streaming (void) const
 
- Public Member Functions inherited from RefCountClass
 RefCountClass (void)
 
 RefCountClass (const RefCountClass &)
 
void Add_Ref (void) const
 
WWINLINE void Release_Ref (void) const
 
int Num_Refs (void) const
 
virtual void Delete_This (void)
 

Protected Member Functions

virtual void Free_Buffer (void)
 
virtual void Determine_Stats (unsigned char *buffer)
 
- Protected Member Functions inherited from RefCountClass
virtual ~RefCountClass (void)
 

Protected Attributes

unsigned char * m_Buffer
 
unsigned long m_Length
 
char * m_Filename
 
unsigned long m_Duration
 
unsigned long m_Rate
 
unsigned long m_Bits
 
unsigned long m_Channels
 
unsigned long m_Type
 

Additional Inherited Members

- Static Public Member Functions inherited from RefCountClass
static int Total_Refs (void)
 
static RefCountClassAdd_Active_Ref (RefCountClass *obj)
 
static RefCountClassSet_Ref_Owner (RefCountClass *obj, char *file, int line)
 
static void Remove_Active_Ref (RefCountClass *obj)
 
static bool Validate_Active_Ref (RefCountClass *obj)
 
- Public Attributes inherited from RefCountClass
RefCountNodeClass ActiveRefNode
 
ActiveRefStruct ActiveRefInfo
 
- Static Public Attributes inherited from RefCountClass
static RefCountListClass ActiveRefList
 

Detailed Description

Definition at line 63 of file SoundBuffer.h.

Constructor & Destructor Documentation

◆ SoundBufferClass()

SoundBufferClass::SoundBufferClass ( void )

Definition at line 69 of file SoundBuffer.cpp.

◆ ~SoundBufferClass()

SoundBufferClass::~SoundBufferClass ( void )
virtual

Definition at line 87 of file SoundBuffer.cpp.

Member Function Documentation

◆ Determine_Stats()

void SoundBufferClass::Determine_Stats ( unsigned char * buffer)
protectedvirtual

Definition at line 119 of file SoundBuffer.cpp.

◆ Free_Buffer()

void SoundBufferClass::Free_Buffer ( void )
protectedvirtual

Reimplemented in StreamSoundBufferClass.

Definition at line 100 of file SoundBuffer.cpp.

◆ Get_Bits()

virtual unsigned long SoundBufferClass::Get_Bits ( void ) const
inlinevirtual

Definition at line 102 of file SoundBuffer.h.

◆ Get_Channels()

virtual unsigned long SoundBufferClass::Get_Channels ( void ) const
inlinevirtual

Definition at line 103 of file SoundBuffer.h.

◆ Get_Duration()

virtual unsigned long SoundBufferClass::Get_Duration ( void ) const
inlinevirtual

Definition at line 100 of file SoundBuffer.h.

◆ Get_Filename()

virtual const char * SoundBufferClass::Get_Filename ( void ) const
inlinevirtual

Definition at line 98 of file SoundBuffer.h.

◆ Get_Rate()

virtual unsigned long SoundBufferClass::Get_Rate ( void ) const
inlinevirtual

Definition at line 101 of file SoundBuffer.h.

◆ Get_Raw_Buffer()

virtual unsigned char * SoundBufferClass::Get_Raw_Buffer ( void ) const
inlinevirtual

Definition at line 92 of file SoundBuffer.h.

◆ Get_Raw_Length()

virtual unsigned long SoundBufferClass::Get_Raw_Length ( void ) const
inlinevirtual

Definition at line 93 of file SoundBuffer.h.

◆ Get_Type()

virtual unsigned long SoundBufferClass::Get_Type ( void ) const
inlinevirtual

Definition at line 104 of file SoundBuffer.h.

◆ Is_Streaming()

virtual bool SoundBufferClass::Is_Streaming ( void ) const
inlinevirtual

Reimplemented in StreamSoundBufferClass.

Definition at line 109 of file SoundBuffer.h.

◆ Load_From_File() [1/2]

bool SoundBufferClass::Load_From_File ( const char * filename)
virtual

Reimplemented in StreamSoundBufferClass.

Definition at line 169 of file SoundBuffer.cpp.

◆ Load_From_File() [2/2]

bool SoundBufferClass::Load_From_File ( FileClass & file)
virtual

Reimplemented in StreamSoundBufferClass.

Definition at line 197 of file SoundBuffer.cpp.

◆ Load_From_Memory()

bool SoundBufferClass::Load_From_Memory ( unsigned char * mem_buffer,
unsigned long size )
virtual

Reimplemented in StreamSoundBufferClass.

Definition at line 246 of file SoundBuffer.cpp.

◆ operator unsigned char *()

SoundBufferClass::operator unsigned char * ( void )
inline

Definition at line 76 of file SoundBuffer.h.

◆ Set_Filename()

void SoundBufferClass::Set_Filename ( const char * name)
virtual

Definition at line 153 of file SoundBuffer.cpp.

Member Data Documentation

◆ m_Bits

unsigned long SoundBufferClass::m_Bits
protected

Definition at line 127 of file SoundBuffer.h.

◆ m_Buffer

unsigned char* SoundBufferClass::m_Buffer
protected

Definition at line 122 of file SoundBuffer.h.

◆ m_Channels

unsigned long SoundBufferClass::m_Channels
protected

Definition at line 128 of file SoundBuffer.h.

◆ m_Duration

unsigned long SoundBufferClass::m_Duration
protected

Definition at line 125 of file SoundBuffer.h.

◆ m_Filename

char* SoundBufferClass::m_Filename
protected

Definition at line 124 of file SoundBuffer.h.

◆ m_Length

unsigned long SoundBufferClass::m_Length
protected

Definition at line 123 of file SoundBuffer.h.

◆ m_Rate

unsigned long SoundBufferClass::m_Rate
protected

Definition at line 126 of file SoundBuffer.h.

◆ m_Type

unsigned long SoundBufferClass::m_Type
protected

Definition at line 129 of file SoundBuffer.h.


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