Name

kOfxPropIsInteractive — Indicates if a host is actively editing the effect with some GUI.

Synopsis

#include "/ofxCore.h"
#define kOfxPropIsInteractive "OfxPropIsInteractive"

Type

kOfxPropIsInteractive is of type int, and has only a single dimension.

Property Set

This is a property that belongs to the effect instance (read only).

Valid Values

0 or 1

Description

Indicates if a host is actively editing the effect with some GUI.

If false the effect currently has no interface, however this may be because the effect is loaded in a background render host, or it may be loaded on an interactive host that has not yet opened an editor for the effect.

The output of an effect should only ever depend on the state of its parameters, not on the interactive flag. The interactive flag is more a courtesy flag to let a plugin know that it has an interace. If a plugin want's to have its behaviour dependant on the interactive flag, it can always make a secret parameter which shadows the state if the flag.