The Image Filter protocol is for compositions that alter an image (or stream of images). For example, an Image Filter could add a special distortion effect to a video clip.
Name | Data type | Required? | Description |
---|---|---|---|
image | Image | Required | The original image. |
time | Real | Required | A number that changes over time, used to control animations or other changing effects. |
duration | Real | Optional | For FxPlug: The length, in seconds, of the clip. |
framerate | Real | Optional | For FxPlug: The framerate of the project, in frames per second. |
frameNumber | Integer | Optional | For FxPlug: The number of frames since the beginning of the clip, starting at 0. |
quality | Real | Optional | For FxPlug: The rendering quality or level of detail. |
time and quality are further explained later in this section.
Name | Data type | Description |
---|---|---|
outputImage | Image | The altered image. |