diff options
author | Matthias Vogelgesang <matthias.vogelgesang@kit.edu> | 2012-02-08 11:39:39 +0100 |
---|---|---|
committer | Matthias Vogelgesang <matthias.vogelgesang@kit.edu> | 2012-02-08 11:39:39 +0100 |
commit | 3df9257175a91fed943959665469ae4c16b2586e (patch) | |
tree | 20f5132e8f8a6ea5babcaaa046c9b0cb9016404c /src/uca-cam.h | |
parent | fe5b686a12d59a03901f056001b5e0e65928f3bb (diff) | |
download | libuca-3df9257175a91fed943959665469ae4c16b2586e.tar.gz libuca-3df9257175a91fed943959665469ae4c16b2586e.tar.bz2 libuca-3df9257175a91fed943959665469ae4c16b2586e.tar.xz libuca-3df9257175a91fed943959665469ae4c16b2586e.zip |
Complete libuca documentation
Diffstat (limited to 'src/uca-cam.h')
-rw-r--r-- | src/uca-cam.h | 40 |
1 files changed, 39 insertions, 1 deletions
diff --git a/src/uca-cam.h b/src/uca-cam.h index 5535dd0..0e07c29 100644 --- a/src/uca-cam.h +++ b/src/uca-cam.h @@ -55,16 +55,54 @@ struct uca_camera_priv *uca_cam_new(void); * Represents a camera abstraction, that concrete cameras must implement. */ typedef struct uca_camera_priv { - /* virtual methods to be overridden by concrete cameras */ + /** + * \see ufo_destroy() + */ uint32_t (*destroy) (struct uca_camera_priv *cam); + + /** + * \see ufo_cam_set_property() + */ uint32_t (*set_property) (struct uca_camera_priv *cam, uca_property_ids property, void *data); + + /** + * \see ufo_cam_get_property() + */ uint32_t (*get_property) (struct uca_camera_priv *cam, uca_property_ids property, void *data, size_t num); + + /** + * \see ufo_cam_start_recording() + */ uint32_t (*start_recording) (struct uca_camera_priv *cam); + + /** + * \see ufo_cam_stop_recording() + */ uint32_t (*stop_recording) (struct uca_camera_priv *cam); + + /** + * \see ufo_cam_trigger() + */ uint32_t (*trigger) (struct uca_camera_priv *cam); + + /** + * \see ufo_cam_register_callback() + */ uint32_t (*register_callback) (struct uca_camera_priv *cam, uca_cam_grab_callback callback, void *user); + + /** + * \see ufo_cam_release_buffer() + */ uint32_t (*release_buffer) (struct uca_camera_priv *cam, void *buffer); + + /** + * \see ufo_cam_grab() + */ uint32_t (*grab) (struct uca_camera_priv *cam, char *buffer, void *meta_data); + + /** + * \see ufo_cam_readout() + */ uint32_t (*readout) (struct uca_camera_priv *cam); struct uca_grabber_priv *grabber; /**< grabber associated with this camera */ |