IlvSaturationFilter Class Reference

Saturation filter. More...

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

Inheritance diagram for IlvSaturationFilter:

List of all members.

Public Member Functions
	IlvSaturationFilter (IlFloat saturation=1.0)
	Constructor.
IlFloat	getSaturation () const
	Returns the saturation value.
void	setSaturation (IlFloat saturation)
	Sets the saturation value.

---

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.