IColor

Interface for color representation. More...

#include <color_intf.h>

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.
virtual tVoid	SetRGBA (tUInt32 nRGBA)=0
	Sets a four Byte value containing the 3 Color channels and the alpha channel with the given value.
virtual tUInt8	GetRed () const=0
	Returns the value for the red channel.
virtual tVoid	SetRed (tUInt8 nRedValue)=0
	Sets the value of the red channel.
virtual tUInt8	GetGreen () const=0
	Returns the value for the green channel.
virtual tVoid	SetGreen (tUInt8 nGreenValue)=0
	Sets the value of the green channel.
virtual tUInt8	GetBlue () const=0
	Returns the value for the blue channel.
virtual tVoid	SetBlue (tUInt8 nBlueValue)=0
	Sets the value of the blue channel.
virtual tUInt8	GetAlpha () const=0
	This function returns the value for the alpha channel.
virtual tVoid	SetAlpha (tUInt8 nAlphaValue)=0
	Sets the value of the alpha channel.
virtual tUInt8	GetBrightness () const=0
	This function returns the value for a calculated brightness.

Detailed Description

Interface for color representation.

Definition at line 26 of file color_intf.h.

Constructor & Destructor Documentation

~IColor()

virtual ~IColor ( )

inlinevirtual

virtual destructor to ensure proper cleanup.

Definition at line 32 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

GetBlue()

virtual tUInt8 GetBlue ( ) const

pure virtual

Returns the value for the blue channel.

Returns

tUInt8 blue channel

GetBrightness()

virtual tUInt8 GetBrightness ( ) const

pure virtual

This function returns the value for a calculated brightness.

Returns

calculated brightness

GetGreen()

virtual tUInt8 GetGreen ( ) const

pure virtual

Returns the value for the green channel.

Returns

tUInt8 green channel

GetRed()

virtual tUInt8 GetRed ( ) const

pure virtual

Returns the value for the red channel.

Returns

tUInt8 red channel

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

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

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

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

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

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