VR-Forces 4.8 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Attributes
makVrv::DtReadFramebufferProcessData Class Reference

This is a non-extendable container class used to send the information to the NVidia encoder. More...

Public Member Functions

 DtReadFramebufferProcessData ()
 CTOR. More...
 
virtual ~DtReadFramebufferProcessData ()
 DTOR. More...
 
virtual unsigned charimageData () const
 Return the image data pointer. More...
 
virtual void setImageData (unsigned char *image)
 Set the image data. More...
 
virtual size_t imageSizeInBytes () const
 Get the image size in bytes. More...
 
virtual void setImageSizeInBytes (size_t imageSize)
 Set the image size in bytes. More...
 
virtual std::string encodingFormat () const
 Get the video encoding format ("h264", "h265") More...
 
virtual void setEncodingFormat (const std::string &format)
 Set the video encoding format ("h264", "h265") More...
 
virtual size_t width () const
 get the width of the image More...
 
virtual void setWidth (size_t width)
 set the width of the image More...
 
virtual size_t height () const
 get the height of the image More...
 
virtual void setHeight (size_t height)
 set the height of the image More...
 
virtual size_t rowSizeInBytes () const
 get the row size in bytes More...
 
virtual void setRowSizeInBytes (size_t rowSizeBytes)
 set the row size in bytes More...
 
virtual int pixelFormat () const
 get the pixel format (ex. BGRA) More...
 
virtual void setPixelFormat (int pixelFormat)
 set the pixel format (ex. BGRA) More...
 
virtual int dataType () const
 get data type (ex. ubyte) More...
 
virtual void setDataType (int datatype)
 set data type (ex. ubyte) More...
 
virtual int pixelSizeInBits () const
 get pixel size (bits) More...
 
virtual void setPixelSizeInBits (int pixelSizeInBits)
 set pixel size (bits) More...
 
virtual void deleteImage ()
 if the encoding format is a supported format ("h264" or "h265") delete the image and set the size to zero More...
 
virtual bool allocateAndCopyImage (size_t imageSizeInBytes, void *bufferToBeCopied)
 allocate a new buffer for supported format ("h264" or "h265"), copy it and return true if operation succeed delete previously allocated data More...
 

Protected Attributes

unsigned charmyData
 buffer pointer More...
 
size_t myDataTotalSizeInBytes
 buffer used size in bytes More...
 
size_t myBufferSizeInBytes
 internal size of buffer in bytes More...
 
std::string myEncodingFormat
 video encoding format ("h254", h265") More...
 
size_t myWidth
 image width More...
 
size_t myHeight
 image height More...
 
size_t myRowSizeInBytes
 row size in bytes More...
 
int myPixelFormat
 pixel format(ex.BGRA) More...
 
int myDataType
 data type (ex. ubyte) More...
 
int myPixelSizeInBits
 pixel size(bits) More...
 

Detailed Description

This is a non-extendable container class used to send the information to the NVidia encoder.

Constructor & Destructor Documentation

makVrv::DtReadFramebufferProcessData::DtReadFramebufferProcessData ( )

CTOR.

virtual makVrv::DtReadFramebufferProcessData::~DtReadFramebufferProcessData ( )
virtual

DTOR.

Member Function Documentation

virtual unsigned char* makVrv::DtReadFramebufferProcessData::imageData ( ) const
virtual

Return the image data pointer.

virtual void makVrv::DtReadFramebufferProcessData::setImageData ( unsigned char image)
virtual

Set the image data.

virtual size_t makVrv::DtReadFramebufferProcessData::imageSizeInBytes ( ) const
virtual

Get the image size in bytes.

virtual void makVrv::DtReadFramebufferProcessData::setImageSizeInBytes ( size_t  imageSize)
virtual

Set the image size in bytes.

virtual std::string makVrv::DtReadFramebufferProcessData::encodingFormat ( ) const
virtual

Get the video encoding format ("h264", "h265")

virtual void makVrv::DtReadFramebufferProcessData::setEncodingFormat ( const std::string &  format)
virtual

Set the video encoding format ("h264", "h265")

virtual size_t makVrv::DtReadFramebufferProcessData::width ( ) const
virtual

get the width of the image

virtual void makVrv::DtReadFramebufferProcessData::setWidth ( size_t  width)
virtual

set the width of the image

virtual size_t makVrv::DtReadFramebufferProcessData::height ( ) const
virtual

get the height of the image

virtual void makVrv::DtReadFramebufferProcessData::setHeight ( size_t  height)
virtual

set the height of the image

virtual size_t makVrv::DtReadFramebufferProcessData::rowSizeInBytes ( ) const
virtual

get the row size in bytes

virtual void makVrv::DtReadFramebufferProcessData::setRowSizeInBytes ( size_t  rowSizeBytes)
virtual

set the row size in bytes

virtual int makVrv::DtReadFramebufferProcessData::pixelFormat ( ) const
virtual

get the pixel format (ex. BGRA)

virtual void makVrv::DtReadFramebufferProcessData::setPixelFormat ( int  pixelFormat)
virtual

set the pixel format (ex. BGRA)

virtual int makVrv::DtReadFramebufferProcessData::dataType ( ) const
virtual

get data type (ex. ubyte)

virtual void makVrv::DtReadFramebufferProcessData::setDataType ( int  datatype)
virtual

set data type (ex. ubyte)

virtual int makVrv::DtReadFramebufferProcessData::pixelSizeInBits ( ) const
virtual

get pixel size (bits)

virtual void makVrv::DtReadFramebufferProcessData::setPixelSizeInBits ( int  pixelSizeInBits)
virtual

set pixel size (bits)

virtual void makVrv::DtReadFramebufferProcessData::deleteImage ( )
virtual

if the encoding format is a supported format ("h264" or "h265") delete the image and set the size to zero

virtual bool makVrv::DtReadFramebufferProcessData::allocateAndCopyImage ( size_t  imageSizeInBytes,
void *  bufferToBeCopied 
)
virtual

allocate a new buffer for supported format ("h264" or "h265"), copy it and return true if operation succeed delete previously allocated data

Member Data Documentation

unsigned char* makVrv::DtReadFramebufferProcessData::myData
protected

buffer pointer

size_t makVrv::DtReadFramebufferProcessData::myDataTotalSizeInBytes
protected

buffer used size in bytes

size_t makVrv::DtReadFramebufferProcessData::myBufferSizeInBytes
protected

internal size of buffer in bytes

std::string makVrv::DtReadFramebufferProcessData::myEncodingFormat
protected

video encoding format ("h254", h265")

size_t makVrv::DtReadFramebufferProcessData::myWidth
protected

image width

size_t makVrv::DtReadFramebufferProcessData::myHeight
protected

image height

size_t makVrv::DtReadFramebufferProcessData::myRowSizeInBytes
protected

row size in bytes

int makVrv::DtReadFramebufferProcessData::myPixelFormat
protected

pixel format(ex.BGRA)

int makVrv::DtReadFramebufferProcessData::myDataType
protected

data type (ex. ubyte)

int makVrv::DtReadFramebufferProcessData::myPixelSizeInBits
protected

pixel size(bits)


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

Document ID: Generated on Thu Aug 27 10:56:05 EDT 2020 from SVN revision 217100
Copyright © 2005-2020 MAK Technologies. All Rights Reserved (www.mak.com)