From a3aaeaa9a9853069de301cbc33a9bae737a68388 Mon Sep 17 00:00:00 2001
From: Robbert van der Helm <mail@robbertvanderhelm.nl>
Date: Wed, 9 Jun 2021 20:47:52 +0200
Subject: [PATCH] Mention that busses and channels are zero indexed

---
 src/common/audio-shm.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/src/common/audio-shm.h b/src/common/audio-shm.h
index 83dc5fe0..74f2bc1d 100644
--- a/src/common/audio-shm.h
+++ b/src/common/audio-shm.h
@@ -125,7 +125,7 @@ class AudioShmBuffer {
 
     /**
      * 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>
     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
-     * is stored in.
+     * is stored in. Both the bus and the channel indices start at zero.
      */
     template <typename T>
     T* output_channel_ptr(const uint32_t bus, const uint32_t channel) {