kOfxParamPropDoubleType
Prev Chapter 24. Properties By Name Next

Name

kOfxParamPropDoubleType — Describes how the double parameter should be interpreted by a host.

Synopsis

#include "/ofxParam.h"
#define kOfxParamPropDoubleType "OfxParamPropDoubleType"

Type

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

Property Set

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

Default

The default value is kOfxParamDoubleTypePlain.

Valid Values

This must be one of

  • kOfxParamDoubleTypePlain - parameter has no special interpretation,
  • kOfxParamDoubleTypeAngle - parameter is to be interpretted as an angle,
  • kOfxParamDoubleTypeScale - parameter is to be interpretted as a scale factor,
  • kOfxParamDoubleTypeTime - parameter represents a time value (1D only),
  • kOfxParamDoubleTypeAbsoluteTime - parameter represents an absolute time value (1D only),
  • kOfxParamDoubleTypeNormalisedX - normalised size wrt to the project's X dimension (1D only),
  • kOfxParamDoubleTypeNormalisedXAbsolute - normalised absolute position on the X axis (1D only)
  • kOfxParamDoubleTypeNormalisedY - normalised size wrt to the project's Y dimension(1D only),
  • kOfxParamDoubleTypeNormalisedYAbsolute - normalised absolute position on the Y axis (1D only)
  • kOfxParamDoubleTypeNormalisedXY - normalised to the project's X and Y size (2D only),
  • kOfxParamDoubleTypeNormalisedXYAbsolute - normalised to the projects X and Y size, and is an absolute position on the image plane.

Description

Describes how the double parameter should be interpreted by a host.

Double parameters can be interpreted in several different ways, this property tells the host how to do so and thus gives hints as to the interface of the parameter.

Prev Up Next
kOfxParamPropDisplayMin Home kOfxParamPropEnabled