hyperion.ng
Public Member Functions | List of all members
FramebufferFrameGrabber Class Reference

The FramebufferFrameGrabber is used for creating snapshots of the display (screenshots) More...

#include <FramebufferFrameGrabber.h>

Inheritance diagram for FramebufferFrameGrabber:
Grabber

Public Member Functions

 FramebufferFrameGrabber (const QString &device, const unsigned width, const unsigned height)
 Construct a FramebufferFrameGrabber that will capture snapshots with specified dimensions. More...
 
int grabFrame (Image< ColorRgb > &image)
 Captures a single snapshot of the display and writes the data to the given image. More...
 
virtual void setDevicePath (const QString &path)
 Overwrite Grabber.h implememtation.
 
- Public Member Functions inherited from Grabber
 Grabber (QString grabberName, int width=0, int height=0, int cropLeft=0, int cropRight=0, int cropTop=0, int cropBottom=0)
 
virtual void setVideoMode (VideoMode mode)
 Set the video mode (2D/3D) More...
 
virtual void setCropping (unsigned cropLeft, unsigned cropRight, unsigned cropTop, unsigned cropBottom)
 Apply new crop values, on errors reject the values.
 
virtual bool setWidthHeight (int width, int height)
 Apply new width/height values, on errors (collide with cropping) reject the values. More...
 
virtual void setPixelDecimation (int pixelDecimation)
 Apply new pixelDecimation (used from x11 and qt)
 
virtual void setSignalThreshold (double redSignalThreshold, double greenSignalThreshold, double blueSignalThreshold, int noSignalCounterThreshold=50)
 Apply new signalThreshold (used from v4l)
 
virtual void setSignalDetectionOffset (double verticalMin, double horizontalMin, double verticalMax, double horizontalMax)
 Apply new SignalDetectionOffset (used from v4l)
 
virtual void setSignalDetectionEnable (bool enable)
 Apply SignalDetectionEnable (used from v4l)
 
virtual void setDeviceVideoStandard (QString device, VideoStandard videoStandard)
 Apply device and videoStanded (used from v4l)
 
virtual void setDisplayIndex (int index)
 Apply display index (used from qt)
 
virtual int getImageWidth ()
 get current resulting height of image (after crop)
 
virtual int getImageHeight ()
 get current resulting width of image (after crop)
 
void setEnabled (bool enable)
 Prevent the real capture implementation from capturing if disabled.
 

Additional Inherited Members

- Protected Attributes inherited from Grabber
ImageResampler _imageResampler
 
bool _useImageResampler
 
VideoMode _videoMode
 the selected VideoMode
 
int _width
 With of the captured snapshot [pixels].
 
int _height
 Height of the captured snapshot [pixels].
 
int _cropLeft
 
int _cropRight
 
int _cropTop
 
int _cropBottom
 
bool _enabled
 
Logger_log
 logger instance
 

Detailed Description

The FramebufferFrameGrabber is used for creating snapshots of the display (screenshots)

Constructor & Destructor Documentation

§ FramebufferFrameGrabber()

FramebufferFrameGrabber::FramebufferFrameGrabber ( const QString &  device,
const unsigned  width,
const unsigned  height 
)

Construct a FramebufferFrameGrabber that will capture snapshots with specified dimensions.

Parameters
[in]deviceThe framebuffer device name/path
[in]widthThe width of the captured screenshot
[in]heightThe heigth of the captured screenshot

Member Function Documentation

§ grabFrame()

int FramebufferFrameGrabber::grabFrame ( Image< ColorRgb > &  image)

Captures a single snapshot of the display and writes the data to the given image.

The provided image should have the same dimensions as the configured values (_width and _height)

Parameters
[out]imageThe snapped screenshot (should be initialized with correct width and height)

The documentation for this class was generated from the following files: