FFGLPluginConstants

Enumerations
enum	FFGLPluginType { FFGLPluginTypeEffect = 0, FFGLPluginTypeSource = 1 }
enum	FFGLPluginMode { FFGLPluginModeCPU = 0, FFGLPluginModeGPU = 1 }
Variables
NSString *const	FFGLPixelFormatARGB8888
NSString *const	FFGLPixelFormatBGRA8888
NSString *const	FFGLPixelFormatRGB888
NSString *const	FFGLPixelFormatBGR888
NSString *const	FFGLPixelFormatRGB565
NSString *const	FFGLPixelFormatBGR565
NSString *const	FFGLPluginAttributeNameKey
NSString *const	FFGLPluginAttributeDescriptionKey
NSString *const	FFGLPluginAttributeAuthorKey
NSString *const	FFGLPluginAttributePathKey
NSString *const	FFGLPluginAttributeIdentifierKey
NSString *const	FFGLPluginAttributeMajorVersionKey
NSString *const	FFGLPluginAttributeMinorVersionKey
NSString *const	FFGLParameterAttributeTypeKey
NSString *const	FFGLParameterAttributeNameKey
NSString *const	FFGLParameterAttributeDefaultValueKey
NSString *const	FFGLParameterAttributeMinimumValueKey
NSString *const	FFGLParameterAttributeMaximumValueKey
NSString *const	FFGLParameterAttributeRequiredKey
NSString *const	FFGLParameterTypeBoolean
NSString *const	FFGLParameterTypeEvent
NSString *const	FFGLParameterTypeNumber
NSString *const	FFGLParameterTypeString
NSString *const	FFGLParameterTypeImage

---

Enumeration Type Documentation

enum FFGLPluginMode

Used to distinguish between plugin rendering modes (CPU vs GPU)

Enumerator:

FFGLPluginModeCPU	the plugin is processing image data on the CPU (freeframe 1.0)
FFGLPluginModeGPU	the plugin is processing image data on the GPU (freeframe 1.5/freeframe gl)

enum FFGLPluginType

Used to distinguish between effects and sources.

Enumerator:

FFGLPluginTypeEffect	the plugin is an effect- it operates as a filter on passed images
FFGLPluginTypeSource	the plugin is a source- it generates images

---

Variable Documentation

NSString* const FFGLParameterAttributeDefaultValueKey

Describes the default value for a given parameter key

• For boolean parameters, the object returned for this key is a NSNumber with a boolean value.
• For number paramaters, the object returned for this key is a NSNumber with a float value between 0.0 and 1.0.
• For string paramaters, the object returned for this key is a NSString.

NSString* const FFGLParameterAttributeMaximumValueKey

For number parameters, the object returned for this key is a NSNumber with float value 1.0.

NSString* const FFGLParameterAttributeMinimumValueKey

For number parameters, the object returned for this key is a NSNumber with float value 0.0.

NSString* const FFGLParameterAttributeNameKey

The object returned for this key is a NSString with the name of the parameter. This string should be used to describe the parameter in the user interface.

NSString* const FFGLParameterAttributeRequiredKey

For any parameter, the object returned for this key is a NSNumber with a bool value indicating if that parameter must be set for rendering to succeed. This value will always be YES for boolean, event, number or string inputs. Some image inputs may be optional.

NSString* const FFGLParameterAttributeTypeKey

returns an object which is one of the following strings: FFGLParameterTypeBoolean, FFGLParameterTypeEvent, FFGLParameterTypeNumber, FFGLParameterTypeString, FFGLParameterTypeImage

NSString* const FFGLParameterTypeBoolean

A boolean parameter type

NSString* const FFGLParameterTypeEvent

An event-type parameter

NSString* const FFGLParameterTypeImage

An image-type parameter

NSString* const FFGLParameterTypeNumber

A number-type parameter

NSString* const FFGLParameterTypeString

A string-type parameter

NSString* const FFGLPixelFormatARGB8888

defines a 32-bit ARGB pixel format

NSString* const FFGLPixelFormatBGR565

defines a 16-bit BGR pixel format

NSString* const FFGLPixelFormatBGR888

defines a 24-bit BGR pixel format

NSString* const FFGLPixelFormatBGRA8888

defines a 32-bit BGRA pixel format

NSString* const FFGLPixelFormatRGB565

defines a 16-bit RGB pixel format

NSString* const FFGLPixelFormatRGB888

defines a 24-bit RGB pixel foramt

NSString* const FFGLPluginAttributeAuthorKey

the object returned for this key is an NSString

NSString* const FFGLPluginAttributeDescriptionKey

the object returned for this key is an NSString

NSString* const FFGLPluginAttributeIdentifierKey

returns an NSString four characters long. it is possible two different freeframe plugins could return the same identifier, so it should not be depended on to determine identity.

NSString* const FFGLPluginAttributeMajorVersionKey

returns an NSNumber with integer values representing the major and minor versions of the plugin.

NSString* const FFGLPluginAttributeMinorVersionKey

returns an NSNumber with integer values representing the major and minor versions of the plugin.

NSString* const FFGLPluginAttributeNameKey

the object returned for this key is an NSString

NSString* const FFGLPluginAttributePathKey

the object returned for this key is an NSString