Back to Main Site
Programming Guide
Programming Reference
API Reference
OpenFX Plug-in API Programming Guide
Next
OpenFX Plug-in API Programming Guide
Bruno
Nicoletti
Document version 1.3
Copyright © 2005-2012 The Open Effects Association
Table of Contents
Foreword
Intended Audience
What is OFX
1. OFX Overview
Language
API Definition
Symbolic Dependancies
Host to Plugin Communication
Host to Plugin Communication
2. Introduction To OFX, A Simple Plug-in
Headers
The Plug-in Struct and The Two Exported Functions
The Host Struct
The Main Entry Function
The Load Action
The Describe Action
The Describe In Context Action
The Render Action
In Summary
3. The Generic OFX Plug-in Architecture
Overview
Plug-in Binaries and Required Symbols
OfxGetNumberOfPlugins
OfxGetPlugin
Identifying, Versioning and Defining an OFX Plug-in
The OfxPlugin Struct
Interpreting the OfxPlugin Struct
Suites, Hosts and APIs
Function Suites
The OfxHost Struct
Sequences of Operations Required to Load a Plug-in
Errors, Status Codes and Exceptions
Packaging OFX Plug-ins
Binary Types
Installation Directory Hierarchy
Installation Location
plug-in Icons
Externally Specified Resources
4. Visual Effects Architectures
Clips
Images
Parameters
Time
Effects
Contexts
Co-ordinate Systems
Regions of Definition and Regions of Interest
5. OFX Image Effect Plug-ins
6. Parameters
