vidl2_frame Class Reference

#include <vidl2_frame.h>

Inheritance diagram for vidl2_frame:

[legend]List of all members.

---

Detailed Description

A ref counted video frame.

Definition at line 27 of file vidl2_frame.h.

Public Member Functions
virtual	~vidl2_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.
vidl2_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
	vidl2_frame ()
	Constructor.
	vidl2_frame (unsigned ni, unsigned nj, vidl2_pixel_format fmt)
	Constructor.
Protected Attributes
unsigned	ni_
	frame width.
unsigned	nj_
	frame height.
vidl2_pixel_format	format_
	frame pixel format.
Private Attributes
int	ref_count_

---

Constructor & Destructor Documentation

virtual vidl2_frame::~vidl2_frame (   )  [inline, virtual]

Destructor. Definition at line 31 of file vidl2_frame.h.

vidl2_frame::vidl2_frame (   )  [inline, protected]

Constructor. Definition at line 54 of file vidl2_frame.h.

vidl2_frame::vidl2_frame (  unsigned  ni, unsigned  nj, vidl2_pixel_format  fmt )  [inline, protected]

Constructor. Definition at line 58 of file vidl2_frame.h.

---

Member Function Documentation

virtual const void* vidl2_frame::data (   )  const [pure virtual]

Implemented in vidl2_shared_frame, and vidl2_memory_chunk_frame.

virtual void* vidl2_frame::data (   )  [pure virtual]

Return a pointer to the first element of data. Implemented in vidl2_shared_frame, and vidl2_memory_chunk_frame.

virtual void vidl2_frame::invalidate (   )  [inline, virtual]

Make the buffer invalid (data()==0 and size()==0). Reimplemented in vidl2_shared_frame, and vidl2_memory_chunk_frame. Definition at line 34 of file vidl2_frame.h.

unsigned vidl2_frame::ni (   )  const [inline]

Width. Definition at line 44 of file vidl2_frame.h.

unsigned vidl2_frame::nj (   )  const [inline]

Height. Definition at line 47 of file vidl2_frame.h.

vidl2_pixel_format vidl2_frame::pixel_format (   )  const [inline]

Return the pixel format. Definition at line 50 of file vidl2_frame.h.

void vidl2_frame::ref (   )  [inline]

Increment reference count. Definition at line 73 of file vidl2_frame.h.

int vidl2_frame::ref_count (   )  const [inline]

Number of objects referring to this data. Definition at line 79 of file vidl2_frame.h.

virtual unsigned long vidl2_frame::size (   )  const [pure virtual]

The size of the buffer in bytes. Implemented in vidl2_shared_frame, and vidl2_memory_chunk_frame.

void vidl2_frame::unref (   )

Decrement reference count. Definition at line 19 of file vidl2_frame.cxx.

---

Member Data Documentation

vidl2_pixel_format vidl2_frame::format_ [protected]

frame pixel format. Definition at line 66 of file vidl2_frame.h.

unsigned vidl2_frame::ni_ [protected]

frame width. Definition at line 62 of file vidl2_frame.h.

unsigned vidl2_frame::nj_ [protected]

frame height. Definition at line 64 of file vidl2_frame.h.

int vidl2_frame::ref_count_ [private]

Definition at line 82 of file vidl2_frame.h.

---

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

• contrib/brl/bbas/vidl2/vidl2_frame.h
• contrib/brl/bbas/vidl2/vidl2_frame.cxx

---