hyperion.ng/libsrc/dispmanx-grabber/DispmanxFrameGrabber.h
T. van der Zwan f8c8fa6c74 Moved open and close of display to the 'grab' method, solving resolution switches.
Added doxygen comments to the dispmanx header.
2013-08-21 14:37:00 +00:00

54 lines
1.4 KiB
C++

#pragma once
// BCM includes
#pragma GCC system_header
#include <bcm_host.h>
// STL includes
#include <cstdint>
// Utils includes
#include <utils/RgbImage.h>
///
/// The DispmanxFrameGrabber is used for creating snapshots of the display (screenshots) with a
/// downsized and scaled resolution.
///
class DispmanxFrameGrabber
{
public:
///
/// Construct a DispmanxFrameGrabber that will capture snapshots with specified dimensions.
///
/// @param[in] width The width of the captured screenshot
/// @param[in] height The heigth of the captured screenshot
///
DispmanxFrameGrabber(const unsigned width, const unsigned height);
~DispmanxFrameGrabber();
///
/// 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)
///
/// @param[out] image The snapped screenshot (should be initialized with correct width and
/// height)
///
void grabFrame(RgbImage& image);
private:
/// Handle to the display that is being captured
DISPMANX_DISPLAY_HANDLE_T _vc_display;
/// Handle to the resource for storing the captured snapshot
DISPMANX_RESOURCE_HANDLE_T _vc_resource;
/// Rectangle of the captured resource that is transfered to user space
VC_RECT_T _rectangle;
/// With of the captured snapshot [pixels]
unsigned _width;
/// Height of the captured snapshot [pixels]
unsigned _height;
};