Name

kOfxParamPropUseHostOverlayHandle — A flag to indicate that the host should use a native UI overlay handle for the given parameter.

Synopsis

#include "/ofxParam.h"
#define kOfxParamPropUseHostOverlayHandle "kOfxParamPropUseHostOverlayHandle"

Type

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

Property Set

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

Default

The default value is 0.

Valid Values

0 or 1

Description

A flag to indicate that the host should use a native UI overlay handle for the given parameter.

If set to 1, then a plugin is flaging to the host that the host should use a native UI overlay handle for the given parameter. A plugin can use this to keep a native look and feel for parameter handles. A plugin can use kOfxParamPropHasHostOverlayHandle to see if handles are available on the given parameter.