Mention that busses and channels are zero indexed

This commit is contained in:
Robbert van der Helm
2021-06-09 20:47:52 +02:00
parent 2210cb4fc3
commit a3aaeaa9a9
+2 -2
View File
@@ -125,7 +125,7 @@ class AudioShmBuffer {
/** /**
* Get a pointer to the part of the buffer where this input audio channel is * Get a pointer to the part of the buffer where this input audio channel is
* stored in. * stored in. Both the bus and the channel indices start at zero.
*/ */
template <typename T> template <typename T>
T* input_channel_ptr(const uint32_t bus, const uint32_t channel) { T* input_channel_ptr(const uint32_t bus, const uint32_t channel) {
@@ -135,7 +135,7 @@ class AudioShmBuffer {
/** /**
* Get a pointer to the part of the buffer where this output audio channel * Get a pointer to the part of the buffer where this output audio channel
* is stored in. * is stored in. Both the bus and the channel indices start at zero.
*/ */
template <typename T> template <typename T>
T* output_channel_ptr(const uint32_t bus, const uint32_t channel) { T* output_channel_ptr(const uint32_t bus, const uint32_t channel) {