artec::sdk::base::IImage Class Reference

#include <artec/sdk/base/IImage.h>

Inheritance diagram for artec::sdk::base::IImage:

Public Member Functions
virtual int	getWidth () const =0
virtual int	getHeight () const =0
virtual int	getPitch () const =0
virtual int	getChannels () const =0
virtual PixelFormat	getPixelFormat () const =0
virtual ImageHeader	getHeader () const =0
virtual int	getSize () const =0
virtual void *	getPointer ()=0
virtual const void *	getPointer () const =0
virtual ErrorCode	clone (IImage **dst) const =0
virtual ErrorCode	mirror (Mirror direction)=0
virtual ErrorCode	bgr2rgb ()=0
virtual ErrorCode	rgb2bgr ()=0
Public Member Functions inherited from artec::sdk::base::IRef
virtual int	addRef () const =0
virtual int	release () const =0

Detailed Description

Definition at line 122 of file IImage.h.

Member Function Documentation

virtual ErrorCode artec::sdk::base::IImage::bgr2rgb ( )

pure virtual

Fast in-place channel swap Convert BRG/BGRX image to RGB/RGBX

Returns

ErrorCode_OperationInvalid if source image is not in BGR or BGRX format.

virtual ErrorCode artec::sdk::base::IImage::clone ( IImage **  dst ) const

pure virtual

Clone image

Parameters

dst	new image that will contain copy of source image

Returns

error code

virtual int artec::sdk::base::IImage::getChannels ( ) const

pure virtual

virtual ImageHeader artec::sdk::base::IImage::getHeader ( ) const

pure virtual

virtual int artec::sdk::base::IImage::getHeight ( ) const

pure virtual

virtual int artec::sdk::base::IImage::getPitch ( ) const

pure virtual

virtual PixelFormat artec::sdk::base::IImage::getPixelFormat ( ) const

pure virtual

virtual void* artec::sdk::base::IImage::getPointer ( )

pure virtual

Image bytes

Returns

Pointer on image data

virtual const void* artec::sdk::base::IImage::getPointer ( ) const

pure virtual

Image bytes

Returns

const pointer on image data

virtual int artec::sdk::base::IImage::getSize ( ) const

pure virtual

Return size of image

Returns

Data size in bytes

virtual int artec::sdk::base::IImage::getWidth ( ) const

pure virtual

virtual ErrorCode artec::sdk::base::IImage::mirror ( Mirror  direction )

pure virtual

Fast in-place mirror operation

Parameters

direction

axis relative to which will be made mirroring

Returns

ErrorCode_OperationInvalid if source image is not in Mono, BGR, RGB, BGRX or RGBX format.

virtual ErrorCode artec::sdk::base::IImage::rgb2bgr ( )

pure virtual

Fast in-place channel swap Convert RGB/RGBX image to BGR/BGRX

Returns

ErrorCode_OperationInvalid if source image is not in RGB or RGBX format.

---

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

• artec/sdk/base/IImage.h