Name

kOfxParamPropCacheInvalidation — Specifies how modifying the value of a param will affect any output of an effect over time.

Synopsis

#include "/ofxParam.h"
#define kOfxParamPropCacheInvalidation "OfxParamPropCacheInvalidation"

Type

kOfxParamPropCacheInvalidation is of type C string, and has only a single dimension.

Property Set

This is a property that belongs to the plugin parameter descriptor (read/write) and instance (read only),.

Default

The default value is kOfxParamInvalidateValueChange.

Valid Values

This must be one of

  • kOfxParamInvalidateValueChange
  • kOfxParamInvalidateValueChangeToEnd
  • kOfxParamInvalidateAll

Description

Specifies how modifying the value of a param will affect any output of an effect over time.

Imagine an effect with an animating parameter in a host that caches rendered output. Think of the what happens when you add a new key frame.

  • If the parameter represents something like an absolute position, the cache will only need to be invalidated for the range of frames that keyframe affects.
  • If the parameter represents something like a speed which is integrated, the cache will be invalidated from the keyframe until the end of the clip.
  • There are potentially other situations where the entire cache will need to be invalidated (though I can't think of one off the top of my head).