makVrv::DtVideoFrameBuffer Class Reference

The image as initially captured from the camera is placed into a DtVideoFrameBuffer. More...

Public Types
enum	DataFormat {   RAW, JPG, PNG, BMP,   NITF, X264 }
	Enumerate the compression types. More...

Public Member Functions
	DtVideoFrameBuffer (int imgBufferSize=0, int metadataBufferSize=0)
	CTOR.
	~DtVideoFrameBuffer ()
	DTOR.
unsigned char *	imageData () const
	Get the pixel data.
void	setImageData (unsigned char *imageData, int imageDataSize)
	Set the pixel data. This class creates a copy of the passed in image data.
int	imageSize () const
	Get the number of bytes (may not be the size of the data in the buffer)
DataFormat	type () const
	Get how the data is compressed, if at all.
void	setType (DataFormat type)
	Set how the data is compressed, if at all.
int	y () const
	Get the buffer height.
void	setY (int y)
	Set the buffer height.
int	x () const
	Get the buffer width.
void	setX (int x)
	Set the buffer width.
int	rowInBytes () const
	Get the row size, in bytes.
void	setRowInBytes (int rowInBytes)
	Set the row size, in bytes.
int	bpp () const
	Get the bits per pixel.
void	setBpp (int bpp)
	Set the bits per pixel.
int	format () const
	Get the openGL image format.
void	setFormat (int format)
	Set the openGL image format.
int	dataType () const
	Get the openGL image format.
void	setDataType (int dataType)
	Set the openGL image format.
unsigned char *	metadata () const
	Get the metadata.
void	setMetadata (unsigned char *metadata, int metadataSize)
	Set the metadata.
int	metadataSize () const
	Get the metadata size in bytes.

Protected Member Functions
void	resizeImageBuffer (int sizeInBytes)
	deletes the current buffer and creates a new buffer with the requested size
void	resizeMetadataBuffer (int sizeInBytes)
	deletes the current buffer and creates a new buffer with the requested size

Protected Attributes
unsigned char *	myImageBuffer
int	myImageSize
int	myImageBufferSize
DataFormat	myType
int	myY
int	myX
int	myRowInBytes
int	myBpp
int	myFormat
int	myDataType
unsigned char *	myMetadataBuffer
int	myMetadataSize
int	myMetadataBufferSize

Detailed Description

The image as initially captured from the camera is placed into a DtVideoFrameBuffer.

Instances of DtVideoFrameBuffer are placed on a queue for further processing by the process image task elements.

Member Enumeration Documentation

enum makVrv::DtVideoFrameBuffer::DataFormat

Enumerate the compression types.

Enumerator:

RAW
JPG
PNG
BMP
NITF
X264

Constructor & Destructor Documentation

makVrv::DtVideoFrameBuffer::DtVideoFrameBuffer	(	int	imgBufferSize = 0,
		int	metadataBufferSize = 0
	)

CTOR.

makVrv::DtVideoFrameBuffer::~DtVideoFrameBuffer

(

)

DTOR.

Member Function Documentation

unsigned char* makVrv::DtVideoFrameBuffer::imageData

(

)

const

Get the pixel data.

void makVrv::DtVideoFrameBuffer::setImageData	(	unsigned char *	imageData,
		int	imageDataSize
	)

Set the pixel data. This class creates a copy of the passed in image data.

int makVrv::DtVideoFrameBuffer::imageSize

(

)

const

Get the number of bytes (may not be the size of the data in the buffer)

DataFormat makVrv::DtVideoFrameBuffer::type

(

)

const

Get how the data is compressed, if at all.

void makVrv::DtVideoFrameBuffer::setType

(

DataFormat

type

)

Set how the data is compressed, if at all.

int makVrv::DtVideoFrameBuffer::y

(

)

const

Get the buffer height.

void makVrv::DtVideoFrameBuffer::setY

(

int

y

)

Set the buffer height.

int makVrv::DtVideoFrameBuffer::x

(

)

const

Get the buffer width.

void makVrv::DtVideoFrameBuffer::setX

(

int

x

)

Set the buffer width.

int makVrv::DtVideoFrameBuffer::rowInBytes

(

)

const

Get the row size, in bytes.

void makVrv::DtVideoFrameBuffer::setRowInBytes

(

int

rowInBytes

)

Set the row size, in bytes.

int makVrv::DtVideoFrameBuffer::bpp

(

)

const

Get the bits per pixel.

void makVrv::DtVideoFrameBuffer::setBpp

(

int

bpp

)

Set the bits per pixel.

int makVrv::DtVideoFrameBuffer::format

(

)

const

Get the openGL image format.

void makVrv::DtVideoFrameBuffer::setFormat

(

int

format

)

Set the openGL image format.

int makVrv::DtVideoFrameBuffer::dataType

(

)

const

Get the openGL image format.

void makVrv::DtVideoFrameBuffer::setDataType

(

int

dataType

)

Set the openGL image format.

unsigned char* makVrv::DtVideoFrameBuffer::metadata

(

)

const

Get the metadata.

void makVrv::DtVideoFrameBuffer::setMetadata	(	unsigned char *	metadata,
		int	metadataSize
	)

Set the metadata.

int makVrv::DtVideoFrameBuffer::metadataSize

(

)

const

Get the metadata size in bytes.

void makVrv::DtVideoFrameBuffer::resizeImageBuffer ( int  sizeInBytes )

protected

deletes the current buffer and creates a new buffer with the requested size

void makVrv::DtVideoFrameBuffer::resizeMetadataBuffer ( int  sizeInBytes )

protected

deletes the current buffer and creates a new buffer with the requested size

Member Data Documentation

unsigned char* makVrv::DtVideoFrameBuffer::myImageBuffer

protected

int makVrv::DtVideoFrameBuffer::myImageSize

protected

int makVrv::DtVideoFrameBuffer::myImageBufferSize

protected

DataFormat makVrv::DtVideoFrameBuffer::myType

protected

int makVrv::DtVideoFrameBuffer::myY

protected

int makVrv::DtVideoFrameBuffer::myX

protected

int makVrv::DtVideoFrameBuffer::myRowInBytes

protected

int makVrv::DtVideoFrameBuffer::myBpp

protected

int makVrv::DtVideoFrameBuffer::myFormat

protected

int makVrv::DtVideoFrameBuffer::myDataType

protected

unsigned char* makVrv::DtVideoFrameBuffer::myMetadataBuffer

protected

int makVrv::DtVideoFrameBuffer::myMetadataSize

protected

int makVrv::DtVideoFrameBuffer::myMetadataBufferSize

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-6-branch/include/vrvVideoStream/DtVideoFrameBuffer.h