Developer

API Reference

ITRANSITION_StartFader()

deprecated
Items marked as deprecated have been replaced by a more powerful, alternative feature. Deprecated interfaces include a reference to the replacement interface, which should be used for all new application development. Deprecated features are still supported for backward compatibility, but should be avoided when developing new applications.
Brew Release
Brew MP 1.0.2
See Also
FaderDesc ITransition ITRANSITION_Start ITRANSITION_Stop
Description
This function starts a fader transition effect. Prior to starting the transition an application should first initialize the FaderDesc data structure to identify the target of the fadeout transition and any parameters specific to fader transitions. Once started, the fade effect will continue until the number of milliseconds specified by the msecs parameter have passed, or until the effect has been stopped by calling ITRANSITION_Stop(). At the conclusion of the fade out (whether it has run to completion or has been terminated early), the transition completion notification callback passed in 'pfnDone' will be issued, providing the application with an opportunity to perform any special processing at the end of the effect.
Parameters
  • po
    []:
    pointer to the ITransition interface object.
  • pd
    []:
    pointer to the FaderDesc data structure describing the target widget.
  • msecs
    []:
    defines the duration of the fadeout effect, expressed in milliseconds.
  • pfnDone
    []:
    pointer to the callback function that BREW will issue when the fadeout has ended.
  • pCxt
    []:
    pointer to private data that is created and owned by the caller.
Interface
ITRANSITION
Prototype
 void ITRANSITION_StartFader(ITransition *po, FaderDesc *pd, uint32 msecs, PFNNOTIFY pfnDone, void *pCtx);
Return
None
Side Effect
None
Comment
The FaderDesc structure passed in should include the target widget of the transition as well as the starting and ending transparency values of for that widget as it undergoes its fadeout.
The duration of the fade is expressed in milliseconds. For example, a 2-second fadeout transition would pass 2000 in for the msecs parameter.
The callback function will be called when the fadeout has ended, whether it has run its entire course to completion, or the effect has been terminated by a call to ITRANSITION_Stop(). Applications that do not wish to receive notification following the completion of a fader transition may pass NULL for pfnDone, and no callback will be registered.
The callback function prototype takes the following form...
      typedef void (* PFNNOTIFY)(void * pDate);

...where pData is passed to the callback as teh same pointer passed into the ITRANSITION_StartFader() function in the pCtx parameter. This is a pointer to data owned and managed entirely by the caller.
  • Follow