Mirror/libcamera
1
0
Fork 0
mirror of https://git.libcamera.org/libcamera/libcamera.git synced 2025-07-24 00:55:07 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

libcamera: Fix documentation of buffer allocation/export functions

Browse source 
The V4L2VideoDevice::exportBuffers(),
PipelineHandler::exportFrameBuffers() and
FrameBufferAllocator::allocate() functions all return the number of
allocated buffers on success, but are documented as returning 0 in that
case. Fix their documentation.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>
This commit is contained in:
Laurent Pinchart 2020-01-20 13:24:50 +02:00
parent 667f53b522
commit ce2ea24fb4
3 changed files with 8 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

9
src/libcamera/framebuffer_allocator.cpp
View file

@ -108,7 +108,8 @@ FrameBufferAllocator::~FrameBufferAllocator()
* Upon successful allocation, the allocated buffers can be retrieved with the * Upon successful allocation, the allocated buffers can be retrieved with the
* buffers() method. * buffers() method.
* *
* \return 0 on success or a negative error code otherwise * \return The number of allocated buffers on success or a negative error code
* otherwise
* \retval -EACCES The camera is not in a state where buffers can be allocated * \retval -EACCES The camera is not in a state where buffers can be allocated
* \retval -EINVAL The \a stream does not belong to the camera or the stream is * \retval -EINVAL The \a stream does not belong to the camera or the stream is
* not part of the active camera configuration * not part of the active camera configuration
@ -140,12 +141,8 @@ int FrameBufferAllocator::allocate(Stream *stream)
return -EBUSY; return -EBUSY;
} }
int ret = camera_->pipe_->exportFrameBuffers(camera_.get(), stream, return camera_->pipe_->exportFrameBuffers(camera_.get(), stream,
&buffers_[stream]); &buffers_[stream]);
if (ret)
return ret;
return 0;
} }
/** /**

3
src/libcamera/pipeline_handler.cpp
View file

@ -316,7 +316,8 @@ const ControlInfoMap &PipelineHandler::controls(Camera *camera)
* *
* The only intended caller is the FrameBufferAllocator helper. * The only intended caller is the FrameBufferAllocator helper.
* *
* \return 0 on success or a negative error code otherwise * \return The number of allocated buffers on success or a negative error code
* otherwise
*/ */
/** /**

3
src/libcamera/v4l2_videodevice.cpp
View file

@ -973,7 +973,8 @@ int V4L2VideoDevice::requestBuffers(unsigned int count)
* \brief Allocate buffers from the video device * \brief Allocate buffers from the video device
* \param[in] count Number of buffers to allocate * \param[in] count Number of buffers to allocate
* \param[out] buffers Vector to store allocated buffers * \param[out] buffers Vector to store allocated buffers
* \return 0 on success or a negative error code otherwise * \return The number of allocated buffers on success or a negative error code
* otherwise
*/ */
int V4L2VideoDevice::exportBuffers(unsigned int count, int V4L2VideoDevice::exportBuffers(unsigned int count,
std::vector<std::unique_ptr<FrameBuffer>> *buffers) std::vector<std::unique_ptr<FrameBuffer>> *buffers)