Cinder  0.9.1
Public Types | Public Member Functions | Protected Attributes | List of all members
cinder::audio::BufferInterleavedT< T > Class Template Reference

#include <Buffer.h>

Inherits cinder::audio::BufferBaseT< T >.

Inherited by cinder::audio::BufferDynamicT< BufferInterleaved >.

Public Types

typedef T SampleType
 

Public Member Functions

 BufferInterleavedT (size_t numFrames=0, size_t numChannels=1)
 
void zero (size_t startFrame, size_t numFrames)
 
size_t getNumFrames () const
 
size_t getNumChannels () const
 
size_t getSize () const
 
bool isEmpty () const
 
T * getData ()
 
const T * getData () const
 
T & operator[] (size_t n)
 
const T & operator[] (size_t n) const
 
void zero ()
 

Protected Attributes

std::vector< T > mData
 
size_t mNumChannels
 
size_t mNumFrames
 

Detailed Description

template<typename T>
class cinder::audio::BufferInterleavedT< T >

Audio buffer that stores its channels of type T in one interleaved array (ie. the first sample of channel 1 is directly after the first sample of channel 0).

Member Typedef Documentation

template<typename T>
typedef T cinder::audio::BufferBaseT< T >::SampleType
inherited

The compile-time defined type of samples contained in the buffer.

Constructor & Destructor Documentation

template<typename T >
cinder::audio::BufferInterleavedT< T >::BufferInterleavedT ( size_t  numFrames = 0,
size_t  numChannels = 1 
)

Member Function Documentation

template<typename T >
void cinder::audio::BufferInterleavedT< T >::zero ( size_t  startFrame,
size_t  numFrames 
)
template<typename T>
size_t cinder::audio::BufferBaseT< T >::getNumFrames ( ) const
inherited

Returns the number of frames in the buffer.

template<typename T>
size_t cinder::audio::BufferBaseT< T >::getNumChannels ( ) const
inherited

Returns the number of channels in the buffer.

template<typename T>
size_t cinder::audio::BufferBaseT< T >::getSize ( ) const
inherited

Returns the total size of the buffer (frames * channels).

template<typename T>
bool cinder::audio::BufferBaseT< T >::isEmpty ( ) const
inherited

Returns true if number of frames is zero, false otherwise.

template<typename T>
T* cinder::audio::BufferBaseT< T >::getData ( )
inherited

Returns a pointer to the first sample in the data buffer.

template<typename T>
const T* cinder::audio::BufferBaseT< T >::getData ( ) const
inherited

Returns a const pointer to the first sample in the data buffer.

template<typename T>
T& cinder::audio::BufferBaseT< T >::operator[] ( size_t  n)
inherited
template<typename T>
const T& cinder::audio::BufferBaseT< T >::operator[] ( size_t  n) const
inherited
template<typename T>
void cinder::audio::BufferBaseT< T >::zero ( )
inherited

Sets all samples to the value zero.

Member Data Documentation

template<typename T>
std::vector<T> cinder::audio::BufferBaseT< T >::mData
protectedinherited
template<typename T>
size_t cinder::audio::BufferBaseT< T >::mNumChannels
protectedinherited
template<typename T>
size_t cinder::audio::BufferBaseT< T >::mNumFrames
protectedinherited

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