IlvColorPattern Class Reference

Resource class. More...

#include <ilviews/base/port.h>

Inheritance diagram for IlvColorPattern:

List of all members.

Public Member Functions
	IlvColorPattern (IlvBitmap *bitmap)
	Constructor.
	IlvColorPattern (IlvDisplay *, IlvDim w, IlvDim h, IlUShort depth, unsigned char *data)
	Constructor.
IlUShort	depth () const
	Retrieves the depth (number of bits that define a pixel value) of this pattern.
Friends
class	IlvDisplay

---

Detailed Description

Resource class.

Library: display

Defines a color pattern. This can be used in a filling operation when a colored fill pattern is desired.

See also:

IlvPalette, IlvDisplay::defaultPattern, IlvDisplay::getColorPattern.

---

Constructor & Destructor Documentation

IlvColorPattern::IlvColorPattern	(	IlvDisplay *	,
		IlvDim	w,
		IlvDim	h,
		IlUShort	depth,
		unsigned char *	data
	)

Constructor.

This constructor initializes a new IlvColorPattern object with a bitmap that is defined by the indicated data.

Parameters:

	display	The display where this color pattern is defined.
	w	The width of this color pattern.
	h	The height of this color pattern.
	depth	The depth of this color pattern.
	data	The data that defines this color pattern. This data must be packed into 16-bit words from left to right in a most significant bits first manner, and each scan line, stored from top to bottom, must be padded to 16 bits.

IlvColorPattern::IlvColorPattern

(

IlvBitmap *

bitmap

)

Constructor.

This constructor initializes a new IlvColorPattern object with a pre-allocated bitmap.

Parameters:

bitmap

The bitmap that defines this color pattern. This bitmap is internally copied (it is therefore not locked).

---

Member Function Documentation

IlUShort IlvColorPattern::depth

(

)

const [virtual]

Retrieves the depth (number of bits that define a pixel value) of this pattern.

Returns:

The depth of this pattern. This value is always 1 for instances of IlvPattern, but this member function can return a different value for an instance of IlvColorPattern, which is a subclass of IlvPattern.

Reimplemented from IlvPattern.