summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--src/libcamera/stream.cpp18
1 files changed, 18 insertions, 0 deletions
diff --git a/src/libcamera/stream.cpp b/src/libcamera/stream.cpp
index 71dd461d..aeb479c5 100644
--- a/src/libcamera/stream.cpp
+++ b/src/libcamera/stream.cpp
@@ -211,4 +211,22 @@ Stream::Stream()
* \return The active configuration of the stream
*/
+/**
+ * \var Stream::bufferPool_
+ * \brief The pool of buffers associated with the stream
+ *
+ * The stream buffer pool is populated by the Camera class after a succesfull
+ * stream configuration.
+ */
+
+/**
+ * \var Stream::configuration_
+ * \brief The stream configuration
+ *
+ * The configuration for the stream is set by any successful call to
+ * Camera::configureStreams() that includes the stream, and remains valid until
+ * the next call to Camera::configureStreams() regardless of if it includes the
+ * stream.
+ */
+
} /* namespace libcamera */