Name

kOfxInteractPropSuggestedColour — The suggested colour to draw a widget in an interact, typically for overlays.

Synopsis

#include "/ofxInteract.h"
#define kOfxInteractPropSuggestedColour "OfxInteractPropSuggestedColour"

Type

kOfxInteractPropSuggestedColour is of type double, and has 3 dimensions.

Property Set

This is a property that belongs to the read only on the interact instance.

Default

The default value is 1.0.

Valid Values

greater than or equal to 0.0

Description

The suggested colour to draw a widget in an interact, typically for overlays.

Some applications allow the user to specify colours of any overlay via a colour picker, this property represents the value of that colour. Plugins are at liberty to use this or not when they draw an overlay.

If a host does not support such a colour, it should return kOfxStatReplyDefault