FFGLPlugin Class Reference

A single instance of a FF or FFGL plugin. More...

#import <FFGLPlugin.h>

Public Member Functions
(id)	- initWithPath:
(NSDictionary *)	- attributesForParameterWithKey:
Properties
FFGLPluginType	type
FFGLPluginMode	mode
NSArray *	supportedBufferPixelFormats
NSDictionary *	attributes
NSArray *	parameterKeys

---

Detailed Description

A single instance of a FF or FFGL plugin.

An instance of FFGLPlugin is created by loading a file at a specified path (or by using FFGLPluginManager, but that's discussed elsewhere). Each freeframe "effect" you load has its own instance of FFGLPlugin behind it- the FFGLPlugin must exist for the lifetime off the effect (FFGLRenderer, which is really the "main" class in this framework, automatically retains the plugin used to create it).

Several plugin-related constants used by various methods are listed in the FFGLPluginConstants section.

---

Member Function Documentation

- (NSDictionary *) attributesForParameterWithKey:

(NSString *)

key

Returns a dictionary with information about the parameter specified by key. See the FFGLParameterAttribute... constants, above, for a description of the contents of this dictionary.

Parameters:

key	should be one of the keys returned by parameterKeys.

- (id) initWithPath:

(NSString *)

path

Returns a FFGLPlugin for the FreeFrame plugin at path, if one exists. path should be the path to a FreeFrame plugin.

---

Property Documentation

- (NSDictionary *) attributes [read, assign]

Returns a dictionary with information about the plugin. The dictionary may have some or all of the following keys: FFGLPluginAttributeNameKey FFGLPluginAttributeVersionKey FFGLPluginAttributeDescriptionKey FFGLPluginAttributeIdentifierKey FFGLPluginAttributeAuthorKey FFGLPluginAttributePathKey

- (FFGLPluginMode) mode [read, assign]

Returns one of FFGLPluginModeCPU FFGLPluginModeGPU CPU-mode plugins run in main memory, GPU-mode plugins run on the graphics card.

- (NSArray *) parameterKeys [read, assign]

Returns an array of NSStrings representing the plugin's parameters.

- (NSArray *) supportedBufferPixelFormats [read, assign]

Returns an array of NSStrings indicating the pixel-formats supported. These may be some of FFGLPixelFormatARGB8888 FFGLPixelFormatBGRA8888 FFGLPixelFormatRGB888 FFGLPixelFormatBGR888 FFGLPixelFormatRGB565 FFGLPixelFormatBGR565

- (FFGLPluginType) type [read, assign]

Returns one of FFGLPluginTypeEffect FFGLPluginTypeSource An effect plugin typically has one or more image parameter. A source plugin typically has no image parameters.

---

The documentation for this class was generated from the following files:

• FrameworkSource/FFGLPlugin.h
• FrameworkSource/FFGLPlugin.m