Name

kOfxParamPropSecret — Flags whether a parameter should be exposed to a user,

Synopsis

#include "/ofxParam.h"
#define kOfxParamPropSecret "OfxParamPropSecret"

Type

kOfxParamPropSecret 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) and instance (read/write).

Default

The default value is 0.

Valid Values

0 or 1

Description

Flags whether a parameter should be exposed to a user,

If secret, a parameter is not exposed to a user in any interface, but should otherwise behave as a normal parameter.

Secret params are typically used to hide important state detail that would otherwise be unintelligible to a user, for example the result of a statical analysis that might need many parameters to store.