CVD 0.8
Public Member Functions | Protected Member Functions | Protected Attributes
CVD::VideoFrame< T > Class Template Reference

A frame from a VideoBuffer. More...

#include <videoframe.h>

Inheritance diagram for CVD::VideoFrame< T >:
CVD::BasicImage< T > CVD::SubImage< T > CVD::LocalVideoFrame< T > CVD::V4L1Frame< T > CVD::V4L2FrameT< T > CVD::ColourspaceFrame< T > CVD::DeinterlaceFrame< T > CVD::DiskBuffer2Frame< T > CVD::ServerPushJpegFrame< T > CVD::VideoFileFrame< T >

List of all members.

Public Member Functions

 VideoFrame (double t, T *data, const ImageRef &size, VideoFrameFlags::FieldType f=VideoFrameFlags::Unknown)
 VideoFrame (double t, const BasicImage< T > &im, VideoFrameFlags::FieldType f=VideoFrameFlags::Unknown)
double timestamp () const
VideoFrameFlags::FieldType field () const

Protected Member Functions

virtual ~VideoFrame ()

Protected Attributes

VideoFrameFlags::FieldType my_field
double my_timestamp

Detailed Description

template<class T>
class CVD::VideoFrame< T >

A frame from a VideoBuffer.

Parameters:
TThe pixel type of the video frames

Definition at line 53 of file videoframe.h.


Constructor & Destructor Documentation

template<class T>
CVD::VideoFrame< T >::VideoFrame ( double  t,
T *  data,
const ImageRef size,
VideoFrameFlags::FieldType  f = VideoFrameFlags::Unknown 
) [inline]

(Used internally) Construct a VideoFrame around a block of memory.

The memory is not managed by the VideoFrame so must me managed seperately

Parameters:
tThe time (in seconds) of this frame
dataThe image data for this frame
sizeThe size of this video frame

Definition at line 61 of file videoframe.h.

template<class T>
CVD::VideoFrame< T >::VideoFrame ( double  t,
const BasicImage< T > &  im,
VideoFrameFlags::FieldType  f = VideoFrameFlags::Unknown 
) [inline]

(Used internally) Construct a VideoFrame from a BasicImage

Parameters:
tThe time (in seconds) of this frame
imThe image data for this frame. BasicImages do not manage their own memory, so this must be managed externally

Definition at line 70 of file videoframe.h.


Member Data Documentation

template<class T>
double CVD::VideoFrame< T >::my_timestamp [protected]

Type of field in this frame.

No of seconds since boot of this frame

Definition at line 93 of file videoframe.h.

Referenced by CVD::VideoFrame< Rgb8 >::timestamp(), and CVD::DiskBuffer2Frame< T >::timestamp().


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