Fawkes API  Fawkes Development Version
firevision::MirrorCalibTool::StepResult Class Reference

The result of a step contains a YUV buffer. More...

Public Member Functions

 StepResult (size_t buflen, int width, int height)
 Constructor. More...
 
 StepResult (const StepResult &copy)
 Constructor. More...
 
StepResultoperator= (const StepResult &copy)
 Assignment. More...
 
 ~StepResult ()
 Destructor. More...
 
unsigned char * yuv_buffer ()
 YUV buffer. More...
 
const unsigned char * yuv_buffer () const
 YUV buffer. More...
 
size_t buflen () const
 YUV buffer's length. More...
 
int width () const
 Width of YUV buffer. More...
 
int height () const
 Height of YUV buffer. More...
 

Detailed Description

The result of a step contains a YUV buffer.

The different steps are descripted in the MirrorCalibTool's doc.

Definition at line 113 of file mirror_calib.cpp.

Constructor & Destructor Documentation

◆ StepResult() [1/2]

firevision::MirrorCalibTool::StepResult::StepResult ( size_t  buflen,
int  width,
int  height 
)
inline

Constructor.

Parameters
buflen
width
height

Definition at line 126 of file mirror_calib.cpp.

◆ StepResult() [2/2]

firevision::MirrorCalibTool::StepResult::StepResult ( const StepResult copy)
inline

Constructor.

Parameters
copy

Definition at line 138 of file mirror_calib.cpp.

◆ ~StepResult()

firevision::MirrorCalibTool::StepResult::~StepResult ( )
inline

Destructor.

Definition at line 169 of file mirror_calib.cpp.

Member Function Documentation

◆ buflen()

size_t firevision::MirrorCalibTool::StepResult::buflen ( ) const
inline

YUV buffer's length.

Returns
buffer length

Definition at line 187 of file mirror_calib.cpp.

Referenced by firevision::MirrorCalibTool::next_step().

◆ height()

int firevision::MirrorCalibTool::StepResult::height ( ) const
inline

Height of YUV buffer.

Returns
height

Definition at line 195 of file mirror_calib.cpp.

Referenced by firevision::MirrorCalibTool::next_step().

◆ operator=()

StepResult& firevision::MirrorCalibTool::StepResult::operator= ( const StepResult copy)
inline

Assignment.

Parameters
copyresult to assign
Returns
reference to this instance

Definition at line 151 of file mirror_calib.cpp.

◆ width()

int firevision::MirrorCalibTool::StepResult::width ( ) const
inline

Width of YUV buffer.

Returns
height

Definition at line 191 of file mirror_calib.cpp.

Referenced by firevision::MirrorCalibTool::next_step().

◆ yuv_buffer() [1/2]

unsigned char* firevision::MirrorCalibTool::StepResult::yuv_buffer ( )
inline

YUV buffer.

Returns
YUV buffer

Definition at line 179 of file mirror_calib.cpp.

Referenced by firevision::MirrorCalibTool::next_step().

◆ yuv_buffer() [2/2]

const unsigned char* firevision::MirrorCalibTool::StepResult::yuv_buffer ( ) const
inline

YUV buffer.

Returns
YUV buffer

Definition at line 183 of file mirror_calib.cpp.


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