Microsoft DirectX 8.1 (C++)

IAMTimelineEffectable::EffectInsBefore

The EffectInsBefore method inserts an effect into the object at the specified priority level.

Syntax

HRESULT EffectInsBefore(
    IAMTimelineObj *pFX,
    long Priority
);

Parameters

pFX

Pointer to the IAMTimelineObj interface of the effect.

Priority

Priority level at which to insert the effect. Use the value –1 to insert the effect at the end of the priority list.

Return Value

Returns S_OK if successful or E_NOTIMPL if the object is not an effect. Otherwise, returns another HRESULT value indicating the cause of the error.

Remarks

The start and stop times of the effect are clipped within the bounds of the object's time range, if necessary.

If there is already an effect at the specified priority level, all the effects from that point on move down the priority list to make room for the new effect.

See Also