IlvSaturationFilter Class Reference

Saturation filter. More...

#include <ilviews/bitmaps/filters/colmatrix.h>

Inheritance diagram for IlvSaturationFilter:

Public Member Functions
	IlvSaturationFilter (IlFloat saturation=1.0)
	Constructor. More...
IlFloat	getSaturation () const
	Returns the saturation value. More...
void	setSaturation (IlFloat saturation)
	Sets the saturation value. More...
Public Member Functions inherited from IlvColorMatrixFilter
	IlvColorMatrixFilter (const IlFloat *values=0)
	Constructor. More...
	~IlvColorMatrixFilter ()
	Destructor. More...
IlvBitmapData *	apply (IlUInt count=0, const IlvBitmapData **inputs=0)
	Applies the color matrix to the given image.
const IlFloat *	getValues (IlUInt &count) const
	Returns the matrix coefficients. More...
void	setValues (const IlFloat *values)
	Sets the matrix coefficients. More...
void	setValues (IlFloat a00, IlFloat a01, IlFloat a02, IlFloat a03, IlFloat a04, IlFloat a10, IlFloat a11, IlFloat a12, IlFloat a13, IlFloat a14, IlFloat a20, IlFloat a21, IlFloat a22, IlFloat a23, IlFloat a24, IlFloat a30, IlFloat a31, IlFloat a32, IlFloat a33, IlFloat a34)
	Sets the matrix coefficients. More...
Public Member Functions inherited from IlvBitmapFilter
	IlvBitmapFilter ()
	Constructor. More...
virtual	~IlvBitmapFilter ()
	Destructor. More...
IlvBitmapData *	applyUnary (const IlvBitmapData *data)
	Convenience method for unary filters. More...
virtual const char *	getClassName () const
	Returns the class name of the filter. More...
IlUInt	getHeight () const
	Returns the height of the filter effect region. More...
const char *const *	getInputs (IlUInt &count) const
	Returns the name of the input bitmap data. More...
const char *	getName () const
	Returns the name of the filter. More...
IlUInt	getRefCount () const
	Returns the reference count for this instance.
const char *	getResult () const
	Returns the name of the result bitmap data. More...
IlUInt	getWidth () const
	Returns the width of the filter effect region. More...
IlInt	getX () const
	Returns the left coordinate of the filter effect region. More...
IlInt	getY () const
	Returns the top coordinate of the filter effect region. More...
void	lock ()
	Locks the current instance.
void	setHeight (IlUInt height)
	Sets the height of the filter effect region. More...
void	setInputs (IlUInt count, const char *const *name)
	Sets the input names of the filter. More...
void	setName (const char *id)
	Sets the name of the filter. More...
void	setResult (const char *name)
	Sets the result name of the filter. More...
void	setWidth (IlUInt width)
	Sets the width of the filter effect region. More...
void	setX (IlInt x)
	Sets the left coordinate of the filter effect region. More...
void	setY (IlInt y)
	Sets the top coordinate of the filter effect region. More...
void	unLock ()
	Unlocks the current instance. When the reference count is 0, the instance is deleted.

Additional Inherited Members
Static Public Member Functions inherited from IlvBitmapFilter
static IlvBitmapFilter *	Create (const char *classname, IlBoolean forceLoad=IlTrue)
	This static method creates an instance of a bitmap filter of given classname. If the filter class is not registered and forceLoad is IlTrue, an attempt to load a dynamic module for this filter is made. More...
static const char **	GetRegisteredFilters (IlUInt &num)
	This static method returns an array of registered filter class names. More...

Detailed Description

Saturation filter.

Library: ilvbmpflt

This bitmap filter lets you saturate the color components of an image The saturate operation is equivalent to the following matrix operation:

R' = 0.213 + 0.787s    0.715 - 0.715s   0.072 - 0.072s   0   0    R
G' = 0.213 - 0.213s    0.715 + 0.285s   0.072 - 0.072s   0   0    G
B' = 0.213 - 0.213s    0.715 - 0.715s   0.072 + 0.928s   0   0    B
A' =              0                 0                0   1   0    A
1  =              0                 0                0   0   1    1

where s ranges from 0.0 to 1.0.

See Also

IlvRGBBitmapData, IlvBitmapFilter, IlvColorMatrixFilter, IlvLuminanceToAlphaFilter, IlvHueRotateFilter

Constructor & Destructor Documentation

IlvSaturationFilter::IlvSaturationFilter

(

IlFloat

saturation = 1.0

)

Constructor.

Initializes a new instance of the class IlvBlendFilter.

Parameters

saturation

The saturation value. The default saturation value is 1.0.

Member Function Documentation

IlFloat IlvSaturationFilter::getSaturation

(

)

const

Returns the saturation value.

Returns

The saturation value.

void IlvSaturationFilter::setSaturation

(

IlFloat

saturation

)

Sets the saturation value.

Parameters

saturation

The saturation value.