#include <imageprocessor/imageprocessoreffect.h>
Link against: imageprocessor.lib
class ImageProcessor::TEffect |
Protected Attributes | |
---|---|
CImageProcessorImpl & | iImageProcessorImpl |
TBool | iIsActive |
Plugin::MEffect & | iPluginEffect |
TAny * | iReserved |
TUid | iUid |
Public Member Enumerations | |
---|---|
enum | TEffectInputType { EEffectInputTypeInt, EEffectInputTypeReal32, EEffectInputTypeCustom } |
Public Member Functions | |
---|---|
IMPORT_C void | BeginL() |
IMPORT_C void | EndL() |
IMPORT_C TAny * | Extension(TUid) |
IMPORT_C TEffectInputType | InputType() |
TBool | IsActive() |
IMPORT_C void | LevelL(TInt &) |
IMPORT_C void | LevelL(TReal32 &) |
IMPORT_C void | LevelSettings(TInt &, TInt &, TInt &) |
IMPORT_C void | LevelSettings(TReal32 &, TReal32 &, TReal32 &) |
Plugin::MEffect & | PluginEffect() |
IMPORT_C void | ResetL() |
IMPORT_C void | SetLevelL(TInt) |
IMPORT_C void | SetLevelL(TReal32) |
TUid | Type() |
Protected Member Functions | |
---|---|
TEffect(const TUid &, Plugin::MEffect &, CImageProcessorImpl &) |
The class is the parent class of all effects. The extended class should implement three stages/functions: "begin -> set -> end"
CImageProcessorImpl & | iImageProcessorImpl | [protected] |
TBool | iIsActive | [protected] |
Plugin::MEffect & | iPluginEffect | [protected] |
TAny * | iReserved | [protected] |
TUid | iUid | [protected] |
Describes the type of the effect in terms of the type of parameter input to adjust levels.
Enumerator | Value | Description |
---|---|---|
EEffectInputTypeInt | ||
EEffectInputTypeReal32 | ||
EEffectInputTypeCustom |
TEffect | ( | const TUid & | aUid, |
Plugin::MEffect & | aPluginEffect, | ||
CImageProcessorImpl & | aImageProcessorImpl | ||
) | [protected] |
Constructor.
Parameters | |
---|---|
aUid | The uid of the effect. |
aPluginEffect | The effect plugin. |
aImageProcessorImpl | The image processor implementation. |
IMPORT_C void | BeginL | ( | ) |
The begin function of effects, which is first part of the three stages/functions: "begin -> set -> end". .
IMPORT_C void | EndL | ( | ) |
The end function of effects, which is last part of the three stages/functions: "begin -> set -> end". .
IMPORT_C TEffectInputType | InputType | ( | ) | const |
Retrieves the input type for the effect.
TBool | IsActive | ( | ) | const [inline] |
Gets the state of the effect.
IMPORT_C void | LevelL | ( | TInt & | aLevel | ) | const |
Parameters | |
---|---|
aLevel | The level value. |
Leave Codes | |
---|---|
KErrNotSupported | The input type is not supported by the effect. The supported input type can be queried by calling |
IMPORT_C void | LevelL | ( | TReal32 & | aLevel | ) | const |
Parameters | |
---|---|
aLevel | The level value. |
Leave Codes | |
---|---|
KErrNotSupported | The input type is not supported by the effect. The supported input type can be queried by calling |
Retrieves the effect level range. If minimum level equals the maximum level the particular input type is not supported.
Parameters | |
---|---|
aMinimumLevel | The minimum value of the level. |
aMaximumLevel | The maximum value of the level. |
aLevelStep | The value of the level step. The level step defines the level range resolution between minimim and maximum levels. |
IMPORT_C void | LevelSettings | ( | TReal32 & | aMinimumLevel, |
TReal32 & | aMaximumLevel, | |||
TReal32 & | aLevelStep | |||
) | const |
Retrieves the effect level range. If minimum level equals the maximum level the particular input type is not supported.
Parameters | |
---|---|
aMinimumLevel | The minimum value of the level. |
aMaximumLevel | The maximum value of the level. |
aLevelStep | The value of the level step. The level step defines the level range resolution between minimim and maximum levels. |
Plugin::MEffect & | PluginEffect | ( | ) | const [inline] |
Gets associated plugin of the effect.
IMPORT_C void | ResetL | ( | ) |
The reset function of effects, which resets the effect parameters and state.
IMPORT_C void | SetLevelL | ( | TInt | aLevel | ) |
Sets the level to the effect.
See also: TEffect::BeginL()
See also: TEffect::LevelSettings(TInt& aMinimumLevel, TInt& aMaximumLevel, TInt& aLevelStep)
See also: TEffect::InputType()
Parameters | |
---|---|
aLevel | The level value to be set. |
Leave Codes | |
---|---|
KErrNotReady | The effect is not active. The effect should be set active by calling |
KErrArgument | The level is not in the level range. The range can be queried by calling TEffect::LevelSettings(TInt& aMinimumLevel, TInt& aMaximumLevel, TInt& aLevelStep) function. |
KErrNotSupported | The input type is not supported by the effect. The supported input type can be queried by calling |
IMPORT_C void | SetLevelL | ( | TReal32 | aLevel | ) |
Sets the level to the effect.
See also: TEffect::BeginL()
See also: TEffect::LevelSettings(TReal32& aMinimumLevel, TReal32& aMaximumLevel, TReal32& aLevelStep)
See also: TEffect::InputType()
Parameters | |
---|---|
aLevel | The level value to be set. |
Leave Codes | |
---|---|
KErrNotReady | The effect is not active. The effect should be set active by calling |
KErrArgument | The level is not in the level range. The range can be queried by calling TEffect::LevelSettings(TReal32& aMinimumLevel, TReal32& aMaximumLevel, TReal32& aLevelStep) function. |
KErrNotSupported | The input type is not supported for the effect. The supported input type can be queried by calling |