ImageProcessor::TEffectWhiteBalance Class Reference

class ImageProcessor::TEffectWhiteBalance : public ImageProcessor::TEffect

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

Inherits from

Constructor & Destructor Documentation

TEffectWhiteBalance(Plugin::MEffect &, CImageProcessorImpl &)

TEffectWhiteBalance(Plugin::MEffect &aEffect,
CImageProcessorImpl &aImageProcessorImpl
)[private]

Parameters

Plugin::MEffect & aEffect
CImageProcessorImpl & aImageProcessorImpl

Member Functions Documentation

ReferenceWhiteColorL()

IMPORT_C TRgbReferenceWhiteColorL()const

Gets the current rgb value of the reference white color

SetWhiteBalanceL(TWhiteBalanceMode, TRgb)

IMPORT_C voidSetWhiteBalanceL(TWhiteBalanceModeaWhiteBalanceMode,
TRgbaReferenceWhiteColor
)

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

leave
KErrNotReady The effect is not active.
leave
KErrArgument The whitebalance mode is not in the TWhiteBalanceMode enumeration

Parameters

TWhiteBalanceMode aWhiteBalanceModeThe white balance mode.
TRgb aReferenceWhiteColorThe rgb value of the reference white color.

WhiteBalanceModeL()

IMPORT_C TWhiteBalanceModeWhiteBalanceModeL()const

Gets the white balance mode

Member Enumerations Documentation

Enum TWhiteBalanceMode

Parameters to define the white balance modes.

Enumerators

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.