ImageProcessor::TEffectWhiteBalance Class Reference

#include <imageprocessor/imageprocessoreffect.h>

Link against: imageprocessor.lib

class ImageProcessor::TEffectWhiteBalance : public ImageProcessor::TEffect

Inherits from

Public Member Enumerations
enum	TWhiteBalanceMode { EWhiteBalanceMeanMode, EWhiteBalanceMaxMode, EWhiteBalanceManualMode, EWhiteBalanceClusterMode }

Public Member Functions
IMPORT_C TRgb	ReferenceWhiteColorL()
IMPORT_C void	SetWhiteBalanceL(TWhiteBalanceMode, TRgb)
IMPORT_C TWhiteBalanceMode	WhiteBalanceModeL()

Inherited Attributes
	ImageProcessor::TEffect::iImageProcessorImpl
	ImageProcessor::TEffect::iIsActive
	ImageProcessor::TEffect::iPluginEffect
	ImageProcessor::TEffect::iReserved
	ImageProcessor::TEffect::iUid

Inherited Enumerations
	ImageProcessor::TEffect:TEffectInputType

Inherited Functions
	ImageProcessor::TEffect::BeginL()
	ImageProcessor::TEffect::EndL()
	ImageProcessor::TEffect::Extension(TUid)
	ImageProcessor::TEffect::InputType()const
	ImageProcessor::TEffect::IsActive()const
	ImageProcessor::TEffect::LevelL(TInt &)const
	ImageProcessor::TEffect::LevelL(TReal32 &)const
	ImageProcessor::TEffect::LevelSettings(TInt &,TInt &,TInt &)const
	ImageProcessor::TEffect::LevelSettings(TReal32 &,TReal32 &,TReal32 &)const
	ImageProcessor::TEffect::PluginEffect()const
	ImageProcessor::TEffect::ResetL()
	ImageProcessor::TEffect::SetLevelL(TInt)
	ImageProcessor::TEffect::SetLevelL(TReal32)
	ImageProcessor::TEffect::TEffect(const TUid &,Plugin::MEffect &,CImageProcessorImpl &)
	ImageProcessor::TEffect::Type()const

The class provides functions to perform white balance adjustment on an image.

Parameters to define the white balance modes.

Enumerator	Value	Description
EWhiteBalanceMeanMode		Uses the estimated mean gray for the color correction, which is the default mode.
EWhiteBalanceMaxMode		Uses the estimated maximum intensity color.
EWhiteBalanceManualMode		Uses a white reference color.
EWhiteBalanceClusterMode		Calulates the reference from the mean value of the 256-bin distribution.

IMPORT_C TRgb

ReferenceWhiteColorL

(

)

const

Gets the current rgb value of the reference white color

Returns: The rgb value of the reference white color

Specifies the white balance mode and the value of reference white color.

leave: KErrArgument The whitebalance mode is not in the TWhiteBalanceMode enumeration

Parameter	Description
aWhiteBalanceMode	The white balance mode.
aReferenceWhiteColor	The rgb value of the reference white color.

WhiteBalanceModeL

(

)

const

Gets the white balance mode

Returns: The value of the white balance mode