diff options
| author | Matthias Vogelgesang <matthias.vogelgesang@ipe.fzk.de> | 2011-03-01 09:47:10 +0100 |
|---|---|---|
| committer | Matthias Vogelgesang <matthias.vogelgesang@ipe.fzk.de> | 2011-03-01 09:47:10 +0100 |
| commit | 9b65b8182769c7cf993e256444d331ffec9f2d02 (patch) | |
| tree | c17c373c939c9bca852f72ca958c2c511eea7bb6 /src/uca-grabber.h | |
| parent | a92101a277aed63224e1bd2077c99826e9e35f1d (diff) | |
| download | libuca-9b65b8182769c7cf993e256444d331ffec9f2d02.tar.gz libuca-9b65b8182769c7cf993e256444d331ffec9f2d02.tar.bz2 libuca-9b65b8182769c7cf993e256444d331ffec9f2d02.tar.xz libuca-9b65b8182769c7cf993e256444d331ffec9f2d02.zip | |
Documentation added
Diffstat (limited to 'src/uca-grabber.h')
| -rw-r--r-- | src/uca-grabber.h | 12 |
1 files changed, 11 insertions, 1 deletions
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 { |