IlvFloodFilter Class Reference

Flood filter. More...

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

Inheritance diagram for IlvFloodFilter:

Public Member Functions
	IlvFloodFilter (IlUInt r=0, IlUInt g=0, IlUInt b=0, IlUInt a=255)
	Constructor. More...
IlvBitmapData *	apply (IlUInt count=0, const IlvBitmapData **inputs=0)
	Applies the flood to the given image.
IlUInt	getA () const
	Returns the alpha component value of the fill color. More...
IlUInt	getB () const
	Returns the blue component value of the fill color. More...
void	getColor (IlUInt &r, IlUInt &g, IlUInt &b, IlUInt &a) const
	Returns the component values of the fill color. More...
IlUInt	getG () const
	Returns the green component value of the fill color. More...
IlUInt	getR () const
	Returns the red component value of the fill color. More...
void	setA (IlUInt a)
	Sets the alpha component value of the fill color. More...
void	setB (IlUInt b)
	Sets the blue component value of the fill color. More...
void	setColor (IlUInt r, IlUInt g, IlUInt b, IlUInt a=255)
	Sets the fill color. More...
void	setG (IlUInt g)
	Sets the green component value of the fill color. More...
void	setR (IlUInt r)
	Sets the red component value of the fill color. 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

Flood filter.

Library: ilvbmpflt

This bitmap filter lets you create an image filled with specified component values.

See Also

IlvRGBBitmapData, IlvBitmapFilter

Constructor & Destructor Documentation

IlvFloodFilter::IlvFloodFilter	(	IlUInt	r = 0,
		IlUInt	g = 0,
		IlUInt	b = 0,
		IlUInt	a = 255
	)

Constructor.

Initializes a new instance of the class IlvFloodFilter. The default component values are all set to 0 for color and 255 for opacity.

Member Function Documentation

IlUInt IlvFloodFilter::getA

(

)

const

Returns the alpha component value of the fill color.

Returns

The alpha component value.

IlUInt IlvFloodFilter::getB

(

)

const

Returns the blue component value of the fill color.

Returns

The blue component value.

void IlvFloodFilter::getColor	(	IlUInt &	r,
		IlUInt &	g,
		IlUInt &	b,
		IlUInt &	a
	)		const

Returns the component values of the fill color.

Parameters

The	red component value.
The	green component value.
The	blue component value.
The	alpha component value.

IlUInt IlvFloodFilter::getG

(

)

const

Returns the green component value of the fill color.

Returns

The green component value.

IlUInt IlvFloodFilter::getR

(

)

const

Returns the red component value of the fill color.

Returns

The red component value.

void IlvFloodFilter::setA

(

IlUInt

a

)

Sets the alpha component value of the fill color.

Parameters

a	The new alpha component value.

void IlvFloodFilter::setB

(

IlUInt

b

)

Sets the blue component value of the fill color.

Parameters

b	The new blue component value.

void IlvFloodFilter::setColor	(	IlUInt	r,
		IlUInt	g,
		IlUInt	b,
		IlUInt	a = 255
	)

Sets the fill color.

Parameters

r	The new red component value
g	The new green component value
b	The new blue component value
a	The new alpha component value

void IlvFloodFilter::setG

(

IlUInt

g

)

Sets the green component value of the fill color.

Parameters

g	The new green component value.

void IlvFloodFilter::setR

(

IlUInt

r

)

Sets the red component value of the fill color.

Parameters

r	The new red component value.