Project

General

Profile

BitmapToolkit Scol plugin
Classes | Public Member Functions | List of all members
raspicam::_private::Private_Impl Class Reference

#include <private_impl.h>

Public Member Functions

 Private_Impl ()
 
 ~Private_Impl ()
 
bool open (bool StartCapture=true)
 
bool isOpened () const
 
bool startCapture ()
 
bool isCapturing () const
 
bool grab ()
 
void retrieve (unsigned char *data, RASPICAM_FORMAT type=RASPICAM_FORMAT_IGNORE)
 
unsigned char * getImageBufferData () const
 
size_t getImageBufferSize () const
 
void release ()
 
void setFormat (RASPICAM_FORMAT fmt)
 
void setWidth (unsigned int width)
 
void setHeight (unsigned int height)
 
void setCaptureSize (unsigned int width, unsigned int height)
 
void setBrightness (unsigned int brightness)
 
void setRotation (int rotation)
 
void setISO (int iso)
 
void setSharpness (int sharpness)
 
void setContrast (int contrast)
 
void setSaturation (int saturation)
 
void setExposure (RASPICAM_EXPOSURE exposure)
 
void setVideoStabilization (bool v)
 
void setExposureCompensation (int val)
 
void setAWB (RASPICAM_AWB awb)
 
void setAWB_RB (float red, float blue)
 
void setFrameRate (unsigned int frame_rate)
 
void setImageEffect (RASPICAM_IMAGE_EFFECT imageEffect)
 
void setMetering (RASPICAM_METERING metering)
 
void setHorizontalFlip (bool hFlip)
 
void setVerticalFlip (bool vFlip)
 
void setShutterSpeed (unsigned int shutter)
 
RASPICAM_FORMAT getFormat () const
 
unsigned int getWidth () const
 
unsigned int getHeight () const
 
unsigned int getBrightness () const
 
unsigned int getRotation () const
 
int getISO () const
 
int getSharpness () const
 
int getContrast () const
 
int getSaturation () const
 
int getShutterSpeed () const
 
unsigned int getFrameRate () const
 
RASPICAM_EXPOSURE getExposure () const
 
RASPICAM_AWB getAWB () const
 
float getAWBG_red ()
 
float getAWBG_blue ()
 
RASPICAM_IMAGE_EFFECT getImageEffect () const
 
RASPICAM_METERING getMetering () const
 
bool isHorizontallyFlipped () const
 
bool isVerticallyFlipped () const
 
std::string getId () const
 
size_t getImageTypeSize (RASPICAM_FORMAT type) const
 

Detailed Description

Base class that do all the hard work

Definition at line 55 of file private_impl.h.

Constructor & Destructor Documentation

◆ Private_Impl()

raspicam::_private::Private_Impl::Private_Impl ( )

Constructor

Definition at line 53 of file private_impl.cpp.

◆ ~Private_Impl()

raspicam::_private::Private_Impl::~Private_Impl ( )

Destructor

Definition at line 62 of file private_impl.cpp.

Member Function Documentation

◆ getAWB()

RASPICAM_AWB raspicam::_private::Private_Impl::getAWB ( ) const
inline

Definition at line 203 of file private_impl.h.

◆ getAWBG_blue()

float raspicam::_private::Private_Impl::getAWBG_blue ( )
inline

Definition at line 210 of file private_impl.h.

◆ getAWBG_red()

float raspicam::_private::Private_Impl::getAWBG_red ( )
inline

Definition at line 208 of file private_impl.h.

◆ getBrightness()

unsigned int raspicam::_private::Private_Impl::getBrightness ( ) const
inline

Definition at line 167 of file private_impl.h.

◆ getContrast()

int raspicam::_private::Private_Impl::getContrast ( ) const
inline

Definition at line 183 of file private_impl.h.

◆ getExposure()

RASPICAM_EXPOSURE raspicam::_private::Private_Impl::getExposure ( ) const
inline

Definition at line 199 of file private_impl.h.

◆ getFormat()

RASPICAM_FORMAT raspicam::_private::Private_Impl::getFormat ( ) const
inline

Definition at line 157 of file private_impl.h.

◆ getFrameRate()

unsigned int raspicam::_private::Private_Impl::getFrameRate ( ) const
inline

Definition at line 195 of file private_impl.h.

◆ getHeight()

unsigned int raspicam::_private::Private_Impl::getHeight ( ) const
inline

Definition at line 163 of file private_impl.h.

◆ getId()

string raspicam::_private::Private_Impl::getId ( ) const

Definition at line 794 of file private_impl.cpp.

◆ getImageBufferData()

unsigned char * raspicam::_private::Private_Impl::getImageBufferData ( ) const

Alternative to retrieve. Returns a pointer to the original image data buffer. Be careful, if you call grab(), this will be rewritten with the new data

Definition at line 209 of file private_impl.cpp.

◆ getImageBufferSize()

size_t raspicam::_private::Private_Impl::getImageBufferSize ( ) const

Returns the size of the buffer returned in getImagePtr. If is like calling getImageTypeSize(getFormat()). Just for dummies :P

Definition at line 213 of file private_impl.cpp.

◆ getImageEffect()

RASPICAM_IMAGE_EFFECT raspicam::_private::Private_Impl::getImageEffect ( ) const
inline

Definition at line 212 of file private_impl.h.

◆ getImageTypeSize()

size_t raspicam::_private::Private_Impl::getImageTypeSize ( RASPICAM_FORMAT  type) const

Returns the size of the required buffer for the different image types in retrieve

Definition at line 223 of file private_impl.cpp.

◆ getISO()

int raspicam::_private::Private_Impl::getISO ( ) const
inline

Definition at line 175 of file private_impl.h.

◆ getMetering()

RASPICAM_METERING raspicam::_private::Private_Impl::getMetering ( ) const
inline

Definition at line 216 of file private_impl.h.

◆ getRotation()

unsigned int raspicam::_private::Private_Impl::getRotation ( ) const
inline

Definition at line 171 of file private_impl.h.

◆ getSaturation()

int raspicam::_private::Private_Impl::getSaturation ( ) const
inline

Definition at line 187 of file private_impl.h.

◆ getSharpness()

int raspicam::_private::Private_Impl::getSharpness ( ) const
inline

Definition at line 179 of file private_impl.h.

◆ getShutterSpeed()

int raspicam::_private::Private_Impl::getShutterSpeed ( ) const
inline

Definition at line 191 of file private_impl.h.

◆ getWidth()

unsigned int raspicam::_private::Private_Impl::getWidth ( ) const
inline

Definition at line 159 of file private_impl.h.

◆ grab()

bool raspicam::_private::Private_Impl::grab ( )

Grabs the next frame and keeps it in internal buffer. Blocks until next frame arrives

Definition at line 168 of file private_impl.cpp.

◆ isCapturing()

bool raspicam::_private::Private_Impl::isCapturing ( ) const
inline

Indicates if is capturing

Definition at line 106 of file private_impl.h.

◆ isHorizontallyFlipped()

bool raspicam::_private::Private_Impl::isHorizontallyFlipped ( ) const
inline

Definition at line 220 of file private_impl.h.

◆ isOpened()

bool raspicam::_private::Private_Impl::isOpened ( ) const
inline

indicates if camera is open

Definition at line 97 of file private_impl.h.

◆ isVerticallyFlipped()

bool raspicam::_private::Private_Impl::isVerticallyFlipped ( ) const
inline

Definition at line 224 of file private_impl.h.

◆ open()

bool raspicam::_private::Private_Impl::open ( bool  StartCapture = true)

Opens the camera and start capturing

Definition at line 98 of file private_impl.cpp.

◆ release()

void raspicam::_private::Private_Impl::release ( )

Stops camera and free resources

Definition at line 145 of file private_impl.cpp.

◆ retrieve()

void raspicam::_private::Private_Impl::retrieve ( unsigned char *  data,
RASPICAM_FORMAT  type = RASPICAM_FORMAT_IGNORE 
)

Retrieves the buffer previously grabbed. NOTE: Change in version 0.0.5. Format is stablished in setFormat function So type param is ignored. Do not use this parameter. You can use getFormat to know the current format

Definition at line 176 of file private_impl.cpp.

◆ setAWB()

void raspicam::_private::Private_Impl::setAWB ( RASPICAM_AWB  awb)

Definition at line 618 of file private_impl.cpp.

◆ setAWB_RB()

void raspicam::_private::Private_Impl::setAWB_RB ( float  red,
float  blue 
)

Definition at line 608 of file private_impl.cpp.

◆ setBrightness()

void raspicam::_private::Private_Impl::setBrightness ( unsigned int  brightness)

Definition at line 557 of file private_impl.cpp.

◆ setCaptureSize()

void raspicam::_private::Private_Impl::setCaptureSize ( unsigned int  width,
unsigned int  height 
)

Definition at line 547 of file private_impl.cpp.

◆ setContrast()

void raspicam::_private::Private_Impl::setContrast ( int  contrast)

Definition at line 593 of file private_impl.cpp.

◆ setExposure()

void raspicam::_private::Private_Impl::setExposure ( RASPICAM_EXPOSURE  exposure)

Definition at line 613 of file private_impl.cpp.

◆ setExposureCompensation()

void raspicam::_private::Private_Impl::setExposureCompensation ( int  val)

Definition at line 632 of file private_impl.cpp.

◆ setFormat()

void raspicam::_private::Private_Impl::setFormat ( RASPICAM_FORMAT  fmt)

Definition at line 539 of file private_impl.cpp.

◆ setFrameRate()

void raspicam::_private::Private_Impl::setFrameRate ( unsigned int  frame_rate)

Definition at line 772 of file private_impl.cpp.

◆ setHeight()

void raspicam::_private::Private_Impl::setHeight ( unsigned int  height)

Definition at line 536 of file private_impl.cpp.

◆ setHorizontalFlip()

void raspicam::_private::Private_Impl::setHorizontalFlip ( bool  hFlip)

Definition at line 639 of file private_impl.cpp.

◆ setImageEffect()

void raspicam::_private::Private_Impl::setImageEffect ( RASPICAM_IMAGE_EFFECT  imageEffect)

Definition at line 623 of file private_impl.cpp.

◆ setISO()

void raspicam::_private::Private_Impl::setISO ( int  iso)

Definition at line 581 of file private_impl.cpp.

◆ setMetering()

void raspicam::_private::Private_Impl::setMetering ( RASPICAM_METERING  metering)

Definition at line 628 of file private_impl.cpp.

◆ setRotation()

void raspicam::_private::Private_Impl::setRotation ( int  rotation)

Definition at line 572 of file private_impl.cpp.

◆ setSaturation()

void raspicam::_private::Private_Impl::setSaturation ( int  saturation)

Definition at line 600 of file private_impl.cpp.

◆ setSharpness()

void raspicam::_private::Private_Impl::setSharpness ( int  sharpness)

Definition at line 586 of file private_impl.cpp.

◆ setShutterSpeed()

void raspicam::_private::Private_Impl::setShutterSpeed ( unsigned int  shutter)

Set the shutter speed to the specified value (in microseconds). There is currently an upper limit of approximately 330000us (330ms, 0.33s) past which operation is undefined.

Definition at line 562 of file private_impl.cpp.

◆ setVerticalFlip()

void raspicam::_private::Private_Impl::setVerticalFlip ( bool  vFlip)

Definition at line 644 of file private_impl.cpp.

◆ setVideoStabilization()

void raspicam::_private::Private_Impl::setVideoStabilization ( bool  v)

Definition at line 552 of file private_impl.cpp.

◆ setWidth()

void raspicam::_private::Private_Impl::setWidth ( unsigned int  width)

Definition at line 532 of file private_impl.cpp.

◆ startCapture()

bool raspicam::_private::Private_Impl::startCapture ( )

Starts camera capture

Definition at line 117 of file private_impl.cpp.

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.8