Visual Servoing Platform  version 3.6.1 under development (2024-04-22)
vpFrameGrabber.h
1 /*
2  * ViSP, open source Visual Servoing Platform software.
3  * Copyright (C) 2005 - 2023 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 
34 #ifndef vpFrameGrabber_hh
35 #define vpFrameGrabber_hh
36 
37 #include <visp3/core/vpImage.h>
38 #include <visp3/core/vpRGBa.h>
39 
93 class VISP_EXPORT vpFrameGrabber
94 {
95 public:
96  bool init;
97 
98 protected:
99  unsigned int height;
100  unsigned int width;
101 
102 public:
106  unsigned int getHeight() const;
108  unsigned int getWidth() const;
110 
111 public:
112  vpFrameGrabber() : init(false), height(0), width(0) { };
113 
114 #if (VISP_CXX_STANDARD > VISP_CXX_STANDARD_98)
115  virtual ~vpFrameGrabber() = default;
116 #else
117  virtual ~vpFrameGrabber() { }
118 #endif
119  virtual void open(vpImage<unsigned char> &I) = 0;
120  virtual void open(vpImage<vpRGBa> &I) = 0;
121 
122  virtual void acquire(vpImage<unsigned char> &I) = 0;
123  virtual void acquire(vpImage<vpRGBa> &I) = 0;
124 
129  virtual void close() = 0;
130 };
131 
132 #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