Rogue Wave Views
Foundation Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions
IlvSaturationFilter Class Reference

Saturation filter. More...

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

Inheritance diagram for IlvSaturationFilter:
IlvColorMatrixFilter IlvBitmapFilter IlvValueInterface

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...
 
IlvBitmapDataapply (IlUInt count=0, const IlvBitmapData **inputs=0)
 Applies the color matrix to the given image.
 
const IlFloatgetValues (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...
 
IlvBitmapDataapplyUnary (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.
 
- Public Member Functions inherited from IlvValueInterface
virtual IlBoolean applyValue (const IlvValue &value)
 Apply an accessor. More...
 
virtual IlBoolean changeValue (const IlvValue &val)
 Changes the value of an accessor. More...
 
virtual IlBoolean changeValues (const IlvValue *values, IlUShort count=0)
 Changes several accessor values simultaneously. More...
 
virtual void getAccessors (const IlSymbol *const **names, const IlvValueTypeClass *const **types, IlUInt &count) const
 Retrieves the list of available accessors of an object. More...
 
virtual IlvValuequeryValue (IlvValue &val) const
 Retrieves an accessor value. More...
 
virtual void queryValues (IlvValue *values, IlUShort count) const
 Retrieves multiple accessor values simultaneously. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from IlvBitmapFilter
static IlvBitmapFilterCreate (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
saturationThe 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
saturationThe saturation value.

© Copyright 2016, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.