ImageProcessor::TEffectWhiteBalance Class Reference

#include <imageprocessor/imageprocessoreffect.h>

Link against: imageprocessor.lib

class ImageProcessor::TEffectWhiteBalance : public ImageProcessor::TEffect

Inherits from

Detailed Description

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

Member Enumeration Documentation

Enum TWhiteBalanceMode

Parameters to define the white balance modes.

EnumeratorValueDescription
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.

Member Function Documentation

ReferenceWhiteColorL ( )

IMPORT_C TRgbReferenceWhiteColorL()const

Gets the current rgb value of the reference white color

Return Value
The 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.

Parameters
aWhiteBalanceModeThe white balance mode.
aReferenceWhiteColorThe rgb value of the reference white color.
Leave Codes
KErrNotReadyThe effect is not active.
KErrArgumentThe whitebalance mode is not in the TWhiteBalanceMode enumeration

WhiteBalanceModeL ( )

IMPORT_C TWhiteBalanceModeWhiteBalanceModeL()const

Gets the white balance mode

Return Value
The value of the white balance mode