Protocol

FxFilter

The FxFilter protocol defines the methods a filter plug-in must implement to render output.

Declaration

@protocol FxFilter

Overview

Filters are a type of plug-in that takes an input image, modifies it, and produces an output image. This differs from generators which create output without having any input image, and transitions which take two images and move between them.

Filters can be used for color manipulations, distortions, timing changes, and much more.

The FxFilter protocol derives from FxBaseEffect protocol and adds several other methods, including the renderOutput:withInput:withInfo: method which is where a plug-in actually renders its effect.

Topics

Getting the Output Frame Size

- getOutputWidth:height:withInput:withInfo:

Returns the size of the image output by the plug-in.

Required.

Creating and Rendering Frames

- frameSetup:inputInfo:hardware:software:

Determines the type of input and output image the plug-in requires.

Required.

- frameCleanup

Allows the plug-in to clean up after filter rendering.

Required.

- renderOutput:withInput:withInfo:

Renders the output image.

Required.

- numberOfFramesToScheduleAtRenderTime:

Allows the filter to tell the host application how many frames it will need from the input at the given render time.

- schedule:frames:forRenderAtTime:

Allows the filter to tell the host application which frames it will need from the input at a given render time.

Relationships

Inherits From