IlvFloodFilter Class Reference

Flood filter. More...

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

Inheritance diagram for IlvFloodFilter:

List of all members.

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

---

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.