[libcamera-devel] [PATCH] libcamera: FrameBuffer: Correct Buffer references

Kieran Bingham kieran.bingham at ideasonboard.com
Wed Jul 29 14:02:12 CEST 2020


Update the remaining (capitalised) Buffer references to the new FrameBuffer
object that they refer to.

Lower-case 'buffer' terms are kept, as a generic reference to a buffer
rather than the specific type 'FrameBuffer'.

Signed-off-by: Kieran Bingham <kieran.bingham at ideasonboard.com>
---
 src/libcamera/buffer.cpp | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/src/libcamera/buffer.cpp b/src/libcamera/buffer.cpp
index 0fe12ab93b58..500d1cf791e7 100644
--- a/src/libcamera/buffer.cpp
+++ b/src/libcamera/buffer.cpp
@@ -174,11 +174,11 @@ FrameBuffer::FrameBuffer(const std::vector<Plane> &planes, unsigned int cookie)
  * The intended callers of this method are buffer completion handlers that
  * need to associate a buffer to the request it belongs to.
  *
- * A Buffer is associated to a request by Request::addBuffer() and the
+ * A FrameBuffer is associated to a request by Request::addBuffer() and the
  * association is valid until the buffer completes. The returned request
  * pointer is valid only during that interval.
  *
- * \return The Request the Buffer belongs to, or nullptr if the buffer is
+ * \return The Request the FrameBuffer belongs to, or nullptr if the buffer is
  * not associated with a request
  */
 
@@ -224,7 +224,7 @@ FrameBuffer::FrameBuffer(const std::vector<Plane> &planes, unsigned int cookie)
 
 /**
  * \brief Copy the contents from another buffer
- * \param[in] src Buffer to copy
+ * \param[in] src FrameBuffer to copy
  *
  * Copy the buffer contents and metadata from \a src to this buffer. The
  * destination FrameBuffer shall have the same number of planes as the source
-- 
2.25.1



More information about the libcamera-devel mailing list