Developer

API Reference

ITransition2_GetStepMode()

Brew Release
Brew MP 1.0.2
See Also
- ITransition2
- ITransition2_GetProperty
- ITransition2_SetStepMode
Description
This function is a ITransition2_GetProperty shortcut used to get the step mode of the transition. The step mode determines how a transition will run. In real time mode, the transition determines the current step to draw based on the given runtime and the elapsed time received from the step() function. The transition will be finished when the elapsed time is greater than the run time. In step mode, the transition will step to the next frame with every step() calls it receives, ignoring the elapsed time. Step mode ensures that every single step of the transition is performed, but how long it takes is largely dependent on the controller's step time and how busy the system is. The transition will be over once it reaches the defined max steps.
Parameters
  • pif
    []:
    [in] Pointer to the ITransition2 interface object.
  • pnStepMode
    []:
    [out] integer pointer that will hold the property's value
Prototype
   int ITransition2_GetStepMode(ITransition2* pif, int* pnStepMode)
Return
   AEE_SUCCESS          - The requested property has been retrieved.
   AEE_EBADPARM         - Invalid out parameter.
   ECLASSNOTSUPPORT     - The requested property is not supported.
Side Effect
None
Comment
Step mode can be set to the following values: ITransition2_PVAL_STEPMODE_REAL : Real time mode ITransition2_PVAL_STEPMODE_FRAME : Frame-by-frame mode.
  • Follow