Symbian^3 Application Developer Library >

CHuiFxEngine Class Reference

class CHuiFxEngine : public CBase

Inherits from

Public Member Functions
~CHuiFxEngine ()
IMPORT_C CHuiFxRenderbuffer * AcquireRenderbuffer (const TSize &)
CHuiFxRenderbuffer * AcquireRenderbuffer (const TSize &, TBool )
IMPORT_C TInt ActiveGroupEffect ()
IMPORT_C TBool AddEffectToGroup ( TInt )
IMPORT_C void AdvanceTime ( TReal32 )
IMPORT_C void BeginGroupEffect ( TInt )
void ClearCache ()
void Composite ( CHuiFxRenderbuffer &, CHuiFxRenderbuffer &, const TRect &, const TRect &, THuiFxBlendingMode , TInt )
IMPORT_C void Composite ( CHuiGc &, CHuiFxRenderbuffer &, const TPoint &, TBool , TInt )
CHuiFxFilter * CreateFilterL ( THuiFxFilterType )
CHuiFxRenderbuffer * DefaultRenderbuffer ()
IMPORT_C void EnableLowMemoryState ( TBool )
IMPORT_C THuiFxEngineType EngineType ()
IMPORT_C TBool FxmlUsesInput1 (const TDesC &)
IMPORT_C TBool FxmlUsesOpaqueHint (const TDesC &)
IMPORT_C TReal32 GetReferenceValue ( THuiFxReferencePoint )
TBool HasActiveEffects ()
TBool HasActiveFadeEffect ()
IMPORT_C void LoadEffectL (const TDesC &, CHuiFxEffect *&, MHuiEffectable *, TRect *, MAlfGfxEffectObserver *, TInt , TInt )
IMPORT_C void LoadGroupEffectL (const TDesC &, CHuiFxEffect *&, MHuiEffectable *, TInt , TRect *, MAlfGfxEffectObserver *, TInt , TInt )
TInt LowMemoryState ()
void NotifyEffectEndObservers ()
void NotifyEffectReady ( TInt )
IMPORT_C void RegisterEffectL (const TDesC &)
IMPORT_C void Release ()
IMPORT_C void ReleaseRenderbuffer ( CHuiFxRenderbuffer *)
IMPORT_C void RestoreL ()
IMPORT_C void SetMemoryLevel ( THuiMemoryLevel )
void SetObserver ( MHuiEffectObserver *)
IMPORT_C void StartGroupEffect ( TInt )
IMPORT_C void UnRegisterEffectL (const TDesC &)
Protected Member Functions
IMPORT_C void AddEffectL ( CHuiFxEffect *)
IMPORT_C void ConstructL ( THuiFxEngineType )
IMPORT_C void RemoveEffect ( CHuiFxEffect *)
Private Member Functions
CHuiFxRenderbuffer * AcquireNativeRenderbuffer (const TSize &)
TInt FindEffectGroup ( TInt )
TBool FxmlUsesInput1 ( CHuiFxEffect &)
void InsertFreeRenderbuffer ( CHuiFxRenderbuffer *)
TBool IsCacheEmpty ()
TBool IsCacheFull ()
CHuiFxRenderbuffer * LookupFreeRenderbuffer (const TSize &, TBool )
NONSHARABLE_STRUCT (TEffectGroupStruct)
void ReleaseNativeRenderbuffer ( CHuiFxRenderbuffer *)
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
TInt iBuffersInUse
TRequestStatus iParserStatus
Private Attributes
const TInt CACHE_SIZE
RArray < TEffectGroupStruct > iActiveEffectGroups
RPointerArray < CHuiFxEffect > iActiveEffects
CHuiFxRenderbuffer * iBufferCache
TInt iBuffersInCache
CHuiFxEffectCache * iCache
MHuiEffectObserver * iEffectObserver
TRect iExtRect
TInt iLowGraphicsMemoryMode
THuiFxEngineType iType

Constructor & Destructor Documentation

~CHuiFxEngine()

IMPORT_C ~CHuiFxEngine ( ) [virtual]

Member Functions Documentation

AcquireNativeRenderbuffer(const TSize &)

CHuiFxRenderbuffer * AcquireNativeRenderbuffer ( const TSize & aDesiredSize ) [private, pure virtual]

Parameters

const TSize & aDesiredSize

AcquireRenderbuffer(const TSize &)

IMPORT_C CHuiFxRenderbuffer * AcquireRenderbuffer ( const TSize & aDesiredSize ) [virtual]

Parameters

const TSize & aDesiredSize

AcquireRenderbuffer(const TSize &, TBool)

CHuiFxRenderbuffer * AcquireRenderbuffer ( const TSize & aDesiredSize,
TBool aAlllowLarger
)

Parameters

const TSize & aDesiredSize
TBool aAlllowLarger

ActiveGroupEffect()

IMPORT_C TInt ActiveGroupEffect ( )

AddEffectL(CHuiFxEffect *)

IMPORT_C void AddEffectL ( CHuiFxEffect * aEffect ) [protected]

Parameters

CHuiFxEffect * aEffect

AddEffectToGroup(TInt)

IMPORT_C TBool AddEffectToGroup ( TInt aGroup )

Parameters

TInt aGroup

AdvanceTime(TReal32)

IMPORT_C void AdvanceTime ( TReal32 aElapsedTime )

Parameters

TReal32 aElapsedTime

BeginGroupEffect(TInt)

IMPORT_C void BeginGroupEffect ( TInt aGroup )

Parameters

TInt aGroup

ClearCache()

void ClearCache ( )

Composite(CHuiFxRenderbuffer &, CHuiFxRenderbuffer &, const TRect &, const TRect &, THuiFxBlendingMode, TInt)

void Composite ( CHuiFxRenderbuffer & aTarget,
CHuiFxRenderbuffer & aSource,
const TRect & aTargetRect,
const TRect & aSourceRect,
THuiFxBlendingMode aMode,
TInt aAlpha
) [pure virtual]

Parameters

CHuiFxRenderbuffer & aTarget
CHuiFxRenderbuffer & aSource
const TRect & aTargetRect
const TRect & aSourceRect
THuiFxBlendingMode aMode
TInt aAlpha

Composite(CHuiGc &, CHuiFxRenderbuffer &, const TPoint &, TBool, TInt)

IMPORT_C void Composite ( CHuiGc & aGc,
CHuiFxRenderbuffer & aSource,
const TPoint & aTargetPoint,
TBool aOpaque,
TInt aAlpha
) [virtual]

Parameters

CHuiGc & aGc
CHuiFxRenderbuffer & aSource
const TPoint & aTargetPoint
TBool aOpaque
TInt aAlpha

ConstructL(THuiFxEngineType)

IMPORT_C void ConstructL ( THuiFxEngineType aEngineType ) [protected]

Parameters

THuiFxEngineType aEngineType

CreateFilterL(THuiFxFilterType)

CHuiFxFilter * CreateFilterL ( THuiFxFilterType aType ) [pure virtual]

Parameters

THuiFxFilterType aType

DefaultRenderbuffer()

CHuiFxRenderbuffer * DefaultRenderbuffer ( ) [pure virtual]

EnableLowMemoryState(TBool)

IMPORT_C void EnableLowMemoryState ( TBool aEnable )

Parameters

TBool aEnable

EngineType()

IMPORT_C THuiFxEngineType EngineType ( )

FindEffectGroup(TInt)

TInt FindEffectGroup ( TInt aGroup ) [private]

Parameters

TInt aGroup

FxmlUsesInput1(const TDesC &)

IMPORT_C TBool FxmlUsesInput1 ( const TDesC & aFileName )

Parameters

const TDesC & aFileName

FxmlUsesInput1(CHuiFxEffect &)

TBool FxmlUsesInput1 ( CHuiFxEffect & aEffect ) [private]

Parameters

CHuiFxEffect & aEffect

FxmlUsesOpaqueHint(const TDesC &)

IMPORT_C TBool FxmlUsesOpaqueHint ( const TDesC & aFileName )

Parameters

const TDesC & aFileName

GetReferenceValue(THuiFxReferencePoint)

IMPORT_C TReal32 GetReferenceValue ( THuiFxReferencePoint aPoint )

Parameters

THuiFxReferencePoint aPoint

HasActiveEffects()

TBool HasActiveEffects ( ) const

HasActiveFadeEffect()

TBool HasActiveFadeEffect ( ) const

InsertFreeRenderbuffer(CHuiFxRenderbuffer *)

void InsertFreeRenderbuffer ( CHuiFxRenderbuffer * aBuffer ) [private]

Parameters

CHuiFxRenderbuffer * aBuffer

IsCacheEmpty()

TBool IsCacheEmpty ( ) const [private, inline]

IsCacheFull()

TBool IsCacheFull ( ) const [private, inline]

LoadEffectL(const TDesC &, CHuiFxEffect *&, MHuiEffectable *, TRect *, MAlfGfxEffectObserver *, TInt, TInt)

IMPORT_C void LoadEffectL ( const TDesC & aFileName,
CHuiFxEffect *& aEffect,
MHuiEffectable * aVisual = 0,
TRect * extRect = 0,
MAlfGfxEffectObserver * aEffectEndObserver = 0,
TInt aHandle = 0,
TInt aFlags = 0
)

Parameters

const TDesC & aFileName
CHuiFxEffect *& aEffect
MHuiEffectable * aVisual = 0
TRect * extRect = 0
MAlfGfxEffectObserver * aEffectEndObserver = 0
TInt aHandle = 0
TInt aFlags = 0

LoadGroupEffectL(const TDesC &, CHuiFxEffect *&, MHuiEffectable *, TInt, TRect *, MAlfGfxEffectObserver *, TInt, TInt)

IMPORT_C void LoadGroupEffectL ( const TDesC & aFileName,
CHuiFxEffect *& aEffect,
MHuiEffectable * aVisual = 0,
TInt aGroupHandle = 0,
TRect * extRect = 0,
MAlfGfxEffectObserver * aEffectEndObserver = 0,
TInt aHandle = 0,
TInt aFlags = 0
)

Parameters

const TDesC & aFileName
CHuiFxEffect *& aEffect
MHuiEffectable * aVisual = 0
TInt aGroupHandle = 0
TRect * extRect = 0
MAlfGfxEffectObserver * aEffectEndObserver = 0
TInt aHandle = 0
TInt aFlags = 0

LookupFreeRenderbuffer(const TSize &, TBool)

CHuiFxRenderbuffer * LookupFreeRenderbuffer ( const TSize & aDesiredSize,
TBool aAlllowLarger
) [private]

Parameters

const TSize & aDesiredSize
TBool aAlllowLarger

LowMemoryState()

TInt LowMemoryState ( )

NONSHARABLE_STRUCT(TEffectGroupStruct)

NONSHARABLE_STRUCT ( TEffectGroupStruct ) [private, inline]

Parameters

TEffectGroupStruct

NotifyEffectEndObservers()

void NotifyEffectEndObservers ( )

NotifyEffectReady(TInt)

void NotifyEffectReady ( TInt aGroupId )

Group effects wait until each effect has been drawn once.

Group effects are set into motion by NotifyEffectReady, when all effects in the group have been drawn at least once.

Parameters

TInt aGroupId

RegisterEffectL(const TDesC &)

IMPORT_C void RegisterEffectL ( const TDesC & aFileName )

Parameters

const TDesC & aFileName

Release()

IMPORT_C void Release ( ) [virtual]

ReleaseNativeRenderbuffer(CHuiFxRenderbuffer *)

void ReleaseNativeRenderbuffer ( CHuiFxRenderbuffer * aBuffer ) [private, pure virtual]

Parameters

CHuiFxRenderbuffer * aBuffer

ReleaseRenderbuffer(CHuiFxRenderbuffer *)

IMPORT_C void ReleaseRenderbuffer ( CHuiFxRenderbuffer * aBuffer ) [virtual]

Parameters

CHuiFxRenderbuffer * aBuffer

RemoveEffect(CHuiFxEffect *)

IMPORT_C void RemoveEffect ( CHuiFxEffect * aEffect ) [protected]

Parameters

CHuiFxEffect * aEffect

RestoreL()

IMPORT_C void RestoreL ( ) [virtual]

SetMemoryLevel(THuiMemoryLevel)

IMPORT_C void SetMemoryLevel ( THuiMemoryLevel aLevel )

Parameters

THuiMemoryLevel aLevel

SetObserver(MHuiEffectObserver *)

void SetObserver ( MHuiEffectObserver * aObserver ) [inline]

Parameters

MHuiEffectObserver * aObserver

StartGroupEffect(TInt)

IMPORT_C void StartGroupEffect ( TInt aGroup )

Parameters

TInt aGroup

UnRegisterEffectL(const TDesC &)

IMPORT_C void UnRegisterEffectL ( const TDesC & aFileName )

Parameters

const TDesC & aFileName

Member Data Documentation

const TInt CACHE_SIZE

const TInt CACHE_SIZE [private, static]

RArray< TEffectGroupStruct > iActiveEffectGroups

RArray < TEffectGroupStruct > iActiveEffectGroups [private]

Only one simultanious effect group is supported

RPointerArray< CHuiFxEffect > iActiveEffects

RPointerArray < CHuiFxEffect > iActiveEffects [private]

CHuiFxRenderbuffer * iBufferCache

CHuiFxRenderbuffer * iBufferCache [private]

TInt iBuffersInCache

TInt iBuffersInCache [private]

TInt iBuffersInUse

TInt iBuffersInUse [protected]

CHuiFxEffectCache * iCache

CHuiFxEffectCache * iCache [private]

MHuiEffectObserver * iEffectObserver

MHuiEffectObserver * iEffectObserver [private]

TRect iExtRect

TRect iExtRect [private]

TInt iLowGraphicsMemoryMode

TInt iLowGraphicsMemoryMode [private]

TRequestStatus iParserStatus

TRequestStatus iParserStatus [protected]

THuiFxEngineType iType

THuiFxEngineType iType [private]

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.