lauchmelder/SFML
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added rdoc comments to all audio classes.

Browse source 
git-svn-id: https://sfml.svn.sourceforge.net/svnroot/sfml/branches/sfml2@1714 4e206d99-4929-0410-ac5d-dfc041789085
This commit is contained in:
groogy 2010-11-25 19:30:10 +00:00
parent 191776fbec
commit 50a5ecd79f
7 changed files with 336 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

13
bindings/ruby/sfml-audio/audio/SoundBufferRecorder.cpp
View file

@ -103,6 +103,14 @@ static void SoundBufferRecorder_Free( rbSoundBufferRecorder * anObject )
delete anObject;
}
/* call-seq:
* sound_buffer_recorder.getBuffer() -> sound_buffer
*
* Get the sound buffer containing the captured audio data.
*
* The sound buffer is valid only after the capture has ended. This function provides a read-only access to the internal
* sound buffer, but it can be copied if you need to make any modification to it.
*/
static VALUE SoundBufferRecorder_GetBuffer( VALUE self )
{
sf::SoundBufferRecorder *object = NULL;
@ -113,6 +121,11 @@ static VALUE SoundBufferRecorder_GetBuffer( VALUE self )
return rbData;
}
/* call-seq:
* SoundBufferRecorder.new() -> sound_buffer_recorder
*
* Creates a sound buffer recorder instance for us.
*/
static VALUE SoundBufferRecorder_New( int argc, VALUE *args, VALUE aKlass )
{
rbSoundBufferRecorder *object = new rbSoundBufferRecorder();