add channel arg to WvIn::tick

StkFrames& tick( StkFrames& frames ) ` is now StkFrames& tick(
StkFrames& frames, unsigned int channel = 0 )` . same applies to
FIleLoop and FileWvIn
This commit is contained in:
Abhi
2014-09-16 12:50:58 -04:00
parent d1acfb07ed
commit b196c58c75
5 changed files with 54 additions and 43 deletions

View File

@@ -140,17 +140,15 @@ class FileLoop : protected FileWvIn
*/
StkFloat tick( unsigned int channel = 0 );
//! Fill the StkFrames argument with computed frames and return the same reference.
//! Fill the StkFrames object with computed sample frames, starting at the specified channel and return the same reference.
/*!
The number of channels in the StkFrames argument should equal
the number of channels in the file data. However, this is only
checked if _STK_DEBUG_ is defined during compilation, in which
case an incompatibility will trigger an StkError exception. If no
file data is loaded, the function does nothing (a warning will be
issued if _STK_DEBUG_ is defined during compilation and
Stk::showWarnings() has been set to \e true).
The \c channel argument plus the number of output channels must
be less than the number of channels in the StkFrames argument (the
first channel is specified by 0). However, range checking is only
performed if _STK_DEBUG_ is defined during compilation, in which
case an out-of-range value will trigger an StkError exception.
*/
StkFrames& tick( StkFrames& frames );
virtual StkFrames& tick( StkFrames& frames,unsigned int channel = 0 );
protected:

View File

@@ -150,16 +150,15 @@ public:
*/
virtual StkFloat tick( unsigned int channel = 0 );
//! Fill the StkFrames argument with computed frames and return the same reference.
//! Fill the StkFrames object with computed sample frames, starting at the specified channel and return the same reference.
/*!
The number of channels in the StkFrames argument must equal
the number of channels in the file data. However, this is only
checked if _STK_DEBUG_ is defined during compilation, in which
case an incompatibility will trigger an StkError exception. If no
file data is loaded, the function does nothing (a warning will be
issued if _STK_DEBUG_ is defined during compilation).
The \c channel argument plus the number of output channels must
be less than the number of channels in the StkFrames argument (the
first channel is specified by 0). However, range checking is only
performed if _STK_DEBUG_ is defined during compilation, in which
case an out-of-range value will trigger an StkError exception.
*/
virtual StkFrames& tick( StkFrames& frames );
virtual StkFrames& tick( StkFrames& frames,unsigned int channel = 0 );
protected:

View File

@@ -31,8 +31,8 @@ public:
//! Compute one sample frame and return the specified \c channel value.
virtual StkFloat tick( unsigned int channel = 0 ) = 0;
//! Fill the StkFrames argument with computed frames and return the same reference.
virtual StkFrames& tick( StkFrames& frames ) = 0;
//! Fill the StkFrames object with computed sample frames, starting at the specified channel and return the same reference.
virtual StkFrames& tick( StkFrames& frames, unsigned int channel = 0 ) = 0;
protected: