Developer

API Reference

ITRANSITION_Start()

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 TransitionDesc ITRANSITION_StartFader ITRANSITION_StartMover ITRANSITION_Stop MoverDesc
Description
This function starts a particular transition effect. Prior to starting the transition an application should first initialize the TransitionDesc data structure associated with the given transition (FaderDesc, MoverDesc, etc.) to identify the target of the transition effect and any parameters specific to that effect. Once started, the effect will continue until "m" milliseconds have passed, or until the effect has been stopped by calling ITRANSITION_Stop(). At the conclusion of the transition effect (whether it has run to completion or has been terminated early), the transition completion notification callback passed in "f" will be issued, providing the application with an opportunity to perform any special processing at the end of the effect.
Parameters
  • p
    []:
    Pointer to the ITransition interface object.
  • d
    []:
    Pointer to the TransitionDesc data structure.
  • m
    []:
    Defines the duration of the transition effect, expressed in milliseconds.
  • f
    []:
    Pointer to the callback function that Brew MP will issue when the transition effect has ended.
  • c
    []:
    Pointer to private data that is created and owned by the caller.
Interface
ITRANSITION
Prototype
   void ITRANSITION_Start(ITransition *p, TransitionDesc *d, long m, PFNNOTIFY f, void *c);
Return
None
Side Effect
None
Comment
The TransitionDesc structure should identify the target widget as well as any parameters specifically required by a particular implementation of the transition interface. For example, those parameters required by the fader or mover transitions.
Since the duration of the transition effect is expressed in milliseconds, a 2-second fade out transition should pass 2000 in the "m" parameter.
The callback function, f, will be called when the associated transition effect has ended. This can either be when it has run its entire course to completion, or the effect has been terminated by a call to ITRANSITION_Stop(). Applets that do not wish to receive notification following the completion of a transition effect may pass NULL for in the f parameter, and no callback will be registered.
The callback function prototype takes the following form...
      typedef void (* PNFNOTIFY)(void * pData);

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