diff options
author | Joerg Mueller <nexyon@gmail.com> | 2011-08-16 17:00:55 +0400 |
---|---|---|
committer | Joerg Mueller <nexyon@gmail.com> | 2011-08-16 17:00:55 +0400 |
commit | 02d2472baacd8ac091a29392a2bc9ac8693fb5e7 (patch) | |
tree | dfd8a80ce8c1771a318a46120c81514836ed4b2d /intern/audaspace/OpenAL | |
parent | a67562e73cbc2f4a9641fbc4d1147b4b2cc935c4 (diff) |
3D Audio GSoC:
Code documentation.
Also:
* Fix: rlint for MSVC.
* Minor other small fixes/changes.
Diffstat (limited to 'intern/audaspace/OpenAL')
-rw-r--r-- | intern/audaspace/OpenAL/AUD_OpenALDevice.h | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/intern/audaspace/OpenAL/AUD_OpenALDevice.h b/intern/audaspace/OpenAL/AUD_OpenALDevice.h index 3e8b05d79e2..a04b483132a 100644 --- a/intern/audaspace/OpenAL/AUD_OpenALDevice.h +++ b/intern/audaspace/OpenAL/AUD_OpenALDevice.h @@ -100,6 +100,13 @@ private: public: + /** + * Creates a new OpenAL handle. + * \param device The OpenAL device the handle belongs to. + * \param format The AL format. + * \param reader The reader this handle plays. + * \param keep Whether to keep the handle alive when the reader ends. + */ AUD_OpenALHandle(AUD_OpenALDevice* device, ALenum format, AUD_Reference<AUD_IReader> reader, bool keep); virtual ~AUD_OpenALHandle() {} @@ -214,6 +221,7 @@ private: /** * Starts the streaming thread. + * \param Whether the previous thread should be joined. */ void start(bool join = true); |