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

Interface for common raster image objects. More...

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

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

Public Member Functions
virtual int	getWidth () const =0
	Return image width. More...
virtual int	getHeight () const =0
	Return image height. More...
virtual int	getPitch () const =0
	Return image pitch. More...
virtual int	getChannels () const =0
	Return number of channels. More...
virtual PixelFormat	getPixelFormat () const =0
	Return image pixel format. More...
virtual ImageHeader	getHeader () const =0
	Return image header. More...
virtual int	getSize () const =0
	Return size of image. More...
virtual void *	getPointer ()=0
	Image bytes. More...
virtual const void *	getPointer () const =0
	Image bytes. More...
virtual ErrorCode	clone (IImage **dst) const =0
	Clone image. More...
virtual ErrorCode	mirror (Mirror direction)=0
	Fast in-place mirror operation. More...
virtual ErrorCode	bgr2rgb ()=0
	Fast in-place channel swap Convert BRG/BGRX image to RGB/RGBX. More...
virtual ErrorCode	rgb2bgr ()=0
	Fast in-place channel swap Convert RGB/RGBX image to BGR/BGRX. More...
Public Member Functions inherited from artec::sdk::base::IRef
virtual int	addRef () const =0
	Increase object reference counter. More...
virtual int	release () const =0
	Decrease object reference counter. More...

Detailed Description

Interface for common raster image objects.

Definition at line 126 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

ErrorCode_ArgumentInvalid if dst is NULL pointer.

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

pure virtual

Return number of channels.

Returns

Number of image color channels

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

pure virtual

Return image header.

Returns

Common image header in the ImageHeader struct

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

pure virtual

Return image height.

Returns

Image height in pixels

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

pure virtual

Return image pitch.

Returns

Image pitch in bytes

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

pure virtual

Return image pixel format.

Returns

Enum value PixelFormat

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

pure virtual

Image bytes.

Returns

Pointer to image data

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

pure virtual

Image bytes.

Returns

const pointer to 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

Return image width.

Returns

Image width in pixels

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

pure virtual

Fast in-place mirror operation.

Parameters

direction

axis relative to which the image will be mirrored

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