vetOutputVoid Class Reference

Inheritance diagram for vetOutputVoid:

Public Member Functions
	vetOutputVoid (bool deleteFrames=false)
	Default constructor initializes variables.
VETRESULT	run ()
	Currently not used.
void	setFrameMemoryClearEnabled (bool value=true)
	Set cleaning mode on/off.
bool	isFrameMemoryClearEnabled ()
	check if frames are cleaned (deleted).
VETRESULT	setInputFrameRate (float fps=0)
	Set display frame rate (elaboration time is not subtracted).
long	getInputFrameRateDelay ()
	Read current input frame delay.
VETRESULT	setHeight (unsigned int value)
	Set current canvas' height.
VETRESULT	setWidth (unsigned int value)
	Set current canvas' width.
VETRESULT	importFrom (vetFrameYUV420 &img)
	Display frame, conversion to vetFrameRGB24 and data-copy routine.
VETRESULT	importFrom (vetFrameRGB24 &img)
	Display frame, data-copy routine. (optimized).
VETRESULT	importFrom (vetFrameT< unsigned char > &img)
	Display frame, conversion to vetFrameRGB24 and single channel data-copy routine.
Protected Attributes
bool	clearMemory
	If true frames are deleted after importing. default is false.
long	v_sleeptime
	millisec to wait before returning program control.

---

Detailed Description

Definition at line 38 of file vetOuputVoid.h.

---

Constructor & Destructor Documentation

vetOutputVoid::vetOutputVoid (  bool  deleteFrames = false  )

Default constructor initializes variables. Parameters: deleteFrames  if true, frames are deleted, nothing is done else. Definition at line 28 of file vetOuputVoid.cpp. References clearMemory, DEBUGMSG, and v_sleeptime.

---

Member Function Documentation

long vetOutputVoid::getInputFrameRateDelay (   )  [inline]

Read current input frame delay. Returns: delay time in milliseconds. See also: v_sleeptime Definition at line 102 of file vetOuputVoid.h. References v_sleeptime.

VETRESULT vetOutputVoid::importFrom (  vetFrameT< unsigned char > &  img  )  [virtual]

Display frame, conversion to vetFrameRGB24 and single channel data-copy routine. Parameters: [in]  img  VETLib Grey Frame to be imported. Returns: VETRET_OK if everything is fine, VETRET_INTERNAL_ERR else. Note: Input operator (<<) call directly this function. See also: operator << (vetFrameT&) Implements vetOutput. Definition at line 117 of file vetOuputVoid.cpp. References clearMemory, DEBUGMSG, v_sleeptime, and VETRET_OK.

VETRESULT vetOutputVoid::importFrom (  vetFrameRGB24 &  img  )  [virtual]

Display frame, data-copy routine. (optimized). Parameters: [in]  img  VETLib Cache24 Frame to be imported. Returns: VETRET_OK if everything is fine, VETRET_INTERNAL_ERR else. Note: Input operator (<<) call directly this function. See also: operator << (vetFrameRGB24&) Implements vetOutput. Definition at line 93 of file vetOuputVoid.cpp. References clearMemory, DEBUGMSG, v_sleeptime, and VETRET_OK.

VETRESULT vetOutputVoid::importFrom (  vetFrameYUV420 &  img  )  [virtual]

Display frame, conversion to vetFrameRGB24 and data-copy routine. Parameters: [in]  img  VETLib Cache Frame to be imported. Returns: VETRET_OK if everything is fine, VETRET_INTERNAL_ERR else. Note: Input operator (<<) call directly this function. See also: operator << (vetFrameYUV420&) Implements vetOutput. Definition at line 70 of file vetOuputVoid.cpp. References clearMemory, DEBUGMSG, v_sleeptime, and VETRET_OK.

bool vetOutputVoid::isFrameMemoryClearEnabled (   )  [inline]

check if frames are cleaned (deleted). Returns: true if after importing frames are cleared (deleted). Definition at line 84 of file vetOuputVoid.h. References clearMemory.

VETRESULT vetOutputVoid::run (   )  [inline]

Currently not used. Returns: VETRET_NOT_IMPLEMENTED Definition at line 69 of file vetOuputVoid.h. References VETRET_NOT_IMPLEMENTED.

void vetOutputVoid::setFrameMemoryClearEnabled (  bool  value = true  )  [inline]

Set cleaning mode on/off. Parameters: [in]  value  if true, frames are deleted, nothing is done else. Definition at line 77 of file vetOuputVoid.h. References clearMemory.

VETRESULT vetOutputVoid::setHeight (  unsigned int  value  )  [inline, virtual]

Set current canvas' height. Returns: height in pixel. Implements vetOutput. Definition at line 110 of file vetOuputVoid.h. References VETRET_NOT_IMPLEMENTED.

VETRESULT vetOutputVoid::setInputFrameRate (  float  fps = 0  )

Set display frame rate (elaboration time is not subtracted). Parameters: [in]  frames  per second (default is 0, no sleep) Returns: VETRET_PARAM_ERR if fps is lower than 0, VETRET_OK else. See also: v_sleeptime Definition at line 45 of file vetOuputVoid.cpp. References v_sleeptime, VETRET_OK, and VETRET_PARAM_ERR.

VETRESULT vetOutputVoid::setWidth (  unsigned int  value  )  [inline, virtual]

Set current canvas' width. Returns: width in pixel. Implements vetOutput. Definition at line 117 of file vetOuputVoid.h. References VETRET_NOT_IMPLEMENTED.

---

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

• vetOuputVoid.h
• vetOuputVoid.cpp

---