Developer

API Reference

ITransition2_GetProperty()

Brew Release
Brew MP 1.0.2
See Also
- ITransition2_SetProperty()
- ITransition2 Interface
Description
This function is used to get a property of the transition. The following properties are available: - ITransition2_PROP_STEPS: Total steps in transition (int)
- ITransition2_PROP_RUNTIME: Runtime of the animation (int)
- ITransition2_PROP_STEPTIME: Time between steps (int)
- ITransition2_PROP_STEPMODE: Real-time or frame by frame (int)
- ITransition2_PROP_WIDGET: Target widget of the transition (IWidget)
- ITransition2_PROP_BITMAP: Target bitmap of the transition (IBitmap)
- ITransition2_PROP_CONTAINER: Target container of the transition (IContainer)
- ITransition2_PROP_SIGNAL_STEP: Step signal (ISignal)
- ITransition2_PROP_SIGNAL_START: Start Signal (ISignal)
- ITransition2_PROP_SIGNAL_END: End Signal (ISignal)
- ITransition2_PROP_CURRENT_STEP: Current Step (int)
- ITransition2_PROP_CURRENT_TIME: Current Time (int)
- ITransition2_PROP_ENDACTION: Transition completed action (int)
- ITransition2_PROP_DESCRIPTOR: Transition parameters (custom struct)

Parameters
  • pif
    [in]:
    Pointer to the ITransition2 interface object.
  • propId
    [in]:
    Specifies the class ID of the property
  • pVal
    [out]:
    Specifies a constant value of the property, if any
  • nValSize
    [in]:
    Specifies the size of the pVal object
  • nSizeReq
    [out]:
    Required size of buffer to return all data
  • ppi
    [out]:
    Receives the IQI object of the property, if any
Interface
Prototype
   AEEResult ITransition2_GetProperty(ITransition2*  pif, 
                                      AEECLSID       propId,
                                      int*           pVal,
                                      int            nValSize, 
                                      int*           nSizeReq,
                                      IQI**          ppi);
Return
   AEE_SUCCESS   --  The requested property has been applied.
   AEE_EBADPARM  --  The requested property could not be applied.
Side Effect
None
Comment
None
  • Follow