Symbian^3 Product Developer Library >

CHuiFxEffect Class Reference

class CHuiFxEffect : public CBase

Inherits from

Public Member Functions
~CHuiFxEffect()
IMPORT_C voidAddLayerL(const CHuiFxLayer *)
IMPORT_C voidAdvanceTime(TReal32)
TBool CachedDraw(CHuiGc &, const TRect &, TBool, TBool, const TRegion &, TBool, TInt)
TBool CachedDraw(CHuiGc &, const TRect &, TBool, TBool)
IMPORT_C TBoolChanged()
voidClearEffectFlag(TInt)
IMPORT_C CHuiFxEffect *CloneL()
IMPORT_C TBoolDraw(CHuiGc &, const TRect &, TBool)
IMPORT_C TIntEffectFlags()
IMPORT_C CHuiFxEngine &Engine()
voidForceCachedRenderTargetUsage(TBool)
TBool FxmlUsesOpaqueHint()
voidFxmlVisualInputs(RArray< THuiFxVisualSrcType > &)
IMPORT_C TIntGroupId()
TInt Handle()
IMPORT_C TBoolIsAnimated()
TBool IsCachedRenderTargetPreferred()
TBool IsCachedRenderTargetSupported()
TBool IsSemitransparent()
IMPORT_C TBoolIsTransformed()
IMPORT_C CHuiFxEffect *NewL(CHuiFxEngine &)
TBool NotifyEffectEndObserver()
voidPrepareCachedRenderTarget(const TPoint &, const TSize &, TBool, TBool)
voidReleaseCachedRenderTarget()
IMPORT_C voidSetEffectEndObserver(MAlfGfxEffectObserver *, TInt)
voidSetEffectFlag(TInt)
IMPORT_C voidSetEffectFlags(TInt)
IMPORT_C voidSetEffectGroup(TInt)
IMPORT_C voidSetEngine(CHuiFxEngine *)
IMPORT_C voidSetExtRect(TRect *)
IMPORT_C voidSetVisual(CHuiVisual *)
IMPORT_C voidSetVisual(MHuiEffectable *)
IMPORT_C TBoolVisualArea(TRect &)
Protected Member Functions
CHuiFxEffect(CHuiFxEngine &)
voidConstructL()
Private Member Functions
TBool IsAppliedToBackground()
TBool IsFiltered()
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Protected Attributes
CHuiFxRenderbuffer *iCachedRenderTarget
MAlfGfxEffectObserver *iEffectEndObserver
TReal32 iElapsedTime
CHuiFxEngine *iEngine
TInt iFlags
TBool iForcedUseCachedRenderTarget
TInt iFramesDrawn
TInt iGroupId
TInt iHandle
CHuiFxGroupLayer *iRoot

Constructor & Destructor Documentation

CHuiFxEffect(CHuiFxEngine &)

CHuiFxEffect(CHuiFxEngine &aEngine)[protected]

Parameters

CHuiFxEngine & aEngine

~CHuiFxEffect()

IMPORT_C~CHuiFxEffect()[virtual]

Member Functions Documentation

AddLayerL(const CHuiFxLayer *)

IMPORT_C voidAddLayerL(const CHuiFxLayer *aLayer)

Parameters

const CHuiFxLayer * aLayer

AdvanceTime(TReal32)

IMPORT_C voidAdvanceTime(TReal32aElapsedTime)

Parameters

TReal32 aElapsedTime

CachedDraw(CHuiGc &, const TRect &, TBool, TBool, const TRegion &, TBool, TInt)

TBool CachedDraw(CHuiGc &aGc,
const TRect &aDisplayRect,
TBoolaRefreshCachedRenderTarget,
TBoolaOpaque,
const TRegion &aClipRegion,
TBoolaHasSurface,
TIntaAlpha = 255
)

Parameters

CHuiGc & aGc
const TRect & aDisplayRect
TBool aRefreshCachedRenderTarget
TBool aOpaque
const TRegion & aClipRegion
TBool aHasSurface
TInt aAlpha = 255

CachedDraw(CHuiGc &, const TRect &, TBool, TBool)

TBool CachedDraw(CHuiGc &aGc,
const TRect &aDisplayRect,
TBoolaRefreshCachedRenderTarget,
TBoolaOpaque
)

Parameters

CHuiGc & aGc
const TRect & aDisplayRect
TBool aRefreshCachedRenderTarget
TBool aOpaque

Changed()

IMPORT_C TBoolChanged()

ClearEffectFlag(TInt)

voidClearEffectFlag(TIntaFlag)

Parameters

TInt aFlag

CloneL()

IMPORT_C CHuiFxEffect *CloneL()const

ConstructL()

voidConstructL()[protected]

Draw(CHuiGc &, const TRect &, TBool)

IMPORT_C TBoolDraw(CHuiGc &aGc,
const TRect &aDisplayRect,
TBoolaHasSurface
)

Parameters

CHuiGc & aGc
const TRect & aDisplayRect
TBool aHasSurface

EffectFlags()

IMPORT_C TIntEffectFlags()

Engine()

IMPORT_C CHuiFxEngine &Engine()const

ForceCachedRenderTargetUsage(TBool)

voidForceCachedRenderTargetUsage(TBoolaUseCachedRenderTarget)

Parameters

TBool aUseCachedRenderTarget

FxmlUsesOpaqueHint()

TBool FxmlUsesOpaqueHint()const

FxmlVisualInputs(RArray< THuiFxVisualSrcType > &)

voidFxmlVisualInputs(RArray< THuiFxVisualSrcType > &aArray)

Parameters

RArray< THuiFxVisualSrcType > & aArray

GroupId()

IMPORT_C TIntGroupId()

Handle()

TInt Handle()const [inline]

IsAnimated()

IMPORT_C TBoolIsAnimated()const

IsAppliedToBackground()

TBool IsAppliedToBackground()[private]

IsCachedRenderTargetPreferred()

TBool IsCachedRenderTargetPreferred()const

IsCachedRenderTargetSupported()

TBool IsCachedRenderTargetSupported()const

IsFiltered()

TBool IsFiltered()const [private]

IsSemitransparent()

TBool IsSemitransparent()const

IsTransformed()

IMPORT_C TBoolIsTransformed()const

NewL(CHuiFxEngine &)

IMPORT_C CHuiFxEffect *NewL(CHuiFxEngine &aEngine)[static]

Parameters

CHuiFxEngine & aEngine

NotifyEffectEndObserver()

TBool NotifyEffectEndObserver()

NotifyEffectEndObserver

PrepareCachedRenderTarget(const TPoint &, const TSize &, TBool, TBool)

voidPrepareCachedRenderTarget(const TPoint &aPosition,
const TSize &aSize,
TBoolaClear,
TBoolaEnableBackground
)

Parameters

const TPoint & aPosition
const TSize & aSize
TBool aClear
TBool aEnableBackground

ReleaseCachedRenderTarget()

voidReleaseCachedRenderTarget()

SetEffectEndObserver(MAlfGfxEffectObserver *, TInt)

IMPORT_C voidSetEffectEndObserver(MAlfGfxEffectObserver *aEffectEndObserver,
TIntaHandle
)

Parameters

MAlfGfxEffectObserver * aEffectEndObserver
TInt aHandle

SetEffectFlag(TInt)

voidSetEffectFlag(TIntaFlag)

Parameters

TInt aFlag

SetEffectFlags(TInt)

IMPORT_C voidSetEffectFlags(TIntaFlags)

Parameters

TInt aFlags

SetEffectGroup(TInt)

IMPORT_C voidSetEffectGroup(TIntaGroupId)

Parameters

TInt aGroupId

SetEngine(CHuiFxEngine *)

IMPORT_C voidSetEngine(CHuiFxEngine *aEngine)

Parameters

CHuiFxEngine * aEngine

SetExtRect(TRect *)

IMPORT_C voidSetExtRect(TRect *aExtRect)

Parameters

TRect * aExtRect

SetVisual(CHuiVisual *)

IMPORT_C voidSetVisual(CHuiVisual *aVisual)

Parameters

CHuiVisual * aVisual

SetVisual(MHuiEffectable *)

IMPORT_C voidSetVisual(MHuiEffectable *aVisual)

Parameters

MHuiEffectable * aVisual

VisualArea(TRect &)

IMPORT_C TBoolVisualArea(TRect &aRect)const

Parameters

TRect & aRect

Member Data Documentation

CHuiFxRenderbuffer * iCachedRenderTarget

CHuiFxRenderbuffer *iCachedRenderTarget[protected]

MAlfGfxEffectObserver * iEffectEndObserver

MAlfGfxEffectObserver *iEffectEndObserver[protected]

TReal32 iElapsedTime

TReal32 iElapsedTime[protected]

CHuiFxEngine * iEngine

CHuiFxEngine *iEngine[protected]

TInt iFlags

TInt iFlags[protected]

TBool iForcedUseCachedRenderTarget

TBool iForcedUseCachedRenderTarget[protected]

TInt iFramesDrawn

TInt iFramesDrawn[protected]

TInt iGroupId

TInt iGroupId[protected]

TInt iHandle

TInt iHandle[protected]

CHuiFxGroupLayer * iRoot

CHuiFxGroupLayer *iRoot[protected]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.