X11Grabber Class Reference

Inheritance diagram for X11Grabber:

Public Member Functions
	X11Grabber (int cropLeft, int cropRight, int cropTop, int cropBottom, int pixelDecimation)
bool	Setup ()
virtual int	grabFrame (Image< ColorRgb > &image, bool forceUpdate=false)
	Captures a single snapshot of the display and writes the data to the given image. More...
int	updateScreenDimensions (bool force=false)
	update dimension according current screen
virtual void	setVideoMode (VideoMode mode)
	Set the video mode (2D/3D) More...
virtual bool	setWidthHeight (int width, int height)
	Apply new width/height values, overwrite Grabber.h implementation as X11 doesn't use width/height, just pixelDecimation to calc dimensions.
virtual void	setPixelDecimation (int pixelDecimation)
	Apply new pixelDecimation.
virtual void	setCropping (unsigned cropLeft, unsigned cropRight, unsigned cropTop, unsigned cropBottom)
	Set the crop values. More...
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	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 void	setDevicePath (const QString &path)
	Apply path for device (used from framebuffer)
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

Member Function Documentation

grabFrame()

int X11Grabber::grabFrame ( Image< ColorRgb > &  image, bool  forceUpdate = false  )

virtual

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]

image

The snapped screenshot (should be initialized with correct width and height)

setCropping()

void X11Grabber::setCropping ( unsigned  cropLeft, unsigned  cropRight, unsigned  cropTop, unsigned  cropBottom  )

virtual

Set the crop values.

Parameters

cropLeft	Left pixel crop
cropRight	Right pixel crop
cropTop	Top pixel crop
cropBottom	Bottom pixel crop

Reimplemented from Grabber.

setVideoMode()

void X11Grabber::setVideoMode ( VideoMode  mode )

virtual

Set the video mode (2D/3D)

Parameters

[in]

mode

The new video mode

Reimplemented from Grabber.

---

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

• include/grabber/X11Grabber.h
• libsrc/grabber/x11/X11Grabber.cpp