vetFrame Class Reference

An abstract base class for all images in VETLib. More...

#include <vetFrame.h>

Inheritance diagram for vetFrame:

Public Types
enum	VETFRAME_PROFILE
enum	VETFRAME_CHANNEL_TYPE
enum
	Ignore this, it's a class-type definition, mostly used by VETLib WorkShop, sintax is a bit more complex than usual because of a VC6 BUG, it's the same as: const int vetClassType = VETCLASS_TYPE_FRAME;.
Public Member Functions
	vetFrame ()
	Create an image with 0x0 dimension.
	vetFrame (unsigned int w, unsigned int h)
	Create an image with the given dimensions.
virtual	~vetFrame ()
	Default virtual destructor.
virtual void *	dump_buffer ()=0
	Read current buffer address.
virtual unsigned int	getBufferSize ()=0
	Read current buffer size (for example the real size of array).
virtual VETRESULT	setBlack ()=0
	Initialize image (with current canvas) to black (min brightness).
virtual VETRESULT	setWhite ()=0
	Initialize image (with current canvas) to white (max brightness).
unsigned int	getWidth () const
	Read current image's width.
unsigned int	getWidth ()
	Read current image's width.
unsigned int	getHeight () const
	Read current image's height.
unsigned int	getHeight ()
	Read current image's height.
virtual unsigned int	getBpp ()=0
	Get current format's BPP (Bits per Pixel).
virtual VETFRAME_PROFILE	getProfile ()=0
virtual VETFRAME_CHANNEL_TYPE	getChannelType ()=0
virtual int	getFOURCC ()=0
	Get FOURCC code of current data format, visit http://www.fourcc.org for all codes.
Data Fields
unsigned int	width
unsigned int	height
long	timeStamp
	Copy Constructor.

---

Detailed Description

An abstract base class for all images in VETLib.

Bug:

Warning:

Todo:

Version:

1.0.2

Date:

22/12/2005

Author:

Alessandro Polo

VETLib Framework 1.0.2 Copyright (C) Alessandro Polo 2006 http://www.ewgate.net/vetlib

Definition at line 29 of file vetFrame.h.

---

Constructor & Destructor Documentation

vetFrame::vetFrame (   )  [inline]

Create an image with 0x0 dimension. Default constructor. protected as an instance of this class cannot be directly created. instead an instance of an inherited class should be used. Definition at line 65 of file vetFrame.h.

---

Member Function Documentation

virtual void* vetFrame::dump_buffer (   )  [pure virtual]

Read current buffer address. Returns: pointer to current buffer. Implemented in vetFrameGrey, vetFrameHSV, vetFrameRGB24, vetFrameRGB96, vetFrameRGBA32, vetFrameT< T >, vetFrameYUV420, and vetFrameT< unsigned char >.

virtual unsigned int vetFrame::getBpp (   )  [pure virtual]

Get current format's BPP (Bits per Pixel). Returns: number of bits for a single pixel (or macropixel). Implemented in vetFrameGrey, vetFrameHSV, vetFrameRGB24, vetFrameRGB96, vetFrameRGBA32, vetFrameT< T >, vetFrameYUV420, and vetFrameT< unsigned char >.

virtual unsigned int vetFrame::getBufferSize (   )  [pure virtual]

Read current buffer size (for example the real size of array). Returns: size in bytes of current buffer. Implemented in vetFrameGrey, vetFrameRGB24, vetFrameRGB96, vetFrameRGBA32, vetFrameT< T >, vetFrameYUV420, and vetFrameT< unsigned char >.

virtual VETFRAME_CHANNEL_TYPE vetFrame::getChannelType (   )  [pure virtual]

Returns: . Implemented in vetFrameGrey, vetFrameHSV, vetFrameRGB24, vetFrameRGB96, vetFrameRGBA32, vetFrameT< T >, vetFrameYUV420, and vetFrameT< unsigned char >.

virtual int vetFrame::getFOURCC (   )  [pure virtual]

Get FOURCC code of current data format, visit http://www.fourcc.org for all codes. Returns: int value (usually defined as HEX 0x...). Implemented in vetFrameGrey, vetFrameHSV, vetFrameRGB24, vetFrameRGB96, vetFrameRGBA32, vetFrameT< T >, vetFrameYUV420, and vetFrameT< unsigned char >.

unsigned int vetFrame::getHeight (   )  [inline]

Read current image's height. Returns: Height in pixel. Reimplemented in vetFrameGreyETI, vetFrameRGBETI, vetFrameT< T >, and vetFrameT< unsigned char >. Definition at line 181 of file vetFrame.h. References height.

unsigned int vetFrame::getHeight (   )  const [inline]

Read current image's height. Returns: Height in pixel. Reimplemented in vetFrameT< T >, and vetFrameT< unsigned char >. Definition at line 175 of file vetFrame.h. References height. Referenced by vetFrameGreyETI::operator<<(), vetFrameRGBETI::operator>>(), vetFrameGreyETI::operator>>(), vetCodec_IMG::save(), and vetCodec_BMP::save().

virtual VETFRAME_PROFILE vetFrame::getProfile (   )  [pure virtual]

Returns: . Implemented in vetFrameGrey, vetFrameHSV, vetFrameRGB24, vetFrameRGB96, vetFrameRGBA32, vetFrameT< T >, vetFrameYUV420, and vetFrameT< unsigned char >.

unsigned int vetFrame::getWidth (   )  [inline]

Read current image's width. Returns: Width in pixel. Reimplemented in vetFrameGreyETI, vetFrameRGBETI, vetFrameT< T >, and vetFrameT< unsigned char >. Definition at line 167 of file vetFrame.h. References width.

unsigned int vetFrame::getWidth (   )  const [inline]

Read current image's width. Returns: Width in pixel. Reimplemented in vetFrameT< T >, and vetFrameT< unsigned char >. Definition at line 161 of file vetFrame.h. References width. Referenced by vetFrameGreyETI::operator<<(), vetFrameRGBETI::operator>>(), vetFrameGreyETI::operator>>(), vetCodec_IMG::save(), and vetCodec_BMP::save().

---

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

• vetFrame.h

---