Visual Servoing Platform  version 3.0.1
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
vpFrameGrabber.h
1 /****************************************************************************
2  *
3  * This file is part of the ViSP software.
4  * Copyright (C) 2005 - 2017 by Inria. All rights reserved.
5  *
6  * This software is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * ("GPL") version 2 as published by the Free Software Foundation.
9  * See the file LICENSE.txt at the root directory of this source
10  * distribution for additional information about the GNU GPL.
11  *
12  * For using ViSP with software that can not be combined with the GNU
13  * GPL, please contact Inria about acquiring a ViSP Professional
14  * Edition License.
15  *
16  * See http://visp.inria.fr for more information.
17  *
18  * This software was developed at:
19  * Inria Rennes - Bretagne Atlantique
20  * Campus Universitaire de Beaulieu
21  * 35042 Rennes Cedex
22  * France
23  *
24  * If you have questions regarding the use of this file, please contact
25  * Inria at visp@inria.fr
26  *
27  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
28  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
29  *
30  * Description:
31  * Frame grabbing.
32  *
33  * Authors:
34  * Eric Marchand
35  *
36  *****************************************************************************/
37 
38 
39 
40 #ifndef vpFrameGrabber_hh
41 #define vpFrameGrabber_hh
42 
43 #include <visp3/core/vpImage.h>
44 #include <visp3/core/vpRGBa.h>
45 
102 class VISP_EXPORT vpFrameGrabber
103 {
104 public :
105  bool init ;
106 
107 protected:
108  unsigned int height ;
109  unsigned int width ;
110 
111 public:
114  inline unsigned int getHeight() const { return height ; }
117  inline unsigned int getWidth() const { return width ; }
119 
120 public:
121  vpFrameGrabber() : init(false), height(0), width(0) {};
122  virtual ~vpFrameGrabber() { ; }
123 
124  virtual void open(vpImage<unsigned char> &I) =0 ;
125  virtual void open(vpImage<vpRGBa> &I) =0 ;
126 
127  virtual void acquire(vpImage<unsigned char> &I) =0 ;
128  virtual void acquire(vpImage<vpRGBa> &I) =0 ;
129 
130 
135  virtual void close() =0 ;
136 } ;
137 
138 #endif
virtual ~vpFrameGrabber()
unsigned int getWidth() const
Return the number of columns in the image.
unsigned int height
Number of rows in the image.
Base class for all video devices. It is designed to provide a front end to video sources.
bool init
Set to true if the frame grabber has been initialized.
unsigned int width
Number of columns in the image.