IColor

Interface for color representation. More...

Inheritance diagram for IColor:

Public Member Functions
virtual	~IColor ()
	virtual destructor to ensure proper cleanup.
virtual tVoid	Release ()=0
	Releases this color.
virtual tUInt32	GetRGBA () const =0
	Gets a four Byte value containing the 3 color channels and the alpha channel. More...
virtual tVoid	SetRGBA (tUInt32 nRGBA)=0
	Sets a four Byte value containing the 3 Color channels and the alpha channel with the given value. More...
virtual tUInt8	GetRed () const =0
	Returns the value for the red channel. More...
virtual tVoid	SetRed (tUInt8 nRedValue)=0
	Sets the value of the red channel. More...
virtual tUInt8	GetGreen () const =0
	Returns the value for the green channel. More...
virtual tVoid	SetGreen (tUInt8 nGreenValue)=0
	Sets the value of the green channel. More...
virtual tUInt8	GetBlue () const =0
	Returns the value for the blue channel. More...
virtual tVoid	SetBlue (tUInt8 nBlueValue)=0
	Sets the value of the blue channel. More...
virtual tUInt8	GetAlpha () const =0
	This function returns the value for the alpha channel. More...
virtual tVoid	SetAlpha (tUInt8 nAlphaValue)=0
	Sets the value of the alpha channel. More...
virtual tUInt8	GetBrightness () const =0
	This function returns the value for a calculated brightness. More...

Detailed Description

Interface for color representation.

Definition at line 26 of file color_intf.h.

Member Function Documentation

GetAlpha()

virtual tUInt8 GetAlpha ( ) const

pure virtual

This function returns the value for the alpha channel.

Returns

tUInt8 alpha channel

Implemented in cColor.

Referenced by cColor::cColor().

GetBlue()

virtual tUInt8 GetBlue ( ) const

pure virtual

Returns the value for the blue channel.

Returns

tUInt8 blue channel

Implemented in cColor.

Referenced by cColor::cColor().

GetBrightness()

virtual tUInt8 GetBrightness ( ) const

pure virtual

This function returns the value for a calculated brightness.

Returns

calculated brightness

Implemented in cColor.

GetGreen()

virtual tUInt8 GetGreen ( ) const

pure virtual

Returns the value for the green channel.

Returns

tUInt8 green channel

Implemented in cColor.

Referenced by cColor::cColor().

GetRed()

virtual tUInt8 GetRed ( ) const

pure virtual

Returns the value for the red channel.

Returns

tUInt8 red channel

Implemented in cColor.

Referenced by cColor::cColor().

GetRGBA()

virtual tUInt32 GetRGBA ( ) const

pure virtual

Gets a four Byte value containing the 3 color channels and the alpha channel.

Returns

tUInt32 combined return value, first byte represents red, second green, third blue and the last the alpha channel

Implemented in cColor.

SetAlpha()

virtual tVoid SetAlpha ( tUInt8  nAlphaValue )

pure virtual

Sets the value of the alpha channel.

Parameters

nAlphaValue

[in] value for the alpha channel

Returns

void

Implemented in cColor.

SetBlue()

virtual tVoid SetBlue ( tUInt8  nBlueValue )

pure virtual

Sets the value of the blue channel.

Parameters

nBlueValue

[in] value for the blue channel

Returns

void

Implemented in cColor.

SetGreen()

virtual tVoid SetGreen ( tUInt8  nGreenValue )

pure virtual

Sets the value of the green channel.

Parameters

nGreenValue

[in] value for the green channel

Returns

void

Implemented in cColor.

SetRed()

virtual tVoid SetRed ( tUInt8  nRedValue )

pure virtual

Sets the value of the red channel.

Parameters

nRedValue

[in] value for the red channel

Returns

void

Implemented in cColor.

SetRGBA()

virtual tVoid SetRGBA ( tUInt32  nRGBA )

pure virtual

Sets a four Byte value containing the 3 Color channels and the alpha channel with the given value.

Parameters

nRGBA

[in] four Byte value

Returns

void

Implemented in cColor.