Name

kOfxImageClipPropIsMask — Indicates that a clip is intended to be used as a mask input

Synopsis

#include "/ofxImageEffect.h"
#define kOfxImageClipPropIsMask "OfxImageClipPropIsMask"

Type

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

Property Set

This is a property that belongs to the clip descriptor (read/write).

Default

The default value is 0.

Valid Values

This must be one of 0 or 1

Description

Indicates that a clip is intended to be used as a mask input

Set this property on any clip which will only ever have single channel alpha images fetched from it. Typically on an optional clip such as a junk matte in a keyer.

This property acts as a hint to hosts indicating that they could feed the effect from a rotoshape (or similar) rather than an 'ordinary' clip.