Visual Servoing Platform  version 3.6.1 under development (2024-07-23)
vpFrameGrabber.h
1 /*
2  * ViSP, open source Visual Servoing Platform software.
3  * Copyright (C) 2005 - 2024 by Inria. All rights reserved.
4  *
5  * This software is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
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 https://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 
40 #ifndef VP_FRAME_GRABBER_H
41 #define VP_FRAME_GRABBER_H
42 
43 #include <visp3/core/vpConfig.h>
44 #include <visp3/core/vpImage.h>
45 #include <visp3/core/vpRGBa.h>
46 
99 class VISP_EXPORT vpFrameGrabber
100 {
101 public:
102  bool init;
103 
104 public:
108  unsigned int getHeight() const;
110  unsigned int getWidth() const;
112 
113 public:
114  vpFrameGrabber() : init(false), height(0), width(0) { };
115 
116 #if (VISP_CXX_STANDARD > VISP_CXX_STANDARD_98)
117  virtual ~vpFrameGrabber() = default;
118 #else
119  virtual ~vpFrameGrabber() { }
120 #endif
121  virtual void open(vpImage<unsigned char> &I) = 0;
122  virtual void open(vpImage<vpRGBa> &I) = 0;
123 
124  virtual void acquire(vpImage<unsigned char> &I) = 0;
125  virtual void acquire(vpImage<vpRGBa> &I) = 0;
126 
131  virtual void close() = 0;
132 
133 protected:
134  unsigned int height;
135  unsigned int width;
136 };
137 END_VISP_NAMESPACE
138 #endif
Base class for all video devices. It is designed to provide a front end to video sources.
virtual void acquire(vpImage< vpRGBa > &I)=0
virtual void open(vpImage< unsigned char > &I)=0
unsigned int height
Number of rows in the image.
bool init
Set to true if the frame grabber has been initialized.
unsigned int width
Number of columns in the image.
virtual void open(vpImage< vpRGBa > &I)=0
virtual void acquire(vpImage< unsigned char > &I)=0
virtual void close()=0
virtual ~vpFrameGrabber()=default