Raytrix Light Field SDK  v3.1
Logo
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Events Groups Pages
Rx::Interop::Runtime28::IImage Class Referenceabstract

Detailed Description

Interface supported by Raytrix images.

Inherited by Rx::CRxImage, and Rx::CRxImageMoniker.

Public Member Functions

virtual bool Create (int iWidth, int iHeight, Rx::Interop::Runtime28::EPixelType::ID ePixelType, Rx::Interop::Runtime28::EDataType::ID eDataType)=0
 Create an image of given type and size and reserve the appropriate amount of memory. We can use as input types enums as they stay compatible between module versions even if the enum declarations have different numbers of entries. More...
 
virtual bool Create (int iWidth, int iHeight, Rx::Interop::Runtime28::EPixelType::ID ePixelType, Rx::Interop::Runtime28::EDataType::ID eDataType, const void *pData)=0
 Create an image of given type and size and copy the data from the given pointer. More...
 
virtual bool Create (const IImage *pImage)=0
 Create image from given image. More...
 
virtual bool Destroy ()=0
 Destroy image. More...
 
virtual unsigned GetByteCount () const =0
 Gets the byte count. More...
 
virtual int GetBytesPerPixel () const =0
 Gets the bytes per pixel. More...
 
virtual void * GetDataPtr ()=0
 Gets the data pointer. More...
 
virtual const void * GetDataPtr () const =0
 Gets the data pointer. More...
 
virtual unsigned GetPixelCount () const =0
 Gets the pixel count. More...
 
virtual void GetSize (int &iWidth, int &iHeight) const =0
 Gets the size of this image. More...
 
virtual void GetType (Rx::Interop::Runtime28::EPixelType::ID &ePixelType, Rx::Interop::Runtime28::EDataType::ID &eDataType) const =0
 Gets the type of this image. More...
 
virtual bool IsValid () const =0
 Test whether this image exists. More...
 

Member Function Documentation

virtual bool Rx::Interop::Runtime28::IImage::Create ( int  iWidth,
int  iHeight,
Rx::Interop::Runtime28::EPixelType::ID  ePixelType,
Rx::Interop::Runtime28::EDataType::ID  eDataType 
)
pure virtual

Create an image of given type and size and reserve the appropriate amount of memory. We can use as input types enums as they stay compatible between module versions even if the enum declarations have different numbers of entries.

Parameters
iWidthZero-based index of the width.
iHeightZero-based index of the height.
ePixelTypeType of the pixel.
eDataTypeType of the data.
Returns
True if it succeeds, false if it fails.

Implemented in Rx::CRxImage, and Rx::CRxImageMoniker.

virtual bool Rx::Interop::Runtime28::IImage::Create ( int  iWidth,
int  iHeight,
Rx::Interop::Runtime28::EPixelType::ID  ePixelType,
Rx::Interop::Runtime28::EDataType::ID  eDataType,
const void *  pData 
)
pure virtual

Create an image of given type and size and copy the data from the given pointer.

Parameters
iWidthZero-based index of the width.
iHeightZero-based index of the height.
ePixelTypeType of the pixel.
eDataTypeType of the data.
pDataThe data.
Returns
True if it succeeds, false if it fails.

Implemented in Rx::CRxImage, and Rx::CRxImageMoniker.

virtual bool Rx::Interop::Runtime28::IImage::Create ( const IImage pImage)
pure virtual

Create image from given image.

Parameters
pImageThe image.
Returns
True if it succeeds, false if it fails.

Implemented in Rx::CRxImage, and Rx::CRxImageMoniker.

virtual bool Rx::Interop::Runtime28::IImage::Destroy ( )
pure virtual

Destroy image.

Returns
True if it succeeds, false if it fails.

Implemented in Rx::CRxImage, and Rx::CRxImageMoniker.

virtual unsigned Rx::Interop::Runtime28::IImage::GetByteCount ( ) const
pure virtual

Gets the byte count.

Returns
The byte count.

Implemented in Rx::CRxImage, and Rx::CRxImageMoniker.

virtual int Rx::Interop::Runtime28::IImage::GetBytesPerPixel ( ) const
pure virtual

Gets the bytes per pixel.

Returns
The bytes per pixel.

Implemented in Rx::CRxImage, and Rx::CRxImageMoniker.

virtual void* Rx::Interop::Runtime28::IImage::GetDataPtr ( )
pure virtual

Gets the data pointer.

Returns
Null if it fails, else the data pointer.

Implemented in Rx::CRxImage, and Rx::CRxImageMoniker.

virtual const void* Rx::Interop::Runtime28::IImage::GetDataPtr ( ) const
pure virtual

Gets the data pointer.

Returns
Null if it fails, else the data pointer.

Implemented in Rx::CRxImage, and Rx::CRxImageMoniker.

virtual unsigned Rx::Interop::Runtime28::IImage::GetPixelCount ( ) const
pure virtual

Gets the pixel count.

Returns
The pixel count.

Implemented in Rx::CRxImage, and Rx::CRxImageMoniker.

virtual void Rx::Interop::Runtime28::IImage::GetSize ( int &  iWidth,
int &  iHeight 
) const
pure virtual

Gets the size of this image.

Parameters
iWidth[out] The width.
iHeight[out] The height.

Implemented in Rx::CRxImage, and Rx::CRxImageMoniker.

virtual void Rx::Interop::Runtime28::IImage::GetType ( Rx::Interop::Runtime28::EPixelType::ID ePixelType,
Rx::Interop::Runtime28::EDataType::ID eDataType 
) const
pure virtual

Gets the type of this image.

Parameters
ePixelType[out] Type of the pixel.
eDataType[out] Type of the data.

Implemented in Rx::CRxImageMoniker, and Rx::CRxImage.

virtual bool Rx::Interop::Runtime28::IImage::IsValid ( ) const
pure virtual

Test whether this image exists.

Returns
True if valid, false if not.

Implemented in Rx::CRxImage, and Rx::CRxImageMoniker.