Symbian^3 Application Developer Library >

CHuiFxEffect Class Reference

class CHuiFxEffect : public CBase

Inherits from

Public Member Functions
~CHuiFxEffect ()
IMPORT_C void AddLayerL (const CHuiFxLayer *)
IMPORT_C void AdvanceTime ( TReal32 )
TBool CachedDraw ( CHuiGc &, const TRect &, TBool , TBool , const TRegion &, TBool , TInt )
TBool CachedDraw ( CHuiGc &, const TRect &, TBool , TBool )
IMPORT_C TBool Changed ()
void ClearEffectFlag ( TInt )
IMPORT_C CHuiFxEffect * CloneL ()
IMPORT_C TBool Draw ( CHuiGc &, const TRect &, TBool )
IMPORT_C TInt EffectFlags ()
IMPORT_C CHuiFxEngine & Engine ()
void ForceCachedRenderTargetUsage ( TBool )
TBool FxmlUsesOpaqueHint ()
void FxmlVisualInputs ( RArray < THuiFxVisualSrcType > &)
IMPORT_C TInt GroupId ()
TInt Handle ()
IMPORT_C TBool IsAnimated ()
TBool IsCachedRenderTargetPreferred ()
TBool IsCachedRenderTargetSupported ()
TBool IsSemitransparent ()
IMPORT_C TBool IsTransformed ()
IMPORT_C CHuiFxEffect * NewL ( CHuiFxEngine &)
TBool NotifyEffectEndObserver ()
void PrepareCachedRenderTarget (const TPoint &, const TSize &, TBool , TBool )
void ReleaseCachedRenderTarget ()
IMPORT_C void SetEffectEndObserver ( MAlfGfxEffectObserver *, TInt )
void SetEffectFlag ( TInt )
IMPORT_C void SetEffectFlags ( TInt )
IMPORT_C void SetEffectGroup ( TInt )
IMPORT_C void SetEngine ( CHuiFxEngine *)
IMPORT_C void SetExtRect ( TRect *)
IMPORT_C void SetVisual ( CHuiVisual *)
IMPORT_C void SetVisual ( MHuiEffectable *)
IMPORT_C TBool VisualArea ( TRect &)
Protected Member Functions
CHuiFxEffect ( CHuiFxEngine &)
void ConstructL ()
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 void AddLayerL ( const CHuiFxLayer * aLayer )

Parameters

const CHuiFxLayer * aLayer

AdvanceTime(TReal32)

IMPORT_C void AdvanceTime ( TReal32 aElapsedTime )

Parameters

TReal32 aElapsedTime

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

TBool CachedDraw ( CHuiGc & aGc,
const TRect & aDisplayRect,
TBool aRefreshCachedRenderTarget,
TBool aOpaque,
const TRegion & aClipRegion,
TBool aHasSurface,
TInt aAlpha = 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,
TBool aRefreshCachedRenderTarget,
TBool aOpaque
)

Parameters

CHuiGc & aGc
const TRect & aDisplayRect
TBool aRefreshCachedRenderTarget
TBool aOpaque

Changed()

IMPORT_C TBool Changed ( )

ClearEffectFlag(TInt)

void ClearEffectFlag ( TInt aFlag )

Parameters

TInt aFlag

CloneL()

IMPORT_C CHuiFxEffect * CloneL ( ) const

ConstructL()

void ConstructL ( ) [protected]

Draw(CHuiGc &, const TRect &, TBool)

IMPORT_C TBool Draw ( CHuiGc & aGc,
const TRect & aDisplayRect,
TBool aHasSurface
)

Parameters

CHuiGc & aGc
const TRect & aDisplayRect
TBool aHasSurface

EffectFlags()

IMPORT_C TInt EffectFlags ( )

Engine()

IMPORT_C CHuiFxEngine & Engine ( ) const

ForceCachedRenderTargetUsage(TBool)

void ForceCachedRenderTargetUsage ( TBool aUseCachedRenderTarget )

Parameters

TBool aUseCachedRenderTarget

FxmlUsesOpaqueHint()

TBool FxmlUsesOpaqueHint ( ) const

FxmlVisualInputs(RArray< THuiFxVisualSrcType > &)

void FxmlVisualInputs ( RArray < THuiFxVisualSrcType > & aArray )

Parameters

RArray < THuiFxVisualSrcType > & aArray

GroupId()

IMPORT_C TInt GroupId ( )

Handle()

TInt Handle ( ) const [inline]

IsAnimated()

IMPORT_C TBool IsAnimated ( ) 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 TBool IsTransformed ( ) const

NewL(CHuiFxEngine &)

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

Parameters

CHuiFxEngine & aEngine

NotifyEffectEndObserver()

TBool NotifyEffectEndObserver ( )

NotifyEffectEndObserver

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

void PrepareCachedRenderTarget ( const TPoint & aPosition,
const TSize & aSize,
TBool aClear,
TBool aEnableBackground
)

Parameters

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

ReleaseCachedRenderTarget()

void ReleaseCachedRenderTarget ( )

SetEffectEndObserver(MAlfGfxEffectObserver *, TInt)

IMPORT_C void SetEffectEndObserver ( MAlfGfxEffectObserver * aEffectEndObserver,
TInt aHandle
)

Parameters

MAlfGfxEffectObserver * aEffectEndObserver
TInt aHandle

SetEffectFlag(TInt)

void SetEffectFlag ( TInt aFlag )

Parameters

TInt aFlag

SetEffectFlags(TInt)

IMPORT_C void SetEffectFlags ( TInt aFlags )

Parameters

TInt aFlags

SetEffectGroup(TInt)

IMPORT_C void SetEffectGroup ( TInt aGroupId )

Parameters

TInt aGroupId

SetEngine(CHuiFxEngine *)

IMPORT_C void SetEngine ( CHuiFxEngine * aEngine )

Parameters

CHuiFxEngine * aEngine

SetExtRect(TRect *)

IMPORT_C void SetExtRect ( TRect * aExtRect )

Parameters

TRect * aExtRect

SetVisual(CHuiVisual *)

IMPORT_C void SetVisual ( CHuiVisual * aVisual )

Parameters

CHuiVisual * aVisual

SetVisual(MHuiEffectable *)

IMPORT_C void SetVisual ( MHuiEffectable * aVisual )

Parameters

MHuiEffectable * aVisual

VisualArea(TRect &)

IMPORT_C TBool VisualArea ( 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.