removeFx()

FxPtr fl::FxEngine::removeFx

(

int

index

)

Requests removal of an effect from the engine, which might not happen immediately (for example the Fx needs to finish a transition).

Parameters

index

The index of the effect to remove.

Returns

A pointer to the removed effect, or nullptr if the index was invalid.

Definition at line 56 of file fx_engine.cpp.

                                  {
    if (!mEffects.has(index)) {
        return FxPtr();
    }
    
    FxPtr removedFx;
    bool ok = mEffects.get(index, &removedFx);
    if (!ok) {
        return FxPtr();
    }
    
    if (mCurrId == index) {
        // If we're removing the current effect, switch to the next one
        mEffects.next(mCurrId, &mCurrId, true);
        mDurationSet = true;
        mDuration = 0; // Instant transition
    }
    
    return removedFx;
}

References mCurrId, mDuration, mDurationSet, and mEffects.