SoundBuffer.hpp

// Copyright 2019 Arthur Sonzogni. All rights reserved.
// Use of this source code is governed by the MIT license that can be found in
// the LICENSE file.
 
#ifndef SMK_SOUND_BUFFER_HPP
#define SMK_SOUND_BUFFER_HPP
 
#include <string>
 
namespace smk {
class Sound;
 
// Please make sure to init OpenAL in main() before loading any file. You can
// initialize the "empty" version first and then std::move the one associated
// with a file.
//
 
/// @brief A sound file loaded in memory.
/// @see Sound
///
/// Example
/// -------
/// ~~~cpp
/// // Load a sound file.
/// auto sound_buffer = smk::SoundBuffer(asset::water_mp3);
///
/// // Create a sound source.
/// auto sound = smk::Sound(sound_buffer);
///
/// // Start playing.
/// sound.Play()
/// ~~~
class SoundBuffer {
 public:
  SoundBuffer();  // Empty sound buffer
  SoundBuffer(const std::string& filename);
 
  ~SoundBuffer();
 
  // --- Move only resource ----------------------------------------------------
  SoundBuffer(SoundBuffer&&) noexcept;
  SoundBuffer(const SoundBuffer&) = delete;
  SoundBuffer& operator=(SoundBuffer&&) noexcept;
  SoundBuffer& operator=(const SoundBuffer&) = delete;
  // ---------------------------------------------------------------------------
 
  unsigned int buffer() const;
 
 private:
  unsigned int buffer_ = 0;
};
}  // namespace smk
 
#endif /* end of include guard: SMK_SOUND_BUFFER_HPP */