OD::RGBImage Class Reference

Class for Red, Green, Blue image. More...

Inheritance diagram for OD::RGBImage:

Public Member Functions
virtual	~RGBImage ()
virtual bool	blendWith (const RGBImage &sourceimage, bool blendtransparency=false, unsigned char blendtransparencyval=0, bool blendequaltransparency=false, bool with_opacity=false)
virtual int	bufferSize () const
virtual void	clear (const Color &)=0
virtual void	fill (unsigned char *) const
virtual Color	get (int, int) const =0
virtual unsigned char *	getData ()
virtual const unsigned char *	getData () const
virtual int	getSize (bool xdir) const =0
virtual bool	hasAlpha () const
virtual char	nrComponents () const =0
virtual bool	put (const unsigned char *, bool xdir_slowest=true, bool with_opacity=false)
virtual bool	putFromBitmap (const unsigned char *bitmap, const unsigned char *mask=0)
virtual bool	set (int, int, const Color &)=0
virtual bool	setSize (int, int)=0

Detailed Description

Class for Red, Green, Blue image.

<>

Constructor & Destructor Documentation

~RGBImage()

virtual OD::RGBImage::~RGBImage ( )

inlinevirtual

Member Function Documentation

blendWith()

virtual bool OD::RGBImage::blendWith ( const RGBImage &  sourceimage, bool  blendtransparency = false, unsigned char  blendtransparencyval = 0, bool  blendequaltransparency = false, bool  with_opacity = false  )

virtual

Fills image with data from array.param xdir_slowest False if ydir is the slowest dimension, param with_opacity If true, eventual 4th component will be treated as a opacity instead of a transparency. Blends image with another image of same size. The provided images' transparency will be used to blend the two images proportionally.

Parameters

sourceimage
blendtransparency	if true, the color will be blended by source image's color if the transparency equal to the param blendtransparencyval.
blendtransparencyval
blendequaltransparency	if false,the color will be not blended when sourceimage has same transparency as this image has.
with_opacity	if true,eventual 4th component will be treated as a opacity instead of a transparency.

bufferSize()

virtual int OD::RGBImage::bufferSize ( ) const

virtual

clear()

virtual void OD::RGBImage::clear ( const Color &  )

pure virtual

Implemented in uiRGBArray.

fill()

virtual void OD::RGBImage::fill ( unsigned char *  ) const

virtual

Reimplemented in visBase::RGBImage.

get()

virtual Color OD::RGBImage::get ( int  , int    ) const

pure virtual

Implemented in visBase::RGBImage, and uiRGBArray.

getData() [1/2]

virtual unsigned char* OD::RGBImage::getData ( )

inlinevirtual

Reimplemented in uiRGBArray.

getData() [2/2]

virtual const unsigned char* OD::RGBImage::getData ( ) const

inlinevirtual

Reimplemented in uiRGBArray.

getSize()

virtual int OD::RGBImage::getSize ( bool  xdir ) const

pure virtual

Implemented in visBase::RGBImage, and uiRGBArray.

hasAlpha()

virtual bool OD::RGBImage::hasAlpha ( ) const

virtual

Reimplemented in visBase::RGBImage.

nrComponents()

virtual char OD::RGBImage::nrComponents ( ) const

pure virtual

Return values

1	grayscale
2	grayscale+alpha
3	rgb
4	rgb+alpha

Implemented in visBase::RGBImage, and uiRGBArray.

put()

virtual bool OD::RGBImage::put ( const unsigned char *  , bool  xdir_slowest = true, bool  with_opacity = false  )

virtual

Fills array with content. Each pixel's components are the fastest dimension, slowest is xdir. Caller must ensure sufficient mem is allocated.

putFromBitmap()

virtual bool OD::RGBImage::putFromBitmap ( const unsigned char *  bitmap, const unsigned char *  mask = 0  )

virtual

set()

virtual bool OD::RGBImage::set ( int  , int  , const Color &    )

pure virtual

Implemented in visBase::RGBImage, and uiRGBArray.

setSize()

virtual bool OD::RGBImage::setSize ( int  , int    )

pure virtual

Implemented in visBase::RGBImage, and uiRGBArray.