A ref counted video frame. More...
#include <vidl_frame.h>
Public Member Functions | |
| virtual | ~vidl_frame () |
| Destructor. | |
| virtual void | invalidate () |
| Make the buffer invalid (data()==0 and size()==0). | |
| virtual void * | data ()=0 |
| Return a pointer to the first element of data. | |
| virtual const void * | data () const =0 |
| virtual unsigned long | size () const =0 |
| The size of the buffer in bytes. | |
| unsigned | ni () const |
| Width. | |
| unsigned | nj () const |
| Height. | |
| vidl_pixel_format | pixel_format () const |
| Return the pixel format. | |
| void | ref () |
| Increment reference count. | |
| void | unref () |
| Decrement reference count. | |
| int | ref_count () const |
| Number of objects referring to this data. | |
Protected Member Functions | |
| vidl_frame () | |
| Constructor. | |
| vidl_frame (unsigned ni, unsigned nj, vidl_pixel_format fmt) | |
| Constructor. | |
Protected Attributes | |
| unsigned | ni_ |
| frame width. | |
| unsigned | nj_ |
| frame height. | |
| vidl_pixel_format | format_ |
| frame pixel format. | |
Private Attributes | |
| int | ref_count_ |
Detailed Description
A ref counted video frame.
Definition at line 26 of file vidl_frame.h.
Constructor & Destructor Documentation
| virtual vidl_frame::~vidl_frame | ( | ) | [inline, virtual] |
Destructor.
Definition at line 30 of file vidl_frame.h.
| vidl_frame::vidl_frame | ( | ) | [inline, protected] |
Constructor.
Definition at line 53 of file vidl_frame.h.
| vidl_frame::vidl_frame | ( | unsigned | ni, |
| unsigned | nj, | ||
| vidl_pixel_format | fmt | ||
| ) | [inline, protected] |
Constructor.
Definition at line 57 of file vidl_frame.h.
Member Function Documentation
| virtual void* vidl_frame::data | ( | ) | [pure virtual] |
Return a pointer to the first element of data.
Implemented in vidl_memory_chunk_frame, and vidl_shared_frame.
| virtual const void* vidl_frame::data | ( | ) | const [pure virtual] |
Implemented in vidl_memory_chunk_frame, and vidl_shared_frame.
| virtual void vidl_frame::invalidate | ( | ) | [inline, virtual] |
Make the buffer invalid (data()==0 and size()==0).
Reimplemented in vidl_memory_chunk_frame, and vidl_shared_frame.
Definition at line 33 of file vidl_frame.h.
| unsigned vidl_frame::ni | ( | ) | const [inline] |
Width.
Definition at line 43 of file vidl_frame.h.
| unsigned vidl_frame::nj | ( | ) | const [inline] |
Height.
Definition at line 46 of file vidl_frame.h.
| vidl_pixel_format vidl_frame::pixel_format | ( | ) | const [inline] |
Return the pixel format.
Definition at line 49 of file vidl_frame.h.
| void vidl_frame::ref | ( | ) | [inline] |
Increment reference count.
Definition at line 72 of file vidl_frame.h.
| int vidl_frame::ref_count | ( | ) | const [inline] |
Number of objects referring to this data.
Definition at line 78 of file vidl_frame.h.
| virtual unsigned long vidl_frame::size | ( | ) | const [pure virtual] |
The size of the buffer in bytes.
Implemented in vidl_memory_chunk_frame, and vidl_shared_frame.
| void vidl_frame::unref | ( | ) |
Decrement reference count.
Definition at line 19 of file vidl_frame.cxx.
Member Data Documentation
vidl_pixel_format vidl_frame::format_ [protected] |
frame pixel format.
Definition at line 65 of file vidl_frame.h.
unsigned vidl_frame::ni_ [protected] |
frame width.
Definition at line 61 of file vidl_frame.h.
unsigned vidl_frame::nj_ [protected] |
frame height.
Definition at line 63 of file vidl_frame.h.
int vidl_frame::ref_count_ [private] |
Definition at line 81 of file vidl_frame.h.
The documentation for this class was generated from the following files:
- core/vidl/vidl_frame.h
- core/vidl/vidl_frame.cxx
