Parameters

How can we help?
< All Topics

Parameters

This page is a reference guide to all FFGL parameters supported by FFGL 2.2.

 

Standard Parameter

 

This is the most common FFGL parameter. Most other parameters are based on the standard parameter.

It is defined as FF_TYPE_STANDARD in the FFGL SDK.

It contains a Float value in the range 0.0-1.0.

The standard representation of this parameter is a Fader.

 

 

Red Parameter

 

This parameter is identical to the standard parameter but represents the Red portion of an RGB or RGBA color value.

It is defined as FF_TYPE_RED in the FFGL SDK.

The standard representation of this parameter is a Fader or a Color Wheel if combined with other color types.

 

 

Green Parameter

 

This parameter is identical to the standard parameter but represents the Green portion of an RGB or RGBA color value.

It is defined as FF_TYPE_GREEN in the FFGL SDK.

The standard representation of this parameter is a Fader or a Color Wheel if combined with other color types.

Blue Parameter

 

This parameter is identical to the standard parameter but represents the Blue portion of an RGB or RGBA color value.

It is defined as FF_TYPE_BLUE in the FFGL SDK.

The standard representation of this parameter is a Fader or a Color Wheel if combined with other color types.

Alpha Parameter

 

This parameter is identical to the standard parameter but represents the Alpha portion of an RGB or RGBA color value.

It is defined as FF_TYPE_ALPHA in the FFGL SDK.

The standard representation of this parameter is a Fader or a Color Wheel if combined with other color types.

Hue Parameter

 

This parameter is identical to the standard parameter but represents the Hue portion of an HSV color value.

It is defined as FF_TYPE_HUE in the FFGL SDK.

The standard representation of this parameter is a Fader or a Color Wheel if combined with other color types.

Saturation Parameter

 

This parameter is identical to the standard parameter but represents the Saturation portion of an HSV color value.

It is defined as FF_TYPE_SATURATION in the FFGL SDK.

The standard representation of this parameter is a Fader or a Color Wheel if combined with other color types.

Brightness Parameter

 

This parameter is identical to the Standard Parameter but represents the Brightness portion of an HSV color value.

It is defined as FF_TYPE_BRIGHTNESS in the FFGL SDK.

The standard representation of this parameter is a Fader or a Color Wheel if combined with other color types.

X Parameter

 

This parameter is identical to the standard parameter but represents the X value of a Position coordinate.

It is defined as FF_TYPE_XPOS in the FFGL SDK.

The standard representation of this parameter is a Fader or a Color Wheel if combined with the Y parameter.

 

 

Y Parameter

 

This parameter is identical to the standard parameter but represents the Y value of a Position coordinate.

It is defined as FF_TYPE_YPOS in the FFGL SDK.

The standard representation of this parameter is a Fader or a Color Wheel if combined with the X parameter.

Boolean Parameter

 

This parameter is identical to the standard parameter but can only contain a 0 or 1 value.

It is defined as FF_TYPE_BOOLEAN in the FFGL SDK.

The standard representation of this parameter is a Checkable Button.

 

 

Integer Parameter

 

This parameter is identical to the standard parameter but its value is rounded to the nearest whole number.

It is defined as FF_TYPE_INTEGER in the FFGL SDK.

It contains a Float value.

Option Parameter

 

This parameter is used to represent a group of options each represented by a Name and a Float value. .

It is defined as FF_TYPE_OPTION in the FFGL SDK.

It contains a Float value equal to the value of the current active option.

The standard representation of this parameter is a Dropdown.

 

 

Text Parameter

 

This parameter is used to represent a single Text value.

It is defined as FF_TYPE_TEXT in the FFGL SDK.

It contains a String value.

The standard representation of this parameter is a Textbox.

 

 

File Parameter

 

This parameter is identical to the text parameter but its value represents the name of a file of a given group of file extensions (e.g. .txt, .mp4 etc.)

It is defined as FF_TYPE_FILE in the FFGL SDK.

It contains a String value.

The standard representation of this parameter is a Filebox.

 

 

Event Parameter

 

This parameter is identical to the boolean parameter but it represents an event trigger from the host application.

It is defined as FF_TYPE_EVENT in the FFGL SDK.

It contains an Integer value in a given range.

The standard representation of this parameter is a Single Shot Button.

 

 

Buffer Parameter

 

This parameter is used to represent an array of numbers each represented by a float value. .

It is defined as FF_TYPE_BUFFER in the FFGL SDK.

It contains a Float value equal to the value of the current active number.

The standard representation of this parameter is a Display.