From 9b65b8182769c7cf993e256444d331ffec9f2d02 Mon Sep 17 00:00:00 2001 From: Matthias Vogelgesang Date: Tue, 1 Mar 2011 09:47:10 +0100 Subject: Documentation added --- src/uca-grabber.h | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) (limited to 'src/uca-grabber.h') diff --git a/src/uca-grabber.h b/src/uca-grabber.h index dd68688..4485b07 100644 --- a/src/uca-grabber.h +++ b/src/uca-grabber.h @@ -46,9 +46,19 @@ typedef uint32_t (*uca_grabber_alloc) (struct uca_grabber_t *grabber, uint32_t n */ typedef uint32_t (*uca_grabber_acquire) (struct uca_grabber_t *grabber, int32_t n_frames); +/** + * \brief Stop acquiring frames + */ typedef uint32_t (*uca_grabber_stop_acquire) (struct uca_grabber_t *grabber); -typedef uint32_t (*uca_grabber_grab) (struct uca_grabber_t *grabber, void **buffer, size_t n_bytes); +/** + * \brief Grab a frame + * + * This method is usually called through the camera interface and not directly. + * + * \param[in] buffer The pointer of the frame buffer is set here + */ +typedef uint32_t (*uca_grabber_grab) (struct uca_grabber_t *grabber, void **buffer); struct uca_grabber_t { -- cgit v1.2.3